Publishing Your Archive
Nick Sweeting edited this page 2026-09-01 12:03:28 -07:00

Page revisions

32 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
14aabd2866 Updated Publishing Your Archive (markdown) 2024-05-10 15:42:14 -07:00
Nick Sweeting
f8c2b3e763 Updated Publishing Your Archive (markdown) 2024-05-10 15:41:52 -07:00
Nick Sweeting
bdd15196da Updated Publishing Your Archive (markdown) 2024-05-10 15:37:33 -07:00
Nick Sweeting
87ea011e2d Updated Publishing Your Archive (markdown) 2024-05-10 15:34:13 -07:00
Nick Sweeting
cd5a9c3e54 Updated Publishing Your Archive (markdown) 2024-05-10 15:33:46 -07:00
Nick Sweeting
f99dca1092 Updated Publishing Your Archive (markdown) 2024-05-03 19:04:54 -07:00
Nick Sweeting
a7099684dd Updated Publishing Your Archive (markdown) 2024-05-03 19:02:14 -07:00
Nick Sweeting
21fe946b8e Updated Publishing Your Archive (markdown) 2024-05-03 18:55:09 -07:00
Nick Sweeting
743679aa57 Updated Publishing Your Archive (markdown) 2024-05-03 18:53:51 -07:00
Nick Sweeting
2e4e29c973 Updated Publishing Your Archive (markdown) 2024-05-03 18:44:06 -07:00
Nick Sweeting
1a98129310 Updated Publishing Your Archive (markdown) 2024-05-03 18:40:50 -07:00
Nick Sweeting
ef54ef65c7 Updated Publishing Your Archive (markdown) 2024-05-03 18:39:55 -07:00
Nick Sweeting
c48e32eead Updated Publishing Your Archive (markdown) 2024-05-03 18:37:22 -07:00
Nick Sweeting
7f4d59a27b Updated Publishing Your Archive (markdown) 2024-05-03 18:35:40 -07:00
Nick Sweeting
a4e25425b9 Updated Publishing Your Archive (markdown) 2024-05-03 18:34:42 -07:00
Nick Sweeting
f0928354d3 Updated Publishing Your Archive (markdown) 2024-05-03 18:34:23 -07:00
Nick Sweeting
442f074bd7 Updated Publishing Your Archive (markdown) 2024-05-03 18:34:01 -07:00
Nick Sweeting
4f8df6f334 Updated Publishing Your Archive (markdown) 2024-05-03 18:31:29 -07:00
Nick Sweeting
4230bb5dca Updated Publishing Your Archive (markdown) 2024-05-03 18:29:49 -07:00
Nick Sweeting
f8c688e392 Updated Publishing Your Archive (markdown) 2024-05-03 18:29:24 -07:00
Nick Sweeting
a85a7f18fb Updated Publishing Your Archive (markdown) 2024-05-03 18:28:29 -07:00
Nick Sweeting
189a74c3ce Updated Publishing Your Archive (markdown) 2024-05-03 18:28:06 -07:00
Nick Sweeting
c0788fe9c7 Updated Publishing Your Archive (markdown) 2022-04-12 20:20:12 -04:00
#swipswaps
0ca977864a minor typo: was 'assosciated' 2021-01-25 14:03:45 -05:00
Nick Sweeting
c80265286b Updated Publishing Your Archive (markdown) 2020-12-12 08:54:06 -05:00
Nick Sweeting
160162ee5d Updated Publishing Your Archive (markdown) 2020-12-12 08:53:39 -05:00
Nick Sweeting
e57e974383 Updated Publishing Your Archive (markdown) 2020-12-12 08:52:07 -05:00
Nick Sweeting
f1b6bf6758 add sphinx documentation setup 2019-04-28 16:45:47 -04:00
Nick Sweeting
f74664e041 Updated Publishing Your Archive (markdown) 2019-02-26 21:25:36 -05:00
Nick Sweeting
3a7d908333 Created Publishing Your Archive (markdown) 2018-12-31 19:53:37 -05:00