upgrade sl

Overview

In this page:

• Upgrading from 3.4.0 to v4.70.0

Upgrading from 3.4.0

• Change the image version in .env

SL_VERSION=4.6.5-beta

• Check and apply migration commands

For instance, to upgrade from 3.4.0 to 4.6.x-beta, the following change must be done in simple-login-compose.yaml:

  migration:
    image: simplelogin/app:$SL_VERSION
-   command: [ "flask", "db", "upgrade" ]
+   command: [ "alembic", "upgrade", "head" ]
    container_name: sl-migration
    env_file: .env

Finally, the following command must be run in the database:

docker compose exec -it postgres psql -U myuser simplelogin
> UPDATE email_log SET alias_id=(SELECT alias_id FROM contact WHERE contact.id = email_log.contact_id);
> \q

• Restart containers

docker compose stop && docker compose up --detach

After successfully upgrading to v4.6.x-beta you might want to upgrade to the latest stable version. Change the SL_IMAGE and SL_VERSION variables from the .env file:

SL_VERSION=v4.70.0
SL_IMAGE=app-ci

Caution: some underpowered VPS might exhibit some WORKER_TIMEOUT errors when running the sl-app image. To mitigate this issue, you may want to increase the starting timeout value in simple-login-compose.yaml:

  app:
    image: simplelogin/$SL_IMAGE:$SL_VERSION
    container_name: sl-app
    env_file: .env
    volumes:
      - ./pgp:/sl/pgp
      - ./upload:/code/static/upload
      - ./dkim.key:/dkim.key
      - ./dkim.pub.key:/dkim.pub.key
+   command: ["gunicorn","wsgi:app","-b","0.0.0.0:7777","-w","2","--timeout","30"]
    restart: unless-stopped

And restart the containers.

This will pull up the latest versions of the docker images, potentially running the updated sl-migration steps, and startup the application.