Mirroristas/CommunitySolidServer
2
0
Fork 0
mirror of https://github.com/CommunitySolidServer/CommunitySolidServer.git synced 2024-10-03 14:55:10 +00:00
Code Issues Packages Projects Releases Wiki Activity
CommunitySolidServer/config/identity/README.md
Jasper Vaneessen 9a5fc674f3
style: Enforce linting rules on markdown files 
* chore: add markdownlint-cli2 and config for mkdocs

* style: enforce linting rules on mkdocs md files

* chore: tweaks to markdownlint rules

* style: linting changelog

* style: linting release notes

* style: linting .github md files

* style: further linting of docs

* style: linting readmes

* chore: update linting script entries

* docs: tweak release after rebase

* chore: simplify root md linting config

* chore: extend base config

* chore: implement requested changes

* chore: remove unnecessary exception

* chore: fix comment type

* styling: single config + list spacing

* chore: implement requested changes

* chore: use .cjs files for markdownlint config

* chore: implement requested changes
2022-08-25 11:32:09 +02:00

1.8 KiB
Raw Blame History

Identity

Options related to the Identity Provider.

Access

Determines how publicly accessible some IDP features are.

  • public: Everything is publicly accessible.
  • restricted: The IDP components use the same authorization scheme as the main LDP component. For example, if the server uses WebACL authorization and the registration endpoint is /idp/register/, access to registration can be restricted by creating a valid /idp/register/.acl resource. WARNING: This setting will write the necessary resources to the .well-known and IDP containers to make this work. Again in the case of WebACL, this means ACL resources allowing full control access. So make sure to update those two containers so only the correct credentials have the correct rights.

Email

Necessary for sending e-mail when using IDP.

  • default: Disables e-mail functionality.
  • example: An example of what your e-mail configuration should look like. In that case you should not import anything from this folder but have the settings in your root config.

Handler

Contains everything needed for setting up the Identity Provider.

  • default: As of writing there is not much customization possible. This contains everything needed.

Ownership

Which technique to use to determine if a requesting agent owns a WebID.

  • token: A token needs to added to the WebID to prove ownership.
  • unsafe-no-check: No verification is done, the agent is always believed.

Pod

What to use for pod creation.

  • dynamic: Every created pod has its own Components.js config for its ResourceStore, which can differ from the others.
  • static: All pod data is stored in separate containers in the same ResourceStore.

Registration

If users should be able to register on the server.

  • enabled: Enables registration.
  • disabled: Disables registration.