Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/gnmyt/Nexterm/llms.txt

Use this file to discover all available pages before exploring further.

Nexterm follows a rolling release model: the latest tag on each Docker image always points to the most recent stable release. Upgrading consists of pulling the new image and recreating your container.
Back up your data volume before upgrading. While Nexterm data migrations are handled automatically, a backup gives you a recovery point if something goes wrong. See the backup guide for instructions.

​
Upgrade with docker run

If you started Nexterm with a docker run command, run the following sequence to pull the latest image and recreate the container:
1

Pull the latest image

Replace nexterm/aio with nexterm/server or nexterm/engine if you are running a split deployment.
docker pull nexterm/aio:latest
2

Stop and remove the existing container

This removes the container but leaves the nexterm data volume intact.
docker stop nexterm && docker remove nexterm
3

Start the updated container

Run the same docker run command you used during installation. Your data volume is reattached automatically.
docker run -d \
  -e ENCRYPTION_KEY=YOUR_ENCRYPTION_KEY \
  --network host \
  --name nexterm \
  --restart always \
  -v nexterm:/app/data \
  nexterm/aio:latest

​
Upgrade with Docker Compose

1

Pull the latest images

Run this from the directory containing your docker-compose.yml:
docker compose pull
2

Recreate the containers

docker compose up -d
Compose detects that the pulled images differ from the running containers and recreates only the affected services.
You can combine both steps into a single command: docker compose pull && docker compose up -d

​
Verify the upgrade

After the container restarts, open the Nexterm web interface and confirm it loads correctly. The version number is visible in the bottom-left corner of the sidebar.

​
Things to watch for

Nexterm is in beta, and some releases may include breaking changes to environment variables, volume paths, or configuration file formats. Read the GitHub release notes before upgrading to check for any manual migration steps required for that release.
  • Encryption key — the ENCRYPTION_KEY value must stay the same across upgrades. Changing it will make existing stored credentials unreadable.
  • Split deployments — upgrade both nexterm/server and nexterm/engine together. Running mismatched versions is not supported and may cause connection failures.
  • Configuration files — if a release changes the engine config.yaml schema, update your file before restarting the engine container.

Build docs developers (and LLMs) love

Get started for freeTalk to us