mirror of
https://github.com/0rangebananaspy/authelia.git
synced 2024-09-14 22:47:21 +07:00
[Buildkite] Add contents of BREAKING.md for tag to releases (#797)
This will ensure that notes pertaining to a version in the BREAKING.md will be published in each of the respective github releases. All information from: '## Breaking in $TAG' until the next '## Breaking in $TAG' is included.
This commit is contained in:
parent
a15b9fe699
commit
95f6c1a893
|
@ -12,7 +12,7 @@ do
|
||||||
done
|
done
|
||||||
|
|
||||||
echo "--- :github: Deploy artifacts for release: ${BUILDKITE_TAG}"
|
echo "--- :github: Deploy artifacts for release: ${BUILDKITE_TAG}"
|
||||||
hub release create "${BUILDKITE_TAG}" "${artifacts[@]}" -F <(echo -e "${BUILDKITE_TAG}\n\n## Changelog\n$(git log --oneline --pretty='* %h %s' $(git describe --abbrev=0 --tags $(git rev-list --tags --skip=1 --max-count=1))...$(git describe --abbrev=0 --tags))\n\n## Docker Container\n* \`docker pull authelia/authelia:${BUILDKITE_TAG//v}\`"); EXIT=$?
|
hub release create "${BUILDKITE_TAG}" "${artifacts[@]}" -F <(echo -e "${BUILDKITE_TAG}\n\n$(awk "/${BUILDKITE_TAG}/" RS="## Breaking" BREAKING.md)\n\n## Changelog\n$(git log --oneline --pretty='* %h %s' $(git describe --abbrev=0 --tags $(git rev-list --tags --skip=1 --max-count=1))...$(git describe --abbrev=0 --tags))\n\n## Docker Container\n* \`docker pull authelia/authelia:${BUILDKITE_TAG//v}\`" | sed -e 's/^ /## Breaking /' | sed -e '/./b' -e :n -e 'N;s/\n$//;tn'); EXIT=$?
|
||||||
|
|
||||||
if [[ $EXIT -eq 0 ]];
|
if [[ $EXIT -eq 0 ]];
|
||||||
then
|
then
|
||||||
|
|
32
BREAKING.md
32
BREAKING.md
|
@ -7,7 +7,6 @@ and read this documentation before upgrading. This is where you will get informa
|
||||||
breaking changes and about what you should do to overcome those changes.
|
breaking changes and about what you should do to overcome those changes.
|
||||||
|
|
||||||
## Breaking in v4.7.0
|
## Breaking in v4.7.0
|
||||||
|
|
||||||
* `logs_level` configuration key has been renamed to `log_level`.
|
* `logs_level` configuration key has been renamed to `log_level`.
|
||||||
* `users_filter` was a search pattern for a given user with the `{0}` matcher replaced with the
|
* `users_filter` was a search pattern for a given user with the `{0}` matcher replaced with the
|
||||||
actual username. In v4.7.0, `username_attribute` has been introduced. Consequently, the computed
|
actual username. In v4.7.0, `username_attribute` has been introduced. Consequently, the computed
|
||||||
|
@ -17,7 +16,6 @@ the LDAP search query. For instance if `username_attribute` is set to `uid` and
|
||||||
set to `(objectClass=person)` then the computed filter is `(&(uid=john)(objectClass=person))`.
|
set to `(objectClass=person)` then the computed filter is `(&(uid=john)(objectClass=person))`.
|
||||||
|
|
||||||
## Breaking in v4.0.0
|
## Breaking in v4.0.0
|
||||||
|
|
||||||
Authelia has been rewritten in Go for better code maintainability and for performance and
|
Authelia has been rewritten in Go for better code maintainability and for performance and
|
||||||
security reasons.
|
security reasons.
|
||||||
|
|
||||||
|
@ -27,7 +25,6 @@ induced breaking the previous data model and the configuration to bring new feat
|
||||||
fortunately migration tools are provided to ease the task.
|
fortunately migration tools are provided to ease the task.
|
||||||
|
|
||||||
### Major updates
|
### Major updates
|
||||||
|
|
||||||
* The configuration mostly remained the same, only one major key has been added: `jwt_secret`
|
* 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
|
and one key removed: `secure` from the SMTP notifier as the Go SMTP library default to TLS
|
||||||
if available.
|
if available.
|
||||||
|
@ -44,25 +41,24 @@ available like allowing device cloning detection.
|
||||||
large performance gain in order to use Authelia in demanding environments.
|
large performance gain in order to use Authelia in demanding environments.
|
||||||
|
|
||||||
### Data migration tools
|
### 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)
|
||||||
supported by Authelia v4.
|
supported by Authelia v4.
|
||||||
|
|
||||||
Example of usage:
|
Example of usage:
|
||||||
|
```
|
||||||
|
# Migrate a local database into the targeted database defined in config-v4.yml with Docker
|
||||||
|
docker run --rm -v /path/to/config-v4.yml:/config.yml -v /old/db/path:/db authelia/authelia authelia migrate local --config=/config.yml --db-path=/db
|
||||||
|
|
||||||
# Migrate a local database into the targeted database defined in config-v4.yml with Docker
|
# Migrate a mongo database into the targeted database defined in config-v4.yml with Docker
|
||||||
docker run --rm -v /path/to/config-v4.yml:/config.yml -v /old/db/path:/db authelia/authelia authelia migrate local --config=/config.yml --db-path=/db
|
docker run --rm -v /path/to/config-v4.yml:/config.yml authelia/authelia authelia migrate mongo --config=/config.yml --url=mongodb://myuser:mypassword@mymongo:27017 --database=authelia
|
||||||
|
|
||||||
# Migrate a mongo database into the targeted database defined in config-v4.yml with Docker
|
# Migrate a local database into the targeted database defined in config-v4.yml
|
||||||
docker run --rm -v /path/to/config-v4.yml:/config.yml authelia/authelia authelia migrate mongo --config=/config.yml --url=mongodb://myuser:mypassword@mymongo:27017 --database=authelia
|
authelia-scripts migrate local --config=/path/to/config-v4.yml --db-path=/old/db/path
|
||||||
|
|
||||||
# Migrate a local database into the targeted database defined in config-v4.yml
|
|
||||||
authelia-scripts migrate local --config=/path/to/config-v4.yml --db-path=/old/db/path
|
|
||||||
|
|
||||||
# Migrate a mongo database into the targeted database defined in config-v4.yml
|
|
||||||
authelia-scripts migrate mongo --config=/path/to/config-v4.yml --url=mongodb://myuser:mypassword@mymongo:27017 --database=authelia
|
|
||||||
|
|
||||||
|
# Migrate a mongo database into the targeted database defined in config-v4.yml
|
||||||
|
authelia-scripts migrate mongo --config=/path/to/config-v4.yml --url=mongodb://myuser:mypassword@mymongo:27017 --database=authelia
|
||||||
|
```
|
||||||
|
|
||||||
Those commands migrate TOTP secrets, U2F devices, authentication traces and user preferences so
|
Those commands migrate TOTP secrets, U2F devices, authentication traces and user preferences so
|
||||||
that the migration is almost seamless for your users.
|
that the migration is almost seamless for your users.
|
||||||
|
@ -75,7 +71,6 @@ device. This is because their identity verification token will not be usable in
|
||||||
## Breaking in v3.14.0
|
## Breaking in v3.14.0
|
||||||
|
|
||||||
### Headers in nginx configuration
|
### Headers in nginx configuration
|
||||||
|
|
||||||
In order to support Traefik as a third party proxy interacting with Authelia some changes had to be made
|
In order to support Traefik as a third party proxy interacting with Authelia some changes had to be made
|
||||||
to Authelia and the nginx proxy configuration.
|
to Authelia and the nginx proxy configuration.
|
||||||
|
|
||||||
|
@ -86,14 +81,13 @@ headers are used to build the URL.
|
||||||
Authelia endpoint /api/verify does not produce the `Redirect` header containing the target URL the user is trying to visit.
|
Authelia endpoint /api/verify does not produce the `Redirect` header containing the target URL the user is trying to visit.
|
||||||
This header was used in early versions to redirect the user to the login portal providing the target URL as a query parameter.
|
This header was used in early versions to redirect the user to the login portal providing the target URL as a query parameter.
|
||||||
However this target URL can be computed automatically with the following statement:
|
However this target URL can be computed automatically with the following statement:
|
||||||
|
```
|
||||||
set $target_url $scheme://$http_host$request_uri;
|
set $target_url $scheme://$http_host$request_uri;
|
||||||
|
```
|
||||||
|
|
||||||
## Breaking in v3.11.0
|
## Breaking in v3.11.0
|
||||||
|
|
||||||
### ACL configuration
|
### ACL configuration
|
||||||
|
|
||||||
ACL definition in the configuration file has been updated to allow more authorization use cases.
|
ACL definition in the configuration file has been updated to allow more authorization use cases.
|
||||||
The change basically removed the three categories "any", "groups" and "users" to introduce an
|
The change basically removed the three categories "any", "groups" and "users" to introduce an
|
||||||
iptables-like format where the authorization policy is just an ordered list of rules with a few
|
iptables-like format where the authorization policy is just an ordered list of rules with a few
|
||||||
|
|
Loading…
Reference in New Issue
Block a user