mirror of
https://github.com/CommunitySolidServer/CommunitySolidServer.git
synced 2024-10-03 14:55:10 +00:00
9a5fc674f3
* chore: add markdownlint-cli2 and config for mkdocs * style: enforce linting rules on mkdocs md files * chore: tweaks to markdownlint rules * style: linting changelog * style: linting release notes * style: linting .github md files * style: further linting of docs * style: linting readmes * chore: update linting script entries * docs: tweak release after rebase * chore: simplify root md linting config * chore: extend base config * chore: implement requested changes * chore: remove unnecessary exception * chore: fix comment type * styling: single config + list spacing * chore: implement requested changes * chore: use .cjs files for markdownlint config * chore: implement requested changes
37 lines
1.2 KiB
Markdown
37 lines
1.2 KiB
Markdown
# HTTP
|
|
|
|
Options related to the base support of HTTP requests by the server.
|
|
|
|
## Handler
|
|
|
|
Sets up all the handlers a request will potentially pass through.
|
|
|
|
* *default*: The full setup, that is middleware + static files + IDP + LDP.
|
|
* *simple*: A simpler setup in which the IDP is disabled.
|
|
|
|
## Middleware
|
|
|
|
A set of handlers that will always be run on all requests to add some metadata
|
|
and then pass the request along.
|
|
|
|
* *no-websockets*: The default setup but without the websocket-related metadata.
|
|
* *websockets*: The default setup with several handlers.
|
|
|
|
## Server-Factory
|
|
|
|
The factory used to create the actual server object.
|
|
|
|
* *no-websockets*: Only HTTP.
|
|
* *websockets*: HTTP and websockets.
|
|
* *https-no-websockets*: Only HTTPS. Adds 2 new CLI params to set the key/cert paths.
|
|
* *https-websockets*: HTTPS and websockets. Adds 2 new CLI params to set the key/cert paths.
|
|
* *https-example*: An example configuration to use HTTPS directly at the server (instead of at a reverse proxy)
|
|
by adding the key/cert paths to the config itself.
|
|
|
|
## Static
|
|
|
|
Support for static files that should be found at a specific path.
|
|
|
|
* *default*: The default handler with a favicon and css for the IDP.
|
|
New entries can easily be added for new files.
|