Quick Start

Use this page to get BoxBox running quickly with Docker Compose and the published GitHub Container Registry image. This is the preferred deployment path and does not require cloning the repository. For the full deployment reference, see Docker deployment.

Quick Install with Compose

mkdir -p boxbox
cd boxbox

curl -fsSLO https://raw.githubusercontent.com/jR4dh3y/BoxBox/master/docker-compose.yml
curl -fsSLO https://raw.githubusercontent.com/jR4dh3y/BoxBox/master/.env.example
mkdir -p backend
curl -fsSL https://raw.githubusercontent.com/jR4dh3y/BoxBox/master/backend/config.yaml -o backend/config.yaml

cp .env.example .env
$EDITOR .env

docker compose pull
docker compose up -d

Open http://localhost:8080 and sign in as admin with the password you set in BOXBOX_USERS_admin.

For a single-container docker run command or local source build, use the separate alternatives in Docker deployment.

Required Edits

Before starting a reachable deployment, change at least:

BOXBOX_JWT_SECRET="$(openssl rand -base64 32)"
BOXBOX_USERS_admin="a-long-unique-password"
HOST_PORT=8080

Also edit backend/config.yaml if you want to expose different paths. The default sidebar folders map to $HOME/Desktop, $HOME/Downloads, and the other standard home folders unless you set HOME_PATH; override DESKTOP_PATH, DOWNLOADS_PATH, DOCUMENTS_PATH, MUSIC_PATH, PICTURES_PATH, or VIDEOS_PATH in .env to point one shortcut somewhere custom.

Open BoxBox

For the quick install above, open:

http://localhost:8080