BoxBox

A modern, self-hosted file manager for your homelab

BoxBox is a self-hosted file manager for homelab and NAS-style servers. It provides a browser UI for mounted Linux paths, large file uploads, previews, search, and background file operations.

Quick Start

git clone https://github.com/jR4dh3y/BoxBox.git
cd BoxBox
cp .env.example .env
# Edit .env, especially FM_JWT_SECRET and FM_USERS_admin.
docker compose up -d --build

The provided compose file is Traefik-oriented. For a simple local docker run setup, see docs/docker.md.

Features

• Browse multiple configured mount points from one web UI.
• Upload large files with chunked and resumable upload support.
• Preview common image, audio, video, PDF, and code/text files.
• Copy, move, and delete files through background jobs.
• Track job progress through WebSocket updates.
• Search directories by file or folder name.
• Configure read-only mounts, users, rate limits, and allowed origins.

Repository Layout

backend/      Go API server and embedded frontend host
frontend/     SvelteKit application
docs/         Public project documentation
scripts/      Local development helpers
Dockerfile    Unified frontend/backend production image

Documentation

Start with docs/index.md for install, configuration, API, development, security, architecture, and troubleshooting docs.

License

MIT. See LICENSE.