Skip to content

Commit

Permalink
* Update docs and configuration template
Browse files Browse the repository at this point in the history
  • Loading branch information
nightah committed May 19, 2020
1 parent f8b44d3 commit 7988f6f
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 1 deletion.
2 changes: 1 addition & 1 deletion config.template.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ server:
read_buffer_size: 4096
# Write buffer size configures the http server's maximum outgoing response size in bytes.
write_buffer_size: 4096
# Set the path Authelia listens on. Most users will keep this set as a blank string. Must only be alphanumeric chars.
# Set the path Authelia listens on, must be alphanumeric chars.
path: ""

# Level of verbosity for logs: info, debug, trace
Expand Down
18 changes: 18 additions & 0 deletions docs/configuration/server.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,28 @@ server:
read_buffer_size: 4096
# Write buffer size configures the http server's maximum outgoing response size in bytes.
write_buffer_size: 4096
# Set the path Authelia listens on, must be alphanumeric chars.
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.
Example: https://auth.example.com/authelia, https://example.com/authelia
```yaml
server:
path: authelia
```

0 comments on commit 7988f6f

Please sign in to comment.