Getting started¶
Requirements¶
- Docker Engine and Docker Compose.
- Persistent storage for
/appdata. - A Plex token and/or Jellyfin API key.
- Optional SMTP and Discord credentials.
Install with Compose¶
git clone https://github.com/Nexius2/VODUM.git
cd VODUM
cp .env.example .env
mkdir -p appdata logs backups
docker compose up -d
Open http://YOUR_SERVER_IP:8097. The included Compose file maps:
| Host | Container |
|---|---|
./appdata |
/appdata |
./logs |
/appdata/logs |
./backups |
/appdata/backups |
First-run wizard¶
The wizard creates the administrator account, chooses the interface language and guides initial server configuration. Use a strong password and keep the application restricted to trusted networks.
After setup:
- Add a server and validate its credentials.
- Run the provider synchronization task.
- Confirm libraries and users were imported.
- Configure expiration behavior and Communications.
- Review enabled tasks before turning on global scheduling.
- Create a full backup.
Upgrade¶
docker compose pull
docker compose up -d
docker compose logs -f vodum
Startup applies idempotent database bootstrap and migrations automatically. Do not interrupt the first start after an upgrade.