Usage
Nick Sweeting edited this page 2026-09-01 12:03:28 -07:00

Page revisions

137 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
f95cdf81c9
fix docs 2026-03-15 15:29:02 -07:00
Nick Sweeting
e841d14220 Updated Usage (markdown) 2024-12-04 00:42:08 -08:00
Nick Sweeting
194215bf63 Updated Usage (markdown) 2024-11-02 16:18:14 -04:00
Nick Sweeting
6a95aeb5de
add latest sphinx build 2024-10-04 15:25:22 -07:00
Nick Sweeting
e159c0aad0 Updated Usage (markdown) 2024-09-11 03:52:59 -07:00
Nick Sweeting
4e3399d5c8 Updated Usage (markdown) 2024-05-06 06:23:25 -07:00
Nick Sweeting
6ccf85252c Updated Usage (markdown) 2024-03-19 20:23:50 -07:00
Nick Sweeting
b577fd7631 Updated Usage (markdown) 2024-03-19 18:23:11 -07:00
Nick Sweeting
7dfb5d8d3e Updated Usage (markdown) 2024-03-19 18:21:53 -07:00
Nick Sweeting
088dc10d76 Updated Usage (markdown) 2024-03-19 18:20:57 -07:00
Nick Sweeting
582b168d49 Updated Usage (markdown) 2024-03-19 18:18:43 -07:00
Nick Sweeting
1a2753bb6c Updated Usage (markdown) 2024-03-19 18:14:39 -07:00
Nick Sweeting
2cb6c47e21 Updated Usage (markdown) 2024-03-19 17:54:20 -07:00
Nick Sweeting
99f56b5348 Updated Usage (markdown) 2024-03-19 17:48:58 -07:00
Nick Sweeting
24a1ee84e3 Updated Usage (markdown) 2024-03-19 17:46:32 -07:00
Nick Sweeting
ad3278c4d5 Updated Usage (markdown) 2024-03-19 17:42:07 -07:00
Nick Sweeting
e7a5b6a925 Updated Usage (markdown) 2024-03-19 17:41:13 -07:00
Nick Sweeting
3199d20f66 Updated Usage (markdown) 2024-03-19 17:37:20 -07:00
Nick Sweeting
20a9785506 Updated Usage (markdown) 2024-03-19 17:36:00 -07:00
Nick Sweeting
7817397253 Updated Usage (markdown) 2024-03-19 17:35:01 -07:00
Nick Sweeting
1506dbf0d1 Updated Usage (markdown) 2024-03-19 17:33:27 -07:00
Nick Sweeting
5c2de6d85d Updated Usage (markdown) 2024-03-19 17:32:20 -07:00
Nick Sweeting
5a1e1e3623 Updated Usage (markdown) 2024-03-19 17:21:08 -07:00
Nick Sweeting
72b0d7c70f Updated Usage (markdown) 2024-03-19 17:20:21 -07:00
Nick Sweeting
012d23d7b8 Updated Usage (markdown) 2024-03-19 17:19:26 -07:00
Nick Sweeting
5fc29e1bf3 Updated Usage (markdown) 2024-02-18 18:01:30 -08:00
Nick Sweeting
bdb21ab669 Updated Usage (markdown) 2024-02-18 04:37:27 -08:00
Nick Sweeting
49b2ef86f3 Updated Usage (markdown) 2024-02-18 03:40:01 -08:00
Nick Sweeting
234a8fc8d7 Updated Usage (markdown) 2024-02-08 14:59:48 -08:00
Nick Sweeting
6e8d06ac73 Updated Usage (markdown) 2024-02-08 14:59:03 -08:00
Nick Sweeting
5647c4b7eb Updated Usage (markdown) 2024-02-08 14:58:29 -08:00
Nick Sweeting
9c23f81a81 Updated Usage (markdown) 2024-02-08 14:57:15 -08:00
Nick Sweeting
72b728cccd replace i.imgur.com links with imgur.zervice.io mirror 2024-01-19 01:38:59 -08:00
Nick Sweeting
f685d29844 fix html tags 2024-01-19 01:05:27 -08:00
Nick Sweeting
0ed4ce4d66 Updated Usage (markdown) 2024-01-04 12:47:57 -08:00
Nick Sweeting
a7332e1efd Updated Usage (markdown) 2023-12-19 11:43:06 -08:00
Nick Sweeting
65a5840686 Updated Usage (markdown) 2023-08-15 17:39:33 -07:00
Nick Sweeting
be5b97976e Updated Usage (markdown) 2023-02-19 14:00:38 -08:00
Nick Sweeting
f6b707fdd8 Updated Usage (markdown) 2023-01-31 00:20:43 -08:00
Nick Sweeting
d2f3922939 Updated Usage (markdown) 2023-01-31 00:17:13 -08:00
Nick Sweeting
71d23316d0 Updated Usage (markdown) 2023-01-31 00:16:25 -08:00
Nick Sweeting
74f17530e3 Updated Usage (markdown) 2023-01-31 00:11:56 -08:00
Nick Sweeting
dfdf2d3ba1 Updated Usage (markdown) 2023-01-31 00:11:23 -08:00
Nick Sweeting
5f8b31c498 Updated Usage (markdown) 2023-01-30 23:58:56 -08:00
Nick Sweeting
37f8ab8d4a Updated Usage (markdown) 2023-01-30 23:58:11 -08:00
Nick Sweeting
6e9701456a Updated Usage (markdown) 2023-01-30 23:53:45 -08:00
Nick Sweeting
b3eb4a8274 Updated Usage (markdown) 2022-11-18 14:18:47 -08:00
Nick Sweeting
d32cce629a Updated Usage (markdown) 2022-11-18 14:15:45 -08:00