mirror of
https://github.com/0rangebananaspy/authelia.git
synced 2024-09-14 22:47:21 +07:00
fcd0b5e46a
* [FEATURE] Allow Authelia to listen on a specified path
* Fix linting and add a couple typescript types
* Template index.html to support base_url
* Update docs and configuration template
* Access base path from body attribute.
* Update CSP
* Fix unit test
Also remove check for body as this will never get triggered, react itself is loaded inside the body so this has to always be successful.
* Template index.html with ${PUBLIC_URL}
* Define PUBLIC_URL in .env(s)
* Add docs clarification
Co-authored-by: Amir Zarrinkafsh <nightah@me.com>
Co-authored-by: Clement Michaud <clement.michaud34@gmail.com>
51 lines
1.5 KiB
Markdown
51 lines
1.5 KiB
Markdown
---
|
|
layout: default
|
|
title: Server
|
|
parent: Configuration
|
|
nav_order: 7
|
|
---
|
|
|
|
# Server
|
|
|
|
The server section configures and tunes the http server module Authelia uses.
|
|
|
|
## Configuration
|
|
|
|
```yaml
|
|
# Configuration options specific to the internal http server
|
|
server:
|
|
# Buffers usually should be configured to be the same value.
|
|
# Explanation at https://docs.authelia.com/configuration/server.html
|
|
# Read buffer size configures the http server's maximum incoming request size in bytes.
|
|
read_buffer_size: 4096
|
|
# Write buffer size configures the http server's maximum outgoing response size in bytes.
|
|
write_buffer_size: 4096
|
|
# Set the single level path Authelia listens on, must be alphanumeric chars and should not contain any slashes.
|
|
path: ""
|
|
```
|
|
|
|
### Buffer Sizes
|
|
|
|
The read and write buffer sizes generally should be the same. This is because when Authelia verifies
|
|
if the user is authorized to visit a URL, it also sends back nearly the same size response
|
|
(write_buffer_size) as the request (read_buffer_size).
|
|
|
|
### Path
|
|
|
|
Authelia by default is served from the root `/` location, either via its own domain or subdomain.
|
|
|
|
Example: https://auth.example.com/, https://example.com/
|
|
```yaml
|
|
server:
|
|
path: ""
|
|
```
|
|
|
|
Modifying this setting will allow you to serve Authelia out from a specified base path. Please note
|
|
that currently only a single level path is supported meaning slashes are not allowed, and only
|
|
alphanumeric characters are supported.
|
|
|
|
Example: https://auth.example.com/authelia/, https://example.com/authelia/
|
|
```yaml
|
|
server:
|
|
path: authelia
|
|
``` |