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 Public Zulip Server
🐞 Open an issue or feature request in our bug tracker
💠 Reach out to me on Twitter @ArchiveBoxApp or @theSquashSH

Readme | Demo | Quickstart | Usage | Community

🏛️ Need professional support? Hire Us 💬

✨ Or donate to support open-source development ✨

^{ArchiveBox operates as a US 501(c)(3) nonprofit FSP, donations are tax-deductible.
(fiscally sponsored by HCB EIN: 81-2908499)}

_{The name ArchiveBox™️ is trademarked in the US and you can find the ArchiveBox brand kit here.}

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

Getting Started

🔢 Quickstart
🖥️ Install
🐳 Docker
➡️ Supported Sources
⬅️ Supported Outputs

Usage

Reference

Guides

Upgrading
Setting up Storage (NFS/SMB/S3/etc)
Setting up Authentication (SSO/LDAP/etc)
Setting up Search (rg/sonic/etc)
Scheduled Archiving
Publishing Your Archive
Chromium Install
Cookies & Sessions Setup
Merging Collections
Troubleshooting

More Info

✏️ Help improve our documentation...