From 107126929b036cb258394f1e8954e12b5be852d6 Mon Sep 17 00:00:00 2001 From: Amir Zarrinkafsh Date: Fri, 24 Jan 2020 20:21:17 +1100 Subject: [PATCH] Update README.md with AUR references and remove CHANGELOG.md (#576) * Update README.md Provide badges and references to the AUR for Arch Linux Authelia packages. Closes #571 #572. * Add systemd unit file Include the unit in future release artifacts. * Remove CHANGELOG.md As of future releases Changelog details will dynamically be generated. * Update README.md Add badge for authelia-git package. * Update Changelog to only publish explicit Docker tag Do not include Major and Minor versions, as these will change over time. --- .buildkite/hooks/pre-artifact | 2 +- .buildkite/steps/ghartifacts.sh | 2 +- CHANGELOG.md | 187 -------------------------------- README.md | 15 ++- authelia.service | 11 ++ 5 files changed, 22 insertions(+), 195 deletions(-) delete mode 100644 CHANGELOG.md create mode 100644 authelia.service diff --git a/.buildkite/hooks/pre-artifact b/.buildkite/hooks/pre-artifact index 1b08186fc..9275390cb 100755 --- a/.buildkite/hooks/pre-artifact +++ b/.buildkite/hooks/pre-artifact @@ -12,7 +12,7 @@ then docker cp authelia-binary:/usr/app/authelia ./authelia-linux-"${ARCH}" docker cp authelia-binary:/usr/app/public_html ./ docker rm -f authelia-binary - tar -czf authelia-linux-"${ARCH}".tar.gz authelia-linux-"${ARCH}" config.template.yml public_html + tar -czf authelia-linux-"${ARCH}".tar.gz authelia-linux-"${ARCH}" authelia.service config.template.yml public_html sha256sum authelia-linux-"${ARCH}".tar.gz > authelia-linux-"${ARCH}".tar.gz.sha256 # Saving image for push to docker hub docker save $DOCKER_IMAGE | zstdmt -T0 -12 > authelia-image-"${ARCH}".tar.zst diff --git a/.buildkite/steps/ghartifacts.sh b/.buildkite/steps/ghartifacts.sh index 504ee9100..c8412d812 100755 --- a/.buildkite/steps/ghartifacts.sh +++ b/.buildkite/steps/ghartifacts.sh @@ -12,4 +12,4 @@ do done echo "--- :github: Deploy artifacts for release: ${BUILDKITE_TAG}" -hub release create "${artifacts[@]}" -m "${BUILDKITE_TAG}" "${BUILDKITE_TAG}" \ No newline at end of file +hub release create "${artifacts[@]}" -m "${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 images\n* docker pull authelia/authelia:${BUILDKITE_TAG//v}" "${BUILDKITE_TAG}" \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index 6b22da909..000000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,187 +0,0 @@ -Release Notes - Version 4.2.0 ------------------------------ -* Bump version of Alpine to 3.11.3 -* Integrate hash-password and migrate command to authelia binary. -* Add possibility to read secrets from env variables. -* [BUGFIX] Fix bug in the validation of the notifier configuration. -* Escape special LDAP characters. - -Release Notes - Version 4.1.0 ------------------------------ -* Add support of HAProxy as a reverse proxy. -* Huge optimization of build time for standard and cross compiled targets (Many thanks to @nightah). -* Statically link authelia binary. -* Multiple optimizations to docker images to reduce size. -* Add support of authentication mechanisms to SMTP notifier and enforce use of TLS (Many thanks to @james-d-elliott). -* Introduce Buildkite build (will soon replace Travis. Many thanks to @nightah). -* Fix Postgres bad column name. -* Many fixes to the documentation. -* Support hashes without {CRYPT} in file-based users database. -* Allow blank additional\_groups\_dn and additional\_users\_dn. -* Fix wrong remote IP in logs. -* URL encode rd parameter to allow parameters in original URL. -* Fix broken remember me functionality. -* Make authelia binary build reproducible. - -Release Notes - Version 4.0.0 ------------------------------- -* Authelia is rewritten in Go. -* Authelia frontend has been rewritten with Material-UI and simplified. -* configuration.yml should include a secret for jwt issuance and verification. -* 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 mongo option for storing user preferences and device secrets has been deprecated in favor of SQL options: mysql and postgres. -* The "secure" flag from the SMTP notifier configuration has been removed as TLS is used by default when available. -* authelia-scripts tool has been rewritten in Go. -* Use pure implementation of crypt. -* Introduction of a "migrate" command to authelia-scripts to help migrating from v3 to v4. -* Authelia is built and available on Dockerhub in 3 flavors: amd64, arm32v7 and arm64v8. -* Introduction of suites in Go. -* Add support of LDAP over TLS. -* Publish Authelia as self-sufficient archives. -* Remove the need of putting weird characters /%23/ in the redirection URL to portal. -* Publish multiple docker tags per version (one for major, minor and patch) -* Add `host` configuration to restring binding to local interface 127.0.0.1. -* Add `google_analytics` configuration option to provide a tracking ID for admins to track the use of the portal thanks to a GA dashboard. - -Release Notes - Version 3.16.3 ------------------------------- -* Update changelog of previous versions. - -Release Notes - Version 3.16.2 ------------------------------- -* Update email footer to inform user of actions to take if she is receiving an unexpected email from Authelia. - -Release Notes - Version 3.16.1 ------------------------------- -* Update NPM API key. - -Release Notes - Version 3.16.0 ------------------------------- -* Configure a CA for LDAPS. -* Password could be provided as env variables to avoid exposing them in a file (also simpler to use and protect in Kubernetes). - -Release Notes - Version 3.15.0 ------------------------------- -* Change license from MIT to Apache 2.0. - -Release Notes - Version 3.14.0 ------------------------------- -* [BREAKING] Add official support for Traefik with a dedicated suite. -* Add support for network-based ACL rules allowing to apply different authorization strategies on different networks. -* Several bug fixes (unusual error message when using U2F, X-Forwarded-User and X-Forwarded-Groups was not propagated on bypassed endpoints). - -Release Notes - Version 3.13.0 ------------------------------- -* Rewrite Authelia portal in Typescript. -* Introduce concept of suites and authelia-scripts. -* Add official support for Kubernetes and a suite. -* Improve documentation for nginx. -* Fix bypass policy not properly handled. -* Implement Duo push notification as a second factor. -* Display only available 2FA options (U2F if supported in browser, Duo push if configured). - -Release Notes - Version 3.12.0 ------------------------------- -* Add logs to troubleshoot LDAP sanitizer. -* Add {uid} placeholder for LDAP search queries for groups. - -Release Notes - Version 3.11.0 ------------------------------- -* [BREAKING] Flatten ACL rules to enable some use cases. Configuration of ACLs -must be updated. -* Fix open redirection threat. -* Define minimum level of authentication required for a resource in ACL to be -authorized. -* Allow Authelia to be built with different themes. -* Fix bug in hash matching when using file-based users database. -* Fix dead link in documentation. - -Release Notes - Version 3.10.0 ------------------------------- -* Add docker-compose for deploying Authelia on Swarm*. -* Add "keep me logged in" checkbox in first factor page. -* Fix U2F compatibility with Firefox. -* Bump dependencies to fix vulnerabilities reported by snyk. -* Improve documentation for dev setup. - -Release Notes - Version 3.9.5 ------------------------------ -* Fix images in README in NPM. - -Release Notes - Version 3.9.4 ------------------------------ -* Update Authelia icon & add documentation image. -* Add snyk badge - -Release Notes - Version 3.9.3 ------------------------------ -* Fix npm publication. -* Use IP coming from X-Forwarded-For header in logs. -* Fix CONTRIBUTORS.md. - -Release Notes - Version 3.9.2 ------------------------------ -* Put back link to Gitter instead of Slack. - -Release Notes - Version 3.9.1 ------------------------------ -* Split the README in several parts. -* Fix Kubernetes configuration file for Authelia. - -Release Notes - Version 3.9.0 ------------------------------ -Features: -* Add support for file users database to replace LDAP in development -environments. -* Add authentication configuration options for mongo and redis. - -Configuration changes: -* [BREAKING] `ldap` key has been nested in `authentication_backend`. -* New `username` and `password` options for mongo storage. -* New `password` option for redis. - -Release Notes - Version 3.8.3 ------------------------------ -* Fix ECONNRESET issues when LDAP queries failed. (#261). - -Release Notes - Version 3.8.2 ------------------------------ -* Fix publication to NPM. - -Release Notes - Version 3.8.1 ------------------------------ -* Fix publication to NPM. - -Release Notes - Version 3.8.0 ------------------------------ -Features: -* Add support for Kubernetes nginx ingress controller. -* Add example configuration for kubernetes. -* Disable forms when authentication is in progress. -* Make most of configuration options optional and create a minimal configuration. -* Introduce helmet package to improve security. - -Configuration changes: -* [Breaking] `redirect=` in nginx configuration has been replaced by `rd=` to be -be compatible with Kubernetes ingress controller. - -Release Notes - Version 3.7.1 ------------------------------ -Configuration change: -* storage.mongo now contains two keys: `url` and `database`. - -Release Notes - Version 3.7.0 ------------------------------ -Features: -* Support basic authorization for single factor endpoints. -* Add issuer and label in TOTP otp url. -* Improve UI of second factor page. -* Use SHA512 password encryption algorithm of LDAP. -* Improve security of Authelia website. -* Support for default redirection url. -* Support for session inactivity timeout. - -Bugs: -* Fix U2F factor not working in Firefox - diff --git a/README.md b/README.md index 157554db1..5070bec44 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,14 @@ [![Build](https://img.shields.io/buildkite/d6543d3ece3433f46dbe5fd9fcfaf1f68a6dbc48eb1048bc22/master?style=flat-square&color=brightgreen)](https://buildkite.com/authelia/authelia) [![Docker Tag](https://images.microbadger.com/badges/version/authelia/authelia.svg)](https://microbadger.com/images/authelia/authelia) - [![Docker Size](https://img.shields.io/microbadger/image-size/authelia/authelia?logo=docker&style=flat-square&=blue)](https://microbadger.com/images/authelia/authelia) + [![Docker Size](https://img.shields.io/microbadger/image-size/authelia/authelia?logo=docker&style=flat-square&color=blue)](https://microbadger.com/images/authelia/authelia) [![GitHub Release](https://img.shields.io/github/release/authelia/authelia.svg?logo=github&style=flat-square&color=blue)](https://github.com/authelia/authelia/releases) + [![AUR source version](https://img.shields.io/aur/version/authelia?logo=arch-linux&label=authelia&style=flat-square&color=blue)](https://aur.archlinux.org/packages/authelia/) + [![AUR binary version](https://img.shields.io/aur/version/authelia-bin?logo=arch-linux&label=authelia-bin&style=flat-square&color=blue)](https://aur.archlinux.org/packages/authelia/) + [![AUR development version](https://img.shields.io/aur/version/authelia-git?logo=arch-linux&label=authelia-git&style=flat-square&color=blue)](https://aur.archlinux.org/packages/authelia/) [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg?style=flat-square)][Apache 2.0] - [![Matrix](https://img.shields.io/matrix/authelia:matrix.org?logo=matrix&style=flat-square&color=blue)](https://riot.im/app/#/room/#authelia:matrix.org) [![Sponsor](https://img.shields.io/badge/donate-opencollective-blue.svg?style=flat-square)](https://opencollective.com/authelia-sponsors) + [![Matrix](https://img.shields.io/matrix/authelia:matrix.org?logo=matrix&style=flat-square&color=blue)](https://riot.im/app/#/room/#authelia:matrix.org) **Authelia** is an open-source authentication and authorization server providing 2-factor authentication and single sign-on (SSO) for your @@ -25,8 +28,8 @@ The architecture is shown in the diagram below. **BREAKING NEWS: Authelia v4 has been released! Please read BREAKING.md if you want to migrate from v3 to v4. Otherwise, start fresh in v4 and enjoy!** -**Authelia** can be installed as a standalone service using a [Static binary](https://github.com/authelia/authelia/releases/latest) or [Docker] -but can also be deployed easily on [Kubernetes] leveraging ingress controllers and ingress configuration. +**Authelia** can be installed as a standalone service from the [AUR](https://aur.archlinux.org/packages/authelia/), using a [Static binary](https://github.com/authelia/authelia/releases/latest), [Docker] +or can also be deployed easily on [Kubernetes] leveraging ingress controllers and ingress configuration.

@@ -100,9 +103,9 @@ Security is taken very seriously here, therefore we follow the rule of responsib Would you like to report any vulnerability discovered in Authelia, please first contact **clems4ever** on [Matrix](https://riot.im/app/#/room/#authelia:matrix.org) or by [email](mailto:clement.michaud34@gmail.com). -## Changelog & Breaking changes +## Breaking changes -See [CHANGELOG](./CHANGELOG.md) and [BREAKING](./BREAKING.md). +See [BREAKING](./BREAKING.md). ## Contribute diff --git a/authelia.service b/authelia.service new file mode 100644 index 000000000..c46eda311 --- /dev/null +++ b/authelia.service @@ -0,0 +1,11 @@ +[Unit] +Description=Authelia authentication and authorization server +After=network.target + +[Service] +Environment=PUBLIC_DIR=/usr/share/webapps/authelia +ExecStart=/usr/bin/authelia --config /etc/authelia/configuration.yml +SyslogIdentifier=authelia + +[Install] +WantedBy=multi-user.target