Docs

Install and run AnimSync Self-Hosted

The current release is built from source with Docker Compose. Published images and a full install guide come with commercial licensing.

Requirements

	Minimum	Comfortable
Docker	Docker Engine with Compose v2, or Docker Desktop, or Synology Container Manager (DSM 7.2+)
Memory while running	about 1 GB free	2 GB or more
Memory while building	about 2 GB	4 GB
Disk	about 1 GB for images, plus your published files	database on SSD
Network	internet access while building; none needed while running

First start

Get the source and copy the settings file:
```
cp .env.example .env
```
Set a real database password and the web port in .env (POSTGRES_PASSWORD, WEB_PORT).
Build and start:
```
docker compose up -d --build
```
The web app answers on http://localhost:8080 (or your WEB_PORT). Database migrations run when the API starts.

Optional sample project:

docker compose exec api node dist/seed.js

There is no sign-in on self-hosted installs yet. Keep AnimSync on a trusted network or VPN, and never publish the database port.

Publishing from scripts

The sto command line publishes a file as a new version, with an optional review video and 3D preview:

sto publish attack.fbx --project BOSS --asset AS_Attack --video attack.mp4 --fps 30 --frames 64

Backups

Back up two things together: the PostgreSQL database and the blobdata volume that holds published files and videos.

docker compose exec postgres sh -c 'pg_dump -U sto -Fc sto > /tmp/animsync.dump'
docker compose cp postgres:/tmp/animsync.dump ./animsync.dump

Upgrading

Take a backup (above).
Get the new release and rebuild:
```
docker compose up -d --build
```
Check what is running: GET /api/meta reports the version and database schema.

Upgrades are one-way: to go back, restore the backup taken before upgrading. An older release refuses to start on a database that a newer one has upgraded.