CommunitySolidServer/documentation/Create-a-custom-configuration.md
2021-05-19 11:29:19 +02:00

1.4 KiB

By default, the server will start with a set of preconfigured components. These components are configured in config/default.json. Learn more about the structure of this config file in the notes for developers.

Local development environment

This guide assumes the server is installed locally by cloning the git repo.

When starting the server via bin/server.js, you can provide another config via the -c flag. For example:

$ bin/server.js -c config/default.json

The command above will behave in the exact same way as just running bin/server.js, since config/default.json is the default server config for when -c is not provided.

If you for example create a copy from config/default.json named my-config.json, and make some adjustments, you can invoke it as follows:

$ bin/server.js -c my-config.json

Globally installed server

TODO: after making a first release, write a guide on how to create a custom config for it when it is globally installed.

Including the server as dependency in another package.

TODO: after making a first release, write a guide on how to create a custom config for it when it is included as a dependency in another package.