Setting up Search
Nick Sweeting edited this page 2026-09-01 12:03:28 -07:00

Page revisions

30 Commits

Author SHA1 Message Date
Nick Sweeting
14751a4942
Sync documentation from ArchiveBox dev 2026-09-01 12:03:28 -07:00
Nick Sweeting
5937a62bda 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
Nick Sweeting
38cc954900
update docs builder to use myst-parser and autodoc2 2024-10-04 19:13:19 -07:00
Nick Sweeting
a04d3fd3e2 Updated Setting up Search (markdown) 2024-08-28 01:43:00 -04:00
Nick Sweeting
f6fea910c6 Updated Setting up Search (markdown) 2024-05-10 15:32:34 -07:00
Nick Sweeting
c1f78e14e9 Updated Setting up Search (markdown) 2024-05-10 15:31:42 -07:00
Nick Sweeting
b6e7f38a5c Updated Setting up Search (markdown) 2024-05-10 15:30:20 -07:00
Nick Sweeting
b083a1ab4f Updated Setting up Search (markdown) 2024-05-10 15:29:46 -07:00
Nick Sweeting
1265953463 Updated Setting up Search (markdown) 2024-05-10 15:29:20 -07:00
Nick Sweeting
7b030067cd Updated Setting up Search (markdown) 2024-05-10 15:28:42 -07:00
Nick Sweeting
e1f76f436d Updated Setting up Search (markdown) 2024-05-10 15:28:00 -07:00
Nick Sweeting
38773e76fd Updated Setting up Search (markdown) 2024-05-10 15:27:18 -07:00
Nick Sweeting
b085a40576 Updated Setting up Search (markdown) 2024-05-10 15:25:49 -07:00
Nick Sweeting
fb4078b392 Updated Setting up Search (markdown) 2024-05-10 15:25:29 -07:00
Nick Sweeting
927fd9e6d7 Updated Setting up Search (markdown) 2024-05-10 15:23:50 -07:00
Nick Sweeting
0620cc9513 Updated Setting up Search (markdown) 2024-05-10 15:23:21 -07:00
Nick Sweeting
dab9c33970 Updated Setting up Search (markdown) 2024-05-10 15:21:36 -07:00
Nick Sweeting
b92a161f8e Updated Setting up Search (markdown) 2024-05-10 15:21:10 -07:00
Nick Sweeting
9926933f5f Updated Setting up Search (markdown) 2024-05-10 14:08:03 -07:00
Nick Sweeting
9f48e6b8ae Updated Setting up Search (markdown) 2024-05-10 13:55:03 -07:00
Nick Sweeting
163142a04c Updated Setting up Search (markdown) 2024-05-07 02:46:46 -07:00
Nick Sweeting
af71cda6f3 Updated Setting up Search (markdown) 2024-05-07 02:45:50 -07:00
Nick Sweeting
41c661d269 Updated Setting up Search (markdown) 2024-05-07 02:43:24 -07:00
Nick Sweeting
133121e2bb Updated Setting up Search (markdown) 2024-05-07 02:42:39 -07:00
Nick Sweeting
9035c2652e Updated Setting up Search (markdown) 2024-05-07 02:42:10 -07:00
Nick Sweeting
fc7ec8ad9e Updated Setting up Search (markdown) 2024-05-07 01:28:12 -07:00
Nick Sweeting
602b8b5359 Updated Setting up Search (markdown) 2024-05-07 01:12:22 -07:00
Nick Sweeting
466cfd8bae Updated Setting up Search (markdown) 2024-05-07 01:09:20 -07:00
Nick Sweeting
78dbe1f0ef Updated Setting up Search (markdown) 2024-05-07 01:03:25 -07:00
Nick Sweeting
d9b180af52 Created Setting up Search (markdown) 2024-05-07 00:45:44 -07:00