Tweak config to get better error message. (#509)

* Tweak config to get better error message. * Add note about secrets.
bluesky · Jul 11, 2023 · 5452453 · 5452453
1 parent 540a00a
commit 5452453
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 1 deletion.
diff --git a/docs/source/how-to/docker.md b/docs/source/how-to/docker.md
@@ -13,6 +13,22 @@ It is best practice to use a specific tag instead of `latest`.
 See the [list of tiled image versions on GitHub](https://github.com/bluesky/tiled/pkgs/container/tiled)
 for tags.
 
+```{note}
+
+Some of the examples below set an environment variable
+`TILED_SINGLE_USER_API_KEY` to `secret`, as a placeholder. For actual use, use
+a difficult-to-guess secret. Two equally good ways to generate a secure
+secret...
+
+With ``openssl``:
+
+    openssl rand -hex 32
+
+With ``python``:
+
+    python -c "import secrets; print(secrets.token_hex(32))"
+
+```
 
 ## Example: A writable catalog
 

diff --git a/example_configs/single_catalog_single_user.yml b/example_configs/single_catalog_single_user.yml
@@ -2,7 +2,6 @@ authentication:
   # The default is false. Set to true to enable any HTTP client that can
   # connect to _read_. An API key is still required to write.
   allow_anonymous_access: false
-  single_user_api_key: ${TILED_SINGLE_USER_API_KEY}
 trees:
   - path: /
     tree: catalog