techies/authelia
1
0
Fork 0
mirror of https://github.com/0rangebananaspy/authelia.git synced 2024-09-14 22:47:21 +07:00
Code Issues Projects Releases Wiki Activity

Update BREAKING.md and CHANGELOG.md

Browse Source
This commit is contained in:
Clement Michaud 2019-12-05 21:57:42 +01:00 committed by Clément Michaud
parent 61c1365ba2
commit 2b544346f3
2 changed files with 19 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
BREAKING.md
View File

@ -13,7 +13,24 @@ The principles stay the same, Authelia is still an authenticating and authorizin
that the system is more reliable overall. This induced breaking the previous data model and the configuration to bring new features that the system is more reliable overall. This induced breaking the previous data model and the configuration to bring new features
but fortunately migration tools are provided to ease the task. but fortunately migration tools are provided to ease the task.
### Migration tools ### Major updates
* The configuration mostly remained the same, only one major key has been added: `jwt_secret`
and one key removed: `secure` from the SMTP notifier as the Go SMTP library default to TLS
if available.
* The Hash router has been replaced by a Browser router. This means that the weird characters
/%23/ in the URL could now be safely removed.
* The local storage used for dev purpose was a `nedb` database which was implementing the
same interface as mongo but was not really standard. It has been replaced by a good old
sqlite3 database.
* The model of the database is not compatible with v3. This has been decided to better fit
with Golang libraries.
* Some features have been upgraded such as U2F in order to use the latest security features
available like allowing device cloning detection.
* Furthermore, a top-notch web server implementation (fasthttp) has been selected to allow a
large performance gain in order to use Authelia in demanding environments.
### Data migration tools
An authelia-scripts command is provided to perform the data model migration from a local database An authelia-scripts command is provided to perform the data model migration from a local database
or a mongo database created by Authelia v3 into a target SQL database (sqlite3, mysql, postgres) or a mongo database created by Authelia v3 into a target SQL database (sqlite3, mysql, postgres)
@ -36,16 +53,6 @@ made to expire after a few minutes anyway. Consequently, the users who initiated
which has not been completed before the migration will have to restart the device registration process for their which has not been completed before the migration will have to restart the device registration process for their
device. This is because their identity verification token will not be usable in v4. device. This is because their identity verification token will not be usable in v4.
### Major changes in details:
* The configuration mostly remained the same, only one major key has been added: `jwt_secret` and one key removed: `secure` from the
SMTP notifier as the Go SMTP library default to TLS if available.
* The local storage used for dev purpose was a `nedb` database which was implementing the same interface
as mongo but was not really standard. It has been replaced by a good old sqlite3 database.
* The model of the database is not compatible with v3. This has been decided to better fit with Golang libraries.
* Some features have been upgraded such as U2F in order to use the latest security features available like allowing device cloning detection.
* Furthermore, a top-notch web server implementation (fasthttp) has been selected to allow a large performance gain in order to use Authelia in demanding environments.
## Breaking in v3.14.0 ## Breaking in v3.14.0
### Headers in nginx configuration ### Headers in nginx configuration

1
CHANGELOG.md
View File

@ -1,6 +1,7 @@
Release Notes - Version 4.0.0 Release Notes - Version 4.0.0
------------------------------ ------------------------------
* Authelia is rewritten in Go. * Authelia is rewritten in Go.
* Authelia frontend has been rewritten with Material-UI and simplified.
* config.yml should include a secret for jwt issuance and verification. * config.yml should include a secret for jwt issuance and verification.
* Models in database have been updated to better fit with the Go library. * Models in database have been updated to better fit with the Go library.
* The local storage has been replaced by a good old sqlite3 database. * The local storage has been replaced by a good old sqlite3 database.