diff --git a/CHANGELOG.md b/CHANGELOG.md index d913af3d..93fc8b68 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,10 +1,31 @@ -# Re2o 3.0 +# Re2o 3.0 - Long time no see! + +3 years after the last release, here is the long-waited 3.0 release of Re2o! It comes with a update to (EOL) Django 2.2, a new docker-based installation, a new Radius script, and a great rework on CI tests. ## Install steps -Starting with this release, the legacy installation script is no longer supporter. You can now use the brand new docker-based installation. +Starting with this release, the legacy installation script is no longer supported. You can now use the brand new docker-based installation at [Docker-installation](https://gitlab.federez.net/re2o/re2o/-/wikis/Docker-installation) -TODO: describe docker installation when it will be prod-ready +### Migration guide from Re2o 2.9 + +- Run a git pull +- Ensure that `docker` and `docker-compose` are installed on the server +- Shut down re2o and **make a backup** +- Edit `docker-compose.yml` to suit your needs (notably, you will need to remove the database section, and to provide information for database connection. You can ignore superuser informations) +- If you use custom invoice or voucher template, you will need to mount them in the docker by adding +```yaml + volumes: + - /path/to/invoice/template:templates/default_invoive.html:ro + - /path/to/voucher/template:templates/default_voucher.html:ro +``` +- If you use external optional apps, you will need to mount them in the docker by adding +```yaml + volumes: + - /path/to/external/app:app:ro +``` +- run `docker compose up` + +You will also need to edit the listening port of the nginx docker to be compatible with your reverse proxy configuration. ## Breaking changes diff --git a/docker-compose.yml b/docker-compose.yml index 880d40c4..8abc943d 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -21,6 +21,8 @@ services: target: postgres depends_on: - db + volumes: + - ./re2o/settings_local.py:./re2o/settings_local.py:ro environment: - POSTGRES_DB=postgres - POSTGRES_USER=postgres