Gruxi Web Server

Appearance

Updating Gruxi ​

Updating Gruxi is straightforward. Here are the steps to update your Gruxi instance:

For Docker users ​

This requires that you have set up your docker-compose.yml file as described in our Getting Started guide, with the Gruxi service configured to pull the latest image. If you have a specific version tag in your docker-compose.yml, update it to the desired version.

Pull the latest image and restart your container

sh
docker compose pull
docker compose up -d

This will pull the latest Gruxi image from the container registry and restart your Gruxi container with the new version. Your configuration and data will be preserved since they are stored in mounted volumes.

For non-Docker users ​

If you are running Gruxi without Docker, you can update it by downloading the latest release from the Gruxi GitHub releases page.

Stop the existing Gruxi service, then replace it with the new release, making sure to keep your configuration files and data intact. After replacing the files, restart the Gruxi service to apply the update.

Backup before updating ​

Before performing any update, it is always a good idea to back up your Gruxi configuration and data. This way, if anything goes wrong during the update process, you can easily restore your previous state. There are only a few items to back up:

  • db directory, which contains the SQLite database with your configuration and data.
  • certs directory, if you have TLS certificates.
  • logs directory, if you want to keep your logs (optional).

Data migration ​

Gruxi is designed to migrate your data and configuration across versions, so you should not lose any settings or data when updating. However, it is always good to check the release notes for any breaking changes or migration steps that may be required.