From c14a9ba7de0558d47056aa1f26f575ec53617ad1 Mon Sep 17 00:00:00 2001 From: Nick Sweeting Date: Tue, 23 Jan 2024 14:41:22 -0800 Subject: [PATCH] Updated Configuration (markdown) --- Configuration.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/Configuration.md b/Configuration.md index 4b4fd18..3b57deb 100644 --- a/Configuration.md +++ b/Configuration.md @@ -98,14 +98,27 @@ Maximum allowed download time for fetching media when `SAVE_MEDIA=True` in secon #### `ADMIN_USERNAME` / `ADMIN_PASSWORD` **Possible Values:** [`None`]/`"admin"`/... -Only used on first run / initial setup. ArchiveBox will create an admin user with the specified username and password when these options are found in the environment. +Only used on first run / initial setup in Docker. ArchiveBox will create an admin user with the specified username and password when these options are found in the environment. Useful for setting up a Docker instance of ArchiveBox without needing to run a shell command to create the admin user. +Equivalent to: +```bash +$ archivebox manage createsuperuser +Username: +Password: +Password (again): +``` + *Related options:* -[`PUBLIC_INDEX`](#public_index) +[`PUBLIC_INDEX / PUBLIC_SNAPSHOTS / PUBLIC_ADD_VIEW`](#public_index) --- #### `PUBLIC_INDEX` / `PUBLIC_SNAPSHOTS` / `PUBLIC_ADD_VIEW` + + + + + **Possible Values:** [`False`]/`True` Configure whether or not login is required to use each area of ArchiveBox.