docs: update get started (#3907)

pull/3908/head^2
James Elliott 2022-08-26 20:46:47 +10:00 committed by GitHub
parent 15e1191d1b
commit 21929d6508
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 397 additions and 399 deletions

View File

@ -6,6 +6,9 @@
/** Import Bootstrap */ /** Import Bootstrap */
@import "bootstrap/scss/bootstrap"; @import "bootstrap/scss/bootstrap";
/** Import Bootstrap Icons */
$bootstrap-icons-font-file: "./fonts/bootstrap-icons";
@import "bootstrap-icons/font/bootstrap-icons.scss"; @import "bootstrap-icons/font/bootstrap-icons.scss";
/** Import highlight.js */ /** Import highlight.js */

View File

@ -15,6 +15,20 @@ toc: true
It's important to note that this guide has a layout which we suggest as the best order in areas to tackle, but you may It's important to note that this guide has a layout which we suggest as the best order in areas to tackle, but you may
obviously choose a different path if you are so inclined. obviously choose a different path if you are so inclined.
## Prerequisites
### Forwarded Authentication
Forwarded Authentication is a simple per-request authorization flow that checks the metadata of a request and a session
cookie to determine if a user must be forwarded to the authentication portal.
Due to the fact a cookie is use, it's an intentional design decision that *__ALL__* applications/domains protected via
this method *__MUST__* use secure schemes (`https` and `wss`) for all of their communication.
### OpenID Connect
Only requires Authelia to be use a secure scheme (`https`).
## Configuration ## Configuration
It's important to customize the configuration for *Authelia* in advance of deploying it. The configuration is static and It's important to customize the configuration for *Authelia* in advance of deploying it. The configuration is static and

View File

@ -87,8 +87,8 @@ available in [Kubernetes]. You would likely have to build your own [HAProxy] ima
### Envoy ### Envoy
[Envoy] is currently not documented however we believe it is likely to be technically supported. This should be possible [Envoy] is currently not documented, however a small pending feature will add complete support for [Envoy]. This is
via [Envoy]'s [external authorization](https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/filters/http/ext_authz/v3/ext_authz.proto.html#extensions-filters-http-ext-authz-v3-extauthz). possible via [Envoy]'s [external authorization](https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/filters/http/ext_authz/v3/ext_authz.proto.html#extensions-filters-http-ext-authz-v3-extauthz).
### Caddy ### Caddy

View File

@ -39,16 +39,17 @@
}, },
"devDependencies": { "devDependencies": {
"@babel/cli": "7.18.10", "@babel/cli": "7.18.10",
"@babel/core": "7.18.10", "@babel/core": "7.18.13",
"@babel/preset-env": "7.18.10", "@babel/preset-env": "7.18.10",
"@fullhuman/postcss-purgecss": "4.1.3", "@fullhuman/postcss-purgecss": "4.1.3",
"@hyas/images": "0.2.2", "@hyas/images": "0.2.3",
"@popperjs/core": "2.11.6",
"auto-changelog": "2.4.0", "auto-changelog": "2.4.0",
"autoprefixer": "10.4.8", "autoprefixer": "10.4.8",
"bootstrap": "5.2.0", "bootstrap": "5.2.0",
"bootstrap-icons": "1.9.1", "bootstrap-icons": "1.9.1",
"clipboard": "2.0.11", "clipboard": "2.0.11",
"eslint": "8.21.0", "eslint": "8.22.0",
"exec-bin": "1.0.0", "exec-bin": "1.0.0",
"flexsearch": "0.7.21", "flexsearch": "0.7.21",
"highlight.js": "11.6.0", "highlight.js": "11.6.0",
@ -56,20 +57,17 @@
"instant.page": "5.1.1", "instant.page": "5.1.1",
"katex": "0.16.0", "katex": "0.16.0",
"lazysizes": "5.3.2", "lazysizes": "5.3.2",
"markdownlint-cli2": "0.5.0", "markdownlint-cli2": "0.5.1",
"netlify-plugin-submit-sitemap": "0.4.0", "netlify-plugin-submit-sitemap": "0.4.0",
"node-fetch": "3.2.10", "node-fetch": "3.2.10",
"postcss": "8.4.16", "postcss": "8.4.16",
"postcss-cli": "10.0.0", "postcss-cli": "10.0.0",
"purgecss-whitelister": "2.4.0", "purgecss-whitelister": "2.4.0",
"shx": "0.3.4", "shx": "0.3.4",
"stylelint": "14.9.1", "stylelint": "14.11.0",
"stylelint-config-standard-scss": "4.0.0" "stylelint-config-standard-scss": "4.0.0"
}, },
"otherDependencies": { "otherDependencies": {
"hugo": "0.101.0" "hugo": "0.101.0"
},
"dependencies": {
"@popperjs/core": "2.11.5"
} }
} }

File diff suppressed because it is too large Load Diff