Upgrade
Move highsea to a new release, and what to do if one goes wrong.
Written for highsea 0.1.0.
highsea doesn't update itself. A new release is a new Docker image: you pull it and recreate the container, and highsea does the rest when it starts.
Know when there's a release
System › Updates shows the version you have and the newest one on your channel, with its release notes. highsea checks on its own, and Check now checks straight away. Nothing is downloaded until you pull the image.
The owner chooses the channel, in Settings › General › Updates. Stable shows stable releases only. Beta gets new versions first, and stable versions show on both.
Choose how you follow releases
The compose files use the latest tag, which always points at the newest stable release. Pulling it moves you to whatever is newest.
If you'd rather choose each move yourself, use a version instead:
image: ghcr.io/highsea-tv/highsea:0.1.0and change the number when you're ready. Either way, read the release notes first. While highsea is at 0.x, a release can change how something works, and its notes say what to do.
What happens when highsea starts on a new version
If the new version changes the database, highsea first makes a backup of it, marked Before an update in System › Backups, then updates the database. Your films, downloads and subtitles aren't touched. You don't need to make a backup by hand, though you can with Back up now.
Upgrade
From the folder with compose.yaml:
docker compose pull
docker compose up -dpull downloads the new image and up -d recreates the container from it, keeping your folders. Old images stay on disk until you remove them with docker image prune.
If an update goes wrong
The Before an update backup holds your database exactly as it was, so nothing is lost while you sort it out.
Going back to an older version of highsea isn't supported yet. An older version doesn't know the changes a newer one made to the database, so pinning the old image on its own isn't safe. If a release misbehaves, stay on it and open an issue with what you see in System › Logs.
To undo a change you made yourself, such as a setting, restore any backup from System › Backups with Restore, then Restore and restart. highsea keeps what's there now as a backup of its own, puts the older database in place and restarts on the version you're running. Settings, people and history go back to that moment; anything since is lost. Media files aren't touched, and apps reconnect on their own.
The restart works by highsea stopping itself on purpose, so the container needs a restart policy, as every compose file and template in these guides has: restart: unless-stopped.
Move highsea to another machine
Backups hold the database, but never secret.key, the file in the config folder that seals your passwords and keys. A backup restored on another machine without it can't open them, so sign-ins and connections stop working. Backups explains how to move with a backup and your secret.key.
To move everything at once, stop highsea, copy the whole config folder to the new machine, and start highsea there with the same compose file. Keep the data folder at the same path inside the container, /data, so the library's paths still match.