RPJosh
/
authelia
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README to mention kubernetes in the description 

Also add a link to the wiki.
pull/220/head
Clement Michaud 2018-04-26 09:22:40 +02:00
parent efd037134a
commit d55a7101f1
1 changed files with 18 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -4,15 +4,25 @@
[![Build](https://travis-ci.org/clems4ever/authelia.svg?branch=master)](https://travis-ci.org/clems4ever/authelia) [![Build](https://travis-ci.org/clems4ever/authelia.svg?branch=master)](https://travis-ci.org/clems4ever/authelia)
[![Gitter](https://img.shields.io/gitter/room/badges/shields.svg)](https://gitter.im/authelia/general?utm_source=share-link&utm_medium=link&utm_campaign=share-link) [![Gitter](https://img.shields.io/gitter/room/badges/shields.svg)](https://gitter.im/authelia/general?utm_source=share-link&utm_medium=link&utm_campaign=share-link)
**Authelia** is a complete HTTP 2-factor authentication server for proxies like **Authelia** is an open-source authentication and authorization server.
Nginx or Traefik. It has been designed to be proxy agnostic so that you can Authelia brings 2-factor authentication and single sign-on to secure web
use whichever proxy supporting authentication forwarding. applications and ease authentication. It has been designed to be a companion
of any reverse proxy by helping it handle authentication and authorization
requests.
**Authelia** can be installed on bare-metal using Docker or npm but can also
be deployed easily on a Kubernetes cluster and leverages ingress controller
and ingress configuration concepts to easily configure authentication and
authorization for specific services in your cluster by simply editing your
ingress configuration.
# Table of Contents # Table of Contents
1. [Features summary](#features-summary) 1. [Features summary](#features-summary)
2. [Deployment](#deployment) 2. [Deployment](#deployment)
1. [With NPM](#with-npm) 1. [With NPM](#with-npm)
2. [With Docker](#with-docker) 2. [With Docker](#with-docker)
3. [With Kubernetes](#with-docker)
3. [Getting started](#getting-started) 3. [Getting started](#getting-started)
1. [Pre-requisites](#pre-requisites) 1. [Pre-requisites](#pre-requisites)
2. [Run it!](#run-it) 2. [Run it!](#run-it)
@ -27,7 +37,8 @@ use whichever proxy supporting authentication forwarding.
4. [Security](#security) 4. [Security](#security)
5. [Documentation](#documentation) 5. [Documentation](#documentation)
1. [Authelia configuration](#authelia-configuration) 1. [Authelia configuration](#authelia-configuration)
2. [API documentation](#api-documentation) 2. [Wiki](#wiki)
3. [API documentation](#api-documentation)
6. [Contributing to Authelia](#contributing-to-authelia) 6. [Contributing to Authelia](#contributing-to-authelia)
7. [License](#license) 7. [License](#license)
@ -262,6 +273,9 @@ You can specify another configuration file by giving it as first argument of
authelia config.custom.yml authelia config.custom.yml
### Wiki
A [wiki](../../wiki) is available if you need more details about Authelia.
### API documentation ### API documentation
There is a complete API documentation generated with There is a complete API documentation generated with
[apiDoc](http://apidocjs.com/) and embedded in the repo under the **doc/** [apiDoc](http://apidocjs.com/) and embedded in the repo under the **doc/**