mirror of
https://github.com/CommunitySolidServer/CommunitySolidServer.git
synced 2024-10-03 14:55:10 +00:00
1 line
109 KiB
JSON
1 line
109 KiB
JSON
{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Welcome","text":"<p>Welcome to the Community Solid Server! Here we will cover many aspects of the server, such as how to propose changes, what the architecture looks like, and how to use many of the features the server provides.</p> <p>The documentation here is still incomplete both in content and structure, so feel free to open a discussion about things you want to see added. While we try to update this documentation together with updates in the code, it is always possible we miss something, so please report it if you find incorrect information or links that no longer work.</p> <p>An introductory tutorial that gives a quick overview of the Solid and CSS basics can be found here. This is a good way to get started with the server and its setup.</p> <p>If you want to know what is new in the latest version, you can check out the release notes for a high level overview and information on how to migrate your configuration to the next version. A list that includes all minor changes can be found in the changelog</p>"},{"location":"#using-the-server","title":"Using the server","text":"<ul> <li>Quickly starting the server</li> <li>Basic example HTTP requests</li> <li>Editing the metadata of a resource</li> <li>How to use the Identity Provider</li> <li>How to automate authentication</li> <li>How to automatically seed pods on startup</li> <li>Receiving notifications when resources change</li> <li>Using the CSS as a development server in another project</li> </ul>"},{"location":"#what-the-internals-look-like","title":"What the internals look like","text":"<ul> <li>How the server uses dependency injection</li> <li>What the architecture looks like</li> </ul>"},{"location":"#comprehensive-guides-and-tutorials","title":"Comprehensive guides and tutorials","text":"<ul> <li>The CSS tutorial repository</li> <li>CSS configuration generator</li> </ul>"},{"location":"#making-changes","title":"Making changes","text":"<ul> <li>How to make changes to the repository</li> </ul> <p>For core developers with push access only:</p> <ul> <li>How to release a new version</li> </ul>"},{"location":"architecture/core/","title":"Core building blocks","text":"<p>There are several core building blocks used in many places of the server. These are described here.</p>"},{"location":"architecture/core/#handlers","title":"Handlers","text":"<p>A very important building block that gets reused in many places is the <code>AsyncHandler</code>. The idea is that a handler has 2 important functions. <code>canHandle</code> determines if this class is capable of correctly handling the request, and throws an error if it can not. For example, a class that converts JSON-LD to turtle can handle all requests containing JSON-LD data, but does not know what to do with a request that contains a JPEG. The second function is <code>handle</code> where the class executes on the input data and returns the result. If an error gets thrown here it means there is an issue with the input. For example, if the input data claims to be JSON-LD but is actually not.</p> <p>The power of using this interface really shines when using certain utility classes. The one we use the most is the <code>WaterfallHandler</code>, which takes as input a list of handlers of the same type. The input and output of a <code>WaterfallHandler</code> is the same as those of its inputs, meaning it can be used in the same places. When doing a <code>canHandle</code> call, it will iterate over all its input handlers to find the first one where the <code>canHandle</code> call succeeds, and when calling <code>handle</code> it will return the result of that specific handler. This allows us to chain together many handlers that each have their specific niche, such as handler that each support a specific HTTP method (GET/PUT/POST/etc.), or handlers that only take requests targeting a specific subset of URLs. To the parent class it will look like it has a handler that supports all methods, while in practice it will be a <code>WaterfallHandler</code> containing all these separate handlers.</p> <p>Some other utility classes are the <code>ParallelHandler</code> that runs all handlers simultaneously, and the <code>SequenceHandler</code> that runs all of them one after the other. Since multiple handlers are executed here, these only work for handlers that have no output.</p>"},{"location":"architecture/core/#streams","title":"Streams","text":"<p>Almost all data is handled in a streaming fashion. This allows us to work with very large resources without having to fully load them in memory, a client could be reading data that is being returned by the server while the server is still reading the file. Internally this means we are mostly handling data as <code>Readable</code> objects. We actually use <code>Guarded<Readable></code> which is an internal format we created to help us with error handling. Such streams can be created using utility functions such as <code>guardStream</code> and <code>guardedStreamFrom</code>. Similarly, we have a <code>pipeSafely</code> to pipe streams in such a way that also helps with errors.</p>"},{"location":"architecture/dependency-injection/","title":"Dependency injection","text":"<p>The community server uses the dependency injection framework Components.js to link all class instances together, and uses Components-Generator.js to automatically generate the necessary description configurations of all classes. This framework allows us to configure our components in a JSON file. The advantage of this is that changing the configuration of components does not require any changes to the code, as one can just change the default configuration file, or provide a custom configuration file.</p> <p>More information can be found in the Components.js documentation, but a summarized overview can be found below.</p>"},{"location":"architecture/dependency-injection/#component-files","title":"Component files","text":"<p>Components.js requires a component file for every class you might want to instantiate. Fortunately those get generated automatically by Components-Generator.js. Calling <code>npm run build</code> will call the generator and generate those JSON-LD files in the <code>dist</code> folder. The generator uses the <code>index.ts</code>, so new classes always have to be added there or they will not get a component file.</p>"},{"location":"architecture/dependency-injection/#configuration-files","title":"Configuration files","text":"<p>Configuration files are how we tell Components.js which classes to instantiate and link together. All the community server configurations can be found in the <code>config</code> folder. That folder also contains information about how different pre-defined configurations can be used.</p> <p>A single component in such a configuration file might look as follows:</p> <pre><code>{\n \"comment\": \"Storage used for account management.\",\n \"@id\": \"urn:solid-server:default:AccountStorage\",\n \"@type\": \"JsonResourceStorage\",\n \"source\": { \"@id\": \"urn:solid-server:default:ResourceStore\" },\n \"baseUrl\": { \"@id\": \"urn:solid-server:default:variable:baseUrl\" },\n \"container\": \"/.internal/accounts/\"\n}\n</code></pre> <p>With the corresponding constructor of the <code>JsonResourceStorage</code> class:</p> <pre><code>public constructor(source: ResourceStore, baseUrl: string, container: string)\n</code></pre> <p>The important elements here are the following:</p> <ul> <li><code>\"comment\"</code>: (optional) A description of this component.</li> <li><code>\"@id\"</code>: (optional) A unique identifier of this component, which allows it to be used as parameter values in different places.</li> <li><code>\"@type\"</code>: The class name of the component. This must be a TypeScript class name that is exported via <code>index.ts</code>.</li> </ul> <p>As you can see from the constructor, the other fields are direct mappings from the constructor parameters. <code>source</code> references another object, which we refer to using its identifier <code>urn:solid-server:default:ResourceStore</code>. <code>baseUrl</code> is just a string, but here we use a variable that was set before calling Components.js which is why it also references an <code>@id</code>. These variables are set when starting up the server, based on the command line parameters.</p>"},{"location":"architecture/overview/","title":"Architecture overview","text":"<p>The initial architecture document the project was started from can be found here. Many things have been added since the original inception of the project, but the core ideas within that document are still valid.</p> <p>As can be seen from the architecture, an important idea is the modularity of all components. No actual implementations are defined there, only their interfaces. Making all the components independent of each other in such a way provides us with an enormous flexibility: they can all be replaced by a different implementation, without impacting anything else. This is how we can provide many different configurations for the server, and why it is impossible to provide ready solutions for all possible combinations.</p>"},{"location":"architecture/overview/#architecture-diagrams","title":"Architecture diagrams","text":"<p>Having a modular architecture makes it more difficult to give a complete architecture overview. We will limit ourselves to the more commonly used default configurations we provide, and in certain cases we might give examples of what differences there are based on what configurations are being imported.</p> <p>To do this we will make use of architecture diagrams. We will use an example below to explain the formatting used throughout the architecture documentation:</p> <pre><code>flowchart TD\n LdpHandler(\"<strong>LdpHandler</strong><br>ParsingHttphandler\")\n LdpHandler --> LdpHandlerArgs\n\n subgraph LdpHandlerArgs[\" \"]\n RequestParser(\"<strong>RequestParser</strong><br>BasicRequestParser\")\n Auth(\"<br>AuthorizingHttpHandler\")\n ErrorHandler(\"<strong>ErrorHandler</strong><br><i>ErrorHandler</>\")\n ResponseWriter(\"<strong>ResponseWriter</strong><br>BasicResponseWriter\")\n end</code></pre> <p>Below is a summary of how to interpret such diagrams:</p> <ul> <li>Rounded red box: component instantiated in the Components.js configuration.<ul> <li>First line:<ul> <li>Bold text: shorthand of the instance identifier. In case the full URI is not specified, it can usually be found by prepending <code>urn:solid-server:default:</code> to the shorthand identifier.</li> <li>(empty): this instance has no identifier and is defined in the same place as its parent.</li> </ul> </li> <li>Second line:<ul> <li>Regular text: The class of this instance.</li> <li>Italic text: The interface of this instance. Will be used if the actual class is not relevant for the explanation or can differ.</li> </ul> </li> </ul> </li> <li>Square grey box: the parameters of the linked instance.</li> <li>Arrow: links an instance to its parameters. Can also be used to indicate the order of parameters if relevant.</li> </ul> <p>For example, in the above, LdpHandler is a shorthand for the actual identifier <code>urn:solid-server:default:LdpHandler</code> and is an instance of <code>ParsingHttpHandler</code>. It has 4 parameters, one of which has no identifier but is an instance of <code>AuthorizingHttpHandler</code>.</p>"},{"location":"architecture/overview/#features","title":"Features","text":"<p>Below are the sections that go deeper into the features of the server and how those work.</p> <ul> <li>How Command Line Arguments are parsed and used</li> <li>How the server is initialized and started</li> <li>How HTTP requests are handled</li> <li>How the server handles a standard Solid request</li> <li>How Notification components are configured</li> </ul>"},{"location":"architecture/features/cli/","title":"Parsing Command line arguments","text":"<p>When starting the server, the application actually uses Components.js twice to instantiate components. The first instantiation is used to parse the command line arguments. These then get converted into Components.js variables and are used to instantiate the actual server.</p>"},{"location":"architecture/features/cli/#architecture","title":"Architecture","text":"<pre><code>flowchart TD\n CliResolver(\"<strong>CliResolver</strong><br>CliResolver\")\n CliResolver --> CliResolverArgs\n\n subgraph CliResolverArgs[\" \"]\n CliExtractor(\"<strong>CliExtractor</strong><br>YargsCliExtractor\")\n ShorthandResolver(\"<strong>ShorthandResolver</strong><br>CombinedShorthandResolver\")\n end\n\n ShorthandResolver --> ShorthandResolverArgs\n subgraph ShorthandResolverArgs[\" \"]\n BaseUrlExtractor(\"<br>BaseUrlExtractor\")\n KeyExtractor(\"<br>KeyExtractor\")\n AssetPathExtractor(\"<br>AssetPathExtractor\")\n end</code></pre> <p>The <code>CliResolver</code> (<code>urn:solid-server-app-setup:default:CliResolver</code>) is simply a way to combine both the <code>CliExtractor</code> (<code>urn:solid-server-app-setup:default:CliExtractor</code>) and <code>ShorthandResolver</code> (<code>urn:solid-server-app-setup:default:ShorthandResolver</code>) into a single object and has no other function.</p> <p>Which arguments are supported and which Components.js variables are generated can depend on the configuration that is being used. For example, for an HTTPS server additional arguments will be needed to specify the necessary key/cert files.</p>"},{"location":"architecture/features/cli/#cliresolver","title":"CliResolver","text":"<p>The <code>CliResolver</code> converts the incoming string of arguments into a key/value object. By default, a <code>YargsCliExtractor</code> is used, which makes use of the <code>yargs</code> library and is configured similarly.</p>"},{"location":"architecture/features/cli/#shorthandresolver","title":"ShorthandResolver","text":"<p>The <code>ShorthandResolver</code> uses the key/value object that was generated above to generate Components.js variable bindings. A <code>CombinedShorthandResolver</code> combines the results of multiple <code>ShorthandExtractor</code> by mapping their values to specific variables. For example, a <code>BaseUrlExtractor</code> will be used to extract the value for <code>baseUrl</code>, or <code>port</code> if no <code>baseUrl</code> value is provided, and use it to generate the value for the variable <code>urn:solid-server:default:variable:baseUrl</code>.</p> <p>These extractors are also where the default values for the server are defined. For example, BaseUrlExtractor will be instantiated with a default port of <code>3000</code> which will be used if no port is provided.</p> <p>The variables generated here will be used to initialize the server.</p>"},{"location":"architecture/features/http-handler/","title":"Handling HTTP requests","text":"<p>The direction of the arrows was changed slightly here to make the graph readable.</p> <pre><code>flowchart LR\n HttpHandler(\"<strong>HttpHandler</strong><br>SequenceHandler\")\n HttpHandler --> HttpHandlerArgs\n\n subgraph HttpHandlerArgs[\" \"]\n direction LR\n Middleware(\"<strong>Middleware</strong><br><i>HttpHandler</i>\")\n WaterfallHandler(\"<br>WaterfallHandler\")\n end\n\n Middleware --> WaterfallHandler\n WaterfallHandler --> WaterfallHandlerArgs\n\n subgraph WaterfallHandlerArgs[\" \"]\n direction TB\n StaticAssetHandler(\"<strong>StaticAssetHandler</strong><br>StaticAssetHandler\")\n SetupHandler(\"<strong>SetupHandler</strong><br><i>HttpHandler</i>\")\n OidcHandler(\"<strong>OidcHandler</strong><br><i>HttpHandler</i>\")\n NotificationHttpHandler(\"<strong>NotificationHttpHandler</strong><br><i>HttpHandler</i>\")\n StorageDescriptionHandler(\"<strong>StorageDescriptionHandler</strong><br><i>HttpHandler</i>\")\n AuthResourceHttpHandler(\"<strong>AuthResourceHttpHandler</strong><br><i>HttpHandler</i>\")\n IdentityProviderHttpHandler(\"<strong>IdentityProviderHttpHandler</strong><br><i>HttpHandler</i>\")\n LdpHandler(\"<strong>LdpHandler</strong><br><i>HttpHandler</i>\")\n end\n\n StaticAssetHandler --> SetupHandler\n SetupHandler --> OidcHandler\n OidcHandler --> NotificationHttpHandler\n NotificationHttpHandler --> StorageDescriptionHandler\n StorageDescriptionHandler --> AuthResourceHttpHandler\n AuthResourceHttpHandler --> IdentityProviderHttpHandler\n IdentityProviderHttpHandler --> LdpHandler</code></pre> <p>The <code>HttpHandler</code> is responsible for handling an incoming HTTP request. The request will always first go through the <code>Middleware</code>, where certain required headers will be added such as CORS headers.</p> <p>After that it will go through the list in the <code>WaterfallHandler</code> to find the first handler that understands the request, with the <code>LdpHandler</code> at the bottom being the catch-all default.</p>"},{"location":"architecture/features/http-handler/#staticassethandler","title":"StaticAssetHandler","text":"<p>The <code>urn:solid-server:default:StaticAssetHandler</code> matches exact URLs to static assets which require no further logic. An example of this is the favicon, where the <code>/favicon.ico</code> URL is directed to the favicon file at <code>/templates/images/favicon.ico</code>. It can also map entire folders to a specific path, such as <code>/.well-known/css/styles/</code> which contains all stylesheets.</p>"},{"location":"architecture/features/http-handler/#setuphandler","title":"SetupHandler","text":"<p>The <code>urn:solid-server:default:SetupHandler</code> is responsible for redirecting all requests to <code>/setup</code> until setup is finished, thereby ensuring that setup needs to be finished before anything else can be done on the server, and handling the actual setup request that is sent to <code>/setup</code>. Once setup is finished, this handler will reject all requests and thus no longer be relevant.</p> <p>If the server is configured to not have setup enabled, the corresponding identifier will point to a handler that always rejects all requests.</p>"},{"location":"architecture/features/http-handler/#oidchandler","title":"OidcHandler","text":"<p>The <code>urn:solid-server:default:OidcHandler</code> handles all requests related to the Solid-OIDC specification. The OIDC component is configured to work on the <code>/.oidc/</code> subpath, so this handler catches all those requests and sends them to the internal OIDC library that is used.</p>"},{"location":"architecture/features/http-handler/#notificationhttphandler","title":"NotificationHttpHandler","text":"<p>The <code>urn:solid-server:default:NotificationHttpHandler</code> catches all notification subscription requests. By default these are requests targeting <code>/.notifications/</code>. Which specific subscription type is targeted is then based on the next part of the URL.</p>"},{"location":"architecture/features/http-handler/#storagedescriptionhandler","title":"StorageDescriptionHandler","text":"<p>The <code>urn:solid-server:default:StorageDescriptionHandler</code> returns the relevant RDF data for requests targeting a storage description resource. It does this by knowing which URL suffix is used for such resources, and verifying that the associated container is an actual storage container.</p>"},{"location":"architecture/features/http-handler/#authresourcehttphandler","title":"AuthResourceHttpHandler","text":"<p>The <code>urn:solid-server:default:AuthResourceHttpHandler</code> is identical to the <code>urn:solid-server:default:LdpHandler</code> which will be discussed below, but only handles resources relevant for authorization.</p> <p>In practice this means that is your server is configured to use Web Access Control for authorization, this handler will catch all requests targeting <code>.acl</code> resources.</p> <p>The reason these already need to be handled here is so these can also be used to allow authorization on the following handler(s). More on this can be found in the identity provider documentation</p>"},{"location":"architecture/features/http-handler/#identityproviderhttphandler","title":"IdentityProviderHttpHandler","text":"<p>The <code>urn:solid-server:default:IdentityProviderHttpHandler</code> handles everything related to our custom identity provider API, such as registering, logging in, returning the relevant HTML pages, etc. All these requests are identified by being on the <code>/idp/</code> subpath. More information on the API can be found in the identity provider documentation</p>"},{"location":"architecture/features/http-handler/#ldphandler","title":"LdpHandler","text":"<p>Once a request reaches the <code>urn:solid-server:default:LdpHandler</code>, the server assumes this is a standard Solid request according to the Solid protocol. A detailed description of what happens then can be found here</p>"},{"location":"architecture/features/initialization/","title":"Server initialization","text":"<p>When starting the server, multiple Initializers trigger to set up everything correctly, the last one of which starts listening to the specified port. Similarly, when stopping the server several Finalizers trigger to clean up where necessary, although the latter only happens when starting the server through code.</p>"},{"location":"architecture/features/initialization/#app","title":"App","text":"<pre><code>flowchart TD\n App(\"<strong>App</strong><br>App\")\n App --> AppArgs\n\n subgraph AppArgs[\" \"]\n Initializer(\"<strong>Initializer</strong><br><i>Initializer</i>\")\n AppFinalizer(\"<strong>Finalizer</strong><br><i>Finalizer</i>\")\n end</code></pre> <p><code>App</code> (<code>urn:solid-server:default:App</code>) is the main component that gets instantiated by Components.js. Every other component should be able to trace an instantiation path back to it if it also wants to be instantiated.</p> <p>It's only function is to contain an <code>Initializer</code> and <code>Finalizer</code> which get called by calling <code>start</code>/<code>stop</code> respectively.</p>"},{"location":"architecture/features/initialization/#initializer","title":"Initializer","text":"<pre><code>flowchart TD\n Initializer(\"<strong>Initializer</strong><br>SequenceHandler\")\n Initializer --> InitializerArgs\n\n subgraph InitializerArgs[\" \"]\n direction LR\n LoggerInitializer(\"<strong>LoggerInitializer</strong><br>LoggerInitializer\")\n PrimaryInitializer(\"<strong>PrimaryInitializer</strong><br>ProcessHandler\")\n WorkerInitializer(\"<strong>WorkerInitializer</strong><br>ProcessHandler\")\n end\n\n LoggerInitializer --> PrimaryInitializer\n PrimaryInitializer --> WorkerInitializer</code></pre> <p>The very first thing that needs to happen is initializing the logger. Before this other classes will be unable to use logging.</p> <p>The <code>PrimaryInitializer</code> will only trigger once, in the primary worker thread, while the <code>WorkerInitializer</code> will trigger for every worker thread. Although if your server setup is single-threaded, which is the default, there is no relevant difference between those two.</p>"},{"location":"architecture/features/initialization/#primaryinitializer","title":"PrimaryInitializer","text":"<pre><code>flowchart TD\n PrimaryInitializer(\"<strong>PrimaryInitializer</strong><br>ProcessHandler\")\n PrimaryInitializer --> PrimarySequenceInitializer(\"<strong>PrimarySequenceInitializer</strong><br>SequenceHandler\")\n PrimarySequenceInitializer --> PrimarySequenceInitializerArgs\n\n subgraph PrimarySequenceInitializerArgs[\" \"]\n direction LR\n CleanupInitializer(\"<strong>CleanupInitializer</strong><br>SequenceHandler\")\n PrimaryParallelInitializer(\"<strong>PrimaryParallelInitializer</strong><br>ParallelHandler\")\n WorkerManager(\"<strong>WorkerManager</strong><br>WorkerManager\")\n end\n\n CleanupInitializer --> PrimaryParallelInitializer\n PrimaryParallelInitializer --> WorkerManager</code></pre> <p>The above is a simplification of all the initializers that are present in the <code>PrimaryInitializer</code> as there are several smaller initializers that also trigger but are less relevant here.</p> <p>The <code>CleanupInitializer</code> is an initializer that cleans up anything that might have remained from a previous server start and could impact behaviour. Relevant components in other parts of the configuration are responsible for adding themselves to this array if needed. An example of this is file-based locking components which might need to remove any dangling locking files.</p> <p>The <code>PrimaryParallelInitializer</code> can be used to add any initializers to that have to happen in the primary process. This makes it easier for users to add initializers by being able to append to its handlers.</p> <p>The <code>WorkerManager</code> is responsible for setting up the worker threads, if any.</p>"},{"location":"architecture/features/initialization/#workerinitializer","title":"WorkerInitializer","text":"<pre><code>flowchart TD\n WorkerInitializer(\"<strong>WorkerInitializer</strong><br>ProcessHandler\")\n WorkerInitializer --> WorkerSequenceInitializer(\"<strong>WorkerSequenceInitializer</strong><br>SequenceHandler\")\n WorkerSequenceInitializer --> WorkerSequenceInitializerArgs\n\n subgraph WorkerSequenceInitializerArgs[\" \"]\n direction LR\n WorkerParallelInitializer(\"<strong>WorkerParallelInitializer</strong><br>ParallelHandler\")\n ServerInitializer(\"<strong>ServerInitializer</strong><br>ServerInitializer\")\n end\n\n WorkerParallelInitializer --> ServerInitializer</code></pre> <p>The <code>WorkerInitializer</code> is quite similar to the <code>PrimaryInitializer</code> but triggers once per worker thread. Like the <code>PrimaryParallelInitializer</code>, the <code>WorkerParallelInitializer</code> can be used to add any custom initializers that need to run.</p>"},{"location":"architecture/features/initialization/#serverinitializer","title":"ServerInitializer","text":"<p>The <code>ServerInitializer</code> is the initializer that finally starts up the server by listening to the relevant port, once all the initialization described above is finished. It takes as input 2 components: a <code>HttpServerFactory</code> and a <code>ServerListener</code>.</p> <pre><code>flowchart TD\n ServerInitializer(\"<strong>ServerInitializer</strong><br>ServerInitializer\")\n ServerInitializer --> ServerInitializerArgs\n\n subgraph ServerInitializerArgs[\" \"]\n direction LR\n ServerFactory(\"<strong>ServerFactory</strong><br>BaseServerFactory\")\n ServerListener(\"<strong>ServerListener</strong><br>ParallelHandler\")\n end\n\n ServerListener --> HandlerServerListener(\"<strong>HandlerServerListener</strong><br>HandlerServerListener\")\n\n HandlerServerListener --> HttpHandler(\"<strong>HttpHandler</strong><br><i>HttpHandler</i>\")</code></pre> <p>The <code>HttpServerFactory</code> is responsible for starting a server on a given port. Depending on the configuration this can be an HTTP or an HTTPS server. The created server emits events when it receives requests.</p> <p>A <code>ServerListener</code> is a class that takes the created server as input and attaches a listener to interpret events. One listener that is always used is the <code>urn:solid-server:default:HandlerServerListener</code>, which calls an <code>HttpHandler</code> to resolve HTTP requests.</p> <p>Sometimes it is necessary to add additional listeners, these can then be added to the <code>urn:solid-server:default:ServerListener</code> as it is a <code>ParallellHandler</code>. An example of this is when WebSockets are used to handle notifications.</p>"},{"location":"architecture/features/notifications/","title":"Notifications","text":"<p>This section covers the architecture used to support the Notifications protocol as described in https://solidproject.org/TR/2022/notifications-protocol-20221231.</p> <p>There are three core architectural components, that have distinct entry points:</p> <ul> <li>Exposing metadata to allow discovery of the subscription type.</li> <li>Handling subscriptions targeting a resource.</li> <li>Emitting notifications when there is activity on a resource.</li> </ul>"},{"location":"architecture/features/notifications/#discovery","title":"Discovery","text":"<p>Discovery is done through the storage description resource(s). The server returns the same triples for every such resource as the notification subscription URL is always located in the root of the server.</p> <pre><code>flowchart LR\n StorageDescriptionHandler(\"<br>StorageDescriptionHandler\")\n StorageDescriptionHandler --> StorageDescriber(\"<strong>StorageDescriber</strong><br>ArrayUnionHandler\")\n StorageDescriber --> NotificationDescriber(\"NotificationDescriber<br>NotificationDescriber\")\n NotificationDescriber --> NotificationDescriberArgs\n\n subgraph NotificationDescriberArgs[\" \"]\n direction LR\n NotificationChannelType(\"<br>NotificationChannelType\")\n NotificationChannelType2(\"<br>NotificationChannelType\")\n end</code></pre> <p>The server uses a <code>StorageDescriptionHandler</code> to generate the necessary RDF data and to handle content negotiation. To generate the data we have multiple <code>StorageDescriber</code>s, whose results get merged together in an <code>ArrayUnionHandler</code>.</p> <p>A <code>NotificationChannelType</code> contains the specific details of a specification notification channel type, including a JSON-LD representation of the corresponding subscription resource. One specific instance of a <code>StorageDescriber</code> is a <code>NotificationSubcriber</code>, which merges those JSON-LD descriptions into a single set of RDF quads. When adding a new subscription type, a new instance of such a class should be added to the <code>urn:solid-server:default:StorageDescriber</code>.</p>"},{"location":"architecture/features/notifications/#notificationchannel","title":"NotificationChannel","text":"<p>To subscribe, a client has to send a specific JSON-LD request to the URL found during discovery.</p> <pre><code>flowchart LR\n NotificationTypeHandler(\"<strong>NotificationTypeHandler</strong><br>WaterfallHandler\")\n NotificationTypeHandler --> NotificationTypeHandlerArgs\n\n subgraph NotificationTypeHandlerArgs[\" \"]\n direction LR\n OperationRouterHandler(\"<br>OperationRouterHandler\") --> NotificationSubscriber(\"<br>NotificationSubscriber\")\n NotificationChannelType --> NotificationChannelType(\"<br><i>NotificationChannelType</i>\")\n OperationRouterHandler2(\"<br>OperationRouterHandler\") --> NotificationSubscriber2(\"<br>NotificationSubscriber\")\n NotificationChannelType2 --> NotificationChannelType2(\"<br><i>NotificationChannelType</i>\")\n end</code></pre> <p>Every subscription type should have a subscription URL relative to the root notification URL, which in our configs is set to <code>/.notifications/</code>. For every type there is then a <code>OperationRouterHandler</code> that accepts requests to that specific URL, after which a <code>NotificationSubscriber</code> handles all checks related to subscribing, for which it uses a <code>NotificationChannelType</code>. If the subscription is valid and has authorization, the results will be saved in a <code>NotificationChannelStorage</code>.</p>"},{"location":"architecture/features/notifications/#activity","title":"Activity","text":"<pre><code>flowchart TB\n ListeningActivityHandler(\"<strong>ListeningActivityHandler</strong><br>ListeningActivityHandler\")\n ListeningActivityHandler --> ListeningActivityHandlerArgs\n\n subgraph ListeningActivityHandlerArgs[\" \"]\n NotificationChannelStorage(\"<strong>NotificationChannelStorage</strong><br><i>NotificationChannelStorage</i>\")\n ResourceStore(\"<strong>ResourceStore</strong><br><i>ActivityEmitter</i>\")\n NotificationHandler(\"<strong>NotificationHandler</strong><br>WaterfallHandler\")\n end\n\n NotificationHandler --> NotificationHandlerArgs\n subgraph NotificationHandlerArgs[\" \"]\n direction TB\n NotificationHandler1(\"<br><i>NotificationHandler</i>\")\n NotificationHandler2(\"<br><i>NotificationHandler</i>\")\n end</code></pre> <p>An <code>ActivityEmitter</code> is a class that emits events every time data changes in the server. The <code>MonitoringStore</code> is an implementation of this in the server. The <code>ListeningActivityHandler</code> is the class that listens to these events and makes sure relevant notifications get sent out.</p> <p>It will pull the relevant subscriptions from the storage and call the stored <code>NotificationHandler</code> for each of time. For every subscription type, a <code>NotificationHandler</code> should be added to the <code>WaterfallHandler</code> that handles notifications for the specific type.</p>"},{"location":"architecture/features/notifications/#websocketchannel2023","title":"WebSocketChannel2023","text":"<p>To add support for WebSocketChannel2023 notifications, components were added as described in the documentation above.</p> <p>For discovery, a <code>NotificationDescriber</code> was added with the corresponding settings.</p> <p>As <code>NotificationChannelType</code>, there is a specific <code>WebSocketChannel2023Type</code> that contains all the necessary information.</p>"},{"location":"architecture/features/notifications/#handling-notifications","title":"Handling notifications","text":"<p>As <code>NotificationHandler</code>, the following architecture is used:</p> <pre><code>flowchart TB\n TypedNotificationHandler(\"<br>TypedNotificationHandler\")\n TypedNotificationHandler --> ComposedNotificationHandler(\"<br>ComposedNotificationHandler\")\n ComposedNotificationHandler --> ComposedNotificationHandlerArgs\n\n subgraph ComposedNotificationHandlerArgs[\" \"]\n direction LR\n BaseNotificationGenerator(\"<strong>BaseNotificationGenerator</strong><br><i>NotificationGenerator</i>\")\n BaseNotificationSerializer(\"<strong>BaseNotificationSerializer</strong><br><i>NotificationSerializer</i>\")\n WebSocket2023Emitter(\"<strong>WebSocket2023Emitter</strong><br>WebSocket2023Emitter\")\n BaseNotificationGenerator --> BaseNotificationSerializer --> WebSocket2023Emitter\n end</code></pre> <p>A <code>TypedNotificationHandler</code> is a handler that can be used to filter out subscriptions for a specific type, making sure only WebSocketChannel2023 subscriptions will be handled.</p> <p>A <code>ComposedNotificationHandler</code> combines 3 interfaces to handle the notifications:</p> <ul> <li>A <code>NotificationGenerator</code> converts the information into a Notification object.</li> <li>A <code>NotificationSerializer</code> converts a Notification object into a serialized Representation.</li> <li>A <code>NotificationEmitter</code> takes a Representation and sends it out in a way specific to that subscription type.</li> </ul> <p><code>urn:solid-server:default:BaseNotificationGenerator</code> is a generator that fills in the default Notification template, and also caches the result so it can be reused by multiple subscriptions.</p> <p><code>urn:solid-server:default:BaseNotificationSerializer</code> converts the Notification to a JSON-LD representation and handles any necessary content negotiation based on the <code>accept</code> notification feature.</p> <p>A <code>WebSocket2023Emitter</code> is a specific emitter that checks whether the current open WebSockets correspond to the subscription.</p>"},{"location":"architecture/features/notifications/#websockets","title":"WebSockets","text":"<pre><code>flowchart TB\n WebSocket2023Listener(\"<strong>WebSocket2023Listener</strong><br>WebSocket2023Listener\")\n WebSocket2023Listener --> WebSocket2023ListenerArgs\n\n subgraph WebSocket2023ListenerArgs[\" \"]\n direction LR\n NotificationChannelStorage(\"<strong>NotificationChannelStorage</strong><br>NotificationChannelStorage\")\n SequenceHandler(\"<br>SequenceHandler\")\n end\n\n SequenceHandler --> SequenceHandlerArgs\n\n subgraph SequenceHandlerArgs[\" \"]\n direction TB\n WebSocket2023Storer(\"<strong>WebSocket2023Storer</strong><br>WebSocket2023Storer\")\n WebSocket2023StateHandler(\"<strong>WebSocket2023StateHandler</strong><br>BaseStateHandler\")\n end</code></pre> <p>To detect and store WebSocket connections, the <code>WebSocket2023Listener</code> is added as a listener to the HTTP server. For all WebSocket connections that get opened, it verifies whether they correspond to an existing subscription. If yes, the information gets sent out to its stored <code>WebSocket2023Handler</code>.</p> <p>In this case, this is a <code>SequenceHandler</code>, which contains a <code>WebSocket2023Storer</code> and a <code>BaseStateHandler</code>. The <code>WebSocket2023Storer</code> will store the WebSocket in the same map used by the <code>WebSocket2023Emitter</code>, so that class can emit events later on, as mentioned above. The state handler will make sure that a notification gets sent out if the subscription has a <code>state</code> feature request, as defined in the notification specification.</p>"},{"location":"architecture/features/notifications/#webhookchannel2023","title":"WebHookChannel2023","text":"<p>The additions required to support WebHookChannel2023 are quite similar to those needed for WebSocketChannel2023:</p> <ul> <li>For discovery, there is a <code>WebHookDescriber</code>, which is an extension of a <code>NotificationDescriber</code>.</li> <li>The <code>WebHookChannel2023Type</code> class contains all the necessary typing information.</li> <li><code>WebHookEmitter</code> is the <code>NotificationEmitter</code> that sends the request.</li> <li><code>WebHookUnsubscriber</code> and <code>WebHookWebId</code> are additional utility classes to support the spec requirements.</li> </ul>"},{"location":"architecture/features/protocol/authorization/","title":"Authorization","text":"<pre><code>flowchart TD\n AuthorizingHttpHandler(\"<br>AuthorizingHttpHandler\")\n AuthorizingHttpHandler --> AuthorizingHttpHandlerArgs\n\n subgraph AuthorizingHttpHandlerArgs[\" \"]\n CredentialsExtractor(\"<strong>CredentialsExtractor</strong><br><i>CredentialsExtractor</i>\")\n ModesExtractor(\"<strong>ModesExtractor</strong><br><i>ModesExtractor</i>\")\n PermissionReader(\"<strong>PermissionReader</strong><br><i>PermissionReader</i>\")\n Authorizer(\"<strong>Authorizer</strong><br>PermissionBasedAuthorizer\")\n OperationHttpHandler(\"<br><i>OperationHttpHandler</i>\")\n end</code></pre> <p>Authorization is usually handled by the <code>AuthorizingHttpHandler</code>, which receives a parsed HTTP request in the form of an <code>Operation</code>. It goes through the following steps:</p> <ol> <li>A <code>CredentialsExtractor</code> identifies the credentials of the agent making the call.</li> <li>A <code>ModesExtractor</code> finds which access modes are needed for which resources.</li> <li>A <code>PermissionReader</code> determines the permissions the agent has on the targeted resources.</li> <li>The above results are compared in an <code>Authorizer</code>.</li> <li>If the request is allowed, call the <code>OperationHttpHandler</code>, otherwise throw an error.</li> </ol>"},{"location":"architecture/features/protocol/authorization/#authentication","title":"Authentication","text":"<p>There are multiple <code>CredentialsExtractor</code>s that each determine identity in a different way. Potentially multiple extractors can apply, making a requesting agent have multiple credentials.</p> <p>The diagram below shows the default configuration if authentication is enabled.</p> <pre><code>flowchart TD\n CredentialsExtractor(\"<strong>CredentialsExtractor</strong><br>UnionCredentialsExtractor\")\n CredentialsExtractor --> CredentialsExtractorArgs\n\n subgraph CredentialsExtractorArgs[\" \"]\n WaterfallHandler(\"<br>WaterfallHandler\")\n PublicCredentialsExtractor(\"<br>PublicCredentialsExtractor\")\n end\n\n WaterfallHandler --> WaterfallHandlerArgs\n subgraph WaterfallHandlerArgs[\" \"]\n direction LR\n DPoPWebIdExtractor(\"<br>DPoPWebIdExtractor\") --> BearerWebIdExtractor(\"<br>BearerWebIdExtractor\")\n end</code></pre> <p>Both of the WebID extractors make use of the <code>access-token-verifier</code> library to parse incoming tokens based on the Solid-OIDC specification. All these credentials then get combined into a single union object.</p> <p>If successful, a <code>CredentialsExtractor</code> will return an object containing all the information extracted, such as the WebID of the agent, or the issuer of the token.</p> <p>There are also debug configuration options available that can be used to simulate credentials. These can be enabled as different options through the <code>config/ldp/authentication</code> imports.</p>"},{"location":"architecture/features/protocol/authorization/#modes-extraction","title":"Modes extraction","text":"<p>Access modes are a predefined list of <code>read</code>, <code>write</code>, <code>append</code>, <code>create</code> and <code>delete</code>. The <code>ModesExtractor</code> determine which modes will be necessary and for which resources, based on the request contents.</p> <pre><code>flowchart TD\n ModesExtractor(\"<strong>ModesExtractor</strong><br>IntermediateCreateExtractor\")\n ModesExtractor --> HttpModesExtractor(\"<strong>HttpModesExtractor</strong><br>WaterfallHandler\")\n\n HttpModesExtractor --> HttpModesExtractorArgs\n\n subgraph HttpModesExtractorArgs[\" \"]\n direction LR\n PatchModesExtractor(\"<strong>PatchModesExtractor</strong><br><i>ModesExtractor</i>\") --> MethodModesExtractor(\"<br>MethodModesExtractor\")\n end</code></pre> <p>The <code>IntermediateCreateExtractor</code> is responsible if requests try to create intermediate containers with a single request. E.g., a PUT request to <code>/foo/bar/baz</code> should create both the <code>/foo/</code> and <code>/foo/bar/</code> containers in case they do not exist yet. This extractor makes sure that <code>create</code> permissions are also checked on those containers.</p> <p>Modes can usually be determined based on just the HTTP methods, which is what the <code>MethodModesExtractor</code> does. A GET request will always need the <code>read</code> mode for example.</p> <p>The only exception are PATCH requests, where the necessary modes depend on the body and the PATCH type.</p> <pre><code>flowchart TD\n PatchModesExtractor(\"<strong>PatchModesExtractor</strong><br>WaterfallHandler\") --> PatchModesExtractorArgs\n subgraph PatchModesExtractorArgs[\" \"]\n N3PatchModesExtractor(\"<br>N3PatchModesExtractor\")\n SparqlUpdateModesExtractor(\"<br>SparqlUpdateModesExtractor\")\n end</code></pre> <p>The server supports both N3 Patch and SPARQL Update PATCH requests. In both cases it will parse the bodies to determine what the impact would be of the request and what modes it requires.</p>"},{"location":"architecture/features/protocol/authorization/#permission-reading","title":"Permission reading","text":"<p><code>PermissionReader</code>s take the input of the above to determine which permissions are available. The modes from the previous step are not yet needed, but can be used as optimization as we only need to know if we have permission on those modes. Each reader returns all the information it can find based on the resources and modes it receives. In most of the default configuration the following readers are combined when WebACL is enabled as authorization method. In case authorization is disabled by changing the authorization import to <code>config/ldp/authorization/allow-all.json</code>, the diagram would be a single class that always returns all permissions.</p> <pre><code>flowchart TD\n PermissionReader(\"<strong>PermissionReader</strong><br>AuxiliaryReader\")\n PermissionReader --> UnionPermissionReader(\"<br>UnionPermissionReader\")\n UnionPermissionReader --> UnionPermissionReaderArgs\n\n subgraph UnionPermissionReaderArgs[\" \"]\n PathBasedReader(\"<strong>PathBasedReader</strong><br>PathBasedReader\")\n OwnerPermissionReader(\"<strong>OwnerPermissionReader</strong><br>OwnerPermissionReader\")\n WrappedWebAclReader(\"<strong>WrappedWebAclReader</strong><br>ParentContainerReader\")\n end\n\n WrappedWebAclReader --> WebAclAuxiliaryReader(\"<strong>WebAclAuxiliaryReader</strong><br>AuthAuxiliaryReader\")\n WebAclAuxiliaryReader --> WebAclReader(\"<strong>WebAclReader</strong><br>WebAclReader\")</code></pre> <p>The first thing that happens is that if the target is an auxiliary resource that uses the authorization of its subject resource, the <code>AuxiliaryReader</code> inserts that identifier instead. An example of this is if the requests targets the metadata of a resource.</p> <p>The <code>UnionPermissionReader</code> then combines the results of its readers into a single permission object. If one reader rejects a specific mode and another allows it, the rejection takes priority.</p> <p>The <code>PathBasedReader</code> rejects all permissions for certain paths. This is used to prevent access to the internal data of the server.</p> <p>The <code>OwnerPermissionReader</code> makes sure owners always have control access to the pods they created on the server. Users will always be able to modify the ACL resources in their pod, even if they accidentally removed their own access.</p> <p>The final readers are specifically relevant for the WebACL algorithm. The <code>ParentContainerReader</code> checks the permissions on a parent resource if required: creating a resource requires <code>append</code> permissions on the parent container, while deleting a resource requires <code>write</code> permissions there.</p> <p>In case the target is an ACL resource, <code>control</code> permissions need to be checked, no matter what mode was generated by the <code>ModesExtractor</code>. The <code>AuthAuxiliaryReader</code> makes sure this conversion happens.</p> <p>Finally, the <code>WebAclReader</code> implements the efffective ACL resource algorithm and returns the permissions it finds in that resource. In case no ACL resource is found this indicates a configuration error and no permissions will be granted.</p>"},{"location":"architecture/features/protocol/authorization/#acp","title":"ACP","text":"<p>It is also possible to use ACP as authorization method instead of WebACL. In that case the diagram is very similar, except the <code>AuthAuxiliaryReader</code> is configured for Access Control Resources, and it points to a <code>AcpReader</code> instead.</p>"},{"location":"architecture/features/protocol/authorization/#authorization_1","title":"Authorization","text":"<p>All the results of the previous steps then get combined in the <code>PermissionBasedAuthorizer</code> to either allow or reject a request. If no permissions are found for a requested mode, or they are explicitly forbidden, a 401/403 will be returned, depending on if the agent was logged in or not.</p>"},{"location":"architecture/features/protocol/overview/","title":"Solid protocol","text":"<p>The <code>LdpHandler</code>, named as a reference to the Linked Data Platform specification, chains several handlers together, each with their own specific purpose, to fully resolve the HTTP request. It specifically handles Solid requests as described in the protocol specification, e.g. a POST request to create a new resource.</p> <p>Below is a simplified view of how these handlers are linked.</p> <pre><code>flowchart LR\n LdpHandler(\"<strong>LdpHandler</strong><br>ParsingHttphandler\")\n LdpHandler --> AuthorizingHttpHandler(\"<br>AuthorizingHttpHandler\")\n AuthorizingHttpHandler --> OperationHandler(\"<strong>OperationHandler</strong><br><i>OperationHandler</i>\")\n OperationHandler --> ResourceStore(\"<strong>ResourceStore</strong><br><i>ResourceStore</i>\")</code></pre> <p>A standard request would go through the following steps:</p> <ol> <li>The <code>ParsingHttphandler</code> parses the HTTP request into a manageable format, both body and metadata such as headers.</li> <li>The <code>AuthorizingHttpHandler</code> verifies if the request is authorized to access the targeted resource.</li> <li>The <code>OperationHandler</code> determines which action is required based on the HTTP method.</li> <li>The <code>ResourceStore</code> does all the relevant data work.</li> <li>The <code>ParsingHttphandler</code> eventually receives the response data, or an error, and handles the output.</li> </ol> <p>Below are sections that go deeper into the specific steps.</p> <ul> <li>How input gets parsed and output gets returned</li> <li>How authentication and authorization work</li> <li>What the <code>ResourceStore</code> looks like</li> </ul>"},{"location":"architecture/features/protocol/parsing/","title":"Parsing and responding to HTTP requests","text":"<pre><code>flowchart TD\n ParsingHttphandler(\"<br>ParsingHttphandler\")\n ParsingHttphandler --> ParsingHttphandlerArgs\n\n subgraph ParsingHttphandlerArgs[\" \"]\n RequestParser(\"<strong>RequestParser</strong><br>BasicRequestParser\")\n AuthorizingHttpHandler(\"<strong></strong><br>AuthorizingHttpHandler\")\n ErrorHandler(\"<strong>ErrorHandler</strong><br><i>ErrorHandler</i>\")\n ResponseWriter(\"<strong>ResponseWriter</strong><br>BasicResponseWriter\")\n end</code></pre> <p>A <code>ParsingHttpHandler</code> handles both the parsing of the input data, and the serializing of the output data. It follows these 3 steps:</p> <ol> <li>Use the <code>RequestParser</code> to convert the incoming data into an <code>Operation</code>.</li> <li>Send the <code>Operation</code> to the <code>AuthorizingHttpHandler</code> to receive either a <code>Representation</code> if the operation was a success, or an <code>Error</code> in case something went wrong.<ul> <li>In case of an error the <code>ErrorHandler</code> will convert the <code>Error</code> into a <code>ResponseDescription</code>.</li> </ul> </li> <li>Use the <code>ResponseWriter</code> to output the <code>ResponseDescription</code> as an HTTP response.</li> </ol>"},{"location":"architecture/features/protocol/parsing/#parsing-the-request","title":"Parsing the request","text":"<pre><code>flowchart TD\n RequestParser(\"<strong>RequestParser</strong><br>BasicRequestParser\") --> RequestParserArgs\n subgraph RequestParserArgs[\" \"]\n TargetExtractor(\"<strong>TargetExtractor</strong><br>OriginalUrlExtractor\")\n PreferenceParser(\"<strong>PreferenceParser</strong><br>AcceptPreferenceParser\")\n MetadataParser(\"<strong>MetadataParser</strong><br><i>MetadataParser</i>\")\n BodyParser(\"<br><i>Bodyparser</i>\")\n Conditions(\"<br>BasicConditionsParser\")\n end\n\n OriginalUrlExtractor --> IdentifierStrategy(\"<strong>IdentifierStrategy</strong><br><i>IdentifierStrategy</i>\")</code></pre> <p>The <code>BasicRequestParser</code> is mostly an aggregator of multiple smaller parsers that each handle a very specific part.</p>"},{"location":"architecture/features/protocol/parsing/#url","title":"URL","text":"<p>This is a single class, the <code>OriginalUrlExtractor</code>, but fulfills the very important role of making sure input URLs are handled consistently.</p> <p>The query parameters will always be completely removed from the URL.</p> <p>There is also an algorithm to make sure all URLs have a \"canonical\" version as for example both <code>&</code> and <code>%26</code> can be interpreted in the same way. Specifically all special characters will be encoded into their percent encoding.</p> <p>The <code>IdentifierStrategy</code> it gets as input is used to determine if the resulting URL is within the scope of the server. This can differ depending on if the server uses subdomains or not.</p> <p>The resulting identifier will be stored in the <code>target</code> field of an <code>Operation</code> object.</p>"},{"location":"architecture/features/protocol/parsing/#preferences","title":"Preferences","text":"<p>The <code>AcceptPreferenceParser</code> parses the <code>Accept</code> header and all the relevant <code>Accept-*</code> headers. These will all be put into the <code>preferences</code> field of an <code>Operation</code> object. These will later be used to handle the content negotiation.</p> <p>For example, when sending an <code>Accept: text/turtle; q=0.9</code> header, this wil result in the preferences object <code>{ type: { 'text/turtle': 0.9 } }</code>.</p>"},{"location":"architecture/features/protocol/parsing/#headers","title":"Headers","text":"<p>Several other headers can have relevant metadata, such as the <code>Content-Type</code> header, or the <code>Link: <http://www.w3.org/ns/ldp#Container>; rel=\"type\"</code> header which is used to indicate to the server that a request intends to create a container.</p> <p>Such headers are converted to RDF triples and stored in the <code>RepresentationMetadata</code> object, which will be part of the <code>body</code> field in the <code>Operation</code>.</p> <p>The default <code>MetadataParser</code> is a <code>ParallelHandler</code> that contains several smaller parsers, each looking at a specific header.</p>"},{"location":"architecture/features/protocol/parsing/#body","title":"Body","text":"<p>In case of most requests, the input data stream is used directly in the <code>body</code> field of the <code>Operation</code>, with a few minor checks to make sure the HTTP specification is being followed.</p> <p>In the case of PATCH requests though, there are several specific body parsers that will convert the request into a JavaScript object containing all the necessary information to execute such a PATCH. Several validation checks will already take place there as well.</p>"},{"location":"architecture/features/protocol/parsing/#conditions","title":"Conditions","text":"<p>The <code>BasicConditionsParser</code> parses everything related to conditions headers, such as <code>if-none-match</code> or <code>if-modified-since</code>, and stores the relevant information in the <code>conditions</code> field of the <code>Operation</code>. These will later be used to make sure the request should be aborted or not.</p>"},{"location":"architecture/features/protocol/parsing/#sending-the-response","title":"Sending the response","text":"<p>In case a request is successful, the <code>AuthorizingHttpHandler</code> will return a <code>ResponseDescription</code>, and if not it will throw an error.</p> <p>In case an error gets thrown, this will be caught by the <code>ErrorHandler</code> and converted into a <code>ResponseDescription</code>. The request preferences will be used to make sure the serialization is one that is preferred.</p> <p>Either way we will have a <code>ResponseDescription</code>, which will be sent to the <code>BasicResponseWriter</code> to convert into output headers, data and a status code.</p> <p>To convert the metadata into headers, it uses a <code>MetadataWriter</code>, which functions as the reverse of the <code>MetadataParser</code> mentioned above: it has multiple writers which each convert certain metadata into a specific header.</p>"},{"location":"architecture/features/protocol/resource-store/","title":"Resource store","text":"<p>The interface of a <code>ResourceStore</code> is mostly a 1-to-1 mapping of the HTTP methods:</p> <ul> <li>GET: <code>getRepresentation</code></li> <li>PUT: <code>setRepresentation</code></li> <li>POST: <code>addResource</code></li> <li>DELETE: <code>deleteResource</code></li> <li>PATCH: <code>modifyResource</code></li> </ul> <p>The corresponding <code>OperationHandler</code> of the relevant method is responsible for calling the correct <code>ResourceStore</code> function.</p> <p>In practice, the community server has multiple resource stores chained together, each handling a specific part of the request and then calling the next store in the chain. The default configurations come with the following stores:</p> <ol> <li><code>MonitoringStore</code></li> <li><code>IndexRepresentationStore</code></li> <li><code>LockingResourceStore</code></li> <li><code>PatchingStore</code></li> <li><code>RepresentationConvertingStore</code></li> <li><code>DataAccessorBasedStore</code></li> </ol> <p>This chain can be seen in the configuration part in <code>config/storage/middleware/default.json</code> and all the entries in <code>config/storage/backend</code>.</p>"},{"location":"architecture/features/protocol/resource-store/#monitoringstore","title":"MonitoringStore","text":"<p>This store emits the events that are necessary to emit notifications when resources change.</p> <p>There are 4 different events that can be emitted:</p> <ul> <li><code>this.emit('changed', identifier, activity)</code>: is emitted for every resource that was changed/effected by a call to the store. With activity being undefined or one of the available ActivityStream terms.</li> <li><code>this.emit(AS.Create, identifier)</code>: is emitted for every resource that was created by the call to the store.</li> <li><code>this.emit(AS.Update, identifier)</code>: is emitted for every resource that was updated by the call to the store.</li> <li><code>this.emit(AS.Delete, identifier)</code>: is emitted for every resource that was deleted by the call to the store.</li> </ul> <p>A <code>changed</code> event will always be emitted if a resource was changed. If the correct metadata was set by the source <code>ResourceStore</code>, an additional field will be sent along indicating the type of change, and an additional corresponding event will be emitted, depending on what the change is.</p>"},{"location":"architecture/features/protocol/resource-store/#indexrepresentationstore","title":"IndexRepresentationStore","text":"<p>When doing a GET request on a container <code>/container/</code>, this container returns the contents of <code>/container/index.html</code> instead if HTML is the preferred response type. All these values are the defaults and can be configured for other resources and media types.</p>"},{"location":"architecture/features/protocol/resource-store/#lockingresourcestore","title":"LockingResourceStore","text":"<p>To prevent data corruption, the server locks resources when being targeted by a request. Locks are only released when an operation is completely finished, in the case of read operations this means the entire data stream is read, and in the case of write operations this happens when all relevant data is written. The default lock that is used is a readers-writer lock. This allows simultaneous read requests on the same resource, but only while no write request is in progress.</p>"},{"location":"architecture/features/protocol/resource-store/#patchingstore","title":"PatchingStore","text":"<p>PATCH operations in Solid apply certain transformations on the target resource, which makes them more complicated than only reading or writing data since it involves both. The <code>PatchingStore</code> provides a generic solution for backends that do not implement the <code>modifyResource</code> function so new backends can be added more easily. In case the next store in the chain does not support PATCH, the <code>PatchingStore</code> will GET the data from the next store, apply the transformation on that data, and then PUT it back to the store.</p>"},{"location":"architecture/features/protocol/resource-store/#representationconvertingstore","title":"RepresentationConvertingStore","text":"<p>This store handles everything related to content negotiation. In case the resulting data of a GET request does not match the preferences of a request, it will be converted here. Similarly, if incoming data does not match the type expected by the store, the SPARQL backend only accepts triples for example, that is also handled here</p>"},{"location":"architecture/features/protocol/resource-store/#dataaccessorbasedstore","title":"DataAccessorBasedStore","text":"<p>Large parts of the requirements of the Solid protocol specification are resolved by the <code>DataAccessorBasedStore</code>: POST only working on containers, DELETE not working on non-empty containers, generating <code>ldp:contains</code> triples for containers, etc. Most of this behaviour is independent of how the data is stored which is why it can be generalized here. The store's name comes from the fact that it makes use of <code>DataAccessor</code>s to handle the read/write of resources. A <code>DataAccessor</code> is a simple interface that only focuses on handling the data. It does not concern itself with any of the necessary Solid checks as it assumes those have already been made. This means that if a storage method needs to be supported, only a new <code>DataAccessor</code> needs to be made, after which it can be plugged into the rest of the server.</p>"},{"location":"contributing/making-changes/","title":"Pull requests","text":"<p>The community server is fully written in Typescript.</p> <p>All changes should be done through pull requests.</p> <p>We recommend first discussing a possible solution in the relevant issue to reduce the amount of changes that will be requested.</p> <p>In case any of your changes are breaking, make sure you target the next major branch (<code>versions/x.0.0</code>) instead of the main branch. Breaking changes include: changing interface/class signatures, potentially breaking external custom configurations, and breaking how internal data is stored. In case of doubt you probably want to target the next major branch.</p> <p>We make use of Conventional Commits.</p> <p>Don't forget to update the release notes when adding new major features. Also update any relevant documentation in case this is needed.</p> <p>When making changes to a pull request, we prefer to update the existing commits with a rebase instead of appending new commits, this way the PR can be rebased directly onto the target branch instead of needing to be squashed.</p> <p>There are strict requirements from the linter and the test coverage before a PR is valid. These are configured to run automatically when trying to commit to git. Although there are no tests for it (yet), we strongly advice documenting with TSdoc.</p> <p>If a list of entries is alphabetically sorted, such as index.ts, make sure it stays that way.</p>"},{"location":"contributing/release/","title":"Releasing a new major version","text":"<p>This is only relevant if you are a developer with push access responsible for doing a new release.</p> <p>Steps to follow:</p> <ul> <li>Merge <code>main</code> into <code>versions/next-major</code>.</li> <li>Verify if there are issues when upgrading an existing installation to the new version.<ul> <li>Can the data still be accessed?</li> <li>Does authentication still work?</li> <li>Is there an issue upgrading any of the dependent repositories (see below for links)?</li> <li>None of the above has to be blocking per se, but should be noted in the release notes if relevant.</li> </ul> </li> <li>Verify that the <code>RELEASE_NOTES.md</code> are correct.</li> <li><code>npm run release -- -r major</code><ul> <li>Automatically updates Components.js references to the new version. Committed with <code>chore(release): Update configs to vx.0.0</code>.</li> <li>Updates the <code>package.json</code>, and generates the new entries in <code>CHANGELOG.md</code>. Commits with <code>chore(release): Release version vx.0.0 of the npm package</code></li> <li>Optionally run <code>npx commit-and-tag-version -r major --dry-run</code> to preview the commands that will be run and the changes to <code>CHANGELOG.md</code>.</li> </ul> </li> <li>The <code>postrelease</code> script will now prompt you to manually edit the <code>CHANGELOG.md</code>.<ul> <li>All entries are added in separate sections of the new release according to their commit prefixes.</li> <li>Re-organize the entries accordingly, referencing previous releases. Most of the entries in Chores and Documentation can be removed.</li> <li>Press any key in your terminal when your changes are ready.</li> <li>The <code>postrelease</code> script will amend the release commit, create an annotated tag and push changes to origin.</li> </ul> </li> <li>Merge <code>versions/next-major</code> into <code>main</code> and push.</li> <li>Do a GitHub release.</li> <li><code>npm publish</code><ul> <li><code>npm dist-tag add @solid/community-server@x.0.0 next</code></li> </ul> </li> <li>Rename the <code>versions/x.0.0</code> branch to the next version.</li> <li>Potentially upgrade dependent repositories:<ul> <li>Recipes at https://github.com/CommunitySolidServer/recipes/</li> <li>Tutorials at https://github.com/CommunitySolidServer/tutorials/</li> <li>Generator at https://github.com/CommunitySolidServer/configuration-generator/</li> <li>Hello world component at https://github.com/CommunitySolidServer/hello-world-component/</li> </ul> </li> </ul>"},{"location":"contributing/release/#changes-when-doing-a-pre-release","title":"Changes when doing a pre-release","text":"<ul> <li>Version with <code>npm run release -- -r major --prerelease alpha</code></li> <li>Do not merge <code>versions/next-major</code> into <code>main</code>.</li> <li>Publish with <code>npm publish --tag next</code>.</li> <li>Do not update the branch or anything related.</li> </ul>"},{"location":"contributing/release/#changes-when-doing-a-minor-release","title":"Changes when doing a minor release","text":"<ul> <li>Version with <code>npm run release -- -r minor</code></li> <li>Do not merge <code>versions/next-major</code> into <code>main</code>.</li> </ul>"},{"location":"usage/client-credentials/","title":"Automating authentication with Client Credentials","text":"<p>One potential issue for scripts and other applications is that it requires user interaction to log in and authenticate. The CSS offers an alternative solution for such cases by making use of Client Credentials. Once you have created an account as described in the Identity Provider section, users can request a token that apps can use to authenticate without user input.</p> <p>All requests to the client credentials API currently require you to send along the email and password of that account to identify yourself. This is a temporary solution until the server has more advanced account management, after which this API will change.</p> <p>Below is example code of how to make use of these tokens. It makes use of several utility functions from the Solid Authentication Client. Note that the code below uses top-level <code>await</code>, which not all JavaScript engines support, so this should all be contained in an <code>async</code> function.</p>"},{"location":"usage/client-credentials/#generating-a-token","title":"Generating a token","text":"<p>The code below generates a token linked to your account and WebID. This only needs to be done once, afterwards this token can be used for all future requests.</p> <pre><code>import fetch from 'node-fetch';\n\n// This assumes your server is started under http://localhost:3000/.\n// This URL can also be found by checking the controls in JSON responses when interacting with the IDP API,\n// as described in the Identity Provider section.\nconst response = await fetch('http://localhost:3000/idp/credentials/', {\n method: 'POST',\n headers: { 'content-type': 'application/json' },\n // The email/password fields are those of your account.\n // The name field will be used when generating the ID of your token.\n body: JSON.stringify({ email: 'my-email@example.com', password: 'my-account-password', name: 'my-token' }),\n});\n\n// These are the identifier and secret of your token.\n// Store the secret somewhere safe as there is no way to request it again from the server!\nconst { id, secret } = await response.json();\n</code></pre> <p>If there is something wrong with your input the response code will be 500. If no account is linked to the email, the message will be \"Account does not exist\" and if the password is wrong it will be \"Incorrect password\".</p>"},{"location":"usage/client-credentials/#requesting-an-access-token","title":"Requesting an Access token","text":"<p>The ID and secret combination generated above can be used to request an Access Token from the server. This Access Token is only valid for a certain amount of time, after which a new one needs to be requested.</p> <pre><code>import { createDpopHeader, generateDpopKeyPair } from '@inrupt/solid-client-authn-core';\nimport fetch from 'node-fetch';\n\n// A key pair is needed for encryption.\n// This function from `solid-client-authn` generates such a pair for you.\nconst dpopKey = await generateDpopKeyPair();\n\n// These are the ID and secret generated in the previous step.\n// Both the ID and the secret need to be form-encoded.\nconst authString = `${encodeURIComponent(id)}:${encodeURIComponent(secret)}`;\n// This URL can be found by looking at the \"token_endpoint\" field at\n// http://localhost:3000/.well-known/openid-configuration\n// if your server is hosted at http://localhost:3000/.\nconst tokenUrl = 'http://localhost:3000/.oidc/token';\nconst response = await fetch(tokenUrl, {\n method: 'POST',\n headers: {\n // The header needs to be in base64 encoding.\n authorization: `Basic ${Buffer.from(authString).toString('base64')}`,\n 'content-type': 'application/x-www-form-urlencoded',\n dpop: await createDpopHeader(tokenUrl, 'POST', dpopKey),\n },\n body: 'grant_type=client_credentials&scope=webid',\n});\n\n// This is the Access token that will be used to do an authenticated request to the server.\n// The JSON also contains an \"expires_in\" field in seconds,\n// which you can use to know when you need request a new Access token.\nconst { access_token: accessToken } = await response.json();\n</code></pre>"},{"location":"usage/client-credentials/#using-the-access-token-to-make-an-authenticated-request","title":"Using the Access token to make an authenticated request","text":"<p>Once you have an Access token, you can use it for authenticated requests until it expires.</p> <pre><code>import { buildAuthenticatedFetch } from '@inrupt/solid-client-authn-core';\nimport fetch from 'node-fetch';\n\n// The DPoP key needs to be the same key as the one used in the previous step.\n// The Access token is the one generated in the previous step.\nconst authFetch = await buildAuthenticatedFetch(fetch, accessToken, { dpopKey });\n// authFetch can now be used as a standard fetch function that will authenticate as your WebID.\n// This request will do a simple GET for example.\nconst response = await authFetch('http://localhost:3000/private');\n</code></pre>"},{"location":"usage/client-credentials/#deleting-a-token","title":"Deleting a token","text":"<p>You can see all your existing tokens by doing a POST to <code>http://localhost:3000/idp/credentials/</code> with as body a JSON object containing your email and password. The response will be a JSON list containing all your tokens.</p> <p>Deleting a token requires also doing a POST to the same URL, but adding a <code>delete</code> key to the JSON input object with as value the ID of the token you want to remove.</p>"},{"location":"usage/dev-configuration/","title":"Configuring the CSS as a development server in another project","text":"<p>It can be useful to use the CSS as local server to develop Solid applications against. As an alternative to using CLI arguments, or environment variables, the CSS can be configured in the <code>package.json</code> as follows:</p> <pre><code>{\n \"name\": \"test\",\n \"version\": \"0.0.0\",\n \"private\": \"true\",\n \"config\": {\n \"community-solid-server\": {\n \"port\": 3001,\n \"loggingLevel\": \"error\"\n }\n },\n \"scripts\": {\n \"dev:pod\": \"community-solid-server\"\n },\n \"devDependencies\": {\n \"@solid/community-server\": \"^6.0.0\"\n }\n}\n</code></pre> <p>These parameters will then be used when the <code>community-solid-server</code> command is executed as an npm script (as shown in the example above). Or whenever the <code>community-solid-server</code> command is executed in the same folder as the <code>package.json</code>.</p> <p>Alternatively, the configuration parameters may be placed in a configuration file named <code>.community-solid-server.config.json</code> as follows:</p> <pre><code>{\n \"port\": 3001,\n \"loggingLevel\": \"error\"\n}\n</code></pre> <p>The config may also be written in JavaScript with the config as the default export such as the following <code>.community-solid-server.config.js</code>:</p> <pre><code>module.exports = {\n port: 3001,\n loggingLevel: \"error\"\n};\n</code></pre>"},{"location":"usage/example-requests/","title":"Interacting with the server","text":""},{"location":"usage/example-requests/#put-creating-resources-for-a-given-url","title":"<code>PUT</code>: Creating resources for a given URL","text":"<p>Create a plain text file:</p> <pre><code>curl -X PUT -H \"Content-Type: text/plain\" \\\n -d \"abc\" \\\n http://localhost:3000/myfile.txt\n</code></pre> <p>Create a turtle file:</p> <pre><code>curl -X PUT -H \"Content-Type: text/turtle\" \\\n -d \"<ex:s> <ex:p> <ex:o>.\" \\\n http://localhost:3000/myfile.ttl\n</code></pre>"},{"location":"usage/example-requests/#post-creating-resources-at-a-generated-url","title":"<code>POST</code>: Creating resources at a generated URL","text":"<p>Create a plain text file:</p> <pre><code>curl -X POST -H \"Content-Type: text/plain\" \\\n -d \"abc\" \\\n http://localhost:3000/\n</code></pre> <p>Create a turtle file:</p> <pre><code>curl -X POST -H \"Content-Type: text/turtle\" \\\n -d \"<ex:s> <ex:p> <ex:o>.\" \\\n http://localhost:3000/\n</code></pre> <p>The response's <code>Location</code> header will contain the URL of the created resource.</p>"},{"location":"usage/example-requests/#get-retrieving-resources","title":"<code>GET</code>: Retrieving resources","text":"<p>Retrieve a plain text file:</p> <pre><code>curl -H \"Accept: text/plain\" \\\n http://localhost:3000/myfile.txt\n</code></pre> <p>Retrieve a turtle file:</p> <pre><code>curl -H \"Accept: text/turtle\" \\\n http://localhost:3000/myfile.ttl\n</code></pre> <p>Retrieve a turtle file in a different serialization:</p> <pre><code>curl -H \"Accept: application/ld+json\" \\\n http://localhost:3000/myfile.ttl\n</code></pre>"},{"location":"usage/example-requests/#delete-deleting-resources","title":"<code>DELETE</code>: Deleting resources","text":"<pre><code>curl -X DELETE http://localhost:3000/myfile.txt\n</code></pre>"},{"location":"usage/example-requests/#patch-modifying-resources","title":"<code>PATCH</code>: Modifying resources","text":"<p>Modify a resource using N3 Patch:</p> <pre><code>curl -X PATCH -H \"Content-Type: text/n3\" \\\n --data-raw \"@prefix solid: <http://www.w3.org/ns/solid/terms#>. _:rename a solid:InsertDeletePatch; solid:inserts { <ex:s2> <ex:p2> <ex:o2>. }.\" \\\n http://localhost:3000/myfile.ttl\n</code></pre> <p>Modify a resource using SPARQL Update:</p> <pre><code>curl -X PATCH -H \"Content-Type: application/sparql-update\" \\\n -d \"INSERT DATA { <ex:s2> <ex:p2> <ex:o2> }\" \\\n http://localhost:3000/myfile.ttl\n</code></pre>"},{"location":"usage/example-requests/#head-retrieve-resources-headers","title":"<code>HEAD</code>: Retrieve resources headers","text":"<pre><code>curl -I -H \"Accept: text/plain\" \\\n http://localhost:3000/myfile.txt\n</code></pre>"},{"location":"usage/example-requests/#options-retrieve-resources-communication-options","title":"<code>OPTIONS</code>: Retrieve resources communication options","text":"<pre><code>curl -X OPTIONS -i http://localhost:3000/myfile.txt\n</code></pre>"},{"location":"usage/identity-provider/","title":"Identity Provider","text":"<p>Besides implementing the Solid protocol, the community server can also be an Identity Provider (IDP), officially known as an OpenID Provider (OP), following the Solid OIDC spec as much as possible.</p> <p>It is recommended to use the latest version of the Solid authentication client to interact with the server.</p> <p>The links here assume the server is hosted at <code>http://localhost:3000/</code>.</p>"},{"location":"usage/identity-provider/#registering-an-account","title":"Registering an account","text":"<p>To register an account, you can go to <code>http://localhost:3000/idp/register/</code> if this feature is enabled, which it is on most configurations we provide. Currently our registration page ties 3 features together on the same page:</p> <ul> <li>Creating an account on the server.</li> <li>Creating or linking a WebID to your account.</li> <li>Creating a pod on the server.</li> </ul>"},{"location":"usage/identity-provider/#account","title":"Account","text":"<p>To create an account you need to provide an email address and password. The password will be salted and hashed before being stored. As of now, the account is only used to log in and identify yourself to the IDP when you want to do an authenticated request, but in future the plan is to also use this for account/pod management.</p>"},{"location":"usage/identity-provider/#webid","title":"WebID","text":"<p>We require each account to have a corresponding WebID. You can either let the server create a WebID for you in a pod, which will also need to be created then, or you can link an already existing WebID you have on an external server.</p> <p>In case you try to link your own WebID, you can choose if you want to be able to use this server as your IDP for this WebID. If not, you can still create a pod, but you will not be able to direct the authentication client to this server to identify yourself.</p> <p>Additionally, if you try to register with an external WebID, the first attempt will return an error indicating you need to add an identification triple to your WebID. After doing that you can try to register again. This is how we verify you are the owner of that WebID. After registration the next page will inform you that you have to add an additional triple to your WebID if you want to use the server as your IDP.</p> <p>All of the above is automated if you create the WebID on the server itself.</p>"},{"location":"usage/identity-provider/#pod","title":"Pod","text":"<p>To create a pod you simply have to fill in the name you want your pod to have. This will then be used to generate the full URL of your pod. For example, if you choose the name <code>test</code>, your pod would be located at <code>http://localhost:3000/test/</code> and your generated WebID would be <code>http://localhost:3000/test/profile/card#me</code>.</p> <p>The generated name also depends on the configuration you chose for your server. If you are using the subdomain feature, such as being done in the <code>config/memory-subdomains.json</code> configuration, the generated pod URL would be <code>http://test.localhost:3000/</code>.</p>"},{"location":"usage/identity-provider/#logging-in","title":"Logging in","text":"<p>When using an authenticating client, you will be redirected to a login screen asking for your email and password. After that you will be redirected to a page showing some basic information about the client. There you need to consent that this client is allowed to identify using your WebID. As a result the server will send a token back to the client that contains all the information needed to use your WebID.</p>"},{"location":"usage/identity-provider/#forgot-password","title":"Forgot password","text":"<p>If you forgot your password, you can recover it by going to <code>http://localhost:3000/idp/forgotpassword/</code>. There you can enter your email address to get a recovery mail to reset your password. This feature only works if a mail server was configured, which by default is not the case.</p>"},{"location":"usage/identity-provider/#json-api","title":"JSON API","text":"<p>All of the above happens through HTML pages provided by the server. By default, the server uses the templates found in <code>/templates/identity/email-password/</code> but different templates can be used through configuration.</p> <p>These templates all make use of a JSON API exposed by the server. For example, when doing a GET request to <code>http://localhost:3000/idp/register/</code> with a JSON accept header, the following JSON is returned:</p> <pre><code>{\n \"required\": {\n \"email\": \"string\",\n \"password\": \"string\",\n \"confirmPassword\": \"string\",\n \"createWebId\": \"boolean\",\n \"register\": \"boolean\",\n \"createPod\": \"boolean\",\n \"rootPod\": \"boolean\"\n },\n \"optional\": {\n \"webId\": \"string\",\n \"podName\": \"string\",\n \"template\": \"string\"\n },\n \"controls\": {\n \"register\": \"http://localhost:3000/idp/register/\",\n \"index\": \"http://localhost:3000/idp/\",\n \"prompt\": \"http://localhost:3000/idp/prompt/\",\n \"login\": \"http://localhost:3000/idp/login/\",\n \"forgotPassword\": \"http://localhost:3000/idp/forgotpassword/\"\n },\n \"apiVersion\": \"0.3\"\n}\n</code></pre> <p>The <code>required</code> and <code>optional</code> fields indicate which input fields are expected by the API. These correspond to the fields of the HTML registration page. To register a user, you can do a POST request with a JSON body containing the correct fields:</p> <pre><code>{\n \"email\": \"test@example.com\",\n \"password\": \"secret\",\n \"confirmPassword\": \"secret\",\n \"createWebId\": true,\n \"register\": true,\n \"createPod\": true,\n \"rootPod\": false,\n \"podName\": \"test\"\n}\n</code></pre> <p>Two fields here that are not covered on the HTML page above are <code>rootPod</code> and <code>template</code>. <code>rootPod</code> tells the server to put the pod in the root of the server instead of a location based on the <code>podName</code>. By default the server will reject requests where this is <code>true</code>, except during setup. <code>template</code> is only used by servers running the <code>config/dynamic.json</code> configuration, which is a very custom setup where every pod can have a different Components.js configuration, so this value can usually be ignored.</p>"},{"location":"usage/identity-provider/#idp-configuration","title":"IDP configuration","text":"<p>The above descriptions cover server behaviour with most default configurations, but just like any other feature, there are several features that can be changed through the imports in your configuration file.</p> <p>All available options can be found in the <code>config/identity/</code> folder. Below we go a bit deeper into the available options</p>"},{"location":"usage/identity-provider/#access","title":"access","text":"<p>The <code>access</code> option allows you to set authorization restrictions on the IDP API when enabled, similar to how authorization works on the LDP requests on the server. For example, if the server uses WebACL as authorization scheme, you can put a <code>.acl</code> resource in the <code>/idp/register/</code> container to restrict who is allowed to access the registration API. Note that for everything to work there needs to be a <code>.acl</code> resource in <code>/idp/</code> when using WebACL so resources can be accessed as usual when the server starts up. Make sure you change the permissions on <code>/idp/.acl</code> so not everyone can modify those.</p> <p>All of the above is only relevant if you use the <code>restricted.json</code> setting for this import. When you use <code>public.json</code> the API will simply always be accessible by everyone.</p>"},{"location":"usage/identity-provider/#email","title":"email","text":"<p>In case you want users to be able to reset their password when they forget it, you will need to tell the server which email server to use to send reset mails. <code>example.json</code> contains an example of what this looks like, which you will need to copy over to your base configuration and then remove the <code>config/identity/email</code> import.</p>"},{"location":"usage/identity-provider/#handler","title":"handler","text":"<p>There is only one option here. This import contains all the core components necessary to make the IDP work. In case you need to make some changes to core IDP settings, this is where you would have to look.</p>"},{"location":"usage/identity-provider/#pod_1","title":"pod","text":"<p>The <code>pod</code> options determines how pods are created. <code>static.json</code> is the expected pod behaviour as described above. <code>dynamic.json</code> is an experimental feature that allows users to have a custom Components.js configuration for their own pod. When using such a setup, a JSON file will be written containing all the information of the user pods so they can be recreated when the server restarts.</p>"},{"location":"usage/identity-provider/#registration","title":"registration","text":"<p>This setting allows you to enable/disable registration on the server. Disabling registration here does not disable registration during setup, meaning you can still use this server as an IDP with the account created there.</p>"},{"location":"usage/metadata/","title":"Editing metadata of resources","text":""},{"location":"usage/metadata/#what-is-a-description-resource","title":"What is a description resource","text":"<p>Description resources contain auxiliary information about a resource. In CSS, these represent metadata corresponding to that resource. Every resource always has a corresponding description resource and therefore description resources can not be created or deleted directly.</p> <p>Description resources are discoverable by interacting with their subject resource: the response to a <code>GET</code> or <code>HEAD</code> request on a subject resource will contain a <code>describedby</code> Link Header with a URL that points to its description resource.</p> <p>Clients should always follow this link rather than guessing its URL, because the Solid Protocol does not mandate a specific description resource URL. The default CSS configurations use as a convention that <code>http://example.org/resource</code> has <code>http://example.org/resource.meta</code> as its description resource.</p>"},{"location":"usage/metadata/#how-to-edit-the-metadata-of-a-resource","title":"How to edit the metadata of a resource","text":"<p>Editing the metadata of a resource is performed by editing the description resource directly. This can only be done using <code>PATCH</code> requests (see example workflow).</p> <p><code>PUT</code> requests on description resources are not allowed, because they would replace the entire resource state, whereas some metadata is protected or generated by the server.</p> <p>Similarly, <code>DELETE</code> on description resources is not allowed because a resource will always have some metadata (e.g. <code>rdf:type</code>). Instead, the lifecycle of description resources is managed by the server.</p>"},{"location":"usage/metadata/#protected-metadata","title":"Protected metadata","text":"<p>Some metadata is managed by the server and can not be modified directly, such as the last modified date. The CSS will throw an error (409 <code>ConflictHttpError</code>) when trying to change this protected metadata.</p>"},{"location":"usage/metadata/#preserving-metadata","title":"Preserving metadata","text":"<p><code>PUT</code> requests on a resource will reset the description resource. There is however a way to keep the contents of description resource prior to the <code>PUT</code> request: adding the HTTP <code>Link</code> header targeting the description resource with <code>rel=\"preserve\"</code>.</p> <p>When the resource URL is <code>http://localhost:3000/foobar</code>, preserving its description resource when updating its contents can be achieved like in the following example:</p> <pre><code>curl -X PUT 'http://localhost:3000/foobar' \\\n-H 'Content-Type: text/turtle' \\\n-H 'Link: <http://localhost:3000/foobar.meta>;rel=\"preserve\"' \\\n-d \"<ex:s> <ex:p> <ex:o>.\"\n</code></pre>"},{"location":"usage/metadata/#impact-on-creating-containers","title":"Impact on creating containers","text":"<p>When creating a container the input body is ignored and performing a <code>PUT</code> request on an existing container will result in an error. Container metadata can only be added and modified by performing a <code>PATCH</code> on the description resource, similarly to documents. This is done to clearly differentiate between a container's representation and its metadata.</p>"},{"location":"usage/metadata/#example-of-a-workflow-for-editing-a-description-resource","title":"Example of a workflow for editing a description resource","text":"<p>In this example, we add an inbox description to <code>http://localhost:3000/foo/</code>. This allows discovery of the <code>ldp:inbox</code> as described in the Linked Data Notifications specification.</p> <p>We have started the CSS with the default configuration and have already created an inbox at <code>http://localhost:3000/inbox/</code>.</p> <p>Since we don't know the location of the description resource, we first send a <code>HEAD</code> request to the resource to obtain the URL of its description resource.</p> <pre><code>curl --head 'http://localhost:3000/foo/'\n</code></pre> <p>which will produce a response with at least these headers:</p> <pre><code>HTTP/1.1 200 OK\nLink: <http://localhost:3000/foo/.meta>; rel=\"describedby\"\n</code></pre> <p>Now that we have the URL of the description resource, we create a patch for adding the inbox in the description of the resource.</p> <pre><code>curl -X PATCH 'http://localhost:3000/foo/.meta' \\\n-H 'Content-Type: text/n3' \\\n--data-raw '@prefix solid: <http://www.w3.org/ns/solid/terms#>.\n<> a solid:InsertDeletePatch;\nsolid:inserts { <http://localhost:3000/foo/> <http://www.w3.org/ns/ldp#inbox> <http://localhost:3000/inbox/>. }.'\n</code></pre> <p>After this update, we can verify that the inbox is added by performing a GET request to the description resource</p> <pre><code>curl 'http://localhost:3000/foo/.meta'\n</code></pre> <p>With as result for the body</p> <pre><code>@prefix dc: <http://purl.org/dc/terms/>.\n@prefix ldp: <http://www.w3.org/ns/ldp#>.\n@prefix posix: <http://www.w3.org/ns/posix/stat#>.\n@prefix xsd: <http://www.w3.org/2001/XMLSchema#>.\n\n<http://localhost:3000/foo/> a ldp:Container, ldp:BasicContainer, ldp:Resource;\n dc:modified \"2022-06-09T08:17:07.000Z\"^^xsd:dateTime;\n ldp:inbox <http://localhost:3000/inbox/>;.\n</code></pre> <p>This can also be verified by sending a GET request to the subject resource itself. The inbox location can also be found in the Link headers.</p> <pre><code>curl -v 'http://localhost:3000/foo/'\n</code></pre> <pre><code>HTTP/1.1 200 OK\nLink: <http://localhost:3000/inbox/>; rel=\"http://www.w3.org/ns/ldp#inbox\"\n</code></pre>"},{"location":"usage/notifications/","title":"Receiving notifications","text":"<p>A CSS instance can be configured to support Solid notifications. These can be used to track changes on the server. There are no specific requirements on the type of notifications a Solid server should support, so on this page we'll describe the notification types supported by CSS, and how to make use of the different ways supported to receive notifications.</p>"},{"location":"usage/notifications/#discovering-subscription-services","title":"Discovering subscription services","text":"<p>CSS only supports discovering the notification subscription services through the storage description resource. This can be found by doing a <code>HEAD</code> request on any resource in your pod and looking for the <code>Link</code> header with the <code>http://www.w3.org/ns/solid/terms#storageDescription</code> relationship.</p> <p>For example, when hosting the server on localhost with port 3000, the result is:</p> <pre><code>Link: <http://localhost:3000/.well-known/solid>; rel=\"http://www.w3.org/ns/solid/terms#storageDescription\"\n</code></pre> <p>Doing a GET to <code>http://localhost:3000/.well-known/solid</code> then gives the following result (simplified for readability):</p> <pre><code>@prefix notify: <http://www.w3.org/ns/solid/notifications#>.\n\n<http://localhost:3000/.well-known/solid>\n a <http://www.w3.org/ns/pim/space#Storage> ;\n notify:subscription <http://localhost:3000/.notifications/WebSocketChannel2023/> ,\n <http://localhost:3000/.notifications/WebhookChannel2023/> .\n<http://localhost:3000/.notifications/WebSocketChannel2023/>\n notify:channelType notify:WebSocketChannel2023 ;\n notify:feature notify:accept ,\n notify:endAt ,\n notify:rate ,\n notify:startAt ,\n notify:state .\n<http://localhost:3000/.notifications/WebhookChannel2023/>\n notify:channelType notify:WebhookChannel2023;\n notify:feature notify:accept ,\n notify:endAt ,\n notify:rate ,\n notify:startAt ,\n notify:state .\n</code></pre> <p>This says that there are two available subscription services that can be used for notifications and where to find them. Note that these discovery requests also support content-negotiation, so you could ask for JSON-LD if you prefer. Currently, however, this JSON-LD will not match the examples from the notification specification.</p> <p>The above tells us where to send subscriptions and which features are supported for those services. You subscribe to a channel by <code>POST</code>ing a JSON-LD document to the subscription services. There are some small differences in the structure of these documents, depending on the channel type, which will be discussed below.</p> <p>Subscription requests need to be authenticated using Solid-OIDC. The server will check whether you have <code>Read</code> permission on the resource you want to listen to. Requests without <code>Read</code> permission will be rejected.</p>"},{"location":"usage/notifications/#notification-channel-types","title":"Notification channel types","text":"<p>There are currently up to two supported ways to get notifications in CSS, depending on your configuration: the notification channel types <code>WebSocketChannel2023</code>; and <code>WebhookChannel2023</code>.</p>"},{"location":"usage/notifications/#websockets","title":"WebSockets","text":"<p>To subscribe to the <code>http://localhost:3000/foo</code> resource using WebSockets, you use an authenticated <code>POST</code> request to send the following JSON-LD document to the server, at <code>http://localhost:3000/.notifications/WebSocketChannel2023/</code>:</p> <pre><code>{\n \"@context\": [\"https://www.w3.org/ns/solid/notification/v1\"],\n \"type\": \"http://www.w3.org/ns/solid/notifications#WebSocketChannel2023\",\n \"topic\": \"http://localhost:3000/foo\"\n}\n</code></pre> <p>If you have <code>Read</code> permissions, the server's reply will look like this:</p> <pre><code>{\n \"@context\": [ \"https://www.w3.org/ns/solid/notification/v1\" ],\n \"id\": \"http://localhost:3000/.notifications/WebSocketChannel2023/dea6f614-08ab-4cc1-bbca-5dece0afb1e2\",\n \"type\": \"http://www.w3.org/ns/solid/notifications#WebSocketChannel2023\",\n \"topic\": \"http://localhost:3000/foo\",\n \"receiveFrom\": \"ws://localhost:3000/.notifications/WebSocketChannel2023/?auth=http%3A%2F%2Flocalhost%3A3000%2F.notifications%2FWebSocketChannel2023%2Fdea6f614-08ab-4cc1-bbca-5dece0afb1e2\"\n}\n</code></pre> <p>The most important field is <code>receiveFrom</code>. This field tells you the WebSocket to which you need to connect, through which you will start receiving notifications. In JavaScript, this can be done using the WebSocket object, such as:</p> <pre><code>const ws = new WebSocket(receiveFrom);\nws.on('message', (notification) => console.log(notification));\n</code></pre>"},{"location":"usage/notifications/#webhooks","title":"Webhooks","text":"<p>Similar to the WebSocket subscription, below is sample JSON-LD that would be sent to <code>http://localhost:3000/.notifications/WebhookChannel2023/</code>:</p> <pre><code>{\n \"@context\": [ \"https://www.w3.org/ns/solid/notification/v1\" ],\n \"type\": \"http://www.w3.org/ns/solid/notifications#WebhookChannel2023\",\n \"topic\": \"http://localhost:3000/foo\",\n \"sendTo\": \"https://example.com/webhook\"\n}\n</code></pre> <p>Note that this document has an additional <code>sendTo</code> field. This is the Webhook URL of your server, the URL to which you want the notifications to be sent.</p> <p>The response would then be something like this:</p> <pre><code>{\n \"@context\": [ \"https://www.w3.org/ns/solid/notification/v1\" ],\n \"id\": \"http://localhost:3000/.notifications/WebhookChannel2023/eeaf2c17-699a-4e53-8355-e91d13807e5f\",\n \"type\": \"http://www.w3.org/ns/solid/notifications#WebhookChannel2023\",\n \"topic\": \"http://localhost:3000/foo\",\n \"sendTo\": \"https://example.com/webhook\"\n}\n</code></pre>"},{"location":"usage/notifications/#unsubscribing-from-a-notification-channel","title":"Unsubscribing from a notification channel","text":"<p>Note</p> <p>This feature is not part of the Solid Notification v0.2 specification so might be changed or removed in the future.</p> <p>If you no longer want to receive notifications on the channel you created, you can send a <code>DELETE</code> request to the channel to remove it. Use the value found in the <code>id</code> field of the subscription response. There is no way to retrieve this identifier later on, so make sure to keep track of it just in case you want to unsubscribe at some point. No authorization is needed for this request.</p>"},{"location":"usage/notifications/#notification-format","title":"Notification format","text":"<p>Below is an example notification that would be sent when a resource changes:</p> <pre><code>{\n \"@context\": [\n \"https://www.w3.org/ns/activitystreams\",\n \"https://www.w3.org/ns/solid/notification/v1\"\n ],\n \"id\": \"urn:123456:http://example.com/foo\",\n \"type\": \"Update\",\n \"object\": \"http://localhost:3000/foo\",\n \"state\": \"987654\",\n \"published\": \"2023-02-09T15:08:12.345Z\"\n}\n</code></pre> <p>A notification contains the following fields:</p> <ul> <li><code>id</code>: A unique identifier for this notification.</li> <li><code>type</code>: What happened to trigger the notification. We discuss the possible values below.</li> <li><code>object</code>: The resource that changed.</li> <li><code>state</code>: An identifier indicating the state of the resource. This corresponds to the <code>ETag</code> value you get when doing a request on the resource itself.</li> <li><code>published</code>: When this change occurred.</li> </ul>"},{"location":"usage/notifications/#notification-types","title":"Notification types","text":"<p>CSS supports five different notification types that the client can receive. The format of the notification can slightly change depending on the type.</p> <p>Resource notification types:</p> <ul> <li><code>Create</code>: When the resource is created.</li> <li><code>Update</code>: When the existing resource is changed.</li> <li><code>Delete</code>: When the resource is deleted. Does not have a <code>state</code> field.</li> </ul> <p>Additionally, when listening to a container, there are two extra notifications that are sent out when the contents of the container change. For these notifications, the <code>object</code> fields references the resource that was added or removed, while the new <code>target</code> field references the container itself.</p> <ul> <li><code>Add</code>: When a new resource is added to the container.</li> <li><code>Remove</code>: When a resource is removed from the container.</li> </ul>"},{"location":"usage/notifications/#features","title":"Features","text":"<p>The Solid notification specification describes several extra features that can be supported by notification channels. By default, these are all supported on the channels of a CSS instance, as can be seen in the descriptions returned by the server above. Each feature can be enabled by adding a field to the JSON-LD you send during subscription. The available fields are:</p> <ul> <li><code>startAt</code>: An <code>xsd:dateTime</code> describing when you want notifications to start. No notifications will be sent on this channel before this time.</li> <li><code>endAt</code>: An <code>xsd:dateTime</code> describing when you want notifications to stop. The channel will be destroyed at that time, and no more notifications will be sent.</li> <li><code>state</code>: A string corresponding to the <code>state</code> string of a resource notification. If this value differs from the actual state of the resource, a notification will be sent out immediately to inform the client that its stored state is outdated.</li> <li><code>rate</code>: An <code>xsd:duration</code> indicating how often notifications can be sent out. A new notification will only be sent out after this much time has passed since the previous notification.</li> <li><code>accept</code>: A description of the <code>content-type(s)</code> in which the client would want to receive the notifications. Expects the same values as an <code>Accept</code> HTTP header.</li> </ul>"},{"location":"usage/notifications/#important-note-for-server-owners","title":"Important note for server owners","text":"<p>There is not much restriction on who can create a new notification channel; only <code>Read</code> permissions on the target resource are required. It is therefore possible for the server to accumulate created channels. As these channels still get used every time their corresponding resource changes, this could degrade server performance.</p> <p>For this reason, the default server configuration removes notification channels after two weeks (20160 minutes). You can modify this behaviour by adding the following block to your configuration:</p> <pre><code>{\n \"@id\": \"urn:solid-server:default:WebSocket2023Subscriber\",\n \"@type\": \"NotificationSubscriber\",\n \"maxDuration\": 20160\n}\n</code></pre> <p><code>maxDuration</code> defines after how many minutes every channel will be removed. Setting this value to 0 will allow channels to exist forever. Similarly, to change the maximum duration of webhook channels you can use the identifier <code>urn:solid-server:default:WebHookSubscriber</code>.</p>"},{"location":"usage/seeding-pods/","title":"How to seed Accounts and Pods","text":"<p>If you need to seed accounts and pods, the <code>--seededPodConfigJson</code> command line option can be used with as value the path to a JSON file containing configurations for every required pod. The file needs to contain an array of JSON objects, with each object containing at least a <code>podName</code>, <code>email</code>, and <code>password</code> field.</p> <p>For example:</p> <pre><code>[\n {\n \"podName\": \"example\",\n \"email\": \"hello@example.com\",\n \"password\": \"abc123\"\n }\n]\n</code></pre> <p>You may optionally specify other parameters as described in the Identity Provider documentation.</p> <p>For example, to set up a pod without registering the generated WebID with the Identity Provider:</p> <pre><code>[\n {\n \"podName\": \"example\",\n \"email\": \"hello@example.com\",\n \"password\": \"abc123\",\n \"webId\": \"https://id.inrupt.com/example\",\n \"register\": false\n }\n]\n</code></pre> <p>This feature cannot be used to register pods with pre-existing WebIDs, which requires an interactive validation step.</p>"},{"location":"usage/starting-server/","title":"Starting the Community Solid Server","text":""},{"location":"usage/starting-server/#quickly-spinning-up-a-server","title":"Quickly spinning up a server","text":"<p>Use Node.js\u00a014.14 or up and execute:</p> <pre><code>npx @solid/community-server\n</code></pre> <p>Now visit your brand new server at http://localhost:3000/!</p> <p>To persist your pod's contents between restarts, use:</p> <pre><code>npx @solid/community-server -c @css:config/file.json -f data/\n</code></pre>"},{"location":"usage/starting-server/#local-installation","title":"Local installation","text":"<p>Install the npm package globally with:</p> <pre><code>npm install -g @solid/community-server\n</code></pre> <p>To run the server with in-memory storage, use:</p> <pre><code>community-solid-server # add parameters if needed\n</code></pre> <p>To run the server with your current folder as storage, use:</p> <pre><code>community-solid-server -c @css:config/file.json -f data/\n</code></pre>"},{"location":"usage/starting-server/#configuring-the-server","title":"Configuring the server","text":"<p>The Community Solid Server is designed to be flexible such that people can easily run different configurations. This is useful for customizing the server with plugins, testing applications in different setups, or developing new parts for the server without needing to change its base code.</p> <p>An easy way to customize the server is by passing parameters to the server command. These parameters give you direct access to some commonly used settings:</p> parameter name default value description <code>--port, -p</code> <code>3000</code> The TCP port on which the server should listen. <code>--baseUrl, -b</code> <code>http://localhost:$PORT/</code> The base URL used internally to generate URLs. Change this if your server does not run on <code>http://localhost:$PORT/</code>. <code>--socket</code> The Unix Domain Socket on which the server should listen. <code>--baseUrl</code> must be set if this option is provided <code>--loggingLevel, -l</code> <code>info</code> The detail level of logging; useful for debugging problems. Use <code>debug</code> for full information. <code>--config, -c</code> <code>@css:config/default.json</code> The configuration(s) for the server. The default only stores data in memory; to persist to your filesystem, use <code>@css:config/file.json</code> <code>--rootFilePath, -f</code> <code>./</code> Root folder where the server stores data, when using a file-based configuration. <code>--sparqlEndpoint, -s</code> URL of the SPARQL endpoint, when using a quadstore-based configuration. <code>--showStackTrace, -t</code> false Enables detailed logging on error output. <code>--podConfigJson</code> <code>./pod-config.json</code> Path to the file that keeps track of dynamic Pod configurations. Only relevant when using <code>@css:config/dynamic.json</code>. <code>--seededPodConfigJson</code> Path to the file that keeps track of seeded Pod configurations. <code>--mainModulePath, -m</code> Path from where Components.js will start its lookup when initializing configurations. <code>--workers, -w</code> <code>1</code> Run in multithreaded mode using workers. Special values are <code>-1</code> (scale to <code>num_cores-1</code>), <code>0</code> (scale to <code>num_cores</code>) and 1 (singlethreaded). <p>Parameters can also be passed through environment variables.</p> <p>They are prefixed with <code>CSS_</code> and converted from <code>camelCase</code> to <code>CAMEL_CASE</code></p> <p>eg. <code>--showStackTrace</code> => <code>CSS_SHOW_STACK_TRACE</code></p> <p>Command-line arguments will always override environment variables.</p>"},{"location":"usage/starting-server/#alternative-ways-to-run-the-server","title":"Alternative ways to run the server","text":""},{"location":"usage/starting-server/#from-source","title":"From source","text":"<p>If you rather prefer to run the latest source code version, or if you want to try a specific branch of the code, you can use:</p> <pre><code>git clone https://github.com/CommunitySolidServer/CommunitySolidServer.git\ncd CommunitySolidServer\nnpm ci\nnpm start -- # add parameters if needed\n</code></pre>"},{"location":"usage/starting-server/#via-docker","title":"Via Docker","text":"<p>Docker allows you to run the server without having Node.js installed. Images are built on each tagged version and hosted on Docker Hub.</p> <pre><code># Clone the repo to get access to the configs\ngit clone https://github.com/CommunitySolidServer/CommunitySolidServer.git\ncd CommunitySolidServer\n# Run the image, serving your `~/Solid` directory on `http://localhost:3000`\ndocker run --rm -v ~/Solid:/data -p 3000:3000 -it solidproject/community-server:latest\n# Or use one of the built-in configurations\ndocker run --rm -p 3000:3000 -it solidproject/community-server -c config/default.json\n# Or use your own configuration mapped to the right directory\ndocker run --rm -v ~/solid-config:/config -p 3000:3000 -it solidproject/community-server -c /config/my-config.json\n# Or use environment variables to configure your css instance\ndocker run --rm -v ~/Solid:/data -p 3000:3000 -it -e CSS_CONFIG=config/file-no-setup.json -e CSS_LOGGING_LEVEL=debug solidproject/community-server\n</code></pre>"},{"location":"usage/starting-server/#using-a-helm-chart","title":"Using a Helm Chart","text":"<p>The official Helm Chart for Kubernetes deployment is maintained at CommunitySolidServer/css-helm-chart and published on ArtifactHUB. There you will find complete installation instructions.</p> <pre><code># Summary\nhelm repo add community-solid-server https://communitysolidserver.github.io/css-helm-chart/charts/\nhelm install my-css community-solid-server/community-solid-server\n</code></pre>"}]} |