(https://github.githubassets.com) (https://avatars.githubusercontent.com) (https://github-cloud.s3.amazonaws.com) (https://user-images.githubusercontent.com/) (https://github.githubassets.com) (https://avatars.githubusercontent.com) (https://github.githubassets.com/assets/light-3e154969b9f9.css) (https://github.githubassets.com/assets/dark-9c5b7a476542.css) (https://github.githubassets.com/assets/primer-primitives-fd4f6f126b06.css) (https://github.githubassets.com/assets/primer-3f55af1462e6.css) (https://github.githubassets.com/assets/global-561250c1bd8a.css) (https://github.githubassets.com/assets/github-e4eed26e112b.css) (https://github.githubassets.com/assets/repository-0f7cf89e325a.css) (https://github.githubassets.com/assets/wiki-0f9a446f06a3.css) (https://github.githubassets.com/assets/primer-react-css.8570b2718b0a9c0c8387.module.css) (https://github.githubassets.com/assets/notifications-subscriptions-menu.1bcff9205c241e99cff2.module.css) Home · ArchiveBox/ArchiveBox Wiki · GitHub (repo_wiki) (https://github.githubassets.com/) (/opensearch.xml) (GitHub) (https://github.com/fluidicon.png) (GitHub) (https://github.githubassets.com/assets/pinned-octocat-093da3e6fa40.svg) (https://github.githubassets.com/favicons/favicon.png) (https://github.githubassets.com/favicons/favicon.svg) (/manifest.json)  Skip to content   (https://github.githubassets.com/assets/primer-react-css.8570b2718b0a9c0c8387.module.css)   Navigation Menu Toggle navigation         (/)    (/login?return_to=https%3A%2F%2Fgithub.com%2FArchiveBox%2FArchiveBox%2Fwiki) Sign in    Product    (https://github.com/features/actions)   Actions Automate any workflow    (https://github.com/features/packages)   Packages Host and manage packages    (https://github.com/features/security)    Security Find and fix vulnerabilities    (https://github.com/features/codespaces)    Codespaces Instant dev environments    (https://github.com/features/copilot)    GitHub Copilot Write better code with AI    (https://github.com/features/code-review)    Code review Manage code changes    (https://github.com/features/issues)   Issues Plan and track work    (https://github.com/features/discussions)    Discussions Collaborate outside of code      Explore (https://github.com/features) All features   (https://docs.github.com) Documentation     (https://skills.github.com) GitHub Skills     (https://github.blog) Blog         Solutions    By size (https://github.com/enterprise) Enterprise   (https://github.com/team) Teams   (https://github.com/enterprise/startups) Startups     By industry (https://github.com/solutions/industries/healthcare) Healthcare   (https://github.com/solutions/industries/financial-services) Financial services   (https://github.com/solutions/industries/manufacturing) Manufacturing     By use case (https://github.com/solutions/ci-cd) CI/CD & Automation   (https://github.com/solutions/devops) DevOps   (https://github.com/solutions/devsecops) DevSecOps       Resources    Topics (/resources/articles/ai) AI   (/resources/articles/devops) DevOps   (/resources/articles/security) Security   (/resources/articles/software-development) Software Development   (/resources/articles) View all     Explore (https://resources.github.com/learn/pathways) Learning Pathways     (https://resources.github.com) White papers, Ebooks, Webinars     (https://github.com/customer-stories) Customer Stories   (https://partner.github.com) Partners         Open Source    (/sponsors) GitHub Sponsors Fund open source developers      (https://github.com/readme) The ReadME Project GitHub community articles      Repositories (https://github.com/topics) Topics   (https://github.com/trending) Trending   (https://github.com/collections) Collections       Enterprise    (/enterprise)     Enterprise platform AI-powered developer platform      Available add-ons (https://github.com/enterprise/advanced-security)    Advanced Security Enterprise-grade security features    (/features/copilot#enterprise)    GitHub Copilot Enterprise-grade AI features    (/premium-support)    Premium Support Enterprise-grade 24/7 support        (https://github.com/pricing) Pricing    (Search or jump to...)    Search or jump to...      Search code, repositories, users, issues, pull requests... Search        ()   Clear                (https://docs.github.com/search-github/github-code-search/understanding-github-code-search-syntax) Search syntax tips           Provide feedback         (bqjFmFKlQCNcLcaoJDKSIGYhAs0Bt4Kch/2Uz1ikNXMSyR3YirIkIDFLCB9tVRvYpaixvt6n6KPSiO4ptXZEvg==) We read every piece of feedback, and take your input very seriously.  Include my email address so I can be contacted    Cancel  Submit feedback     Saved searches  Use saved searches to filter your results more quickly         (scPjG7XwGcUXJbxyZ2dj/FFt6Z1zYslFu6WCb9SJvml1k76TPqudnRIcqlxxCzJAuXUc8nwunoFPjnyXCZ6h9A==)  Name (github-ruby) (6dm1W+vD5IlRSgqFVFfjcJN0irqFFcPgCVbYl93O0XIsFWfANSs06/z0ehXd+12DDjJjbB1lsCq5ligr6bQmaQ==)   Query ((repo:mona/a OR repo:mona/b) AND lang:python)  To see all available qualifiers, see our (https://docs.github.com/search-github/github-code-search/understanding-github-code-search-syntax) documentation .        Cancel  Create saved search        (/login?return_to=https%3A%2F%2Fgithub.com%2FArchiveBox%2FArchiveBox%2Fwiki) Sign in   (/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Fwiki%2Findex&source=header-repo&source_repo=ArchiveBox%2FArchiveBox) Sign up  Reseting focus        You signed in with another tab or window. () Reload to refresh your session. You signed out in another tab or window. () Reload to refresh your session. You switched accounts on another tab or window. () Reload to refresh your session.    Dismiss alert        (/ArchiveBox) ArchiveBox   / (/ArchiveBox/ArchiveBox) ArchiveBox   Public     Sponsor    Sponsor ArchiveBox/ArchiveBox                   (/login?return_to=%2FArchiveBox%2FArchiveBox)   Notifications  You must be signed in to change notification settings  (/login?return_to=%2FArchiveBox%2FArchiveBox)   Fork (1,113) 1.1k   (/login?return_to=%2FArchiveBox%2FArchiveBox)   Star  (20,696) 20.7k        (/ArchiveBox/ArchiveBox)   Code (Not available)    (/ArchiveBox/ArchiveBox/issues)    Issues (162) 162   (/ArchiveBox/ArchiveBox/pulls)   Pull requests (3) 3   (/ArchiveBox/ArchiveBox/discussions)   Discussions (Not available)    (/ArchiveBox/ArchiveBox/actions)   Actions (Not available)    (/ArchiveBox/ArchiveBox/projects)   Projects (1) 1   (/ArchiveBox/ArchiveBox/wiki)   Wiki (Not available)    (/ArchiveBox/ArchiveBox/security)   Security (1) 1   (/ArchiveBox/ArchiveBox/pulse)   Insights (Not available)        Additional navigation options (/ArchiveBox/ArchiveBox)    Code    (/ArchiveBox/ArchiveBox/issues)     Issues    (/ArchiveBox/ArchiveBox/pulls)    Pull requests    (/ArchiveBox/ArchiveBox/discussions)    Discussions    (/ArchiveBox/ArchiveBox/actions)    Actions    (/ArchiveBox/ArchiveBox/projects)    Projects    (/ArchiveBox/ArchiveBox/wiki)    Wiki    (/ArchiveBox/ArchiveBox/security)    Security    (/ArchiveBox/ArchiveBox/pulse)    Insights               Home Jump to bottom   Nick Sweeting edited this page (Apr 16, 2024, 9:09 PM UTC) Apr 16, 2024 · (/ArchiveBox/ArchiveBox/wiki/Home/_history) 66 revisions   ArchiveBox Documentation      📖 Use the sidebar on the right to browse documentation topics ➡️  (Expand the Pages section to 🔍 Search for a specific term)  📚 If you need help or have a question, you can:  💬 Chat with us on our (https://zulip.archivebox.io) Public Zulip Server  🐞 Open an (https://github.com/ArchiveBox/ArchiveBox/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) issue or feature request in our bug tracker 💠 Reach out to me on Twitter (https://twitter.com/ArchiveBoxApp) @ArchiveBoxApp or (https://twitter.com/theSquashSH) @theSquashSH   (CLI Screenshot) (Desktop index screenshot) (Desktop details page Screenshot) (https://github.com/ArchiveBox/ArchiveBox) Readme | (https://archive.sweeting.me/) Demo | (https://github.com/ArchiveBox/ArchiveBox/wiki/Quickstart) Quickstart | (https://github.com/ArchiveBox/ArchiveBox/wiki/Usage) Usage | (https://github.com/ArchiveBox/ArchiveBox/wiki/Web-Archiving-Community) Community  🏛️ (https://docs.sweeting.me/s/archivebox-consulting-services) Contact us for professional support 💬  ✨ Or donate to support open-source development ✨  (https://hcb.hackclub.com/donations/start/archivebox) ()  (https://www.patreon.com/theSquashSH) ()  (https://github.com/sponsors/pirate) ()   ArchiveBox operates as a US 501(c)(3) nonprofit, (https://hcb.hackclub.com/donations/start/archivebox) donations are tax-deductible.(fiscally sponsored by (https://hackclub.com/hcb?ref=donation) HCB EIN: 81-2908499 ) The name ArchiveBox™️ is trademarked in the US and you can find the (https://www.stickermule.com/studio/brand-kits/06f665c3-5b24-4da7-98b3-61d68d3996a0) ArchiveBox brand kit here.   (https://github.com/ArchiveBox/ArchiveBox/issues/new?assignees=&labels=&template=documentation_change.md&title=) ✏️ Help improve our documentation...   ()          Toggle table of contents Pages (37) 37    (Find a page…)     Loading    (/ArchiveBox/ArchiveBox/wiki) Home    (/ArchiveBox/ArchiveBox/wiki#archivebox-documentation) ArchiveBox Documentation        Loading    (/ArchiveBox/ArchiveBox/wiki/archivebox) archivebox          Loading    (/ArchiveBox/ArchiveBox/wiki/archivebox.cli) archivebox.cli          Loading    (/ArchiveBox/ArchiveBox/wiki/archivebox.config) archivebox.config          Loading    (/ArchiveBox/ArchiveBox/wiki/archivebox.core) archivebox.core          Loading    (/ArchiveBox/ArchiveBox/wiki/archivebox.core.migrations) archivebox.core.migrations          Loading    (/ArchiveBox/ArchiveBox/wiki/archivebox.core.templatetags) archivebox.core.templatetags          Loading    (/ArchiveBox/ArchiveBox/wiki/archivebox.extractors) archivebox.extractors          Loading    (/ArchiveBox/ArchiveBox/wiki/archivebox.index) archivebox.index          Loading    (/ArchiveBox/ArchiveBox/wiki/archivebox.parsers) archivebox.parsers          Loading    (/ArchiveBox/ArchiveBox/wiki/archivebox.search) archivebox.search          Loading    (/ArchiveBox/ArchiveBox/wiki/archivebox.search.backends) archivebox.search.backends          Loading    (/ArchiveBox/ArchiveBox/wiki/archivebox.vendor) archivebox.vendor          Loading    (/ArchiveBox/ArchiveBox/wiki/Changelog) Changelog          Loading    (/ArchiveBox/ArchiveBox/wiki/Chromium-Install) Chromium Install          Loading    (/ArchiveBox/ArchiveBox/wiki/Configuration) Configuration          Loading    (/ArchiveBox/ArchiveBox/wiki/Contents) Contents          Loading    (/ArchiveBox/ArchiveBox/wiki/Docker) Docker          Loading    (/ArchiveBox/ArchiveBox/wiki/Donations) Donations          Loading    (/ArchiveBox/ArchiveBox/wiki/index) index          Loading    (/ArchiveBox/ArchiveBox/wiki/Install) Install          Loading    (/ArchiveBox/ArchiveBox/wiki/Merging-Collections) Merging Collections          Loading    (/ArchiveBox/ArchiveBox/wiki/modules) modules          Loading    (/ArchiveBox/ArchiveBox/wiki/Publishing-Your-Archive) Publishing Your Archive          Loading    (/ArchiveBox/ArchiveBox/wiki/Quickstart) Quickstart          Loading    (/ArchiveBox/ArchiveBox/wiki/README) README          Loading    (/ArchiveBox/ArchiveBox/wiki/Roadmap) Roadmap          Loading    (/ArchiveBox/ArchiveBox/wiki/Scheduled-Archiving) Scheduled Archiving          Loading    (/ArchiveBox/ArchiveBox/wiki/Security-Overview) Security Overview          Loading    (/ArchiveBox/ArchiveBox/wiki/Setting-up-Authentication) Setting up Authentication          Loading    (/ArchiveBox/ArchiveBox/wiki/Setting-up-Search) Setting up Search          Loading    (/ArchiveBox/ArchiveBox/wiki/Setting-Up-Storage) Setting Up Storage          Loading    (/ArchiveBox/ArchiveBox/wiki/Troubleshooting) Troubleshooting          Loading    (/ArchiveBox/ArchiveBox/wiki/Upgrading) Upgrading          Loading    (/ArchiveBox/ArchiveBox/wiki/Upgrading-or-Merging-Archives) Upgrading or Merging Archives          Loading    (/ArchiveBox/ArchiveBox/wiki/Usage) Usage          Loading    (/ArchiveBox/ArchiveBox/wiki/Web-Archiving-Community) Web Archiving Community       Show 22 more pages…       (wiki/Home) ()   (wiki/Quickstart) Getting Started      🔢 (/ArchiveBox/ArchiveBox/wiki/Quickstart) Quickstart  🖥️ (/ArchiveBox/ArchiveBox/wiki/Install) Install  🐳 (/ArchiveBox/ArchiveBox/wiki/Docker) Docker  ➡️ (https://github.com/ArchiveBox/ArchiveBox/wiki/Quickstart#2-get-your-list-of-urls-to-archive) Supported Sources  ⬅️ (https://github.com/ArchiveBox/ArchiveBox#output-formats) Supported Outputs   (/ArchiveBox/ArchiveBox/wiki/Usage) Usage      ﹩(wiki/Usage#cli-usage) Command Line  🌐 (wiki/Usage#ui-usage) Web UI  🧩 (wiki/Usage#browser-extension-usage) Browser Extension  👾 (https://github.com/ArchiveBox/ArchiveBox/issues/496#issuecomment-2080174235) REST API / (https://github.com/ArchiveBox/ArchiveBox/pull/1418) Webhooks  📜 (https://docs.archivebox.io/en/latest/modules.html) Python API / (wiki/Usage#python-shell-usage) REPL / (wiki/Usage#sql-shell-usage) SQL API   Reference     ⚙️ (/ArchiveBox/ArchiveBox/wiki/Configuration) Configuration  📦 (https://github.com/ArchiveBox/ArchiveBox#dependencies) Dependencies  💿 (https://github.com/ArchiveBox/ArchiveBox#archive-layout) Disk Layout  🔒 (/ArchiveBox/ArchiveBox/wiki/Security-Overview) Security Overview  📝 (https://github.com/ArchiveBox/ArchiveBox#archivebox-development) Developer Documentation   Guides     (/ArchiveBox/ArchiveBox/wiki/Upgrading) Upgrading  (/ArchiveBox/ArchiveBox/wiki/Setting-Up-Storage) Setting up Storage (NFS/SMB/S3/etc)  (/ArchiveBox/ArchiveBox/wiki/Setting-up-Authentication) Setting up Authentication (SSO/LDAP/etc)  (/ArchiveBox/ArchiveBox/wiki/Setting-up-Search) Setting up Search (rg/sonic/etc)  (/ArchiveBox/ArchiveBox/wiki/Scheduled-Archiving) Scheduled Archiving  (/ArchiveBox/ArchiveBox/wiki/Publishing-Your-Archive) Publishing Your Archive  (/ArchiveBox/ArchiveBox/wiki/Chromium-Install) Chromium Install  (https://github.com/ArchiveBox/ArchiveBox/wiki/Chromium-Install#setting-up-a-chromium-user-profile) Cookies & Sessions Setup  (/ArchiveBox/ArchiveBox/wiki/Merging-Collections) Merging Collections  (/ArchiveBox/ArchiveBox/wiki/Troubleshooting) Troubleshooting   More Info     ⭐️ (/ArchiveBox/ArchiveBox/wiki/Web-Archiving-Community) Web Archiving Community  (https://github.com/ArchiveBox/ArchiveBox#background--motivation) Background & Motivation  (https://github.com/ArchiveBox/ArchiveBox#comparison-to-other-projects) Comparison to Other Tools  (https://github.com/ArchiveBox/ArchiveBox/releases) Changelog & (/ArchiveBox/ArchiveBox/wiki/Roadmap) Roadmap   (https://archivebox.io)  (https://github.com/ArchiveBox/ArchiveBox)  (https://hcb.hackclub.com/donations/start/archivebox)  (https://github.com/sponsors/pirate)  (https://www.patreon.com/theSquashSH)  (https://zulip.archivebox.io)      Clone this wiki locally (https://github.com/ArchiveBox/ArchiveBox.wiki.git)                     Footer (GitHub) (https://github.com)    © 2024 GitHub, Inc.   Footer navigation (https://docs.github.com/site-policy/github-terms/github-terms-of-service) Terms  (https://docs.github.com/site-policy/privacy-policies/github-privacy-statement) Privacy  (https://github.com/security) Security  (https://www.githubstatus.com/) Status  (https://docs.github.com/) Docs  (https://support.github.com?tags=dotcom-footer) Contact  Manage cookies    Do not share my personal information              You can’t perform that action at this time.