mirror of
https://github.com/CommunitySolidServer/CommunitySolidServer.git
synced 2024-10-03 14:55:10 +00:00
49 lines
1.7 KiB
Markdown
49 lines
1.7 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.
|
|
|
|
* *default*: The default setup with several handlers.
|
|
|
|
## Notifications
|
|
|
|
Determines how notifications should be sent out from the server when resources change.
|
|
|
|
* *all*: Supports all available notification types of the Solid Notifications protocol
|
|
[specification](https://solidproject.org/TR/notifications-protocol).
|
|
Currently, this includes WebHookSubscription2021 and WebSocketSubscription2021.
|
|
* *disabled*: No notifications are sent out.
|
|
* *legacy-websocket*: Follows the legacy Solid WebSocket
|
|
[specification](https://github.com/solid/solid-spec/blob/master/api-websockets.md).
|
|
* *webhooks*: Follows the WebHookSubscription2021
|
|
[specification](https://github.com/solid/notifications/blob/main/webhook-subscription-2021.md) draft.
|
|
* *websockets*: Follows the WebSocketSubscription2021
|
|
[specification](https://solidproject.org/TR/websocket-subscription-2021).
|
|
|
|
## Server-Factory
|
|
|
|
The factory used to create the actual server object.
|
|
|
|
* *http*: A HTTP server.
|
|
* *https*: A HTTPS server.
|
|
* *https-no-cli-example*: An example of how to set up an HTTPS server
|
|
by defining the key/cert paths directly in 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.
|