Commit Graph

180 Commits

Author SHA1 Message Date
Amir Zarrinkafsh
1f684dbc75 Update README.md 2020-01-18 11:17:25 +11:00
Clément Michaud
bb24cf16f7
Update README.md 2020-01-18 00:41:29 +01:00
Amir Zarrinkafsh
9b8be0fef0 Remove Travis and promote Buildkite (#545)
* Remove Travis and promote Buildkite

* Add Docker Size badge to README.md

* Call MicroBadger webhook to update metadata for shields

Add updateMicroBadger function and refactor publishDockerReadme to be called explicitly instead of on every deployManifest call.
2020-01-16 21:57:44 +01:00
Amir Zarrinkafsh
6cd79d0c4b Update README.md for HAProxy references 2020-01-10 11:41:01 +01:00
Amir Zarrinkafsh
fabb76754e
Rename org from clems4ever to authelia
Also fix references from config.yml to configuration.yml
2019-12-24 13:14:52 +11:00
Clement Michaud
f6d2029e2c Introduce architecture schema in the README. 2019-12-10 12:27:42 +01:00
Clement Michaud
d4e236bc66 Update README to announce v4 has been released. 2019-12-09 13:03:12 +01:00
Clément Michaud
778f069013
Update README.md 2019-12-07 14:39:21 +01:00
Clement Michaud
61c1365ba2 Update README and documentation to close refactoring. 2019-12-05 23:20:12 +01:00
Clément Michaud
cdb87522f4
Fix typo in Readme 2019-12-05 11:10:02 +01:00
Clément Michaud
31cf6980cb
Remove reference to package.json 2019-12-05 11:07:28 +01:00
Clément Michaud
02971ff52c
Update README.md 2019-11-20 18:49:37 +01:00
Clement Michaud
eafd9330dc Update documentation to introduce migration scripts. 2019-11-19 00:11:53 +01:00
Amir Zarrinkafsh
51465f8b77 Sync README.md from GitHub to DockerHub after push-manifest 2019-11-10 11:51:24 +01:00
Clément Michaud
0f248a01e9
Update README.md 2019-11-09 12:43:45 +01:00
Clement Michaud
b1d59dcec4 Add documentation on Authelia v4 in README and add a migration document. 2019-10-29 00:40:45 +01:00
Clément Michaud
eee8c59562
Remove reference to CONTRIBUTORS.md in readme. 2019-10-19 18:34:14 +02:00
Clément Michaud
8478216e5d
Update README.md 2019-04-25 13:36:14 +02:00
Clement Michaud
5a195f7ebd Update README to mention nginx and Traefik and update images. 2019-04-17 23:06:56 +02:00
Clément Michaud
e0dab01442
Update README.md 2019-04-17 00:28:31 +02:00
Clement Michaud
743b84aeaa Change license from MIT to Apache 2.0. 2019-04-16 23:40:15 +02:00
Clement Michaud
ab8402314b Add a link to the breaking changes markdown in README. 2019-04-16 22:58:45 +02:00
Clement Michaud
8a76b5118d Add network criteria in ACLs to specify policy based on network subnet. 2019-03-31 20:11:07 +02:00
Clément Michaud
c2810101a4
Update README.md 2019-03-25 09:04:58 +01:00
Clement Michaud
4eaafb7115 Update the documentation to include information on Duo. 2019-03-24 18:45:32 +01:00
Clement Michaud
76fa325f08 [BREAKING] Create a suite for kubernetes tests.
Authelia client uses hash router instead of browser router in order to work
with Kubernetes nginx-ingress-controller. This is also better for users having
old browsers.

This commit is breaking because it requires to change the configuration of the
proxy to include the # in the URL of the login portal.
2019-03-16 00:13:27 +01:00
Clement Michaud
de15dc52dd Add details on how to deploy Authelia in a dev environment.
Also improve some part of the documentation.
2018-11-16 15:30:26 +01:00
Clement Michaud
82e51e1a71 Improve CONTRIBUTE section of the README. 2018-11-15 22:47:27 +01:00
Clement Michaud
fac17671ee Fix broken link to getting-started in README.md 2018-11-03 13:29:06 +01:00
Clement Michaud
6efa6241d3 Fix image in README.md 2018-08-30 11:33:55 +02:00
Clement Michaud
03c6a4072b Add snyk badge. 2018-08-30 11:26:13 +02:00
Clément Michaud
878add767f Update and rename CONTRIBUTORS.md to CONTRIBUTING.md.
Update README.md to reference this new file.
2018-08-29 00:28:20 +02:00
Clement Michaud
91032a1d3c Add back gitter link instead of Slack. 2018-08-28 21:04:57 +02:00
Clement Michaud
5e4c401efe Add Paypal donation buttons in README. 2018-08-27 22:51:41 +02:00
Clément Michaud
a515ce83c7
Refactor README into several documents unders docs directory. (#265) 2018-08-26 23:46:15 +02:00
Clement Michaud
d55a7101f1 Update README to mention kubernetes in the description
Also add a link to the wiki.
2018-05-02 22:12:33 +02:00
Clement Michaud
185419e09e Update README to reference kubernetes deployment documentation 2018-04-25 08:51:43 +02:00
Clement Michaud
6586402114 Support 'redirect' in /api/verify endpoint to support Traefik
Traefik handles auth forwarding but does not manage redirections like Nginx.
Therefore, Authelia must redirect the user and Traefik will forward this
request.

To support both Nginx and Traefik, /api/verify is now configurable with the
'redirect' get parameter. If the verification fails and 'redirect' is not
provided the response will be a 401 error as before.
If the parameter is provided and set to any URL, the response will be a
redirection (302) to this URL.
2017-12-04 22:52:33 +01:00
Clement Michaud
a8974a9d8e Change domain from test.local to example.com
Warning: you will need to update your /etc/hosts to take this change into
account for the example environment to work.
2017-11-03 00:20:10 +01:00
Clement Michaud
009e7c2b78 Add basic authorization support for single-factor protected endpoints
One can now access a service using the basic authorization mechanism. Note the
service must not be protected by 2 factors.

The Remote-User and Remote-Groups are forwarded from Authelia like any browser
authentication.
2017-11-01 19:38:05 +01:00
Clement Michaud
6d11801d56 Change the how-to to build Authelia in the README 2017-10-31 22:11:01 +01:00
Clement Michaud
22d56b1faa Change basicauth.test.local into single_factor.test.local 2017-10-31 07:27:36 +01:00
Clement Michaud
a3560ef8d3 Add possible security measures in README 2017-10-31 07:27:36 +01:00
Clement Michaud
cd0a93f027 Rename authentication method from 'basic_auth' to 'single_factor' 2017-10-31 07:27:36 +01:00
Clement Michaud
0b33982701 Add notes on security measures deployed in Authelia in README 2017-10-16 20:56:26 +02:00
Clément Michaud
d5035b8704 Merge pull request #131 from clems4ever/disable-second-factor
Allow basic authentication in configuration
2017-10-09 23:27:36 +02:00
Clement Michaud
a0aab77449 Add a section dealing with basic auth in README 2017-10-09 01:14:19 +02:00
Clement Michaud
e4274fbe1b Add a note about filesystem notifier option
This note tells the users testing with npm that they can enable the
filesystem notifier feature to test identity validation without access
to mailcatcher webmail.
2017-10-08 22:58:56 +02:00
Clément Michaud
1636fc27e5 Fix bad merge on README.md 2017-09-25 13:32:25 +02:00
Clement Michaud
4cd78f3f83 Add SMTP notifier as an available option in configuration
One can now plug its own SMTP server to send notifications
for identity validation and password reset requests.

Filesystem has been removed from the template configuration file
since even tests now use mail catcher (the fake webmail) to
retrieve the email and the confirmation link.
2017-09-24 23:20:45 +02:00
Clement Michaud
cf16272a73 Refine access control with per resource ACLs
ACLs can now be defined by subdomain AND resource using pattern matching
with regular expressions.
It allows a very fine-grained access control to backend resources.

[Note] For using example environmnent, user must update its /etc/hosts with
new subdomains updated in README.
2017-09-24 21:39:47 +02:00
FrozenDragoon
e644fe7b7b Split example scripts, allow running example using pre-built docker container (example-dockerhub) or build build from source, as it is now (example-commit). 2017-09-05 06:32:50 -05:00
Clement Michaud
64c06fd6b8 Parameterize authentication regulation via configuration file. Both for flexibility and for testing purposes. 2017-09-03 12:48:35 +02:00
Clement Michaud
c12a085f8e Replace mocha integration tests by cucumber tests 2017-07-31 22:20:33 +02:00
Clément Michaud
b0e3038aa6 Add an howto to create a customized config file from config.template.yml in the "Deployment" section. 2017-07-20 11:43:48 +02:00
Clement Michaud
7cac4b8292 Add "chat on gitter" badge in the readme 2017-07-18 00:50:47 +02:00
Clement Michaud
74cbfc637b Add system tests to test the example from end user point of view 2017-07-16 14:55:01 +02:00
Clement Michaud
d55306cf43 Update README with session management and add a table of contents 2017-07-14 00:52:07 +02:00
Clement Michaud
03c1088a92 Update the README to take example environment changes and new deployment command into account 2017-06-29 13:09:13 +02:00
Clement Michaud
0978c6bebc Package the build in a script and update image sizes in README. 2017-06-16 18:16:41 +02:00
Clement Michaud
ddf1e48535 Refactor client to make it responsive and testable 2017-06-16 18:16:38 +02:00
Clement Michaud
976dd6b87c Update README to add 'grunt build' command before deploying docker services 2017-06-16 18:16:38 +02:00
Clement Michaud
7d21f8d5df Edit README to make the user add more subdomains in /etc/hosts for testing the example locally 2017-03-25 19:10:59 +01:00
Clement Michaud
38a4570b24 Edit the README to add an access control section and update the user base 2017-03-25 15:41:11 +01:00
Clement Michaud
6603634509 Fix error with link to test page in README 2017-03-16 22:33:29 +01:00
Clement Michaud
d91ffb0b06 Ask the user to add lines to /etc/hosts in the getting started section of the README 2017-03-15 23:51:29 +01:00
Clement Michaud
84eb4f64b3 Use images from master branch 2017-01-29 17:06:16 +01:00
Clement Michaud
2304089f7c Adding advice to follow getting started before any deployment 2017-01-29 17:05:15 +01:00
Clement Michaud
d98d20c646 Add deployment section with npm install and docker pull statements 2017-01-29 17:01:57 +01:00
Clement Michaud
7008d9d0bb Add content in the configuration section of the README. Create a npm command called authelia 2017-01-29 16:55:23 +01:00
Clement Michaud
b1045dc075 Update the README with U2F support and new screenshots 2017-01-29 16:42:50 +01:00
Clement Michaud
d27c597a73 Fix title in npm 2016-12-18 13:26:14 +01:00
Clement Michaud
be2b6a9add Fix images in npm 2016-12-18 13:18:42 +01:00
Clement Michaud
1dbbc9fed9 Fix contributors link 2016-12-18 12:59:40 +01:00
Clement Michaud
885dceb769 Move images into separate directory and add link to http://localhost:8080 2016-12-18 12:54:45 +01:00
Clement Michaud
b9d2bfe3bd Adding build status to README and fix title in npm 2016-12-18 12:36:59 +01:00
Clement Michaud
00a30d468c Edit README to adapt repo name 2016-12-18 03:09:39 +01:00
Clément Michaud
dd7cb405e2 Update README.md 2016-12-17 20:52:02 +01:00
Clement Michaud
d9f6be792a Adding more documentation in the README 2016-12-17 20:50:50 +01:00
Clement Michaud
8e474372aa Adding README, LICENSE and CONTRIBUTORS files 2016-12-17 20:26:46 +01:00