diff --git a/README.md b/README.md index 8108da4..78d9ae9 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,7 @@ Or checkout these two videos: - **Keyboard oriented**. You can use SB fully using the keyboard, typinโ€™ the keys. - **Extend it your way**. SB is highly extensible with - [plugs](https://silverbullet.md/๐Ÿ”Œ_Plugs), and you can customize it to your + [plugs](https://silverbullet.md/๐Ÿ”Œ%20Plugs), and you can customize it to your liking and your workflows. ## Installing SilverBullet diff --git a/website/Authelia.md b/website/Authelia.md new file mode 100644 index 0000000..d32e9d5 --- /dev/null +++ b/website/Authelia.md @@ -0,0 +1,26 @@ +# How to setup SilverBullet with Authelia +In order for SilverBullet to work as intended, some files will need to be excluded from your authentication method of choice. These files need to always be accessible, for example for offline or [[PWA]] support. + +The files are the following: +- The web manifest +- The app icon +- The service worker + +These files can be whitelisted by adjusting your Authelia configuration to something like this: + +```yaml +access_control: + default_policy: deny + + rules: + - domain: silverbullet.yourdomain.com + resources: + - '/.client/manifest.json$' + - '/.client/[a-zA-Z0-9_-]+.png$' + - '/service_worker.js$' + policy: bypass + - domain: yourdomain.com + policy: two_factor +``` + +Please adjust this to fit your specific needs. The important part is that the files are associated with `policy: bypass`. diff --git a/website/Install.md b/website/Install.md index 92323bb..8365586 100644 --- a/website/Install.md +++ b/website/Install.md @@ -112,4 +112,7 @@ You can configure SB with environment variables instead of flags as well. The fo * `SB_USER`: Sets single-user credentials (like `--user`), e.g. `SB_USER=pete:1234` * `SB_PORT`: Sets the port to listen to, e.g. `SB_PORT=1234` * `SB_FOLDER`: Sets the folder to expose, e.g. `SB_FOLDER=/space` -* `SB_AUTH`: Loads an [[Authentication]] database from a (JSON encoded) string, e.g. `SB_AUTH=$(cat /path/to/.auth.json)` \ No newline at end of file +* `SB_AUTH`: Loads an [[Authentication]] database from a (JSON encoded) string, e.g. `SB_AUTH=$(cat /path/to/.auth.json)` + +## Using Authelia +You need to adjust a few configuration options in [[Authelia]] in order for SilverBullet to work as intended.