Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: major documentation refresh #3475

Merged
merged 63 commits into from Jun 15, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
63 commits
Select commit Hold shift + click to select a range
bcaf402
docs: major refresh
james-d-elliott Jun 4, 2022
3fed7e8
ci: disable yamllint on pnpm lockfile
james-d-elliott Jun 4, 2022
4ca01e7
docs: update readme.md
james-d-elliott Jun 4, 2022
4cff1b0
docs: fix lint
james-d-elliott Jun 4, 2022
da48d73
docs: fix redirect
james-d-elliott Jun 4, 2022
cd1886b
ci: sort yamllint ignores
james-d-elliott Jun 4, 2022
1cabe68
Merge remote-tracking branch 'origin/master' into refactor-docs
james-d-elliott Jun 4, 2022
e4999fc
fix: broken links
james-d-elliott Jun 4, 2022
b876aba
fix: broken links
james-d-elliott Jun 4, 2022
069ad7e
Merge branch 'master' into refactor-docs
james-d-elliott Jun 4, 2022
c319e8c
fix: broken frontmatter
james-d-elliott Jun 4, 2022
0fdbeff
fix: order
james-d-elliott Jun 4, 2022
274b166
docs: add readme.md
james-d-elliott Jun 4, 2022
75ed0ff
docs: fix double backslash
james-d-elliott Jun 4, 2022
9af64c1
docs: sync
james-d-elliott Jun 4, 2022
cc77125
docs: sync
james-d-elliott Jun 4, 2022
754d2af
docs: sync
james-d-elliott Jun 4, 2022
5adef15
docs: sync
james-d-elliott Jun 6, 2022
f466e27
docs: sync
james-d-elliott Jun 7, 2022
7557bdb
docs: sync
james-d-elliott Jun 7, 2022
c6e4cbf
Merge remote-tracking branch 'origin/master' into refactor-docs
james-d-elliott Jun 7, 2022
df10518
Merge branch 'master' into refactor-docs
james-d-elliott Jun 8, 2022
0892c56
Merge branch 'master' into refactor-docs
james-d-elliott Jun 9, 2022
88ef356
ci: add netlify ignore cmd
james-d-elliott Jun 9, 2022
6a8597f
ci: test
james-d-elliott Jun 9, 2022
f4da752
ci: fix netlify ignore
james-d-elliott Jun 9, 2022
919d240
ci: revert netlify test
james-d-elliott Jun 9, 2022
100a069
ci: netlify test
james-d-elliott Jun 9, 2022
6e26a7d
ci: adjust netlify ignore
james-d-elliott Jun 9, 2022
2282ae0
ci: test netlify ignore
james-d-elliott Jun 9, 2022
ddc7cc4
ci: adjust netlify ignore
james-d-elliott Jun 9, 2022
46b7136
ci: adjust netlify ignore
james-d-elliott Jun 9, 2022
93f468b
ci: test netlify ignore
james-d-elliott Jun 9, 2022
36c510e
docs: sync
james-d-elliott Jun 9, 2022
70bdc17
docs: sync
james-d-elliott Jun 9, 2022
64bcaa7
docs: sync
james-d-elliott Jun 9, 2022
0f4a270
docs: sync
james-d-elliott Jun 9, 2022
7d21231
Merge branch 'master' into refactor-docs
james-d-elliott Jun 11, 2022
9a1eeb9
docs: sync
james-d-elliott Jun 11, 2022
e5f4929
docs: sync
james-d-elliott Jun 11, 2022
12c1469
refactor: apply suggestions
james-d-elliott Jun 12, 2022
d02cd56
refactor: apply suggestions
james-d-elliott Jun 12, 2022
841c055
docs: sync
james-d-elliott Jun 12, 2022
b961b8f
docs: update openid integrations
james-d-elliott Jun 12, 2022
675f6b5
docs: sync
james-d-elliott Jun 12, 2022
81769aa
docs: sync
james-d-elliott Jun 12, 2022
8805e2d
docs: sync
james-d-elliott Jun 12, 2022
31bcb98
docs: update cli
james-d-elliott Jun 12, 2022
21bda59
docs: sync
james-d-elliott Jun 12, 2022
0a23ca0
docs: remove lastmod
james-d-elliott Jun 12, 2022
cab816a
docs: adjust nginx examples
james-d-elliott Jun 12, 2022
1d8c688
docs: adjust csp
james-d-elliott Jun 12, 2022
0940579
docs: adjust csp
james-d-elliott Jun 13, 2022
c2d540d
docs: adjust csp
james-d-elliott Jun 13, 2022
47f5c5e
docs: update cli docs
james-d-elliott Jun 13, 2022
e5123ea
test: use report sample
james-d-elliott Jun 13, 2022
0413109
fix: use sha512
james-d-elliott Jun 13, 2022
d2407c3
revert: report sample
james-d-elliott Jun 14, 2022
6c0937d
docs: add telemetry docs
james-d-elliott Jun 14, 2022
0419209
refactor: quote networks
james-d-elliott Jun 14, 2022
1302257
Merge branch 'master' into refactor-docs
james-d-elliott Jun 14, 2022
2c840c2
Merge remote-tracking branch 'origin/master' into refactor-docs
james-d-elliott Jun 14, 2022
e900a41
Merge branch 'master' into refactor-docs
james-d-elliott Jun 15, 2022
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
9 changes: 1 addition & 8 deletions .buildkite/deployment.sh
Expand Up @@ -61,11 +61,4 @@ steps:
agents:
upload: "fast"
if: build.tag != null

- label: ":book: Deploy Documentation"
command: "syncdoc.sh"
depends_on: ~
agents:
upload: "fast"
if: build.branch == "master"
EOF
EOF
25 changes: 0 additions & 25 deletions .buildkite/steps/syncdoc.sh

This file was deleted.

2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Expand Up @@ -2,7 +2,7 @@
blank_issues_enabled: false
contact_links:
- name: Documentation
url: https://www.authelia.com/docs/
url: https://www.authelia.com/
about: Read the Documentation
- name: Matrix
url: https://matrix.to/#/#community:authelia.com
Expand Down
5 changes: 4 additions & 1 deletion .renovaterc
Expand Up @@ -4,6 +4,9 @@
":semanticCommitTypeAll(build)",
":separatePatchReleases"
],
"ignorePaths": [
"docs/**"
],
"ignorePresets": [
":combinePatchMinorReleases",
"helpers:disableTypesNodeMajor",
Expand Down Expand Up @@ -58,4 +61,4 @@
"gomodTidy",
"gomodNoMassage"
]
}
}
1 change: 1 addition & 0 deletions .yamllint.yml
Expand Up @@ -2,6 +2,7 @@
extends: default

ignore: |
docs/pnpm-lock.yaml
internal/configuration/test_resources/config_bad_quoting.yml
web/pnpm-lock.yaml
web/node_modules/
Expand Down
16 changes: 9 additions & 7 deletions CONTRIBUTING.md
@@ -1,7 +1,7 @@
# Contributing

Anybody willing to contribute to the project either with code, documentation, security reviews or whatever, are very
welcome to create or review pull requests and take part in discussions in any of our public
Anybody willing to contribute to the project either with code, documentation, security reviews or whatever, are very
welcome to create or review pull requests and take part in discussions in any of our public
[chat rooms](./README.md#contact-options).

It's also possible to contribute financially in order to support the community.
Expand All @@ -15,11 +15,13 @@ If you've found a **bug** or have a **feature request** then please create an is
## Code

If you would like to fix a bug or implement a feature, please fork the repository and create a Pull Request.
More information on getting set up locally can be found [here](https://www.authelia.com/docs/contributing/).
More information on getting set up locally can be found in the
[Development Contribution](https://www.authelia.com/contributing/development/introduction/) documentation.

Before you start any Pull Request, it's recommended that you create an issue to discuss first if you have any doubts about requirement or implementation.
That way you can be sure that the maintainer(s) agree on what to change and how, and you can hopefully get a quick merge afterwards.
Also, let the maintainers know that you plan to work on a particular issue so that no one else starts any duplicate work.
Before you start any Pull Request, it's recommended that you create an issue to discuss first if you have any doubts
about requirement or implementation. That way you can be sure that the maintainer(s) agree on what to change and how,
and you can hopefully get a quick merge afterwards. Also, let the maintainers know that you plan to work on a particular
issue so that no one else starts any duplicate work.

Pull Requests can only be merged once all status checks are green, which means `authelia-scripts --log-level debug ci` passes, and coverage does not regress.

Expand All @@ -37,7 +39,7 @@ Read more about this in the [GitHub docs, Re-requesting a review](https://docs.g

## Collaboration with maintainers

Sometimes the codebase can be a challenge to navigate, especially for a first-time contributor. We don't want you
Sometimes the codebase can be a challenge to navigate, especially for a first-time contributor. We don't want you
spending an hour trying to work out something that would take us only a minute to explain.

If you'd like some help getting started we have several [contact options](./README.md#contact-options) available.
68 changes: 33 additions & 35 deletions README.md
@@ -1,5 +1,5 @@
<p align="center">
<img src="./docs/images/authelia-title.png" width="350" title="Authelia">
<img src="./docs/static/images/authelia-title.png" width="350" title="Authelia">
</p>

[![Build](https://img.shields.io/buildkite/d6543d3ece3433f46dbe5fd9fcfaf1f68a6dbc48eb1048bc22/master?logo=buildkite&style=flat-square&color=brightgreen)](https://buildkite.com/authelia/authelia)
Expand All @@ -20,12 +20,12 @@ sign-on (SSO) for your applications via a web portal. It acts as a companion for
[Traefik], [caddy] or [HAProxy] to let them know whether requests should either be allowed or redirected to Authelia's
portal for authentication.

Documentation is available at https://www.authelia.com/docs.
Documentation is available at [https://www.authelia.com/](https://www.authelia.com/).

The following is a simple diagram of the architecture:

<p align="center" style="margin:50px">
<img src="./docs/images/archi.png"/>
<img src="./docs/static/images/archi.png"/>
</p>

**Authelia** can be installed as a standalone service from the [AUR](https://aur.archlinux.org/packages/authelia/),
Expand All @@ -36,27 +36,27 @@ The following is a simple diagram of the architecture:
the Helm [Chart](https://charts.authelia.com) (beta) leveraging ingress controllers and ingress configurations.

<p align="center">
<img src="./docs/images/logos/kubernetes.png" height="100"/>
<img src="./docs/images/logos/docker.logo.png" width="100">
<img src="./docs/static/images/logos/kubernetes.png" height="100"/>
<img src="./docs/static/images/logos/docker.logo.png" width="100">
</p>

Here is what Authelia's portal looks like:

<p align="center">
<img src="./docs/images/1FA.png" width="400" />
<img src="./docs/images/2FA-METHODS.png" width="400" />
<img src="./docs/static/images/1FA.png" width="400" />
<img src="./docs/static/images/2FA-METHODS.png" width="400" />
</p>

## Features summary

This is a list of the key features of Authelia:

* Several second factor methods:
* **[Security Keys](https://www.authelia.com/docs/features/2fa/security-key)** that support [FIDO2]&nbsp;[Webauthn]
with devices like a [YubiKey].
* **[Time-based One-Time password](https://www.authelia.com/docs/features/2fa/one-time-password)**
* **[Security Keys](https://www.authelia.com/overview/authentication/webauthn-security-key/)** that support
[FIDO2]&nbsp;[Webauthn] with devices like a [YubiKey].
* **[Time-based One-Time password](https://www.authelia.com/overview/authentication/one-time-password/)**
with compatible authenticator applications.
* **[Mobile Push Notifications](https://www.authelia.com/docs/features/2fa/push-notifications)**
* **[Mobile Push Notifications](https://www.authelia.com/overview/authentication/push-notification/)**
with [Duo](https://duo.com/).
* Password reset with identity verification using email confirmation.
* Access restriction after too many invalid authentication attempts.
Expand All @@ -78,45 +78,48 @@ This is a list of the key features of Authelia:
[Traefik Kubernetes Ingress](https://doc.traefik.io/traefik/providers/kubernetes-crd/) Kubernetes ingress
controllers out of the box.
* Beta support for installing via Helm using our [Charts](https://charts.authelia.com).
* Beta support for [OpenID Connect](https://www.authelia.com/docs/configuration/identity-providers/oidc.html).
* Beta support for [OpenID Connect](https://www.authelia.com/roadmap/active/openid-connect/).

For more details about the features, follow [Features](https://www.authelia.com/docs/features/).
For more details take a look at the [Overview](https://www.authelia.com/overview/prologue/introduction/).

If you want to know more about the roadmap, follow [Roadmap](https://www.authelia.com/docs/roadmap).
If you want to know more about the roadmap, follow [Roadmap](https://www.authelia.com/roadmap).

## Proxy support

Authelia works in combination with [nginx], [Traefik], [caddy] or [HAProxy]. It can be deployed on bare metal with
Docker or on top of [Kubernetes].

<p align="center">
<img src="./docs/images/logos/nginx.png" height="50"/>
<img src="./docs/images/logos/traefik.png" height="50"/>
<img src="./docs/images/logos/caddy.png" height="50"/>
<img src="./docs/images/logos/haproxy.png" height="50"/>
<img src="./docs/images/logos/kubernetes.png" height="50"/>
<img src="./docs/static/images/logos/nginx.png" height="50"/>
<img src="./docs/static/images/logos/traefik.png" height="50"/>
<img src="./docs/static/images/logos/caddy.png" height="50"/>
<img src="./docs/static/images/logos/haproxy.png" height="50"/>
<img src="./docs/static/images/logos/kubernetes.png" height="50"/>
</p>

***Help Wanted:*** Assistance would be appreciated in getting Authelia working with
[Envoy](https://www.envoyproxy.io/).

<p align="center">
<img src="./docs/images/logos/envoy.png" height="50"/>
<img src="./docs/static/images/logos/envoy.png" height="50"/>
</p>

## Getting Started

See the [Get Started Guide](https://www.authelia.com/integration/prologue/get-started/) or one of the curated examples
below.

### docker-compose

The `docker-compose` bundles act as a starting point for anyone wanting to see Authelia in action. You will have to
customize them to your needs as they come with self-signed certificates.

#### [Local](https://www.authelia.com/docs/getting-started)
#### [Local](https://www.authelia.com/integration/deployment/docker/#local)
The Local compose bundle is intended to test Authelia without worrying about configuration.
It's meant to be used for scenarios where the server is not be exposed to the internet.
Domains will be defined in the local hosts file and self-signed certificates will be utilised.

#### [Lite](https://www.authelia.com/docs/deployment/deployment-lite)
#### [Lite](https://www.authelia.com/integration/deployment/docker/#lite)
The Lite compose bundle is intended for scenarios where the server will be exposed to the internet, domains and DNS will
need to be setup accordingly and certificates will be generated through LetsEncrypt. The Lite element refers to minimal
external dependencies; File based user storage, SQLite based configuration storage. In this configuration, the service
Expand All @@ -140,8 +143,8 @@ This guide will show you how to deploy it on bare metal as well as on
Authelia takes security very seriously. If you discover a vulnerability in Authelia, please see our
[Security Policy](https://github.com/authelia/authelia/security/policy).

For more information about [security](https://www.authelia.com/docs/security/) related matters, please read
[the documentation](https://www.authelia.com/docs/security/).
For more information about [security](https://www.authelia.com/information/security/) related matters, please read
[the documentation](https://www.authelia.com/information/security/).

## Contact Options

Expand Down Expand Up @@ -345,22 +348,17 @@ Companies contributing to Authelia will have a specical mention below. [[Become

#### Balto

Thank you to [<img src="./docs/images/logos/balto.svg" alt="Balto" width="32"> Balto](https://www.getbalto.com/) for
hosting our apt repository.

#### Digital Ocean

Thank you to [<img src="./docs/images/logos/digitalocean.svg" alt="Digital Ocean" width="32"> DigitalOcean](https://www.digitalocean.com/?from=Authelia) for
contributing on OpenCollective.
Thank you to [<img src="./docs/static/images/logos/balto.svg" alt="Balto" width="32"> Balto](https://www.getbalto.com/)
for hosting our apt repository.

#### JetBrains

Thank you to [<img src="./docs/images/logos/jetbrains.svg" alt="JetBrains" width="32"> JetBrains](https://www.jetbrains.com/?from=Authelia)
Thank you to [<img src="./docs/static/images/logos/jetbrains.svg" alt="JetBrains" width="32"> JetBrains](https://www.jetbrains.com/?from=Authelia)
for providing us with free licenses to their great tools.

* [<img src="./docs/images/logos/intellij-idea.svg" alt="IDEA" width="32"> IDEA](http://www.jetbrains.com/idea/)
* [<img src="./docs/images/logos/goland.svg" alt="GoLand" width="32"> GoLand](http://www.jetbrains.com/go/)
* [<img src="./docs/images/logos/webstorm.svg" alt="WebStorm" width="32"> WebStorm](http://www.jetbrains.com/webstorm/)
* [<img src="./docs/static/images/logos/intellij-idea.svg" alt="IDEA" width="32"> IDEA](http://www.jetbrains.com/idea/)
* [<img src="./docs/static/images/logos/goland.svg" alt="GoLand" width="32"> GoLand](http://www.jetbrains.com/go/)
* [<img src="./docs/static/images/logos/webstorm.svg" alt="WebStorm" width="32"> WebStorm](http://www.jetbrains.com/webstorm/)

## License

Expand Down
20 changes: 10 additions & 10 deletions SECURITY.md
Expand Up @@ -2,20 +2,20 @@

## Prologue

Authelia takes security very seriously. We follow the rule of
Authelia takes security very seriously. We follow the rule of
[responsible disclosure](https://en.wikipedia.org/wiki/Responsible_disclosure), and we urge our community to do so as
well instead of making the vulnerability public. This allows time for the security issue to be patched quickly.

If you discover a vulnerability in Authelia, please first contact one of the maintainers privately as described in the
[contact options](#contact-options) below.
If you discover a vulnerability in Authelia, please first contact one of the maintainers privately as described in the
[contact options](#contact-options) below.

We urge you not to disclose the bug publicly at least until we've had a
reasonable chance to fix it, and to clearly communicate any public disclosure timeline in your initial contact with us.
reasonable chance to fix it, and to clearly communicate any public disclosure timeline in your initial contact with us.
If you do not have a particular public disclosure timeline, we will clearly communicate ours as we publish security
advisories.
advisories.

For more information about [security](https://www.authelia.com/docs/security/) related matters, please read
[the documentation](https://www.authelia.com/docs/security/).
For more information about [security](https://www.authelia.com/information/security/) related matters, please read
[the documentation](https://www.authelia.com/information/security/).

## Contact Options

Expand All @@ -25,7 +25,7 @@ privately which is described in each available contact method. The methods inclu

## Credit

Users who report bugs will optionally be creditted for the discovery. Both in the [security advisory] and in our
Users who report bugs will optionally be credited for the discovery. Both in the [security advisory] and in our
[all contributors](./README.md#contribute) configuration/documentation.

## Process
Expand All @@ -40,8 +40,8 @@ Users who report bugs will optionally be creditted for the discovery. Both in th

## Help Wanted

We are actively looking for sponsorship to obtain either a code security audit, penetration testing, or other audits
We are actively looking for sponsorship to obtain either a code security audit, penetration testing, or other audits
related to improving the security of Authelia. If your company or you personally are willing to offer discounts, pro
bono, or funding towards services like these please feel free to contact us on *any* of the methods above.

[security advisory]: https://github.com/authelia/authelia/security/advisories
[security advisory]: https://github.com/authelia/authelia/security/advisories