Upgrade & Maintenance

Upgrade within version 2

Your data lives in the data directory, not in the container. An upgrade is: remove the container, start the new image on the same data.

1. Read the release notes.

2. Take a backup of the data directory.

3. Stop and remove the container. The install page used the name pizug-companion:

   docker stop pizug-companion
   docker rm pizug-companion

4. Pull the version you want. The current one is 2.0.0:

   docker pull pizug/companion:2.0.0

5. Start it with the same data volume, port and environment variables as before:

   docker run -d --name pizug-companion -p 3000:8080 -v pizug_companion:/data --restart=always pizug/companion:2.0.0

With Docker Compose, change the image tag and run docker compose up -d.

The database is updated in place on the first start of a new version. Stored message logs are not rewritten: every version reads the logs that earlier versions wrote.

Going back to an older version

An older version refuses to start on a database that a newer version has already updated, and says so in its log. To go back, restore the backup from step 2.

From version 1 to version 2

Version 2 is a new server. It does not read the data directory of version 1, and there is no migration. Version 1 only held connection settings and a cache of downloaded artifacts, so nothing is lost that cannot be fetched again.

1. Stop and remove the version 1 container. Keep its data directory until version 2 runs, in case you want to look something up.
2. Install version 2 with a new, empty data volume.
3. Create the administrator. Version 2 signs in with a username instead of an email address, and the variables ADMIN_EMAIL / ADMIN_PASS are gone: see the first administrator.
4. Get a new license key. Keys of version 1 are not accepted: see Set License.
5. Connect your tenants again. The service keys you created for version 1 still work.

What changed in the tools is listed in the release notes.

Maintenance

• Disk space. Message logs are what grows. When the data volume has less than 1 GB free, log sync pauses and the application shows an alert; nothing is deleted. Sync continues by itself once there is space, and nothing is missed while the tenant still has the logs. Retention, quotas and the archive directory are described under Message Logs and Configuration.
• Backup. See Backup. Keep master.key with every backup.
• Health. GET /healthz on the HTTP port answers without sign-in, and the Docker image reports its health to Docker.
• Locked out. The command line creates users and resets passwords without a running server: see Users & Roles.