diff --git a/CHANGELOG.md b/CHANGELOG.md index c31aa27c..d913af3d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,49 @@ +# Re2o 3.0 + +## Install steps + +Starting with this release, the legacy installation script is no longer supporter. You can now use the brand new docker-based installation. + +TODO: describe docker installation when it will be prod-ready + +## Breaking changes + +### New python dependencies management system + +The new way to manage python dependencies changed from pip to poetry. To migrate, you will have to install poetry (by following you distribution instructions), then run `poetry install --extras "mysql postgres ldap` (you can remove the features you don't use from the list). Finally, to run any re2o command, prefix it with `poetry run`. For example, to run the server, you now have to run `poetry run python3 ./manage.py runserver`. You will have to change the systemd service file if you use one. + +### Update to Django 2.2 + +This version updates Django from 1.11 to 2.2. This can break a few things in your custom modules if you have some. Please follow Django's instructions to migrate your modules. + +### Migration squashing [!605](https://gitlab.federez.net/re2o/re2o/-/merge_requests/605) + +Old migrations have been cleaned. This means that you will be able to update your database to this version only from Re2o 2.9. If you have a older version of Re2o, you will have to update first to 2.9, then apply migrations, and then update to 3.0. + +You will also have to define the proper LDAP router in your settings_local.py if you use the `ldap_sync` optional app. See `re2o/settings_local.example.py` for an example. + +## New features + +### New API-based Radius script [!614](https://gitlab.federez.net/re2o/re2o/-/merge_requests/614) + +This new Radius script will no longer need to have a full re2o installation on the Radius VM. To use it, activate `api` and `radius` optional apps in your `settings_local.py`, then install [the script itself](https://gitlab.federez.net/re2o/re2o-radius) on the Radius VM by following the repository instructions. + +If you don't use the Apache configuration distributed in re2o, please not that for this optional app to function, you will need to add a `AllowEncodedSlashes On` (or equivalent in your reverse proxy configuration) to the configuration. + +### New deposits optional app [!622](https://gitlab.federez.net/re2o/re2o/-/merge_requests/622) + +### Invoices are now generated from HTML templates instead of LaTeX ones [!621](https://gitlab.federez.net/re2o/re2o/-/merge_requests/621) + +### New custom navbar link option [!631](https://gitlab.federez.net/re2o/re2o/-/merge_requests/631) + +## Deprecation + +The old Radius script is now deprecated. Support for this script will be dropped in a further release. Please migrate to the new API-based one. + +## Bug fixes + +You can view the full list of closed issues [here](https://gitlab.federez.net/re2o/re2o/-/issues?scope=all&state=all&milestone_title=Re2o%202.9). + # Re2o 2.9 ## Install steps