Deploy with Portainer or Synology
The stack needs only docker-compose.yml and your settings. No other file sits beside it.
The images are for Intel and AMD processors only. On Synology, that means the Intel and AMD “+” models.
Before you start
Section titled “Before you start”- A domain name pointing at the machine.
- Ports open: TCP 80 and 443 (your reverse proxy), TCP 7881 and UDP 50000–50100 (voice).
- A settings file: copy
.env.minimal.exampleand fill it in. Use long random values for every password and secret. Leave outCOMPOSE_FILEwhen you paste settings into Portainer.
Portainer
Section titled “Portainer”- Stacks › Add stack. Name it
auratree. - Web editor: paste
docker-compose.yml. - Environment variables › Advanced mode: paste your settings.
- Deploy the stack.
- Containers › the api container › Logs: search for
ADMIN CLAIM CODE. If you missed it, restart the api container: it’s printed again until claimed. Then claim your server. - Reverse proxy. Nothing in the stack faces the internet on its own. Put Nginx Proxy Manager, Caddy or another proxy in front, with two names: your chat address to port 3040, and your voice address to port 7880, both with WebSocket support.
Those ports listen on 127.0.0.1 by default. If your proxy runs in another container or on another machine, set
API_BINDandLIVEKIT_BINDto this machine’s LAN address. - Phone notifications (optional): in the ntfy container’s Console, run the two
ntfycommands from Deploy AuraTree, then add the token to your settings.
To update: Stacks › auratree › Editor, set AURA_VERSION to the new release, and Update the stack. Read the changes between your release and the new one first.
Synology (Container Manager)
Section titled “Synology (Container Manager)”- File Station: make a folder such as
docker/auratree, and putdocker-compose.ymland your settings file (named.env) in it. - Container Manager › Project › Create: pick that folder and use the existing compose file.
- Container › the api container › Log: search for
ADMIN CLAIM CODE. - Control Panel › Login Portal › Advanced › Reverse Proxy: DSM owns ports 80 and 443, so use its proxy. Add two entries: your chat address on HTTPS to localhost port 3040, and your voice address on HTTPS to localhost port 7880, both with WebSocket headers on. Add certificates in Control Panel › Security › Certificate (Let’s Encrypt works).
- Control Panel › Security › Firewall: allow TCP 7881 and UDP 50000–50100, and forward them on your router.
- Backups: in Control Panel › Task Scheduler, add a scheduled task that runs
backup.shfrom the folder as root.
If voice connects and then drops
Section titled “If voice connects and then drops”The UDP range has to reach the machine. Check the firewall on the NAS or server and your router’s port forwarding first.
Your own LiveKit settings
Section titled “Your own LiveKit settings”LiveKit runs from settings inside the compose file. To use your own file, set LIVEKIT_CONFIG to its full path. A path next to the compose file doesn’t work in a Portainer stack.
