BiblioViva Documentation
Installation

Update BiblioViva

This page explains how to bring BiblioViva to the latest version, for whoever manages the computer it runs on. The library's data (patrons, books, loans, photos, settings) stay where they are.

Procedure

Make a backup

  1. Make a backup with Back up now, as described in the section Make a backup now of the step Backups.

The nightly backup and the one to keep outside the computer are explained in the same step.

Update

  1. Open the terminal of the BiblioViva computer, as at the step Connect to the computer.

  2. Copy the following command, paste it and press Enter. It is the same command as the installation.

    curl -fsSL https://raw.githubusercontent.com/itotm/biblioviva/main/setup.sh | bash -s -- --lang en
    
  3. Wait. The program recognises the installation already made, asks no question and writes a line like the following, with the folder and the way of connecting (tailscale or lan) that BiblioViva already has.

    BiblioViva is already installed in /home/<user>/biblioviva (tailscale): updating.
    
  4. Wait for the end. The program downloads the latest version, restarts BiblioViva and writes "BiblioViva is ready." with the usual address. The restart interrupts BiblioViva for a few moments: do it when nobody is working at the desk.

Note. The program rewrites the compose.yml file of the biblioviva folder (and, with Tailscale, tailscale/serve.json) with those of the way of connecting in use. The .env file, with the Tailscale key and the chosen version, and the config and backups folders are not touched. Whoever edited compose.yml by hand must make the edit again.

Update with Docker commands (alternative)

For whoever prefers not to download the installation program again, two commands are enough.

  1. Go into the BiblioViva folder.

    cd ~/biblioviva
    
  2. Download the latest version.

    docker compose pull
    
  3. Restart BiblioViva with the downloaded version.

    docker compose up -d
    

Stay on a version

By default BiblioViva follows the latest published version. To stop it at a precise version, for example not to change version during the school year:

  1. Open the .env file with the terminal's editor.

    nano ~/biblioviva/.env
    
  2. Find the line that starts with BIBLIOVIVA_IMAGE= and replace the part after the = sign with the wanted version, for example:

    BIBLIOVIVA_IMAGE=ghcr.io/itotm/biblioviva:1.0.0
    
  3. Save with Ctrl+O and Enter, exit with Ctrl+X, then run the commands of the previous section (docker compose pull, then docker compose up -d).

To go back to the latest version, write ghcr.io/itotm/biblioviva:latest again. Running the installation command again does not change this line.

Result

BiblioViva answers at the same address as before, the login page opens and the books, the patrons and the loans are those of before.

Possible problems

A–Z index