Docs

Self-hosted

Synology

Run AnimSync in Synology Container Manager on DSM 7.2 or newer. Leave Web Station off, and do not expose the port through QuickConnect.

Synology Container Manager on DSM 7.2 or newer can run the same Compose file. Models without Container Manager cannot. The images are multi-arch, so both x86-64 and ARM64 models that have Container Manager are in range.

Building on a small NAS is the tight step (about 2 GB of memory, 4 GB comfortable). Running needs about 1 GB free. If the NAS is short on memory, build on a PC and copy the images across.

Install

  1. Put the source in a folder such as docker/animsync.
  2. Copy .env.example to .env. Set POSTGRES_PASSWORD. Set WEB_PORT=8090 if 8080 is already taken on DSM, and set POSTGRES_PORT to a free port. The database port stays on the NAS.
  3. In Container Manager, create a project from the existing docker-compose.yml. Leave Web Station and its web portal off. The web container is already the web server. A second proxy in front of it can break large uploads.
  4. Open http://<nas-ip>:8090 and create the administrator account. Invite everyone else from Team.

The sample project command is the same. In Container Manager, open the API container's terminal and run node dist/seed.js.

Keep it on the LAN

Do not port-forward AnimSync, and do not publish it through QuickConnect, DDNS or a public reverse proxy. People sign in with e-mail and password, and a forgotten password is a new link from Team. Remote staff should come in over a VPN.

A hostname on the LAN, if you want one, is a reverse proxy in Control Panel → Login Portal → Advanced, not Web Station. Test a large upload through it.

Update and back up

Rebuild from Container Manager (Project → Action → Build), or over SSH from the project folder:

sudo docker compose up -d --build

Back up first. The database dump and the animsync_blobdata volume are in Backups. Put the copies in a folder Hyper Backup can see. Docker's own storage under @docker is not in Hyper Backup.

An install that has never had passwords follows the one-time link in Upgrades.