Getting Started

This page starts Foxel with Docker Compose.

Prerequisites

Docker installed
Docker Compose installed (included with Docker Desktop)

1. Create data directories

Create data for persistent storage:

bash

mkdir -p data/db data/mount
chmod 777 data/db data/mount

2. Download the Docker Compose file

bash

curl -L -O https://github.com/DrizzleTime/Foxel/raw/main/compose.yaml

After downloading, update the following key environment variables in compose.yaml:

SECRET_KEY
TEMP_LINK_SECRET_KEY

3. Start the services

bash

docker compose up -d

4. Open the app

After the services start, open the page in your browser based on the port mapping in compose.yaml.

On first startup, follow the onboarding page to initialize the admin account.

5. Add storage

Open Storage Adapters, choose a type from the storage overview, and follow Common configuration to set a mount path and credentials. After saving, verify browsing and downloading in the file manager.