Self-hosted
Install and run
Install AnimSync Self-Hosted with Docker Compose, create the administrator account, and publish the first file.
The current release is built from source. These steps assume Docker is already installed. See Server requirements for what the machine needs.
First start
- Get the source and copy the settings file.
cp .env.example .env
- In
.env, set a real database password (POSTGRES_PASSWORD) and the web port (WEB_PORT, 8080 if you leave it).
- Build and start.
docker compose up -d --build
The web app answers on http://localhost:8080, or whichever WEB_PORT you set. Database migrations run when the API starts.
- Open that address and create the administrator account. The first account is the administrator, and the setup page then closes. Invite everyone else from Team. Each invitation is a link you copy to the person, and it works once.
- Optional: load the sample project.
docker compose exec api node dist/seed.js
There is no AnimSync account service to call. Keep the server on a trusted network or a VPN, and never publish the database port. ANIMSYNC_ACCESS=open turns sign-in off for a trusted LAN only.
Publishing from scripts
The animsync command publishes a file as a new version. The project code and the asset name are the ones in AnimSync:
animsync publish attack.fbx --project BOSS --asset AS_Attack --video attack.mp4 --fps 30 --frames 64
Details are in Publishing with animsync.
What to do next
Back up the database and the published files before you change anything. The commands are in Backups. An upgrade is a rebuild, described in Upgrades.