VaultStadio

Self-Hosted Storage Platform with Plugin Architecture

A modern, extensible file storage solution inspired by Google Drive, built for self-hosting on TrueNAS and other platforms.

Quick Start • Overview • Architecture • API • Documentation

---

Features

Core

• Multi-Platform: Web (WASM), Android, iOS, Desktop – built with Compose Multiplatform
• Plugin Architecture: Extend functionality without modifying core code
• Secure Sharing: Password-protected links with expiration and download limits
• Modern Stack: Kotlin, Ktor, Compose Multiplatform, PostgreSQL

Advanced (Phase 6)

• File Versioning: Complete version history with restore and diff
• Sync Protocol: Multi-device synchronization with conflict resolution
• Real-time Collaboration: Multi-user editing with OT algorithm
• Federation: Cross-instance sharing
• WebDAV & S3: Mount as network drive or use AWS CLI

Tech Stack

Layer	Technology
Backend	Kotlin, Ktor, Coroutines, Arrow
Database	PostgreSQL, Exposed ORM, Flyway
Frontend	Compose Multiplatform
Shared	Kotlin Multiplatform
Container	Docker, Helm, Kubernetes

Quick Start

Docker Compose (Recommended)

git clone https://github.com/yourusername/vaultstadio.git
cd vaultstadio

# Configure
cp docker/.env.example docker/.env
# Edit docker/.env: set POSTGRES_PASSWORD and VAULTSTADIO_JWT_SECRET

# Start
docker-compose -f docker/docker-compose.yml up -d

# Access: http://localhost (Web UI), http://localhost:8080 (API)

Development

# Start PostgreSQL
docker-compose -f docker/docker-compose.yml up -d postgres

# Run backend
./gradlew :kotlin-backend:api:run

# Run frontend (choose one)
./gradlew :compose-frontend:composeApp:run              # Desktop
./gradlew :compose-frontend:composeApp:wasmJsBrowserRun # Web

See QUICK_START.md for TrueNAS deployment and more options.

Project Structure

vaultstadio/
├── kotlin-backend/     # Ktor backend (core, api, infrastructure, plugins)
├── compose-frontend/   # Compose Multiplatform UI
├── docker/             # Docker Compose, Dockerfiles
├── helm/               # Kubernetes/TrueNAS Helm charts
└── docs/               # Documentation (see docs/INDEX.md)

Documentation

Document	Description
docs/INDEX.md	Start here – Documentation navigation
docs/PROJECT_OVERVIEW.md	What the project offers
docs/getting-started/QUICK_START.md	Setup guide
docs/architecture/ARCHITECTURE.md	System design
docs/api/API.md	API reference
docs/architecture/KNOWN_ISSUES.md	Known limitations
CONTRIBUTING.md	Contribution guidelines

Commands

# Build
make build                    # Full build
./gradlew :kotlin-backend:api:build -x test

# Test
make test                     # All tests
./gradlew test

# Quality (run before commit)
./gradlew ktlintFormat && ./scripts/check-no-fqn.sh && ./gradlew detekt

# Docker
make docker-up                # Start all
make docker-down              # Stop all

See docs/INDEX.md for complete command reference.

Contributing

See CONTRIBUTING.md for guidelines. Key points:

1. Format with ktlintFormat
2. Check with detekt and check-no-fqn.sh
3. Add tests for new features
4. Write in English

License

MIT License – see LICENSE

---

Made with Kotlin