Skip to content

Commit

Permalink
feat: Split preset configurations by feature
Browse files Browse the repository at this point in the history
  • Loading branch information
joachimvh committed May 19, 2021
1 parent fadbaef commit 452032e
Show file tree
Hide file tree
Showing 151 changed files with 2,358 additions and 2,212 deletions.
55 changes: 55 additions & 0 deletions config/README.md
@@ -0,0 +1,55 @@
This folder contains several configurations that can be used to start up the server.
All those configurations are created in the same way:
features are enabled or disabled by choosing a specific option for every component.
All components are represented by the subfolders found in the folders here:
`ldp` contains all LDP related components,
`identity` all IDP components, etc.
Options are then chosen by importing 1 entry from every component subfolder.
In case none of the available options have the exact feature configuration you want,
it is always possible to not choose any of them and create your own custom version instead.

# How to use
The easiest way to create a new config is by creating a JSON-LD file
that imports one option from every component subfolder
(such as either `allow-everything.json` or `webacl.json` from `ldp/authorization`).
In case none of the available options suffice, there are 2 other ways to handle this:

## Append to an existing config
In case the options mostly suffice, but they just need to do a bit more,
it might be possible to append to one of the solutions.

For example, in case all the existing metadata parsers can remain,
but an additional one needs to be added,
you could import `ldp/metadata-parser/default.json`
and then add the following in your root config:
```json
{
"@id": "urn:solid-server:default:MetadataParser",
"ParallelHandler:_handlers": [
{ "@type": "MyNewParser" }
]
}
```
This will add the new parser to the list of metadata parsers.

Note that generally it is only advised to append to ParallelHandlers or key/value maps.
In case the order is important this can not be guaranteed over separate files.

## Create a new option
If a more drastic change is required,
the solution is to not import anything from that folder but instead write your own.

For example, in case you only want the slug parser but not any of the others,
you would have to not import anything from `ldp/metadata-parser` folder,
but instead have the following in your root config:
```json
{
"@id": "urn:solid-server:default:MetadataParser",
"@type": "ParallelHandler",
"handlers": [
{ "@type": "SlugParser" }
]
}
```
Don't forget that in some cases you would also have to copy some imports!
The existing options can be used as inspiration.
38 changes: 0 additions & 38 deletions config/config-default.json

This file was deleted.

37 changes: 0 additions & 37 deletions config/config-dynamic.json

This file was deleted.

35 changes: 0 additions & 35 deletions config/config-file-subdomains.json

This file was deleted.

38 changes: 0 additions & 38 deletions config/config-file.json

This file was deleted.

35 changes: 0 additions & 35 deletions config/config-memory-subdomains.json

This file was deleted.

58 changes: 0 additions & 58 deletions config/config-path-routing.json

This file was deleted.

39 changes: 0 additions & 39 deletions config/config-rdf-to-sparql-endpoint.json

This file was deleted.

38 changes: 0 additions & 38 deletions config/config-sparql-endpoint.json

This file was deleted.

0 comments on commit 452032e

Please sign in to comment.