 Nick Sweeting
|
46b547b88d
|
docs: fix stale config refs across wiki pages + minor typo fixes
Sweep of all prose doc pages to fix references that were stale, wrong,
or pointed at anchors/options that no longer exist in 0.9.x.
Critical (non-functional examples + factual errors):
- All `PUBLIC_SNAPSHOTS=...` examples (Security-Overview, Publishing-
Your-Archive, Usage) replaced with `PERMISSIONS=public|private`.
- Setting-up-Authentication: drop the "edit CSRF_TRUSTED_ORIGINS in
archivebox/core/settings.py source" advice (no longer user-settable);
update auth-permissions list to use PERMISSIONS instead of
PUBLIC_SNAPSHOTS.
- Security-Overview: SAVE_ARCHIVE_DOT_ORG (with extra underscores)
was never real; use ARCHIVEDOTORG_ENABLED.
- Docker/Install/Usage: FETCH_TITLE/FETCH_SCREENSHOT/FETCH_PDF/FETCH_DOM
were never aliases (only FETCH_MEDIA is); replace with real
<PLUGIN>_ENABLED.
- Troubleshooting: CHROME_BINARY default is `chromium`, not
`chromium-browser`. Also fixed deprecated `brew cask upgrade
chromium-browser` -> `brew upgrade --cask chromium`.
- Docker: typo MAX_MEDIA_SIZE -> MEDIA_MAX_SIZE.
Broken Configuration anchors (must be lowercase on GitHub wiki):
- Security-Overview: #FOOTER_INFO / #OUTPUT_PERMISSIONS / #COOKIES_FILE
-> lowercase.
- Setting-up-Authentication: combined #public_index--public_snapshots--public_add_view
-> individual #public_index / #public_add_view / #permissions.
Plugin option references now link to abx-plugins:
- CHROME_USER_DATA_DIR / CHROME_BINARY / CHROME_SANDBOX -> /#chrome
- RIPGREP_BINARY -> /#search_backend_ripgrep
- WGET_ENABLED / DOM_ENABLED / SAVE_WGET / SAVE_DOM -> respective anchors
- ARCHIVEDOTORG_ENABLED -> /#archivedotorg
- FAVICON_PROVIDER / FAVICON_ENABLED -> /#favicon
- MEDIA_ENABLED -> /#media
Legacy aliases:
- Scheduled-Archiving: URL_WHITELIST/URL_BLACKLIST -> URL_ALLOWLIST/
URL_DENYLIST; dropped non-existent `--overwrite` schedule flag.
Dead source links removed:
- Usage: archivebox/main.py + archivebox/config.py (split to cli/ and
config/common.py).
- Security-Overview: archivebox/extractors/*.py -> plugin anchors.
- Install: dead Configuration#dependency-options and
Configuration#archive-method-toggles anchors -> abx-plugins reference.
Typo fixes (codespell):
- preferrably -> preferably, necesary -> necessary, Rasberry ->
Raspberry, sytem -> system, Dissallow -> Disallow, whats -> what's,
filesytem -> filesystem.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
2026-05-31 03:29:27 -07:00 |
|