From d50dae8a9e20def71dd97d98d875a50fab2668cf Mon Sep 17 00:00:00 2001 From: Nick Sweeting Date: Tue, 23 Jan 2024 14:47:36 -0800 Subject: [PATCH] Updated Configuration (markdown) --- Configuration.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/Configuration.md b/Configuration.md index cfe8728..cde6f03 100644 --- a/Configuration.md +++ b/Configuration.md @@ -50,12 +50,13 @@ This is useful when running ArchiveBox inside Docker as root and you need to exp [`PUID` / `PGID`](#puid--pgid) --- -#### `PUID` / `PGID` +#### `PUID` / `PGID` + **Possible Values:** [`911`]/`1000`/... User and Group ownership to set the output directory and file contents to. **Only settable as environment variables** when using ArchiveBox in Docker. @@ -100,11 +101,12 @@ Maximum allowed download time for fetching media when `SAVE_MEDIA=True` in secon [`SAVE_MEDIA`](#save_media) --- -#### `ADMIN_USERNAME` / `ADMIN_PASSWORD` +#### `ADMIN_USERNAME` / `ADMIN_PASSWORD` + **Possible Values:** [`None`]/`"admin"`/... 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. @@ -122,12 +124,13 @@ Password (again): [`PUBLIC_INDEX / PUBLIC_SNAPSHOTS / PUBLIC_ADD_VIEW`](#public_index) --- -#### `PUBLIC_INDEX` / `PUBLIC_SNAPSHOTS` / `PUBLIC_ADD_VIEW` +#### `PUBLIC_INDEX` / `PUBLIC_SNAPSHOTS` / `PUBLIC_ADD_VIEW` + **Possible Values:** [`False`]/`True` Configure whether or not login is required to use each area of ArchiveBox. @@ -232,6 +235,9 @@ Some text to display in the footer of the archive index. Useful for providing s [`TEMPLATES_DIR`](#templates_dir) --- + + + #### `URL_DENYLIST` **Possible Values:** [`\.(css|js|otf|ttf|woff|woff2|gstatic\.com|googleapis\.com/css)(\?.*)?$`]/`.+\.exe$`/`http(s)?:\/\/(.+)?example.com\/.*`/... @@ -249,12 +255,15 @@ True # this URL would not be archived because it matches the exclusion pattern *Note: all assets required to render each page are still archived, `URL_DENYLIST`/`URL_ALLOWLIST` do not apply to images, css, video, etc. visible inline within the page.* -Note 2: These options used to be called URL_WHITELIST & URL_BLACKLIST before v0.7.1. +Note 2: These options used to be called URL_WHITELIST & URL_BLACKLIST before v0.7.1. *Related options:* [`URL_ALLOWLIST`](#URL_ALLOWLIST), [`SAVE_MEDIA`](#SAVE_MEDIA), [`SAVE_GIT`](#SAVE_GIT), [`GIT_DOMAINS`](#GIT_DOMAINS) --- + + + #### `URL_ALLOWLIST` **Possible Values:** [`None`]/`^http(s)?:\/\/(.+)?example\.com\/?.*$`/...