refactor: replace mkdocs with zensical (#2667)
* move docs to zensical * fix requirements * fixes * remove manual font loading does not work properly with mike * switch back to pymdownx.blocks.admonition * revert back * remove css * add note about privacy plugin * pr review findings
This commit is contained in:
@@ -24,7 +24,7 @@ To automatically register users that log in with an OAuth provider, set the foll
|
||||
|
||||
| Env | Required | Default | Description |
|
||||
| --------------------- | -------- | ------- | ------------------------ |
|
||||
| `OAUTH_AUTO_REGISTER` | ✖️ | `false` | Enable auto-registration |
|
||||
| `OAUTH_AUTO_REGISTER` | :x: | `false` | Enable auto-registration |
|
||||
|
||||
When enabled:
|
||||
|
||||
@@ -46,7 +46,7 @@ To only allow users with an email address from a specific domain to log in, set
|
||||
|
||||
| Env | Required | Default | Description |
|
||||
| ----------------------- | -------- | ------- | --------------------- |
|
||||
| `OAUTH_ALLOWED_DOMAINS` | ✖️ | - | Allowed email domains |
|
||||
| `OAUTH_ALLOWED_DOMAINS` | :x: | - | Allowed email domains |
|
||||
|
||||
You can allow multiple domains by separating them with a comma:
|
||||
|
||||
@@ -58,7 +58,7 @@ To automatically launch the OAuth login flow when visiting the login page, set t
|
||||
|
||||
| Env | Required | Default | Description |
|
||||
| ------------------- | -------- | ------- | ----------------------------- |
|
||||
| `OAUTH_AUTO_LAUNCH` | ✖️ | - | Auto launch an OAuth provider |
|
||||
| `OAUTH_AUTO_LAUNCH` | :x: | - | Auto launch an OAuth provider |
|
||||
|
||||
When enabled:
|
||||
|
||||
@@ -83,10 +83,10 @@ If your provider does not support multiple redirect URIs (e.g. GitHub) but allow
|
||||
|
||||
#### Google
|
||||
|
||||
| Env | Required | Description |
|
||||
| ---------------------------- | -------- | -------------------- |
|
||||
| `OAUTH_GOOGLE_CLIENT_ID` | ✔️ | Google Client ID |
|
||||
| `OAUTH_GOOGLE_CLIENT_SECRET` | ✔️ | Google Client Secret |
|
||||
| Env | Required | Description |
|
||||
| ---------------------------- | ------------------ | -------------------- |
|
||||
| `OAUTH_GOOGLE_CLIENT_ID` | :white_check_mark: | Google Client ID |
|
||||
| `OAUTH_GOOGLE_CLIENT_SECRET` | :white_check_mark: | Google Client Secret |
|
||||
|
||||
<h5>Setup</h5>
|
||||
|
||||
@@ -97,10 +97,10 @@ If your provider does not support multiple redirect URIs (e.g. GitHub) but allow
|
||||
|
||||
#### GitHub
|
||||
|
||||
| Env | Required | Description |
|
||||
| ---------------------------- | -------- | -------------------- |
|
||||
| `OAUTH_GITHUB_CLIENT_ID` | ✔️ | GitHub Client ID |
|
||||
| `OAUTH_GITHUB_CLIENT_SECRET` | ✔️ | GitHub Client Secret |
|
||||
| Env | Required | Description |
|
||||
| ---------------------------- | ------------------ | -------------------- |
|
||||
| `OAUTH_GITHUB_CLIENT_ID` | :white_check_mark: | GitHub Client ID |
|
||||
| `OAUTH_GITHUB_CLIENT_SECRET` | :white_check_mark: | GitHub Client Secret |
|
||||
|
||||
<h5>Setup</h5>
|
||||
|
||||
@@ -122,12 +122,12 @@ The provider needs to support:
|
||||
|
||||
The provider needs to be available with HTTPS and have a valid certificate.
|
||||
|
||||
| Env | Required | Default | Example | Description |
|
||||
| -------------------------- | -------- | ------- | -------------------------- | ------------------ |
|
||||
| `OAUTH_OIDC_SERVER` | ✔️ | - | `https://auth.example.com` | OIDC Server |
|
||||
| `OAUTH_OIDC_CLIENT_ID` | ✔️ | - | - | OIDC Client ID |
|
||||
| `OAUTH_OIDC_CLIENT_SECRET` | ✔️ | - | - | OIDC Client Secret |
|
||||
| `OAUTH_OIDC_NAME` | ✖️ | OIDC | `Authelia` | Provider Name |
|
||||
| Env | Required | Default | Example | Description |
|
||||
| -------------------------- | ------------------ | ------- | -------------------------- | ------------------ |
|
||||
| `OAUTH_OIDC_SERVER` | :white_check_mark: | - | `https://auth.example.com` | OIDC Server |
|
||||
| `OAUTH_OIDC_CLIENT_ID` | :white_check_mark: | - | - | OIDC Client ID |
|
||||
| `OAUTH_OIDC_CLIENT_SECRET` | :white_check_mark: | - | - | OIDC Client Secret |
|
||||
| `OAUTH_OIDC_NAME` | :x: | OIDC | `Authelia` | Provider Name |
|
||||
|
||||
##### Authelia Setup
|
||||
|
||||
@@ -167,7 +167,7 @@ To disable password-based authentication and only allow login via OAuth provider
|
||||
|
||||
| Env | Required | Default | Description |
|
||||
| ----------------------- | -------- | ------- | ------------------------------- |
|
||||
| `DISABLE_PASSWORD_AUTH` | ✖️ | `false` | Disable password authentication |
|
||||
| `DISABLE_PASSWORD_AUTH` | :x: | `false` | Disable password authentication |
|
||||
|
||||
When enabled:
|
||||
|
||||
|
||||
Reference in New Issue
Block a user