docs: misc fixes to documentation after overhaul (#1906)
parent
9e7b73bd56
commit
619da0f7ec
|
@ -16,6 +16,22 @@ When running **Authelia**, you can specify your configuration by passing the fil
|
||||||
$ authelia --config config.custom.yml
|
$ authelia --config config.custom.yml
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Documentation
|
||||||
|
|
||||||
|
We document the configuration in two ways:
|
||||||
|
|
||||||
|
1. The configuration yaml default has comments documenting it. All documentation lines start with `##`. Lines starting
|
||||||
|
with a single `#` are yaml configuration options which are commented to disable them or as examples.
|
||||||
|
|
||||||
|
2. This documentation site. Generally each section of the configuration is in its own section of the documentation
|
||||||
|
site. Each configuration option is listed in its relevant section as a heading, under that heading generally are two
|
||||||
|
or three colored labels.
|
||||||
|
- The `type` label is purple and indicates the yaml value type of the variable. It optionally includes some
|
||||||
|
additional information in parentheses.
|
||||||
|
- The `default` label is blue and indicates the default value if you don't define the option at all. This is not the
|
||||||
|
same value as you will see in the examples in all instances, it is the value set when blank or undefined.
|
||||||
|
- The `required` label changes color. When required it will be red, when not required it will be green, when the
|
||||||
|
required state depends on another configuration value it is yellow.
|
||||||
|
|
||||||
## Validation
|
## Validation
|
||||||
|
|
||||||
|
|
|
@ -117,7 +117,7 @@ log_level: debug
|
||||||
<div markdown="1">
|
<div markdown="1">
|
||||||
type: string
|
type: string
|
||||||
{: .label .label-config .label-purple }
|
{: .label .label-config .label-purple }
|
||||||
default: ""
|
default: text
|
||||||
{: .label .label-config .label-blue }
|
{: .label .label-config .label-blue }
|
||||||
required: no
|
required: no
|
||||||
{: .label .label-config .label-green }
|
{: .label .label-config .label-green }
|
||||||
|
|
|
@ -27,7 +27,7 @@ type: integer
|
||||||
default: 4096
|
default: 4096
|
||||||
{: .label .label-config .label-blue }
|
{: .label .label-config .label-blue }
|
||||||
required: no
|
required: no
|
||||||
{: .label .label-config .label-red }
|
{: .label .label-config .label-green }
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
Configures the maximum request size. The default of 4096 is generally sufficient for most use cases.
|
Configures the maximum request size. The default of 4096 is generally sufficient for most use cases.
|
||||||
|
|
|
@ -8,13 +8,7 @@ has_children: true
|
||||||
|
|
||||||
# Storage backends
|
# Storage backends
|
||||||
|
|
||||||
**Authelia** supports multiple storage backends. The backend is used
|
**Authelia** supports multiple storage backends. The backend is used to store user preferences, 2FA device handles and
|
||||||
to store user preferences, 2FA device handles and secrets, authentication
|
secrets, authentication logs, etc...
|
||||||
logs, etc...
|
|
||||||
|
|
||||||
The available options are:
|
The available storage backends are listed in the table of contents below.
|
||||||
|
|
||||||
* [MariaDB](./mariadb.md)
|
|
||||||
* [MySQL](./mysql.md)
|
|
||||||
* [Postgres](./postgres.md)
|
|
||||||
* [SQLite](./sqlite.md)
|
|
||||||
|
|
|
@ -9,13 +9,25 @@ nav_order: 11
|
||||||
|
|
||||||
The theme section configures the theme and style Authelia uses.
|
The theme section configures the theme and style Authelia uses.
|
||||||
|
|
||||||
There are currently 3 available themes for Authelia:
|
|
||||||
* light (default)
|
|
||||||
* dark
|
|
||||||
* grey
|
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
theme: light
|
theme: light
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Options
|
||||||
|
|
||||||
|
### theme
|
||||||
|
<div markdown="1">
|
||||||
|
type: string
|
||||||
|
{: .label .label-config .label-purple }
|
||||||
|
default: light
|
||||||
|
{: .label .label-config .label-blue }
|
||||||
|
required: no
|
||||||
|
{: .label .label-config .label-green }
|
||||||
|
</div>
|
||||||
|
|
||||||
|
There are currently 3 available themes for Authelia:
|
||||||
|
* light (default)
|
||||||
|
* dark
|
||||||
|
* grey
|
||||||
|
|
Loading…
Reference in New Issue