From 7bb3759cfa9c4daea9a8d93d54f8b4fe2e24cfdb Mon Sep 17 00:00:00 2001 From: maxlath Date: Mon, 3 Mar 2025 00:10:06 +0100 Subject: [PATCH] readme: add section on updates --- README.md | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 48115b5..2dce1e6 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,7 @@ The service orchestration is implemented using Docker Compose. - [Initial configuration](#initial-configuration) - [Generate a TLS certificate](#generate-a-tls-certificate) - [Usage](#usage) +- [Update](#update) - [Tips](#tips) - [Troubleshooting](#troubleshooting) - [Elasticsearch errors](#elasticsearch-errors) @@ -88,7 +89,7 @@ docker run -it --rm --name certbot -p 80:80 -v "$(pwd)/certbot/conf:/etc/letsenc Start all the services (Nginx, CouchDB, Elasticsearch, and the Inventaire [server](https://git.inventaire.io/inventaire)) in production mode: ```sh -docker compose up -d +docker compose up --detach ``` Alternatively, to test locally, you can start only Inventaire and its dependencies (CouchDB and Elasticsearch) without Nginx, with the following command: @@ -96,6 +97,28 @@ Alternatively, to test locally, you can start only Inventaire and its dependenci docker compose up inventaire ``` +## Update + +Before updating to the latest version, check that there are no breaking changes. +You can find your current version number by visiting fetching the URL `/api/config` on your domain (example: https://inventaire.io/api/config). +You can find details about the changes since your version on this page: /home/maxlath/code/inventaire/inventaire/CHANGELOG.md. +For changes marked to require data transformation, [some knowledge of CouchDB is recommended](https://docs.couchdb.org/en/stable/intro/index.html), as well as familiarizing yourself with the [recommanded way to export, transform and reimport data in CouchDB](https://github.com/inventaire/inventaire/blob/main/docs/administration/couchdb_data_transformations.md). + +```sh +cd docker-inventaire +# Pull updates to this repository (might include database versions updates, and such) +git pull origin main +# Pull the updated images +docker compose pull +# Stop and remove the previous `inventaire` container +# Include the `nginx` container and `--volumes` as otherwise the volume shared between the `inventaire` and the `nginx` container keep the files from the previous image +docker compose down inventaire nginx --volumes +# Restart containers with the new image (with the --detach option, to be able to close the terminal) +docker compose up --detach +# Check that it restarted without errors +docker compose logs --follow --tail 500 inventaire +``` + ## Tips General tips on how to run Inventaire can be found in the [server repository docs](https://git.inventaire.io/inventaire/tree/main/docs).