diff --git a/docs/configuration/index.md b/docs/configuration/index.md index 7f94010fe..db4dd6866 100644 --- a/docs/configuration/index.md +++ b/docs/configuration/index.md @@ -8,7 +8,7 @@ has_children: true # Configuration Authelia uses a YAML file as configuration file. A template with all possible -options can be found [here](../config.template.yml), at the root of the repository. +options can be found [here](https://github.com/authelia/authelia/blob/master/config.template.yml), at the root of the repository. When running **Authelia**, you can specify your configuration by passing the file path as shown below. diff --git a/docs/configuration/storage/index.md b/docs/configuration/storage/index.md index 79224e050..5025973c7 100644 --- a/docs/configuration/storage/index.md +++ b/docs/configuration/storage/index.md @@ -14,7 +14,7 @@ logs, etc... The available options are: -* [SQLite](./sqlite.html) -* [MariaDB](./mariadb.html) +* [SQLite](./sqlite.md) +* [MariaDB](./mariadb.md) * ~~MySQL~~ ([#512](https://github.com/authelia/authelia/issues/512)) -* [Postgres]((./postgres.html)) \ No newline at end of file +* [Postgres](./postgres.md) \ No newline at end of file diff --git a/docs/deployment/deployment-ha.md b/docs/deployment/deployment-ha.md index f1c2b4395..4bb025e4d 100644 --- a/docs/deployment/deployment-ha.md +++ b/docs/deployment/deployment-ha.md @@ -37,7 +37,7 @@ the root of the repo. **NOTE**: Prefer using environment variables to set secrets in production otherwise pay attention to the permissions of the configuration file. See -[configuration.md](./configuration.md#secrets) for more information. +[configuration.md](../configuration/secrets.md) for more information. ### Deploy with the distributable version @@ -58,7 +58,7 @@ an infrastructure on bare metal. We would be more than happy to review any PR on -[config.template.yml]: ../config.template.yml -[Getting Started]: ./getting-started.md +[config.template.yml]: https://github.com/authelia/authelia/blob/master/config.template.yml +[Getting Started]: ../getting-started.md [Deployment for Devs]: ./deployment-dev.md [Kubernetes]: https://kubernetes.io/ diff --git a/docs/deployment/deployment-lite.md b/docs/deployment/deployment-lite.md index 246e178a8..9ac78a501 100644 --- a/docs/deployment/deployment-lite.md +++ b/docs/deployment/deployment-lite.md @@ -17,14 +17,14 @@ only two: a reverse proxy such as Nginx, Traefik or HAProxy and Authelia. ## Reverse Proxy Documentation for deploying a reverse proxy collaborating with Authelia is available -[here](./supported-proxies/index). +[here](./supported-proxies/index.md). ## Discard components ### Discard SQL server It's possible to use a SQLite file instead of a SQL server as documented -[here](../configuration/storage/sqlite). +[here](../configuration/storage/sqlite.md). ### Discard Redis @@ -33,7 +33,7 @@ be stored in memory instead. This has the inconvenient of logging out users every time Authelia restarts. The documentation about session management is available -[here](../configuration/session). +[here](../configuration/session.md). ### Discard LDAP @@ -42,7 +42,7 @@ The documentation about session management is available LDAP server or an Active Directory. To use a file backend instead of a LDAP server, please follow the related -documentation [here](../configuration/authentication/file). +documentation [here](../configuration/authentication/file.md). ## FAQ diff --git a/docs/features/2fa/push-notifications.md b/docs/features/2fa/push-notifications.md index ce7e3ee15..312d39ec3 100644 --- a/docs/features/2fa/push-notifications.md +++ b/docs/features/2fa/push-notifications.md @@ -25,7 +25,7 @@ Beware that the name of the user must match the name of the user in Authelia. Then, in Duo interface, click on *Applications* and *Protect an Application*. Select the option *Partner Auth API*. This will generate an integration key, a secret key and a hostname. You can set the name of the application to **Authelia** and then you must add the generated information -to Authelia [configuration](../deployment/configuration.md) as shown below: +to Authelia [configuration](../../deployment/index.md) as shown below: duo_api: hostname: api-123456789.example.com @@ -54,7 +54,7 @@ Users must be enrolled via the Duo Admin panel, they cannot enroll a device from ### Why don't I have access to the *Push Notification* option? It's likely that you have not configured **Authelia** correctly. Please read this -documentation again and be sure you had a look at [config.template.yml](../../config.template.yml). +documentation again and be sure you had a look at [config.template.yml](https://github.com/authelia/authelia/blob/master/config.template.yml). diff --git a/docs/features/access-control.md b/docs/features/access-control.md index 2ee4e2e1d..d4eae6a50 100644 --- a/docs/features/access-control.md +++ b/docs/features/access-control.md @@ -26,4 +26,4 @@ is applied requiring the user to authenticate with two factors. ## Configuration -Please check the dedicated [documentation](./deployment/configuration/access-control.md) +Please check the dedicated [documentation](../configuration/access-control.md) diff --git a/docs/features/regulation.md b/docs/features/regulation.md index e3bb2b02a..8ce81b64c 100644 --- a/docs/features/regulation.md +++ b/docs/features/regulation.md @@ -14,4 +14,4 @@ attempts have been made. ## Configuration -Please check the dedicated [documentation](./deployement/configuration/regulation.md). \ No newline at end of file +Please check the dedicated [documentation](../configuration/regulation.md). \ No newline at end of file diff --git a/docs/features/single-factor.md b/docs/features/single-factor.md index 45b4d027a..d0e14c36a 100644 --- a/docs/features/single-factor.md +++ b/docs/features/single-factor.md @@ -18,7 +18,7 @@ matching `app1.example.com/api/(.*)` with only a single factor and all resources matching `app1.example.com/admin` with two factors. To know more about the configuration of the feature, please visit the -documentation about the [configuration](../deployment/configuration.md). +documentation about the [configuration](../configuration/access-control.md). ## Proxy-Authorization header diff --git a/docs/getting-started.md b/docs/getting-started.md index d2aeaeeac..a05a646ff 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -18,7 +18,7 @@ Then, start the *Standalone* [suite]. $ authelia-scripts suites setup Standalone A [suite] is kind of a virtual environment for running Authelia in a complete ecosystem. -If you want more details please read the related [documentation](./suites.md). +If you want more details please read the related [documentation](./contributing/suites.md). ## Test it! diff --git a/docs/index.md b/docs/index.md index fc8416e09..d81fbd5ef 100644 --- a/docs/index.md +++ b/docs/index.md @@ -35,7 +35,7 @@ Multiple 2-factor methods are available for satisfying every users. **Authelia** is available as Docker images, static binaries and AUR packages so that you can test it in minutes. Let's begin with the -[Getting Started](./getting-started). +[Getting Started](./getting-started.md). ## However, Authelia...