]> git.immae.eu Git - github/bastienwirtz/homer.git/commitdiff
Warn about exposed apikeys 344/head
authorMichael Krieger <phyre@phyre.me>
Mon, 20 Dec 2021 21:11:15 +0000 (16:11 -0500)
committerGitHub <noreply@github.com>
Mon, 20 Dec 2021 21:11:15 +0000 (16:11 -0500)
docs/customservices.md

index 7d475422b33f3bbe63b935a457dec73175a0a0d9..77109b7cb5ac7d95a5c65d368b265a7006d1c7f8 100644 (file)
@@ -1,7 +1,11 @@
 # Custom Services
 
 Some service can use a specific a component that provides some extra features by adding a `type` key to the service yaml
-configuration. Available services are in `src/components/`. Here is an overview of all custom services that are available
+configuration and, where applicable, an apikey. Note that config.yml is exposed at /assets/config.yml via HTTP and any
+apikey included in the configuration file is exposed to anyone who can access the homer instance. Only include an apikey
+if your homer instance is secured behind some form of authentication or access restriction.
+
+Available services are in `src/components/`. Here is an overview of all custom services that are available
 within Homer.
 
 If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page.