Skip to content

Feature/version3 newbie friendly#2

Open
agnetemoos wants to merge 16 commits intoitk-dev:feature/version3from
agnetemoos:feature/version3-newbie-friendly
Open

Feature/version3 newbie friendly#2
agnetemoos wants to merge 16 commits intoitk-dev:feature/version3from
agnetemoos:feature/version3-newbie-friendly

Conversation

@agnetemoos
Copy link
Copy Markdown

Additions and changes to make installation of OS2Display easy for newcomers.

Three use cases are in focus:

  • Installation
  • Upgrade
  • Uninstall/start over

NOTE: Aarhus is welcome to add an .env.aarhus.example or similar with sensible default values for your setup, if that can be of help to you.

Notable changes:

About env vars

  • Descriptions added to all variables in .env.example.
  • The README links to .env.example as the single source of information about configuration variables available.
  • The default value of COMPOSE_FILES is docker-compose.yml,docker-compose.mariadb.yml,docker-compose.traefik.yml.
  • The installer calls env:build if no .env is present when running task install.
  • The variables handled by env:build have changed.

About Taskfile

  • task upgrade added to make it easy to upgrade OS2Display.
  • In task install, added a check for SSL certificates if internal Traefik is configured in .env.
  • Version check added. The installation package version should preferably match the OS2Display version. If they are not aligned, you cannot trust .env.example to be compatible, and there might be relevant tasks missing. I fear that the installation package is downloaded once during installation and never upgraded. The version check checks for major version changes. Can I assume that environment variables are not added, removed, or changed in minor versions?
  • task uninstall added. Uninstall is a useful feature when you are tinkering with the system and somehow screw things up. This helps you start over.
  • In task purge, filter out the --network flag before passing to docker compose.

Traefik reverse proxy

  • If you run task install with default options, Traefik is installed.
  • Fixes to the Traefik configuration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant