Skip to main content

Update

To update an existing version of the TMS on your docker just follow the steps bellow. Please note: Some commands rely on docker compose.

  1. Navigate to the folder which contains the docker-compose.yml file you used to create the server.

  2. Stop the container running the TMS server by executing

    docker compose stop tms-server
    note

    Remember to put in the -E parameter if you are using sudo so your environment variables get passed down to the process running docker compose.

  3. Update the version of your image. This step depends on weather a version tag is used or not:

    1.1 If a version tag is used: Update the version tag of the ghcr.io/dudrie/tutor-management-system image in the docker-compose.yml file.

    1.2 If no version tag is used: Run the following command to update your local image to the latest version:

    docker pull ghcr.io/dudrie/tutor-management-system:latest
  4. Refer to the "Configuration" section of the corresponding release to check if the configuration files have been updated and if any changes are required. If so apply all necessary changes before moving forward.

  5. Export the environment variables as described in the Step-by-Step Guide. Those are needed again because the TMS container will get recreated.

    info

    Reminder: You need the environment variables TMS_DB_USER, TMS_DB_PASSWORD and TMS_SECRET.

  6. Start the container with the new image by running the following command. This will automatically recreate the container.

    docker compose up -d tms-server
  7. (optional) If you want to clean your docker images you can run

    docker image prune
    caution

    This will clean all unused images not only the old TMS image!