diff options
author | Michael Krieger <phyre@phyre.me> | 2021-12-20 16:11:15 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-12-20 16:11:15 -0500 |
commit | ad8efdc799fb066a50aeb4ee28a388239f7b9fc8 (patch) | |
tree | 0ebbecbabad0da958889cc3a7268899aa36c5401 | |
parent | 8283b8da5a93c1141a247c3835678b4e2a2eba16 (diff) | |
download | homer-ad8efdc799fb066a50aeb4ee28a388239f7b9fc8.tar.gz homer-ad8efdc799fb066a50aeb4ee28a388239f7b9fc8.tar.zst homer-ad8efdc799fb066a50aeb4ee28a388239f7b9fc8.zip |
Warn about exposed apikeys
-rw-r--r-- | docs/customservices.md | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/docs/customservices.md b/docs/customservices.md index 7d47542..77109b7 100644 --- a/docs/customservices.md +++ b/docs/customservices.md | |||
@@ -1,7 +1,11 @@ | |||
1 | # Custom Services | 1 | # Custom Services |
2 | 2 | ||
3 | Some service can use a specific a component that provides some extra features by adding a `type` key to the service yaml | 3 | Some service can use a specific a component that provides some extra features by adding a `type` key to the service yaml |
4 | configuration. Available services are in `src/components/`. Here is an overview of all custom services that are available | 4 | configuration and, where applicable, an apikey. Note that config.yml is exposed at /assets/config.yml via HTTP and any |
5 | apikey included in the configuration file is exposed to anyone who can access the homer instance. Only include an apikey | ||
6 | if your homer instance is secured behind some form of authentication or access restriction. | ||
7 | |||
8 | Available services are in `src/components/`. Here is an overview of all custom services that are available | ||
5 | within Homer. | 9 | within Homer. |
6 | 10 | ||
7 | If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page. | 11 | If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page. |