[![](https://github.com/ArchiveBox/ArchiveBox/assets/511499/acffcee3-d1ec-439d-8278-e481101c3d0d)](Home)

# [Getting Started](Quickstart)

 - 🔢 [[Quickstart]]
 - 🖥️ [[Install]]
 - 🐳 [[Docker]]
 - ➡️ [Supported Sources](https://github.com/ArchiveBox/ArchiveBox/wiki/Quickstart#2-get-your-list-of-urls-to-archive)
 - ⬅️ [Supported Outputs](https://github.com/ArchiveBox/ArchiveBox#output-formats)

# [[Usage]]

 - ﹩[Command Line](Usage#cli-usage)
 - 🌐 [Web UI](Usage#ui-usage)
 - 🧩 [Browser Extension](Usage#browser-extension-usage)
 - 👾 [REST API](https://github.com/ArchiveBox/ArchiveBox/issues/496#issuecomment-2080174235) / [Webhooks](https://github.com/ArchiveBox/ArchiveBox/pull/1418)
 - 📜 [Python API](https://docs.archivebox.io/dev/apidocs/index.html) / [REPL](Usage#python-shell-usage) / [SQL API](Usage#sql-shell-usage)

# Reference

 - ⚙️ [[Configuration]]
 - 📦 [Dependencies](https://github.com/ArchiveBox/ArchiveBox#dependencies)
 - 💿 [Disk Layout](https://github.com/ArchiveBox/ArchiveBox#archive-layout)
 - 🔒 [[Security Overview]]
 - 📝 [Developer Documentation](https://github.com/ArchiveBox/ArchiveBox#archivebox-development)

# Guides

 - [[Upgrading]]
 - [[Setting up Storage]] <small>(NFS/SMB/S3/etc)</small>
 - [[Setting up Authentication]] <small>(SSO/LDAP/etc)</small>
 - [[Setting up Search]] <small>(rg/sonic/etc)</small>
 - [[Scheduled Archiving]]
 - [[Publishing Your Archive]]
 - [[Chromium Install]]
 - [Cookies & Sessions Setup](https://github.com/ArchiveBox/ArchiveBox/wiki/Chromium-Install#setting-up-a-chromium-user-profile)
 - [[Merging Collections]]
 - [[Troubleshooting]]

# More Info

 - ⭐️ [[Web Archiving Community]]
 - [Background & Motivation](https://github.com/ArchiveBox/ArchiveBox#background--motivation)
 - [Comparison to Other Tools](https://github.com/ArchiveBox/ArchiveBox#comparison-to-other-projects)
 - [Architecture Diagram](https://github.com/ArchiveBox/ArchiveBox/wiki/ArchiveBox-Architecture-Diagrams)
 - [Changelog](https://github.com/ArchiveBox/ArchiveBox/releases) & [[Roadmap]]

---

<p align="center">
<a href="https://archivebox.io"><img src="https://github.com/ArchiveBox/ArchiveBox/assets/511499/fd4d3161-3860-4b31-a4e9-251c05f75cdf" height="30px"/></a>
<br/><br/>
<a href="https://github.com/ArchiveBox/ArchiveBox"><img src="https://img.shields.io/github/stars/ArchiveBox/ArchiveBox.svg?logo=github&label=Stars&logoColor=blue"/></a> &nbsp; <a href="https://archivebox-shop.fourthwall.com/"><img src="https://img.shields.io/badge/Merch-%23903851.svg"/></a>
<br/>
<a href="https://hcb.hackclub.com/donations/start/archivebox"><img src="https://img.shields.io/badge/Donate-Directly-%13DE5D26.svg"/></a> &nbsp; <a href="https://github.com/sponsors/pirate"><img src="https://img.shields.io/badge/Github_Sponsors-%23B7CDFE.svg"/></a>
<br/><br/>
<a href="https://zulip.archivebox.io"><img src="https://img.shields.io/badge/Community_Chat_Forum-Zulip-%2328A745.svg"/></a>
</p>