Install the server

The Antresol server is a single executable with the web interface built in. You need a computer or NAS that is on while you watch, and ffmpeg.

Docker (recommended)

docker run -d --name antresol --restart unless-stopped \
  -p 8420:8420 \
  -v /path/to/config:/config \
  -v /path/to/library:/media \
  -e VAULT_MEDIA_ROOT=/media \
  ghcr.io/antresol-app/antresol-server:latest

The image is built for linux/amd64 and linux/arm64 and includes ffmpeg.

Ready-made binary

Download the archive for your system from the releases page (Linux x86-64 and ARM64, macOS Apple Silicon and Intel), install ffmpeg and run:

VAULT_DATA_DIR=~/antresol/config VAULT_MEDIA_ROOT=~/antresol ./antresol-server

On macOS the binary is not signed yet: before the first run, execute xattr -d com.apple.quarantine antresol-server.

First run

Open http://<computer-address>:8420 in a browser and create the administrator.

Put your files into these folders inside VAULT_MEDIA_ROOT (with Docker, inside the folder you mount as /media, for example /path/to/library/media/movies/):

Folder	Contents
`media/movies/`	films, one folder per film
`media/series/`	TV shows: `Title/Season 01/…S01E01…`
`media/music/`	music: `Artist/Album/`
`media/books/ebooks/`	EPUB, FB2, MOBI/AZW3 and PDF books
`media/books/audiobooks/`	audiobooks, one folder per book
`media/books/manga/`	comics and manga in CBZ

Create profiles for your family. Give kid profiles an age limit.
Install the Antresol app on iPhone, iPad or Mac and enter the server address.

Main settings

`VAULT_DATA_DIR`	the server's database and settings
`VAULT_MEDIA_ROOT`	the root of the library
`VAULT_LISTEN`	address and port, `:8420` by default
`VAULT_PUBLIC_URL`	the server's https address on the internet, if it has one
`VAULT_TMDB_KEY`	a The Movie Database key for posters and descriptions (optional)

For access over the internet, use https through a reverse proxy or a VPN such as Tailscale. Only add files you have the rights to.

Third-party licences are in THIRD_PARTY_LICENSES.md in every archive.