2019-01-23 02:58:24 +00:00
< div align = "center" >
2023-11-20 01:35:19 +00:00
< em > < img src = "https://archivebox.io/icon.png" height = "90px" > < / em >
2021-01-22 15:31:37 +00:00
< h1 > ArchiveBox< br / > < sub > Open-source self-hosted web archiving.< / sub > < / h1 >
2019-01-23 02:58:24 +00:00
2023-11-09 06:07:27 +00:00
< br / >
2020-11-23 07:04:39 +00:00
▶️ < a href = "https://github.com/ArchiveBox/ArchiveBox/wiki/Quickstart" > Quickstart< / a > |
2021-04-08 07:33:01 +00:00
< a href = "https://demo.archivebox.io" > Demo< / a > |
2021-06-07 12:03:20 +00:00
< a href = "https://github.com/ArchiveBox/ArchiveBox" > GitHub< / a > |
2020-11-23 07:04:39 +00:00
< a href = "https://github.com/ArchiveBox/ArchiveBox/wiki" > Documentation< / a > |
2020-08-18 15:34:28 +00:00
< a href = "#background--motivation" > Info & Motivation< / a > |
2024-01-04 21:58:33 +00:00
< a href = "https://github.com/ArchiveBox/ArchiveBox/wiki/Web-Archiving-Community" > Community< / a >
2019-01-23 04:46:49 +00:00
2023-11-09 06:07:27 +00:00
< br / >
2019-01-23 04:13:38 +00:00
2019-04-12 17:59:22 +00:00
<!-- <a href="http://webchat.freenode.net?channels=ArchiveBox&uio=d4"><img src="https://img.shields.io/badge/Community_chat - IRC - %2328A745.svg"/></a> -->
2020-07-23 16:32:40 +00:00
2023-09-18 14:37:35 +00:00
< a href = "https://github.com/ArchiveBox/ArchiveBox/blob/dev/LICENSE" > < img src = "https://img.shields.io/badge/Open_source-MIT-green.svg?logo=git&logoColor=green" / > < / a >
2020-11-23 07:04:39 +00:00
< 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 >
2024-01-04 21:58:33 +00:00
< a href = "https://github.com/ArchiveBox/ArchiveBox/commits/dev" > < img src = "https://img.shields.io/github/last-commit/ArchiveBox/ArchiveBox.svg?logo=Sublime+Text&logoColor=green&label=Active" / > < / a >
2023-01-31 08:23:34 +00:00
< a href = "https://pypi.org/project/archivebox/" > < img src = "https://img.shields.io/badge/Python-yellow.svg?logo=python&logoColor=yellow" / > < / a >
2023-01-31 07:08:44 +00:00
< a href = "https://github.com/ArchiveBox/ArchiveBox/wiki/Install#dependencies" > < img src = "https://img.shields.io/badge/Chromium-orange.svg?logo=Google+Chrome&logoColor=orange" / > < / a >
< a href = "https://hub.docker.com/r/archivebox/archivebox" > < img src = "https://img.shields.io/badge/Docker-lightblue.svg?logo=docker&logoColor=lightblue" / > < / a >
2023-11-09 06:02:49 +00:00
2023-11-09 06:07:27 +00:00
<!-- <pre lang="bash" align="left"><code style="white - space: pre - line; text - align: left" align="left">
2023-11-09 06:03:14 +00:00
curl -sSL 'https://get.archivebox.io' | sh # (or see pip/brew/Docker instructions below)
2023-11-09 06:07:27 +00:00
< / code > < / pre > -->
2023-11-09 06:02:49 +00:00
2019-07-09 16:51:00 +00:00
< hr / >
2019-01-23 03:00:21 +00:00
< / div >
2023-11-08 10:49:51 +00:00
**ArchiveBox is a powerful, self-hosted internet archiving solution to collect, save, and view websites offline.**
2020-10-10 20:08:52 +00:00
2023-11-19 21:45:00 +00:00
Without active preservation effort, everything on the internet eventually dissapears or degrades. Archive.org does a great job as a free central archive, but they require all archives to be public, and they can't save every type of content.
2023-11-09 06:26:55 +00:00
2023-11-19 21:45:58 +00:00
*ArchiveBox is an open source tool that helps you archive web content on your own (or privately within an organization): save copies of browser bookmarks, preserve evidence for legal cases, backup photos from FB / Insta / Flickr, download your media from YT / Soundcloud / etc., snapshot research papers & academic citations, and more...*
2023-11-09 06:26:33 +00:00
2023-11-09 05:40:30 +00:00
> ➡️ *Use ArchiveBox as a [command-line package](#quickstart) and/or [self-hosted web app](#quickstart) on Linux, macOS, or in [Docker](#quickstart).*
2021-04-08 14:47:06 +00:00
2023-11-09 06:40:06 +00:00
< hr / >
2023-11-08 10:54:03 +00:00
2023-11-09 06:39:20 +00:00
📥 **You can feed ArchiveBox URLs one at a time, or schedule regular imports** from browser bookmarks or history, feeds like RSS, bookmark services like Pocket/Pinboard, and more. See < a href = "#input-formats" > input formats</ a > for a full list.
2021-01-21 02:34:23 +00:00
2023-11-09 06:11:56 +00:00
< img src = "https://github.com/ArchiveBox/ArchiveBox/assets/511499/90f1ce3c-75bb-401d-88ed-6297694b76ae" alt = "snapshot detail page" align = "right" width = "190px" / >
2023-11-09 06:42:20 +00:00
💾 **It saves snapshots of the URLs you feed it in several redundant formats.**
It also detects any content featured *inside* each webpage & extracts it out into a folder:
2023-12-19 16:25:51 +00:00
- `HTML/Generic websites -> HTML, PDF, PNG, WARC, Singlefile`
2023-11-14 04:00:48 +00:00
- `YouTube/SoundCloud/etc. -> MP3/MP4 + subtitles, description, thumbnail`
2023-12-19 16:25:51 +00:00
- `News articles -> article body TXT + title, author, featured images`
- `Github/Gitlab/etc. links -> git cloned source code`
2023-11-09 06:07:27 +00:00
- *[and more...](#output-formats)*
2021-04-08 11:21:04 +00:00
2023-11-14 04:05:04 +00:00
It uses normal filesystem folders to organize archives (no complicated proprietary formats), and offers a CLI + web UI.
2023-11-09 06:26:33 +00:00
2023-11-09 06:33:56 +00:00
---
2023-11-08 10:27:40 +00:00
2023-11-09 06:24:21 +00:00
🏛️ ArchiveBox is used by many *[professionals](https://zulip.archivebox.io/#narrow/stream/167-enterprise/topic/welcome/near/1191102) and [hobbyists](https://zulip.archivebox.io/#narrow/stream/158-development)* who save content off the web, for example:
2023-11-08 10:29:16 +00:00
2023-11-08 10:48:41 +00:00
- **Individuals:**
2023-11-09 05:58:16 +00:00
`backing up browser bookmarks/history` , `saving FB/Insta/etc. content` , `shopping lists`
2023-11-08 10:48:41 +00:00
- **Journalists:**
`crawling and collecting research` , `preserving quoted material` , `fact-checking and review`
- **Lawyers:**
`evidence collection` , `hashing & integrity verifying` , `search, tagging, & review`
- **Researchers:**
2023-11-14 04:06:57 +00:00
`collecting AI training sets` , `feeding analysis / web crawling pipelines`
2021-04-08 11:21:04 +00:00
2023-11-08 10:19:06 +00:00
The goal is to sleep soundly knowing the part of the internet you care about will be automatically preserved in durable, easily accessible formats [for decades ](#background--motivation ) after it goes down.
2023-11-08 10:11:55 +00:00
2021-04-08 11:43:09 +00:00
< div align = "center" >
< br / > < br / >
2024-01-04 20:29:38 +00:00
< img src = "https://github.com/ArchiveBox/ArchiveBox/assets/511499/5a7d95f2-6977-4de6-9f08-42851a1fe1d2" height = "70px" alt = "bookshelf graphic" > < img src = "https://github.com/ArchiveBox/ArchiveBox/assets/511499/b2765a33-0d1e-4019-a1db-920c7e00e20e" height = "75px" alt = "logo" align = "top" / > < img src = "https://github.com/ArchiveBox/ArchiveBox/assets/511499/5a7d95f2-6977-4de6-9f08-42851a1fe1d2" height = "70px" alt = "bookshelf graphic" >
2021-04-08 11:43:09 +00:00
< br / > < br / >
< small > < a href = "https://demo.archivebox.io" > Demo< / a > | < a href = "#screenshots" > Screenshots< / a > | < a href = "https://github.com/ArchiveBox/ArchiveBox/wiki/Usage" > Usage< / a > < / small >
2021-04-08 11:31:47 +00:00
< br / >
2021-04-08 11:43:09 +00:00
< sub > . . . . . . . . . . . . . . . . . . . . . . . . . . . .< / sub >
< br / > < br / >
< / div >
2021-04-08 11:31:47 +00:00
2021-04-08 11:43:09 +00:00
< br / >
2021-04-08 11:31:47 +00:00
2023-06-14 00:35:00 +00:00
**📦 Get ArchiveBox with `docker` / `apt` / `brew` / `pip3` / `nix` / etc. ([see Quickstart below](#quickstart)).**
2021-04-08 11:43:09 +00:00
2021-01-21 02:04:56 +00:00
```bash
2023-06-14 00:35:00 +00:00
# Get ArchiveBox with Docker or Docker Compose (recommended)
docker run -v $PWD/data:/data -it archivebox/archivebox:dev init --setup
# Or install with your preferred package manager (see Quickstart below for apt, brew, and more)
2021-10-26 06:02:23 +00:00
pip3 install archivebox
2023-06-14 00:35:00 +00:00
# Or use the optional auto setup script to install it
2021-04-24 06:41:29 +00:00
curl -sSL 'https://get.archivebox.io' | sh
2021-04-08 11:21:04 +00:00
```
2021-04-24 05:45:36 +00:00
**🔢 Example usage: adding links to archive.**
2021-04-08 11:21:04 +00:00
```bash
2023-06-14 00:43:40 +00:00
archivebox add 'https://example.com' # add URLs one at a time
archivebox add < ~/Downloads/bookmarks.json # or pipe in URLs in any text-based format
archivebox schedule --every=day --depth=1 https://example.com/rss.xml # or auto-import URLs regularly on a schedule
2021-01-21 02:34:23 +00:00
```
2021-04-24 05:45:36 +00:00
**🔢 Example usage: viewing the archived content.**
2021-01-21 02:34:23 +00:00
```bash
2021-04-08 11:53:20 +00:00
archivebox server 0.0.0.0:8000 # use the interactive web UI
archivebox list 'https://example.com' # use the CLI commands (--help for more)
ls ./archive/*/index.json # or browse directly via the filesystem
2021-01-21 02:34:23 +00:00
```
2021-01-20 04:17:54 +00:00
2021-01-21 01:44:17 +00:00
< div align = "center" >
< br / > < br / >
2024-01-04 20:29:38 +00:00
< img src = "https://github.com/ArchiveBox/ArchiveBox/assets/511499/8d67382c-e0ce-4286-89f7-7915f09b930c" width = "22%" alt = "cli init screenshot" align = "top" >
< img src = "https://github.com/ArchiveBox/ArchiveBox/assets/511499/dad2bc51-e7e5-484e-bb26-f956ed692d16" width = "22%" alt = "cli init screenshot" align = "top" >
< img src = "https://github.com/ArchiveBox/ArchiveBox/assets/511499/e8e0b6f8-8fdf-4b7f-8124-c10d8699bdb2" width = "22%" alt = "server snapshot admin screenshot" align = "top" >
< img src = "https://github.com/ArchiveBox/ArchiveBox/assets/511499/ace0954a-ddac-4520-9d18-1c77b1ec50b2" width = "28.6%" alt = "server snapshot details page screenshot" align = "top" / >
2021-04-08 12:20:38 +00:00
< br / > < br / >
2021-01-21 01:44:17 +00:00
< / div >
2021-04-08 10:47:45 +00:00
## Key Features
2023-09-18 14:37:35 +00:00
- [**Free & open source** ](https://github.com/ArchiveBox/ArchiveBox/blob/dev/LICENSE ), doesn't require signing up online, stores all data locally
2021-04-08 10:47:45 +00:00
- [**Powerful, intuitive command line interface** ](https://github.com/ArchiveBox/ArchiveBox/wiki/Usage#CLI-Usage ) with [modular optional dependencies ](#dependencies )
- [**Comprehensive documentation** ](https://github.com/ArchiveBox/ArchiveBox/wiki ), [active development ](https://github.com/ArchiveBox/ArchiveBox/wiki/Roadmap ), and [rich community ](https://github.com/ArchiveBox/ArchiveBox/wiki/Web-Archiving-Community )
2023-11-08 10:58:28 +00:00
- [**Extracts a wide variety of content out-of-the-box** ](https://github.com/ArchiveBox/ArchiveBox/issues/51 ): [media (yt-dlp), articles (readability), code (git), etc. ](#output-formats )
2021-04-08 10:47:45 +00:00
- [**Supports scheduled/realtime importing** ](https://github.com/ArchiveBox/ArchiveBox/wiki/Scheduled-Archiving ) from [many types of sources ](#input-formats )
2023-11-08 08:57:22 +00:00
- [**Uses standard, durable, long-term formats** ](#saves-lots-of-useful-stuff-for-each-imported-link ) like HTML, JSON, PDF, PNG, MP4, TXT, and WARC
2021-04-08 10:47:45 +00:00
- [**Usable as a oneshot CLI** ](https://github.com/ArchiveBox/ArchiveBox/wiki/Usage#CLI-Usage ), [**self-hosted web UI** ](https://github.com/ArchiveBox/ArchiveBox/wiki/Usage#UI-Usage ), [Python API ](https://docs.archivebox.io/en/latest/modules.html ) (BETA), [REST API ](https://github.com/ArchiveBox/ArchiveBox/issues/496 ) (ALPHA), or [desktop app ](https://github.com/ArchiveBox/electron-archivebox ) (ALPHA)
2022-03-03 13:04:19 +00:00
- [**Saves all pages to archive.org as well** ](https://github.com/ArchiveBox/ArchiveBox/wiki/Configuration#save_archive_dot_org ) by default for redundancy (can be [disabled ](https://github.com/ArchiveBox/ArchiveBox/wiki/Security-Overview#stealth-mode ) for local-only mode)
2021-12-17 22:55:40 +00:00
- Advanced users: support for archiving [content requiring login/paywall/cookies ](https://github.com/ArchiveBox/ArchiveBox/wiki/Configuration#chrome_user_data_dir ) (see wiki security caveats!)
2023-11-14 04:07:28 +00:00
- Planned: support for running [JS during archiving ](https://github.com/ArchiveBox/ArchiveBox/issues/51 ) to adblock, [autoscroll ](https://github.com/ArchiveBox/ArchiveBox/issues/80 ), [modal-hide ](https://github.com/ArchiveBox/ArchiveBox/issues/175 ), [thread-expand ](https://github.com/ArchiveBox/ArchiveBox/issues/345 )
2023-11-08 09:53:27 +00:00
2023-11-08 10:03:11 +00:00
< br / >
## 🤝 Professional Integration
2023-11-08 09:53:27 +00:00
*[Contact us](https://zulip.archivebox.io/#narrow/stream/167-enterprise/topic/welcome/near/1191102) if your non-profit institution/org wants to use ArchiveBox professionally.*
- setup & support, team permissioning, hashing, audit logging, backups, custom archiving etc.
2023-11-08 11:02:47 +00:00
- for **individuals** , **NGOs** , **academia** , **governments** , **journalism** , **law** , and more...
2021-04-08 10:47:45 +00:00
2023-11-09 05:58:16 +00:00
*All our work is open-source and primarily geared towards non-profits.*
2023-11-08 11:01:06 +00:00
*Support/consulting pays for hosting and funds new ArchiveBox open-source development.*
2023-11-08 10:03:11 +00:00
< br / >
2021-01-21 01:34:27 +00:00
2021-01-20 20:24:10 +00:00
< div align = "center" >
2021-01-20 20:37:06 +00:00
< br / >
2024-01-04 20:29:38 +00:00
< img src = "https://github.com/ArchiveBox/ArchiveBox/assets/511499/0db52ea7-4a2c-441d-b47f-5553a5d8fe96" width = "49%" alt = "grass" / > < img src = "https://github.com/ArchiveBox/ArchiveBox/assets/511499/0db52ea7-4a2c-441d-b47f-5553a5d8fe96" width = "49%" alt = "grass" / >
2021-01-20 20:24:10 +00:00
< / div >
2021-04-08 12:20:38 +00:00
# Quickstart
2021-01-21 02:39:44 +00:00
2023-12-19 16:25:51 +00:00
**🖥 Supported OSs:** Linux/BSD, macOS, Windows (Docker) ** 👾 CPUs:** `amd64` (`x86_64`), `arm64` (`arm8`), `arm7` < sup > (raspi>=3)</ sup >< br />
2023-12-19 16:30:37 +00:00
< sub > Note: On `arm7` the `playwright` package is not available, so `chromium` must be installed manually if needed.</ sub >
2021-04-24 05:24:37 +00:00
2021-05-07 12:43:09 +00:00
< br / >
2021-04-27 18:58:16 +00:00
2021-05-07 12:43:09 +00:00
#### ✳️ Easy Setup
2021-05-07 12:26:42 +00:00
2020-12-11 20:46:34 +00:00
< details >
2021-05-07 12:50:44 +00:00
< summary > < b > < img src = "https://user-images.githubusercontent.com/511499/117447182-29758200-af0b-11eb-97bd-58723fee62ab.png" alt = "Docker" height = "28px" align = "top" / > < code > docker-compose< / code > < / b > (macOS/Linux/Windows) < b > 👈 recommended< / b > < i > (click to expand)< / i > < / summary >
2021-05-07 12:50:00 +00:00
< br / >
2023-12-19 16:30:37 +00:00
< i > 👍 Docker Compose is recommended for the easiest install/update UX + best security + all the < a href = "#dependencies" > extras< / a > out-of-the-box.< / i >
2021-05-07 12:53:03 +00:00
< br / > < br / >
2021-04-23 22:27:30 +00:00
< ol >
2021-04-23 22:37:57 +00:00
< li > Install < a href = "https://docs.docker.com/get-docker/" > Docker< / a > and < a href = "https://docs.docker.com/compose/install/#install-using-pip" > Docker Compose< / a > on your system (if not already installed).< / li >
2023-09-18 14:37:35 +00:00
< li > Download the < a href = "https://raw.githubusercontent.com/ArchiveBox/ArchiveBox/dev/docker-compose.yml" download > < code > docker-compose.yml< / code > < / a > file into a new empty directory (can be anywhere).
2021-04-23 22:49:24 +00:00
< pre lang = "bash" > < code style = "white-space: pre-line" > mkdir ~/archivebox & & cd ~/archivebox
2023-09-18 14:37:35 +00:00
curl -O 'https://raw.githubusercontent.com/ArchiveBox/ArchiveBox/dev/docker-compose.yml'
2021-04-23 22:27:30 +00:00
< / code > < / pre > < / li >
2021-04-23 22:37:57 +00:00
< li > Run the initial setup and create an admin user.
2023-06-14 00:46:32 +00:00
< pre lang = "bash" > < code style = "white-space: pre-line" > docker compose run archivebox init --setup
2021-04-23 22:27:30 +00:00
< / code > < / pre > < / li >
2021-04-23 22:56:12 +00:00
< li > Optional: Start the server then login to the Web UI < a href = "http://127.0.0.1:8000" > http://127.0.0.1:8000< / a > ⇢ Admin.
2023-06-14 00:46:32 +00:00
< pre lang = "bash" > < code style = "white-space: pre-line" > docker compose up
2021-04-23 23:04:49 +00:00
# completely optional, CLI can always be used without running a server
2023-06-14 00:46:32 +00:00
# docker compose run [-T] archivebox [subcommand] [--args]
2021-04-23 22:27:30 +00:00
< / code > < / pre > < / li >
< / ol >
2021-03-27 09:01:27 +00:00
2021-05-13 04:37:18 +00:00
See < a href = "#%EF%B8%8F-cli-usage" > below< / a > for more usage examples using the CLI, Web UI, or filesystem/SQL/Python to manage your archive.
2021-04-23 22:10:49 +00:00
< br / > < br / >
2020-12-11 20:45:15 +00:00
< / details >
2020-12-11 20:46:34 +00:00
< details >
2023-11-08 11:06:29 +00:00
< summary > < b > < img src = "https://user-images.githubusercontent.com/511499/117447182-29758200-af0b-11eb-97bd-58723fee62ab.png" alt = "Docker" height = "28px" align = "top" / > < code > docker run< / code > < / b > (macOS/Linux/Windows)< / summary >
2021-04-23 22:10:49 +00:00
< br / >
2021-04-23 22:37:57 +00:00
< ol >
< li > Install < a href = "https://docs.docker.com/get-docker/" > Docker< / a > on your system (if not already installed).< / li >
2023-01-31 07:25:59 +00:00
< li > Create a new empty directory and initialize your collection (can be anywhere).
2021-04-23 22:37:57 +00:00
< pre lang = "bash" > < code style = "white-space: pre-line" > mkdir ~/archivebox & & cd ~/archivebox
2021-04-06 01:15:44 +00:00
docker run -v $PWD:/data -it archivebox/archivebox init --setup
2021-04-23 21:50:14 +00:00
< / code > < / pre >
2021-04-23 22:37:57 +00:00
< / li >
2021-04-23 22:56:12 +00:00
< li > Optional: Start the server then login to the Web UI < a href = "http://127.0.0.1:8000" > http://127.0.0.1:8000< / a > ⇢ Admin.
2021-04-23 21:50:14 +00:00
< pre lang = "bash" > < code style = "white-space: pre-line" > docker run -v $PWD:/data -p 8000:8000 archivebox/archivebox
2021-04-23 23:04:49 +00:00
# completely optional, CLI can always be used without running a server
2021-04-23 23:44:53 +00:00
# docker run -v $PWD:/data -it [subcommand] [--args]
2021-04-23 21:50:14 +00:00
< / code > < / pre >
2021-04-23 22:37:57 +00:00
< / li >
< / ol >
2020-12-11 20:50:16 +00:00
2021-05-13 04:37:18 +00:00
See < a href = "#%EF%B8%8F-cli-usage" > below< / a > for more usage examples using the CLI, Web UI, or filesystem/SQL/Python to manage your archive.
2021-05-07 13:26:22 +00:00
< br / > < br / >
< / details >
< details >
2021-05-07 13:30:44 +00:00
< summary > < b > < img src = "https://user-images.githubusercontent.com/511499/117456282-08665e80-af16-11eb-91a1-8102eff54091.png" alt = "curl sh automatic setup script" height = "28px" align = "top" / > < code > bash< / code > auto-setup script< / b > (macOS/Linux)< / summary >
2021-05-07 13:26:22 +00:00
< br / >
< ol >
2021-05-13 03:37:19 +00:00
< li > Install < a href = "https://docs.docker.com/get-docker/" > Docker< / a > on your system (optional, highly recommended but not required).< / li >
2021-05-07 13:26:22 +00:00
< li > Run the automatic setup script.
< pre lang = "bash" > < code style = "white-space: pre-line" > curl -sSL 'https://get.archivebox.io' | sh< / code > < / pre >
< / li >
< / ol >
2021-05-13 09:21:49 +00:00
See < a href = "#%EF%B8%8F-cli-usage" > below< / a > for more usage examples using the CLI, Web UI, or filesystem/SQL/Python to manage your archive.< br / >
2022-04-12 22:27:22 +00:00
See < a href = "https://github.com/ArchiveBox/ArchiveBox/blob/dev/bin/setup.sh" > < code > setup.sh< / code > < / a > for the source code of the auto-install script.< br / >
See < a href = "https://docs.sweeting.me/s/against-curl-sh" > "Against curl | sh as an install method"< / a > blog post for my thoughts on the shortcomings of this install method.
2021-04-23 22:10:49 +00:00
< br / > < br / >
2020-12-11 20:45:15 +00:00
< / details >
2021-05-07 11:44:57 +00:00
< br / >
2021-11-17 02:13:19 +00:00
#### 🛠 Package Manager Setup
2021-04-27 18:59:31 +00:00
2021-11-17 02:13:19 +00:00
< a name = "Manual-Setup" > < / a >
2020-12-11 20:46:34 +00:00
< details >
2021-05-07 12:26:42 +00:00
< summary > < b > < img src = "https://user-images.githubusercontent.com/511499/117448075-49597580-af0c-11eb-91ba-f34fff10096b.png" alt = "aptitude" height = "28px" align = "top" / > < code > apt< / code > < / b > (Ubuntu/Debian)< / summary >
2021-04-23 22:10:49 +00:00
< br / >
2021-04-23 22:37:57 +00:00
< ol >
2021-04-23 22:44:18 +00:00
< li > Add the ArchiveBox repository to your sources.< br / >
2023-11-08 11:07:45 +00:00
< pre lang = "bash" > < code style = "white-space: pre-line" > echo "deb http://ppa.launchpad.net/archivebox/archivebox/ubuntu focal main" | sudo tee /etc/apt/sources.list.d/archivebox.list
2021-04-23 22:10:49 +00:00
sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys C258F79DCC02E369
sudo apt update
2023-01-31 01:17:28 +00:00
< / code > < / pre >
2021-04-23 22:42:02 +00:00
< / li >
2021-04-23 23:11:25 +00:00
< li > Install the ArchiveBox package using < code > apt< / code > .
2021-04-23 22:18:24 +00:00
< pre lang = "bash" > < code style = "white-space: pre-line" > sudo apt install archivebox
2021-05-13 09:14:39 +00:00
sudo python3 -m pip install --upgrade --ignore-installed archivebox # pip needed because apt only provides a broken older version of Django
2021-04-23 22:37:57 +00:00
< / code > < / pre >
< / li >
2023-01-31 07:25:59 +00:00
< li > Create a new empty directory and initialize your collection (can be anywhere).
2021-04-23 22:37:57 +00:00
< pre lang = "bash" > < code style = "white-space: pre-line" > mkdir ~/archivebox & & cd ~/archivebox
2021-04-23 22:10:49 +00:00
archivebox init --setup # if any problems, install with pip instead
2021-04-23 21:50:14 +00:00
< / code > < / pre >
2023-01-31 01:19:09 +00:00
< i > Note: If you encounter issues with NPM/NodeJS, < a href = "https://github.com/nodesource/distributions#debinstall" > install a more recent version< / a > .< / i > < br / > < br / >
2021-04-23 22:37:57 +00:00
< / li >
2021-04-23 22:56:12 +00:00
< li > Optional: Start the server then login to the Web UI < a href = "http://127.0.0.1:8000" > http://127.0.0.1:8000< / a > ⇢ Admin.
2021-04-23 22:27:30 +00:00
< pre lang = "bash" > < code style = "white-space: pre-line" > archivebox server 0.0.0.0:8000
2021-04-23 23:04:49 +00:00
# completely optional, CLI can always be used without running a server
2021-04-23 23:44:53 +00:00
# archivebox [subcommand] [--args]
2021-04-23 22:49:24 +00:00
< / code > < / pre >
< / li >
2021-04-23 22:37:57 +00:00
< / ol >
2020-11-24 04:29:19 +00:00
2021-05-13 09:21:49 +00:00
See < a href = "#%EF%B8%8F-cli-usage" > below< / a > for more usage examples using the CLI, Web UI, or filesystem/SQL/Python to manage your archive.< br / >
See the < a href = "https://github.com/ArchiveBox/debian-archivebox" > < code > debian-archivebox< / code > < / a > repo for more details about this distribution.
2021-04-23 22:10:49 +00:00
< br / > < br / >
2020-12-11 20:45:15 +00:00
< / details >
2019-01-23 07:08:29 +00:00
2020-12-11 20:46:34 +00:00
< details >
2021-05-07 12:26:42 +00:00
< summary > < b > < img src = "https://user-images.githubusercontent.com/511499/117447803-f2ec3700-af0b-11eb-87d3-671d114f011d.png" alt = "homebrew" height = "28px" align = "top" / > < code > brew< / code > < / b > (macOS)< / summary >
2021-04-23 22:10:49 +00:00
< br / >
2021-04-23 22:37:57 +00:00
< ol >
< li > Install < a href = "https://brew.sh/#install" > Homebrew< / a > on your system (if not already installed).< / li >
2021-04-23 22:42:02 +00:00
< li > Install the ArchiveBox package using < code > brew< / code > .
2021-05-07 12:57:21 +00:00
< pre lang = "bash" > < code style = "white-space: pre-line" > brew tap archivebox/archivebox
brew install archivebox
2021-04-23 23:04:49 +00:00
< / code > < / pre >
2021-04-23 22:37:57 +00:00
< / li >
2023-01-31 07:25:59 +00:00
< li > Create a new empty directory and initialize your collection (can be anywhere).
2021-04-23 22:37:57 +00:00
< pre lang = "bash" > < code style = "white-space: pre-line" > mkdir ~/archivebox & & cd ~/archivebox
2021-04-23 22:10:49 +00:00
archivebox init --setup # if any problems, install with pip instead
2021-04-23 21:50:14 +00:00
< / code > < / pre >
2021-04-23 22:37:57 +00:00
< / li >
2021-04-23 22:56:12 +00:00
< li > Optional: Start the server then login to the Web UI < a href = "http://127.0.0.1:8000" > http://127.0.0.1:8000< / a > ⇢ Admin.
2021-04-23 21:50:14 +00:00
< pre lang = "bash" > < code style = "white-space: pre-line" > archivebox server 0.0.0.0:8000
2021-04-23 23:04:49 +00:00
# completely optional, CLI can always be used without running a server
2021-04-23 23:44:53 +00:00
# archivebox [subcommand] [--args]
2021-01-20 03:46:46 +00:00
< / code > < / pre >
2021-04-23 22:37:57 +00:00
< / li >
< / ol >
2020-11-24 04:44:18 +00:00
2021-05-13 09:21:49 +00:00
See < a href = "#%EF%B8%8F-cli-usage" > below< / a > for more usage examples using the CLI, Web UI, or filesystem/SQL/Python to manage your archive.< br / >
See the < a href = "https://github.com/ArchiveBox/homebrew-archivebox" > < code > homebrew-archivebox< / code > < / a > repo for more details about this distribution.
2021-04-23 22:10:49 +00:00
< br / > < br / >
2020-12-11 20:45:15 +00:00
< / details >
2020-11-24 04:37:16 +00:00
2020-12-11 20:46:34 +00:00
< details >
2023-11-09 05:39:40 +00:00
< summary > < b > < img src = "https://user-images.githubusercontent.com/511499/117447613-ba4c5d80-af0b-11eb-8f89-1d98e31b6a79.png" alt = "Pip" height = "28px" align = "top" / > < code > pip< / code > < / b > (macOS/Linux/BSD)< / summary >
2021-04-23 22:10:49 +00:00
< br / >
2021-04-23 22:37:57 +00:00
< ol >
2021-05-07 12:12:44 +00:00
2023-11-08 11:09:22 +00:00
< li > Install < a href = "https://realpython.com/installing-python/" > Python >= v3.9< / a > and < a href = "https://nodejs.org/en/download/package-manager/" > Node >= v18< / a > on your system (if not already installed).< / li >
2021-04-23 22:42:02 +00:00
< li > Install the ArchiveBox package using < code > pip3< / code > .
2021-04-23 22:37:57 +00:00
< pre lang = "bash" > < code style = "white-space: pre-line" > pip3 install archivebox
< / code > < / pre >
< / li >
2023-01-31 07:25:59 +00:00
< li > Create a new empty directory and initialize your collection (can be anywhere).
2021-04-23 22:37:57 +00:00
< pre lang = "bash" > < code style = "white-space: pre-line" > mkdir ~/archivebox & & cd ~/archivebox
2021-04-23 23:04:49 +00:00
archivebox init --setup
# install any missing extras like wget/git/ripgrep/etc. manually as needed
2021-04-23 21:50:14 +00:00
< / code > < / pre >
2021-04-23 22:37:57 +00:00
< / li >
2021-04-23 22:56:12 +00:00
< li > Optional: Start the server then login to the Web UI < a href = "http://127.0.0.1:8000" > http://127.0.0.1:8000< / a > ⇢ Admin.
2021-04-23 21:50:14 +00:00
< pre lang = "bash" > < code style = "white-space: pre-line" > archivebox server 0.0.0.0:8000
2021-04-23 23:04:49 +00:00
# completely optional, CLI can always be used without running a server
2021-04-23 23:44:53 +00:00
# archivebox [subcommand] [--args]
2021-01-20 03:46:46 +00:00
< / code > < / pre >
2021-04-23 22:37:57 +00:00
< / li >
< / ol >
2020-11-23 08:42:11 +00:00
2021-05-13 09:21:49 +00:00
See < a href = "#%EF%B8%8F-cli-usage" > below< / a > for more usage examples using the CLI, Web UI, or filesystem/SQL/Python to manage your archive.< br / >
See the < a href = "https://github.com/ArchiveBox/pip-archivebox" > < code > pip-archivebox< / code > < / a > repo for more details about this distribution.
2021-04-23 22:10:49 +00:00
< br / > < br / >
2020-12-11 20:59:43 +00:00
< / details >
2021-01-20 20:19:22 +00:00
2021-05-13 08:19:22 +00:00
< details >
< summary > < img src = "https://user-images.githubusercontent.com/511499/118077361-f0616580-b381-11eb-973c-ee894a3349fb.png" alt = "Arch" height = "28px" align = "top" / > < code > pacman< / code > / < img src = "https://user-images.githubusercontent.com/511499/118077946-29e6a080-b383-11eb-94f0-d4871da08c3f.png" alt = "FreeBSD" height = "28px" align = "top" / > < code > pkg< / code > / < img src = "https://user-images.githubusercontent.com/511499/118077861-002d7980-b383-11eb-86a7-5936fad9190f.png" alt = "Nix" height = "28px" align = "top" / > < code > nix< / code > (Arch/FreeBSD/NixOS/more)< / summary >
< br / >
2023-11-19 21:51:42 +00:00
> [!WARNING]
> *These are contributed by external volunteers and may lag behind the official `pip` channel.*
2021-05-13 08:19:22 +00:00
< ul >
2022-02-06 20:39:44 +00:00
< li > Arch: < a href = "https://aur.archlinux.org/packages/archivebox/" > < code > yay -S archivebox< / code > < / a > (contributed by < a href = "https://github.com/imlonghao" > < code > @imlonghao< / code > < / a > )< / li >
2021-05-13 09:21:49 +00:00
< li > FreeBSD: < a href = "https://github.com/ArchiveBox/ArchiveBox#%EF%B8%8F-easy-setup" > < code > curl -sSL 'https://get.archivebox.io' | sh< / code > < / a > (uses < code > pkg< / code > + < code > pip3< / code > under-the-hood)< / li >
2021-08-11 15:12:58 +00:00
< li > Nix: < a href = "https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/misc/archivebox/default.nix" > < code > nix-env --install archivebox< / code > < / a > (contributed by < a href = "https://github.com/siraben" > < code > @siraben< / code > < / a > )< / li >
2021-05-13 09:21:49 +00:00
< li > More: < a href = "https://github.com/ArchiveBox/ArchiveBox/issues/new" > < i > contribute another distribution...!< / i > < / a > < / li >
2021-05-13 08:19:22 +00:00
< / ul >
See < a href = "#%EF%B8%8F-cli-usage" > below< / a > for usage examples using the CLI, Web UI, or filesystem/SQL/Python to manage your archive.
< br / > < br / >
< / details >
2021-05-07 13:30:44 +00:00
< br / >
2021-05-07 13:18:42 +00:00
#### 🎗 Other Options
< details >
2021-05-13 04:55:35 +00:00
< summary > < b > < img src = "https://user-images.githubusercontent.com/511499/117447182-29758200-af0b-11eb-97bd-58723fee62ab.png" alt = "Docker" height = "28px" align = "top" / > < code > docker< / code > + < img src = "https://user-images.githubusercontent.com/511499/117447263-4316c980-af0b-11eb-928d-eaf1292ac646.png" alt = "Electron" height = "28px" align = "top" / > < code > electron< / code > Desktop App< / b > (macOS/Linux/Windows)< / summary >
2021-05-07 13:18:42 +00:00
< br / >
< ol >
< li > Install < a href = "https://docs.docker.com/get-docker/" > Docker< / a > on your system (if not already installed).< / li >
2021-05-13 04:55:35 +00:00
< li > Download a binary release for your OS or build the native app from source< br / >
2021-05-13 09:24:36 +00:00
< ul >
< li > macOS: < a href = "https://github.com/ArchiveBox/ArchiveBox/releases/download/v0.6.2/Electron-ArchiveBox-macOS-x64-0.6.2.app.zip" download > < code > ArchiveBox.app.zip< / code > < / a > < / li >
< li > Linux: < code > ArchiveBox.deb< / code > (alpha: < a href = "https://github.com/ArchiveBox/electron-archivebox#quickstart" > build manually< / a > )< / li >
< li > Windows: < code > ArchiveBox.exe< / code > (beta: < a href = "https://github.com/ArchiveBox/electron-archivebox#quickstart" > build manually< / a > )< / li >
< / ul >
< / li >
2021-05-13 04:55:35 +00:00
< / ol >
2024-01-04 20:29:38 +00:00
< img src = "https://github.com/ArchiveBox/ArchiveBox/assets/511499/575ef92f-bb3e-4a7c-a4ba-986c1fd76ecf" width = "320px" >
2021-05-07 13:18:42 +00:00
< br / >
< i > ✨ Alpha (contributors wanted!)< / i > : for more info, see the: < a href = "https://github.com/ArchiveBox/electron-archivebox" > Electron ArchiveBox< / a > repo.
< br / >
< / details >
2021-04-23 19:50:24 +00:00
< details >
2021-05-13 04:55:35 +00:00
< summary > < img src = "https://user-images.githubusercontent.com/511499/117448723-1663b180-af0d-11eb-837f-d43959227810.png" alt = "paid" height = "27px" align = "top" / > Paid hosting solutions (cloud VPS)< / summary >
2021-04-23 19:50:24 +00:00
< br / >
2021-04-23 21:20:03 +00:00
< ul >
2023-11-08 11:16:43 +00:00
< li > < a href = "https://zulip.archivebox.io/#narrow/stream/167-enterprise/topic/welcome/near/1191102" >
< img src = "https://img.shields.io/badge/Custom_Development-ArchiveBox.io-%231a1a1a.svg?style=flat" height = "22px" / >
< / a > (< a href = "https://zulip.archivebox.io/#narrow/stream/167-enterprise/topic/welcome/near/1191102" > get hosting, support, and feature customization directy from us< / a > )< / li >
2021-04-23 21:28:09 +00:00
< li > < a href = "https://monadical.com" >
2023-11-08 11:16:43 +00:00
< img src = "https://img.shields.io/badge/General_Dev_Consulting-Monadical.com-%231a1a1a.svg?style=flat" height = "22px" / >
< / a > (< a href = "https://monadical.com/contact-us.html" > for a generalist software consultancy that helps with ArchiveBox maintainance< / a > )< / li >
2021-04-23 21:10:56 +00:00
< br / >
2023-11-08 11:16:43 +00:00
Other providers of paid ArchiveBox hosting (not officially endorsed):< br / >
2021-04-23 21:20:58 +00:00
< br / > < br / >
2023-11-20 01:35:19 +00:00
< li > < a href = "https://elest.io/open-source/archivebox" > < img src = "https://img.shields.io/badge/Managed_Hosting-Elest.io-%23193f7e.svg?style=flat" height = "22px" / > < / a > < / li >
2021-04-23 23:19:19 +00:00
< li > < a href = "https://www.stellarhosted.com/archivebox/" > < img src = "https://img.shields.io/badge/Semi_Managed_Hosting-StellarHosted.com-%23193f7e.svg?style=flat" height = "22px" / > < / a > (USD $29-250/mo, < a href = "https://www.stellarhosted.com/archivebox/#pricing" > pricing< / a > )< / li >
2022-05-10 11:28:10 +00:00
< li > < a href = "https://www.pikapods.com/pods?run=archivebox" > < img src = "https://img.shields.io/badge/Semi_Managed_Hosting-PikaPods.com-%2343a047.svg?style=flat" height = "22px" / > < / a > (from USD $2.6/mo)< / li >
2021-04-23 20:59:29 +00:00
< li > < a href = "https://m.do.co/c/cbc4c0c17840" >
2021-04-23 23:48:01 +00:00
< img src = "https://img.shields.io/badge/Unmanaged_VPS-DigitalOcean.com-%232f7cf7.svg?style=flat" height = "22px" / >
< / a > (USD $5-50+/mo, < a href = "https://m.do.co/c/cbc4c0c17840" > 🎗 referral link< / a > , < a href = "https://www.digitalocean.com/community/tutorials/how-to-install-and-use-docker-compose-on-ubuntu-20-04" > instructions< / a > )< / li >
2021-04-23 20:59:29 +00:00
< li > < a href = "https://www.vultr.com/?ref=7130289" >
2021-04-23 21:23:25 +00:00
< img src = "https://img.shields.io/badge/Unmanaged_VPS-Vultr.com-%232337a8.svg?style=flat" height = "22px" / >
2021-04-23 23:48:01 +00:00
< / a > (USD $2.5-50+/mo, < a href = "https://www.vultr.com/?ref=7130289" > 🎗 referral link< / a > , < a href = "https://www.vultr.com/docs/install-docker-compose-on-ubuntu-20-04" > instructions< / a > )< / li >
2021-04-23 21:04:08 +00:00
< li > < a href = "https://fly.io/" >
< img src = "https://img.shields.io/badge/Unmanaged_App-Fly.io-%239a2de6.svg?style=flat" height = "22px" / >
2021-04-23 23:48:01 +00:00
< / a > (USD $10-50+/mo, < a href = "https://fly.io/docs/hands-on/start/" > instructions< / a > )< / li >
< li > < a href = "https://aws.amazon.com/marketplace/pp/Linnovate-Open-Source-Innovation-Support-For-Archi/B08RVW6MJ2" > < img src = "https://img.shields.io/badge/Unmanaged_VPS-AWS-%23ee8135.svg?style=flat" height = "22px" / > < / a > (USD $60-200+/mo)< / li >
2021-05-07 13:30:44 +00:00
< li > < a href = "https://azuremarketplace.microsoft.com/en-us/marketplace/apps/meanio.archivebox?ocid=gtmrewards_whatsnewblog_archivebox_vol118" > < img src = "https://img.shields.io/badge/Unmanaged_VPS-Azure-%237cb300.svg?style=flat" height = "22px" / > < / a > (USD $60-200+/mo)< / li >
2021-04-23 21:28:09 +00:00
< br / >
2021-04-23 23:19:19 +00:00
< sub > < i > Referral links marked 🎗 provide $5-10 of free credit for new users and help pay for our < a href = "https://demo.archivebox.io" > demo server< / a > hosting costs.< / i > < / sub >
2021-04-23 19:50:24 +00:00
< / ul >
2021-04-23 21:10:56 +00:00
For more discussion on managed and paid hosting options see here: < a href = "https://github.com/ArchiveBox/ArchiveBox/issues/531" > Issue #531 </ a > .
2021-04-23 19:50:24 +00:00
2021-04-23 19:54:24 +00:00
< / details >
2021-04-08 10:57:58 +00:00
2021-04-23 22:10:49 +00:00
< br / >
2021-04-23 21:55:20 +00:00
2021-04-24 02:33:45 +00:00
#### ➡️ Next Steps
2021-04-24 02:26:42 +00:00
- Import URLs from some of the supported [Input Formats ](#input-formats ) or view the supported [Output Formats ](#output-formats )...
- Tweak your UI or archiving behavior [Configuration ](#configuration ) or read about some of the [Caveats ](#caveats ) and troubleshooting steps...
2022-04-12 22:24:24 +00:00
- Read about the [Dependencies ](#dependencies ) used for archiving, the [Upgrading Process ](https://github.com/ArchiveBox/ArchiveBox/wiki/Upgrading-or-Merging-Archives ), or the [Archive Layout ](#archive-layout ) on disk...
2021-04-24 02:33:45 +00:00
- Or check out our full [Documentation ](#documentation ) or [Community Wiki ](#internet-archiving-ecosystem )...
2021-04-24 02:26:42 +00:00
< br / >
### Usage
2021-04-08 10:47:45 +00:00
#### ⚡️ CLI Usage
```bash
# archivebox [subcommand] [--args]
2021-04-08 13:48:11 +00:00
# docker-compose run archivebox [subcommand] [--args]
# docker run -v $PWD:/data -it [subcommand] [--args]
archivebox init --setup # safe to run init multiple times (also how you update versions)
2021-04-08 10:47:45 +00:00
archivebox --version
2021-04-24 02:08:32 +00:00
archivebox help
2021-04-08 10:47:45 +00:00
```
- `archivebox setup/init/config/status/manage` to administer your collection
2021-04-08 13:48:11 +00:00
- `archivebox add/schedule/remove/update/list/shell/oneshot` to manage Snapshots in the archive
2023-01-31 07:25:59 +00:00
- `archivebox schedule` to pull in fresh URLs regularly from [bookmarks/history/Pocket/Pinboard/RSS/etc. ](#input-formats )
2021-04-08 11:21:04 +00:00
#### 🖥 Web UI Usage
2021-04-08 10:57:58 +00:00
```bash
2021-10-26 05:58:16 +00:00
archivebox manage createsuperuser # set an admin password
archivebox server 0.0.0.0:8000 # open http://127.0.0.1:8000 to view it
2021-04-08 10:57:58 +00:00
2021-04-08 11:21:04 +00:00
# you can also configure whether or not login is required for most features
2021-04-08 10:57:58 +00:00
archivebox config --set PUBLIC_INDEX=False
archivebox config --set PUBLIC_SNAPSHOTS=False
archivebox config --set PUBLIC_ADD_VIEW=False
```
2021-01-21 02:26:24 +00:00
2021-04-08 13:37:07 +00:00
#### 🗄 SQL/Python/Filesystem Usage
```bash
2021-04-08 13:38:02 +00:00
sqlite3 ./index.sqlite3 # run SQL queries on your index
2021-04-08 13:37:07 +00:00
archivebox shell # explore the Python API in a REPL
ls ./archive/*/index.html # or inspect snapshots on the filesystem
```
2021-01-20 20:57:31 +00:00
< br / >
< div align = "center" >
2024-01-04 20:29:38 +00:00
< img src = "https://github.com/ArchiveBox/ArchiveBox/assets/511499/65f82532-18dd-49c5-86f1-02b1f3100e1e" width = "49%" alt = "grass" / > < img src = "https://github.com/ArchiveBox/ArchiveBox/assets/511499/65f82532-18dd-49c5-86f1-02b1f3100e1e" width = "49%" alt = "grass" / >
2021-01-20 20:57:31 +00:00
< / div >
2021-01-21 02:14:06 +00:00
< br / >
2021-01-20 20:24:10 +00:00
2021-01-20 21:10:39 +00:00
< div align = "center" >
< sub > . . . . . . . . . . . . . . . . . . . . . . . . . . . .< / sub >
2021-01-21 02:14:06 +00:00
< br / > < br / >
2021-04-08 07:33:49 +00:00
< a href = "https://demo.archivebox.io" > DEMO: < code > https://demo.archivebox.io< / code > < / a > < br / >
2021-04-08 12:03:26 +00:00
< a href = "https://github.com/ArchiveBox/ArchiveBox/wiki/Usage" > Usage< / a > | < a href = "https://github.com/ArchiveBox/ArchiveBox/wiki/Configuration" > Configuration< / a > | < a href = "#Caveats" > Caveats< / a >
2021-01-20 21:10:39 +00:00
< br / >
< / div >
2021-04-08 10:57:58 +00:00
< br / >
2021-01-21 03:09:09 +00:00
2021-01-20 21:31:10 +00:00
---
< div align = "center" >
2024-01-04 20:29:38 +00:00
< img src = "https://github.com/ArchiveBox/ArchiveBox/assets/511499/ac1f897a-8baa-4f8b-8ee8-7443611f258b" width = "96%" alt = "lego" >
2021-01-20 21:31:10 +00:00
< / div >
2021-04-08 10:47:45 +00:00
< br / >
2021-04-08 14:36:07 +00:00
# Overview
2021-04-24 02:17:21 +00:00
## Input Formats
2020-10-10 20:00:53 +00:00
ArchiveBox supports many input formats for URLs, including Pocket & Pinboard exports, Browser bookmarks, Browser history, plain text, HTML, markdown, and more!
2021-04-08 12:03:26 +00:00
2021-06-07 12:03:20 +00:00
*Click these links for instructions on how to prepare your links from these sources:*
2021-04-08 12:03:26 +00:00
2024-01-04 20:29:38 +00:00
- < img src = "https://github.com/ArchiveBox/ArchiveBox/assets/511499/64078483-21d7-4eb1-aa6e-9ad55afe45b8" height = "22px" /> TXT, RSS, XML, JSON, CSV, SQL, HTML, Markdown, or [any other text-based format... ](https://github.com/ArchiveBox/ArchiveBox/wiki/Usage#Import-a-list-of-URLs-from-a-text-file )
- < img src = "https://github.com/ArchiveBox/ArchiveBox/assets/511499/32b494e6-4de1-4984-8d88-dc02f18e5c34" height = "22px" /> [Browser history ](https://github.com/ArchiveBox/ArchiveBox/wiki/Quickstart#2-get-your-list-of-urls-to-archive ) or [browser bookmarks ](https://github.com/ArchiveBox/ArchiveBox/wiki/Quickstart#2-get-your-list-of-urls-to-archive ) (see instructions for: [Chrome ](https://support.google.com/chrome/answer/96816?hl=en ), [Firefox ](https://support.mozilla.org/en-US/kb/export-firefox-bookmarks-to-backup-or-transfer ), [Safari ](https://github.com/ArchiveBox/ArchiveBox/assets/511499/24ad068e-0fa6-41f4-a7ff-4c26fc91f71a ), [IE ](https://support.microsoft.com/en-us/help/211089/how-to-import-and-export-the-internet-explorer-favorites-folder-to-a-32-bit-version-of-windows ), [Opera ](https://help.opera.com/en/latest/features/#bookmarks:~:text=Click%20the%20import/-,export%20button,-on%20the%20bottom ), [and more... ](https://github.com/ArchiveBox/ArchiveBox/wiki/Quickstart#2-get-your-list-of-urls-to-archive ))
- < img src = "https://github.com/ArchiveBox/ArchiveBox/assets/511499/ff20d251-5347-4b85-ae9b-83037d0ac01e" height = "22px" /> Browser extension [`archivebox-exporter` ](https://github.com/tjhorner/archivebox-exporter ) (realtime archiving from Chrome/Chromium/Firefox)
2023-07-27 23:58:58 +00:00
- < img src = "https://getpocket.com/favicon.ico" height = "22px" /> [Pocket ](https://getpocket.com/export ), [Pinboard ](https://pinboard.in/export/ ), [Instapaper ](https://www.instapaper.com/user ), [Shaarli ](https://shaarli.readthedocs.io/en/master/Usage/#importexport ), [Delicious ](https://www.groovypost.com/howto/howto/export-delicious-bookmarks-xml/ ), [Reddit Saved ](https://github.com/csu/export-saved-reddit ), [Wallabag ](https://doc.wallabag.org/en/user/import/wallabagv2.html ), [Unmark.it ](http://help.unmark.it/import-export ), [OneTab ](https://www.addictivetips.com/web/onetab-save-close-all-chrome-tabs-to-restore-export-or-import/ ), [and more... ](https://github.com/ArchiveBox/ArchiveBox/wiki/Quickstart#2-get-your-list-of-urls-to-archive )
2021-04-08 12:03:26 +00:00
2024-01-04 20:29:38 +00:00
< img src = "https://github.com/ArchiveBox/ArchiveBox/assets/511499/e1e5bd78-b0b6-45dc-914c-e1046fee4bc4" width = "330px" align = "right" >
2021-05-07 13:14:35 +00:00
2020-10-10 20:00:53 +00:00
```bash
2021-04-08 12:20:38 +00:00
# archivebox add --help
2020-10-10 20:00:53 +00:00
archivebox add 'https://example.com/some/page'
archivebox add < ~/Downloads/firefox_bookmarks_export.html
archivebox add --depth=1 'https://news.ycombinator.com#2020-12-12'
2021-04-09 16:33:57 +00:00
echo 'http://example.com' | archivebox add
echo 'any_text_with [urls ](https://example.com ) in it' | archivebox add
2020-10-10 20:00:53 +00:00
2023-06-14 00:46:32 +00:00
# if using Docker, add -i when piping stdin:
2021-04-23 21:50:14 +00:00
# echo 'https://example.com' | docker run -v $PWD:/data -i archivebox/archivebox add
2023-06-14 00:46:32 +00:00
# if using Docker Compose, add -T when piping stdin / stdout:
# echo 'https://example.com' | docker compose run -T archivebox add
2021-02-16 05:03:51 +00:00
```
2021-01-20 19:17:44 +00:00
2020-11-23 07:04:39 +00:00
See the [Usage: CLI ](https://github.com/ArchiveBox/ArchiveBox/wiki/Usage#CLI-Usage ) page for documentation and examples.
2020-10-10 20:00:53 +00:00
2020-12-11 23:40:58 +00:00
It also includes a built-in scheduled import feature with `archivebox schedule` and browser bookmarklet, so you can pull in URLs from RSS feeds, websites, or the filesystem regularly/on-demand.
2020-10-10 20:00:53 +00:00
2021-04-08 10:57:58 +00:00
< br / >
2021-04-24 02:17:21 +00:00
## Output Formats
2021-04-08 14:26:23 +00:00
2023-01-31 07:25:59 +00:00
Inside each Snapshot folder, ArchiveBox saves these different types of extractor outputs as plain files:
2021-04-08 14:26:23 +00:00
2024-01-04 20:29:38 +00:00
< img src = "https://github.com/ArchiveBox/ArchiveBox/assets/511499/ace0954a-ddac-4520-9d18-1c77b1ec50b2" width = "330px" align = "right" >
2021-05-07 13:14:35 +00:00
2021-04-09 16:33:57 +00:00
`./archive/<timestamp>/*`
2020-10-10 20:00:53 +00:00
- **Index:** `index.html` & `index.json` HTML and JSON index files containing metadata and details
2021-01-21 02:50:33 +00:00
- **Title**, **Favicon** , **Headers** Response headers, site favicon, and parsed site title
2021-03-31 03:16:44 +00:00
- **SingleFile:** `singlefile.html` HTML snapshot rendered with headless Chrome using SingleFile
2021-01-21 02:50:33 +00:00
- **Wget Clone:** `example.com/page-name.html` wget clone of the site with `warc/<timestamp>.gz`
- Chrome Headless
- **PDF:** `output.pdf` Printed PDF of site using headless chrome
- **Screenshot:** `screenshot.png` 1440x900 screenshot of site using headless chrome
- **DOM Dump:** `output.html` DOM Dump of the HTML after rendering using headless chrome
2021-03-31 03:16:44 +00:00
- **Article Text:** `article.html/json` Article text extraction using Readability & Mercury
2021-01-21 02:50:33 +00:00
- **Archive.org Permalink:** `archive.org.txt` A link to the saved site on archive.org
2022-09-12 20:34:02 +00:00
- **Audio & Video:** `media/` all audio/video files + playlists, including subtitles & metadata with youtube-dl (or yt-dlp)
2021-06-07 12:03:20 +00:00
- **Source Code:** `git/` clone of any repository found on GitHub, Bitbucket, or GitLab links
2020-11-23 07:04:39 +00:00
- _More coming soon! See the [Roadmap ](https://github.com/ArchiveBox/ArchiveBox/wiki/Roadmap )..._
2020-10-10 20:00:53 +00:00
2021-04-08 12:27:36 +00:00
It does everything out-of-the-box by default, but you can disable or tweak [individual archive methods ](https://github.com/ArchiveBox/ArchiveBox/wiki/Configuration ) via environment variables / config.
2020-10-10 20:00:53 +00:00
2021-04-08 14:26:23 +00:00
< br / >
2021-04-08 12:03:26 +00:00
2021-04-24 00:20:52 +00:00
## Configuration
2024-01-04 20:29:38 +00:00
< img src = "https://github.com/ArchiveBox/ArchiveBox/assets/511499/ea672e6b-4df5-49d8-b550-7f450951fd27" width = "330px" align = "right" >
2021-05-07 13:11:24 +00:00
2021-04-24 00:20:52 +00:00
ArchiveBox can be configured via environment variables, by using the `archivebox config` CLI, or by editing the `ArchiveBox.conf` config file directly.
```bash
archivebox config # view the entire config
archivebox config --get CHROME_BINARY # view a specific value
2021-04-24 02:48:30 +00:00
archivebox config --set CHROME_BINARY=chromium # persist a config using CLI
# OR
echo CHROME_BINARY=chromium >> ArchiveBox.conf # persist a config using file
# OR
env CHROME_BINARY=chromium archivebox ... # run with a one-off config
2021-04-24 00:20:52 +00:00
```
2021-04-24 02:48:30 +00:00
< sup > These methods also work the same way when run inside Docker, see the < a href = "https://github.com/ArchiveBox/ArchiveBox/wiki/Docker#configuration" > Docker Configuration< / a > wiki page for details.< / sup >
2023-09-18 14:37:35 +00:00
**The config loading logic with all the options defined is here: [`archivebox/config.py` ](https://github.com/ArchiveBox/ArchiveBox/blob/dev/archivebox/config.py ).**
2021-04-24 00:20:52 +00:00
Most options are also documented on the ** [Configuration Wiki page ](https://github.com/ArchiveBox/ArchiveBox/wiki/Configuration )**.
2021-04-24 00:44:12 +00:00
#### Most Common Options to Tweak
2021-04-24 00:20:52 +00:00
```bash
2021-04-24 00:34:31 +00:00
# e.g. archivebox config --set TIMEOUT=120
2021-04-24 00:20:52 +00:00
2021-04-24 00:44:12 +00:00
TIMEOUT=120 # default: 60 add more seconds on slower networks
CHECK_SSL_VALIDITY=True # default: False True = allow saving URLs w/ bad SSL
SAVE_ARCHIVE_DOT_ORG=False # default: True False = disable Archive.org saving
MAX_MEDIA_SIZE=1500m # default: 750m raise/lower youtubedl output size
2021-04-24 00:20:52 +00:00
2021-04-24 00:44:12 +00:00
PUBLIC_INDEX=True # default: True whether anon users can view index
PUBLIC_SNAPSHOTS=True # default: True whether anon users can view pages
PUBLIC_ADD_VIEW=False # default: False whether anon users can add new URLs
2024-01-04 20:30:21 +00:00
CHROME_USER_AGENT="Mozilla/5.0 ..." # change these to get around bot blocking
WGET_USER_AGENT="Mozilla/5.0 ..."
CURL_USER_AGENT="Mozilla/5.0 ..."
2021-04-24 00:20:52 +00:00
```
< br / >
2021-04-08 12:46:24 +00:00
## Dependencies
2024-01-04 20:30:21 +00:00
To achieve high-fidelity archives in as many situations as possible, ArchiveBox depends on a variety of high-quality 3rd-party tools and libraries that specialize in extracting different types of content.
< br / >
< details >
< summary > < i > Expand to learn more about ArchiveBox's dependencies...< / i > < / summary >
2024-01-04 20:44:27 +00:00
< br / >
2024-01-04 20:30:21 +00:00
2021-06-07 12:03:20 +00:00
For better security, easier updating, and to avoid polluting your host system with extra dependencies, **it is strongly recommended to use the official [Docker image](https://github.com/ArchiveBox/ArchiveBox/wiki/Docker)** with everything pre-installed for the best experience.
2021-04-08 12:46:24 +00:00
2024-01-04 20:29:38 +00:00
These optional dependencies used for archiving sites include:
< img src = "https://github.com/ArchiveBox/ArchiveBox/assets/511499/62a02155-05d7-4f3e-8de5-75a50a145c4f" alt = "archivebox --version CLI output screenshot showing dependencies installed" width = "330px" align = "right" >
2021-04-08 12:46:24 +00:00
2021-05-07 13:14:35 +00:00
2021-04-08 12:46:24 +00:00
- `chromium` / `chrome` (for screenshots, PDF, DOM HTML, and headless JS scripts)
- `node` & `npm` (for readability, mercury, and singlefile)
- `wget` (for plain HTML, static files, and WARC saving)
2021-04-10 21:27:09 +00:00
- `curl` (for fetching headers, favicon, and posting to Archive.org)
2022-09-12 20:34:02 +00:00
- `youtube-dl` or `yt-dlp` (for audio, video, and subtitles)
2021-04-08 12:46:24 +00:00
- `git` (for cloning git repos)
- and more as we grow...
You don't need to install every dependency to use ArchiveBox. ArchiveBox will automatically disable extractors that rely on dependencies that aren't installed, based on what is configured and available in your `$PATH` .
2021-04-24 00:49:06 +00:00
If not using Docker, make sure to keep the dependencies up-to-date yourself and check that ArchiveBox isn't reporting any incompatibility with the versions you install.
2021-04-08 12:46:24 +00:00
```bash
# install python3 and archivebox with your system package manager
# apt/brew/pip/etc install ... (see Quickstart instructions above)
archivebox setup # auto install all the extractors and extras
2021-04-10 21:27:09 +00:00
archivebox --version # see info and check validity of installed dependencies
2021-04-08 12:46:24 +00:00
```
2022-04-12 22:24:24 +00:00
Installing directly on **Windows without Docker or WSL/WSL2/Cygwin is not officially supported** (I cannot respond to Windows support tickets), but some advanced users have reported getting it working.
2021-04-08 12:46:24 +00:00
2024-01-04 21:32:08 +00:00
#### Learn More
- https://github.com/ArchiveBox/ArchiveBox/wiki/Install#dependencies
- https://github.com/ArchiveBox/ArchiveBox/wiki/Chromium-Install
- https://github.com/ArchiveBox/ArchiveBox/wiki/Upgrading-or-Merging-Archives
- https://github.com/ArchiveBox/ArchiveBox/wiki/Troubleshooting#installing
2021-04-24 02:26:42 +00:00
2024-01-04 20:30:21 +00:00
< / details >
2021-04-24 02:26:42 +00:00
< br / >
## Archive Layout
2024-01-04 21:47:21 +00:00
All of ArchiveBox's state (including the SQLite DB, archived assets, config, logs, etc.) is stored in a single folder called the "ArchiveBox Data Folder".
Data folders can be created anywhere (`~/archivebox` or `$PWD/data` as seen in our examples), and you can create more than one for different collections.
2021-04-24 02:26:42 +00:00
2024-01-04 20:30:21 +00:00
< br / >
< details >
< summary > < i > Expand to learn more about the layout of Archivebox's data on-disk...< / i > < / summary >
2024-01-04 20:44:27 +00:00
< br / >
All `archivebox` CLI commands are designed to be run from inside an ArchiveBox data folder, starting with `archivebox init` to initialize a new collection inside an empty directory.
```bash
2024-01-04 21:47:21 +00:00
mkdir ~/archivebox & & cd ~/archivebox # just an example, can be anywhere
2024-01-04 20:44:27 +00:00
archivebox init
```
2024-01-04 20:30:21 +00:00
2024-01-04 20:44:27 +00:00
The on-disk layout is optimized to be easy to browse by hand and durable long-term. The main index is a standard `index.sqlite3` database in the root of the data folder (it can also be [exported as static JSON/HTML ](https://github.com/ArchiveBox/ArchiveBox/wiki/Publishing-Your-Archive#2-export-and-host-it-as-static-html )), and the archive snapshots are organized by date-added timestamp in the `./archive/` subfolder.
2021-04-24 02:26:42 +00:00
2021-05-07 13:14:35 +00:00
< img src = "https://user-images.githubusercontent.com/511499/117453293-c7b91600-af12-11eb-8a3f-aa48b0f9da3c.png" width = "400px" align = "right" >
2021-04-24 02:26:42 +00:00
```bash
2024-01-04 20:44:27 +00:00
/data/
2021-04-24 02:26:42 +00:00
index.sqlite3
ArchiveBox.conf
archive/
...
1617687755/
index.html
index.json
screenshot.png
media/some_video.mp4
warc/1617687755.warc.gz
git/somerepo.git
...
```
2021-06-07 12:03:20 +00:00
Each snapshot subfolder `./archive/<timestamp>/` includes a static `index.json` and `index.html` describing its contents, and the snapshot extractor outputs are plain files within the folder.
2021-04-24 02:26:42 +00:00
2024-01-04 21:32:08 +00:00
#### Learn More
- https://github.com/ArchiveBox/ArchiveBox/wiki/Usage#Disk-Layout
- https://github.com/ArchiveBox/ArchiveBox/wiki/Usage#large-archives
- https://github.com/ArchiveBox/ArchiveBox/wiki/Security-Overview#output-folder
- https://github.com/ArchiveBox/ArchiveBox/wiki/Publishing-Your-Archive
- https://github.com/ArchiveBox/ArchiveBox/wiki/Upgrading-or-Merging-Archives
2024-01-04 20:30:21 +00:00
< / details >
2021-04-24 02:26:42 +00:00
< br / >
## Static Archive Exporting
2024-01-04 20:30:21 +00:00
You can export the main index to browse it statically as plain HTML files in a folder (without needing to run a server).
< br / >
< details >
< summary > < i > Expand to learn how to export your ArchiveBox collection...< / i > < / summary >
2024-01-04 20:44:27 +00:00
< br / >
2021-04-24 02:26:42 +00:00
2023-10-19 19:57:05 +00:00
> **Note**
> These exports are not paginated, exporting many URLs or the entire archive at once may be slow. Use the filtering CLI flags on the `archivebox list` command to export specific Snapshots or ranges.
2021-04-24 02:26:42 +00:00
```bash
# archivebox list --help
archivebox list --html --with-headers > index.html # export to static html table
archivebox list --json --with-headers > index.json # export to json blob
archivebox list --csv=timestamp,url,title > index.csv # export to csv spreadsheet
2023-06-14 00:46:32 +00:00
# (if using Docker Compose, add the -T flag when piping)
# docker compose run -T archivebox list --html --filter-type=search snozzberries > index.json
2021-04-24 02:26:42 +00:00
```
The paths in the static exports are relative, make sure to keep them next to your `./archive` folder when backing them up or viewing them.
2024-01-04 21:32:08 +00:00
#### Learn More
- https://github.com/ArchiveBox/ArchiveBox/wiki/Publishing-Your-Archive#2-export-and-host-it-as-static-html
- https://github.com/ArchiveBox/ArchiveBox/wiki/Security-Overview#publishing
- https://github.com/ArchiveBox/ArchiveBox/wiki/Configuration#public_index--public_snapshots--public_add_view
2024-01-04 20:44:27 +00:00
2024-01-04 20:30:21 +00:00
< / details >
2021-04-24 02:26:42 +00:00
2021-04-08 12:46:24 +00:00
< br / >
2021-01-20 22:19:01 +00:00
---
2021-01-21 00:45:33 +00:00
< div align = "center" >
2021-01-20 22:19:01 +00:00
< img src = "https://docs.monadical.com/uploads/upload_b6900afc422ae699bfefa2dcda3306f3.png" width = "100%" alt = "security graphic" / >
2021-01-21 00:45:33 +00:00
< / div >
2021-01-20 22:19:01 +00:00
2020-10-10 20:00:53 +00:00
## Caveats
2021-04-24 00:58:06 +00:00
### Archiving Private Content
2021-04-08 10:39:23 +00:00
2023-10-19 19:58:38 +00:00
< a id = "archiving-private-urls" > < / a >
2021-04-24 02:37:33 +00:00
2024-01-04 21:47:21 +00:00
If you're importing pages with private content or URLs containing secret tokens you don't want public (e.g Google Docs, paywalled content, unlisted videos, etc.), **you may want to disable some of the extractor methods to avoid leaking that content to 3rd party APIs or the public** .
2024-01-04 20:30:21 +00:00
< br / >
< details >
< summary > < i > Click to expand...< / i > < / summary >
2021-01-20 03:02:35 +00:00
2020-10-25 02:23:08 +00:00
```bash
2021-04-24 00:58:06 +00:00
# don't save private content to ArchiveBox, e.g.:
archivebox add 'https://docs.google.com/document/d/12345somePrivateDocument'
archivebox add 'https://vimeo.com/somePrivateVideo'
2020-10-25 02:23:08 +00:00
2021-04-24 00:58:06 +00:00
# without first disabling saving to Archive.org:
2021-04-08 12:27:36 +00:00
archivebox config --set SAVE_ARCHIVE_DOT_ORG=False # disable saving all URLs in Archive.org
2023-01-31 07:25:59 +00:00
# restrict the main index, Snapshot content, and Add Page to authenticated users as-needed:
2021-07-07 10:55:07 +00:00
archivebox config --set PUBLIC_INDEX=False
archivebox config --set PUBLIC_SNAPSHOTS=False
archivebox config --set PUBLIC_ADD_VIEW=False
2021-04-24 00:58:06 +00:00
# if extra paranoid or anti-Google:
archivebox config --set SAVE_FAVICON=False # disable favicon fetching (it calls a Google API passing the URL's domain part only)
2021-04-08 12:27:36 +00:00
archivebox config --set CHROME_BINARY=chromium # ensure it's using Chromium instead of Chrome
2020-10-25 02:23:08 +00:00
```
2020-10-10 20:00:53 +00:00
2024-01-04 21:32:08 +00:00
#### Learn More
- https://github.com/ArchiveBox/ArchiveBox/wiki/Publishing-Your-Archive
- https://github.com/ArchiveBox/ArchiveBox/wiki/Security-Overview
- https://github.com/ArchiveBox/ArchiveBox/wiki/Chromium-Install#setting-up-a-chromium-user-profile
- https://github.com/ArchiveBox/ArchiveBox/wiki/Configuration#chrome_user_data_dir
- https://github.com/ArchiveBox/ArchiveBox/wiki/Configuration#cookies_file
2024-01-04 20:30:21 +00:00
< / details >
< br / >
2021-04-08 14:37:57 +00:00
### Security Risks of Viewing Archived JS
2021-04-08 10:39:23 +00:00
2024-01-04 21:47:21 +00:00
Be aware that malicious archived JS can access the contents of other pages in your archive when viewed. Because the Web UI serves all viewed snapshots from a single domain, they share a request context and **typical CSRF/CORS/XSS/CSP protections do not work to prevent cross-site request attacks** . See the [Security Overview ](https://github.com/ArchiveBox/ArchiveBox/wiki/Security-Overview#stealth-mode ) page and [Issue #239 ](https://github.com/ArchiveBox/ArchiveBox/issues/239 ) for more details.
2024-01-04 20:30:21 +00:00
< br / >
< details >
< summary > < i > Click to expand...< / i > < / summary >
2021-01-20 03:02:35 +00:00
2020-10-25 02:23:08 +00:00
```bash
# visiting an archived page with malicious JS:
https://127.0.0.1:8000/archive/1602401954/example.com/index.html
2020-10-10 20:00:53 +00:00
2021-04-08 12:20:38 +00:00
# example.com/index.js can now make a request to read everything from:
2020-10-25 02:23:08 +00:00
https://127.0.0.1:8000/index.html
https://127.0.0.1:8000/archive/*
# then example.com/index.js can send it off to some evil server
```
2021-05-13 09:27:48 +00:00
The admin UI is also served from the same origin as replayed JS, so malicious pages could also potentially use your ArchiveBox login cookies to perform admin actions (e.g. adding/removing links, running extractors, etc.). We are planning to fix this security shortcoming in a future version by using separate ports/origins to serve the Admin UI and archived content (see [Issue #239 ](https://github.com/ArchiveBox/ArchiveBox/issues/239 )).
2023-11-04 04:17:37 +00:00
*Note: Only the `wget` & `dom` extractor methods execute archived JS when viewing snapshots, all other archive methods produce static output that does not execute JS on viewing. If you are worried about these issues ^ you should disable these extractors using `archivebox config --set SAVE_WGET=False SAVE_DOM=False` .*
2021-05-13 09:31:40 +00:00
2024-01-04 21:32:08 +00:00
#### Learn More
- https://github.com/ArchiveBox/ArchiveBox/wiki/Security-Overview
- https://github.com/ArchiveBox/ArchiveBox/issues/239
- https://github.com/ArchiveBox/ArchiveBox/security/advisories/GHSA-cr45-98w9-gwqx (`CVE-2023-45815`)
- https://github.com/ArchiveBox/ArchiveBox/wiki/Security-Overview#publishing
< / details >
< br / >
### Working Around Sites that Block Archiving
2024-01-04 21:47:21 +00:00
For various reasons, many large sites (Reddit, Twitter, Cloudflare, etc.) actively block archiving or bots in general. There are a number of approaches to work around this.
2024-01-04 21:32:08 +00:00
< br / >
< details >
< summary > < i > Click to expand...< / i > < / summary >
2024-01-04 21:58:33 +00:00
< br / >
2024-01-04 21:32:08 +00:00
- Set [`CHROME_USER_AGENT`, `WGET_USER_AGENT`, `CURL_USER_AGENT` ](https://github.com/ArchiveBox/ArchiveBox/wiki/Configuration#curl_user_agent ) to impersonate a real browser (instead of an ArchiveBox bot)
- Set up a logged-in browser session for archiving using [`CHROME_DATA_DIR` & `COOKIES_FILE` ](https://github.com/ArchiveBox/ArchiveBox/wiki/Chromium-Install#setting-up-a-chromium-user-profile )
- Rewrite your URLs before archiving to swap in an alternative frontend thats more bot-friendly e.g.
`reddit.com/some/url` -> `teddit.net/some/url` : https://github.com/mendel5/alternative-front-ends
In the future we plan on adding support for running JS scripts during archiving to block ads, cookie popups, modals, and fix other issues. Follow here for progress: [Issue #51 ](https://github.com/ArchiveBox/ArchiveBox/issues/51 ).
2024-01-04 20:30:21 +00:00
< / details >
< br / >
2024-01-04 21:32:08 +00:00
2021-04-08 14:37:57 +00:00
### Saving Multiple Snapshots of a Single URL
2021-04-08 10:39:23 +00:00
2024-01-04 21:47:21 +00:00
ArchiveBox appends a hash with the current date `https://example.com#2020-10-24` to differentiate when a single URL is archived multiple times.
2024-01-04 20:30:21 +00:00
< br / >
< details >
< summary > < i > Click to expand...< / i > < / summary >
2024-01-04 21:58:33 +00:00
< br / >
2024-01-04 20:30:21 +00:00
2024-01-04 21:47:21 +00:00
Because ArchiveBox uniquely identifies snapshots by URL, it must use a workaround to take multiple snapshots of the same URL (otherwise they would show up as a single Snapshot entry). It makes the URLs of repeated snapshots unique by adding a hash with the archive date at the end:
2021-01-20 03:02:35 +00:00
2020-10-25 02:23:08 +00:00
```bash
archivebox add 'https://example.com#2020-10-24'
...
archivebox add 'https://example.com#2020-10-25'
```
2021-01-20 20:35:28 +00:00
2024-01-04 21:47:21 +00:00
The < img src = "https://user-images.githubusercontent.com/511499/115942091-73c02300-a476-11eb-958e-5c1fc04da488.png" alt = "Re-Snapshot Button" height = "24px" / > button in the Admin UI is a shortcut for this hash-date multi-snapshotting workaround.
Improved support for saving multiple snapshots of a single URL without this hash-date workaround will be [added eventually ](https://github.com/ArchiveBox/ArchiveBox/issues/179 ) (along with the ability to view diffs of the changes between runs).
2021-04-24 00:58:06 +00:00
2024-01-04 21:32:08 +00:00
#### Learn More
- https://github.com/ArchiveBox/ArchiveBox/issues/179
- https://github.com/ArchiveBox/ArchiveBox/wiki/Usage#explanation-of-buttons-in-the-web-ui---admin-snapshots-list
2024-01-04 20:30:21 +00:00
< / details >
< br / >
2021-04-08 14:37:57 +00:00
### Storage Requirements
2021-04-08 10:39:23 +00:00
2024-01-04 21:58:33 +00:00
Because ArchiveBox is designed to ingest a large volume of URLs with multiple copies of each URL stored by different 3rd-party tools, it can be quite disk-space intensive.
There also also some special requirements when using filesystems like NFS/SMB/FUSE.
2024-01-04 21:47:21 +00:00
2024-01-04 20:30:21 +00:00
< br / >
< details >
< summary > < i > Click to expand...< / i > < / summary >
2024-01-04 21:58:33 +00:00
< br / >
2024-01-04 20:30:21 +00:00
2024-01-04 21:47:21 +00:00
**ArchiveBox can use anywhere from ~1gb per 1000 articles, to ~50gb per 1000 articles**, mostly dependent on whether you're saving audio & video using `SAVE_MEDIA=True` and whether you lower `MEDIA_MAX_SIZE=750mb` .
2021-04-08 10:39:23 +00:00
2023-11-14 01:17:50 +00:00
Disk usage can be reduced by using a compressed/deduplicated filesystem like ZFS/BTRFS, or by turning off extractors methods you don't need. You can also deduplicate content with a tool like [fdupes ](https://github.com/adrianlopezroche/fdupes ) or [rdfind ](https://github.com/pauldreik/rdfind ). **Don't store large collections on older filesystems like EXT3/FAT** as they may not be able to handle more than 50k directory entries in the `archive/` folder. **Try to keep the `index.sqlite3` file on local drive (not a network mount)** or SSD for maximum performance, however the `archive/` folder can be on a network mount or slower HDD.
2021-04-08 10:39:23 +00:00
2024-01-04 20:30:21 +00:00
If using Docker or NFS/SMB/FUSE for the `data/archive/` folder, you may need to set [`PUID` & `PGID` ](https://github.com/ArchiveBox/ArchiveBox/wiki/Configuration#puid--pgid ) and [disable `root_squash` ](https://github.com/ArchiveBox/ArchiveBox/issues/1304 ) on your fileshare server.
2024-01-04 21:32:08 +00:00
#### Learn More
- https://github.com/ArchiveBox/ArchiveBox/wiki/Usage#Disk-Layout
- https://github.com/ArchiveBox/ArchiveBox/wiki/Security-Overview#output-folder
- https://github.com/ArchiveBox/ArchiveBox/wiki/Usage#large-archives
- https://github.com/ArchiveBox/ArchiveBox/wiki/Configuration#puid--pgid
- https://github.com/ArchiveBox/ArchiveBox/wiki/Security-Overview#do-not-run-as-root
2024-01-04 20:30:21 +00:00
< / details >
2021-01-20 22:19:56 +00:00
< br / >
2021-01-20 20:35:28 +00:00
2021-01-20 21:31:10 +00:00
---
2021-01-20 22:19:56 +00:00
< br / >
2021-01-20 20:35:28 +00:00
## Screenshots
< div align = "center" width = "80%" >
2024-01-04 20:29:38 +00:00
< img src = "https://github.com/ArchiveBox/ArchiveBox/assets/511499/0362bcd1-1dfd-43c6-b4ec-db5e78da07b2" width = "80%" / >
2021-01-20 20:35:28 +00:00
< table >
< tbody >
< tr >
< td >
2024-01-04 20:29:38 +00:00
< img src = "https://github.com/ArchiveBox/ArchiveBox/assets/511499/e9fdcb16-344e-48c8-8be0-efa48ec155d5" alt = "brew install archivebox" > < br / >
< img src = "https://github.com/ArchiveBox/ArchiveBox/assets/511499/e235c9d8-fda9-499d-a6a5-59b0e6a0efce" alt = "archivebox version" >
2021-01-20 20:35:28 +00:00
< / td >
< td >
2024-01-04 20:29:38 +00:00
< img src = "https://github.com/ArchiveBox/ArchiveBox/assets/511499/0e3da0c7-d2c2-4a71-b096-6caedafd6ef7" alt = "archivebox init" > < br / >
2021-01-20 20:35:28 +00:00
< / td >
< td >
2024-01-04 20:29:38 +00:00
< img src = "https://github.com/ArchiveBox/ArchiveBox/assets/511499/31c47440-ec14-4a02-99a3-aae8a9078d46" alt = "archivebox add" >
2021-01-20 20:35:28 +00:00
< / td >
< td >
2024-01-04 20:29:38 +00:00
< img src = "https://github.com/ArchiveBox/ArchiveBox/assets/511499/ebcdc21d-e2af-4bf8-ad4b-bc4f3151bbef" alt = "archivebox data dir" >
2021-01-20 20:35:28 +00:00
< / td >
< / tr >
< tr >
< td >
2024-01-04 20:29:38 +00:00
< img src = "https://github.com/ArchiveBox/ArchiveBox/assets/511499/ea672e6b-4df5-49d8-b550-7f450951fd27" alt = "archivebox server" >
2021-01-20 20:35:28 +00:00
< / td >
< td >
2024-01-04 20:29:38 +00:00
< img src = "https://github.com/ArchiveBox/ArchiveBox/assets/511499/e1e5bd78-b0b6-45dc-914c-e1046fee4bc4" alt = "archivebox server add" >
2021-01-20 20:35:28 +00:00
< / td >
< td >
2024-01-04 20:29:38 +00:00
< img src = "https://github.com/ArchiveBox/ArchiveBox/assets/511499/e8e0b6f8-8fdf-4b7f-8124-c10d8699bdb2" alt = "archivebox server list" >
2021-01-20 20:35:28 +00:00
< / td >
< td >
2024-01-04 20:29:38 +00:00
< img src = "https://github.com/ArchiveBox/ArchiveBox/assets/511499/ace0954a-ddac-4520-9d18-1c77b1ec50b2" alt = "archivebox server detail" >
2021-01-20 20:35:28 +00:00
< / td >
< / tr >
< / tbody >
< / table >
< / div >
2021-01-20 22:03:34 +00:00
< br / >
2021-01-20 20:35:28 +00:00
2020-10-10 20:00:53 +00:00
---
2021-01-20 23:34:11 +00:00
< br / >
2021-01-21 00:45:33 +00:00
< div align = "center" >
2024-01-04 20:29:38 +00:00
< img src = "https://github.com/ArchiveBox/ArchiveBox/assets/511499/ca85432e-a2df-40c6-968f-51a1ef99b24e" width = "100%" alt = "paisley graphic" >
2021-01-21 00:45:33 +00:00
< / div >
2019-03-19 05:19:04 +00:00
2020-10-10 20:00:53 +00:00
# Background & Motivation
2019-03-12 22:09:20 +00:00
2023-01-31 07:25:59 +00:00
ArchiveBox aims to enable more of the internet to be saved from deterioration by empowering people to self-host their own archives. The intent is for all the web content you care about to be viewable with common software in 50 - 100 years without needing to run ArchiveBox or other specialized software to replay it.
2021-04-08 10:39:23 +00:00
2024-01-04 21:32:08 +00:00
< br / >
< details >
2024-01-04 21:58:33 +00:00
< summary > < i > Click to read more...< / i > < / summary >
< br / >
2024-01-04 21:32:08 +00:00
2020-07-23 16:32:40 +00:00
Vast treasure troves of knowledge are lost every day on the internet to link rot. As a society, we have an imperative to preserve some important parts of that treasure, just like we preserve our books, paintings, and music in physical libraries long after the originals go out of print or fade into obscurity.
2019-03-12 22:42:19 +00:00
2021-04-08 10:39:23 +00:00
Whether it's to resist censorship by saving articles before they get taken down or edited, or just to save a collection of early 2010's flash games you love to play, having the tools to archive internet content enables to you save the stuff you care most about before it disappears.
2019-03-12 22:09:20 +00:00
2019-03-12 22:52:51 +00:00
< div align = "center" >
2024-01-04 20:29:38 +00:00
< img src = "https://github.com/ArchiveBox/ArchiveBox/assets/511499/71e36bc5-1c94-44e2-92b6-405fa898c734" width = "40%" / > < br / >
< sup > < i > Image from < a href = "https://perma.cc/" > Perma.cc< / a > ...< / i > < br / > < / sup >
2019-03-12 22:52:51 +00:00
< / div >
2019-03-12 22:31:05 +00:00
2021-04-08 10:39:23 +00:00
The balance between the permanence and ephemeral nature of content on the internet is part of what makes it beautiful. I don't think everything should be preserved in an automated fashion--making all content permanent and never removable, but I do think people should be able to decide for themselves and effectively archive specific content that they care about.
2019-03-12 22:53:52 +00:00
2020-10-10 20:00:53 +00:00
Because modern websites are complicated and often rely on dynamic content,
2021-04-08 12:59:12 +00:00
ArchiveBox archives the sites in **several different formats** beyond what public archiving services like Archive.org/Archive.is save. Using multiple methods and the market-dominant browser to execute JS ensures we can save even the most complex, finicky websites in at least a few high-quality, long-term data formats.
2020-10-10 20:00:53 +00:00
2024-01-04 21:32:08 +00:00
< / details >
< br / >
2019-03-13 04:45:01 +00:00
## Comparison to Other Projects
2019-03-12 22:49:11 +00:00
2024-01-04 20:29:38 +00:00
< img src = "https://github.com/ArchiveBox/ArchiveBox/assets/511499/4cac62a9-e8fb-425b-85a3-ca644aa6dd42" width = "5%" align = "right" alt = "comparison" / >
2019-03-19 05:46:01 +00:00
2024-01-04 21:58:33 +00:00
> [!TIP]
> **Check out our [community page](https://github.com/ArchiveBox/ArchiveBox/wiki/Web-Archiving-Community) for an index of web archiving initiatives and projects.**
2019-03-12 22:09:20 +00:00
2021-04-08 10:39:23 +00:00
A variety of open and closed-source archiving projects exist, but few provide a nice UI and CLI to manage a large, high-fidelity archive collection over time.
2019-03-19 05:42:32 +00:00
2021-04-08 10:39:23 +00:00
ArchiveBox tries to be a robust, set-and-forget archiving solution suitable for archiving RSS feeds, bookmarks, or your entire browsing history (beware, it may be too big to store), ~~including private/authenticated content that you wouldn't otherwise share with a centralized service~~ (this is not recommended due to JS replay security concerns).
2019-03-19 05:25:00 +00:00
2021-04-08 10:47:45 +00:00
### Comparison With Centralized Public Archives
2019-03-13 04:45:01 +00:00
2021-06-07 12:03:20 +00:00
Not all content is suitable to be archived in a centralized collection, whether because it's private, copyrighted, too large, or too complex. ArchiveBox hopes to fill that gap.
2019-03-13 04:45:01 +00:00
2021-04-08 10:39:23 +00:00
By having each user store their own content locally, we can save much larger portions of everyone's browsing history than a shared centralized service would be able to handle. The eventual goal is to work towards federated archiving where users can share portions of their collections with each other.
2021-04-08 10:47:45 +00:00
### Comparison With Other Self-Hosted Archiving Options
2021-04-08 10:39:23 +00:00
2021-06-07 12:03:20 +00:00
ArchiveBox differentiates itself from [similar self-hosted projects ](https://github.com/ArchiveBox/ArchiveBox/wiki/Web-Archiving-Community#Web-Archiving-Projects ) by providing both a comprehensive CLI interface for managing your archive, a Web UI that can be used either independently or together with the CLI, and a simple on-disk data format that can be used without either.
2021-04-08 10:39:23 +00:00
2024-01-04 21:32:08 +00:00
< details >
2024-01-04 22:58:41 +00:00
< summary > < i > Click to see the < b > ⭐️ officially recommended< / b > alternatives to ArchiveBox...< / i > < / summary >
< br / >
2024-01-04 21:32:08 +00:00
2021-04-08 10:39:23 +00:00
2021-04-24 02:02:01 +00:00
*If you want better fidelity for very complex interactive pages with heavy JS/streams/API requests, check out [ArchiveWeb.page ](https://archiveweb.page ) and [ReplayWeb.page ](https://replayweb.page ).*
2021-04-08 10:39:23 +00:00
2021-04-24 02:02:01 +00:00
*If you want more bookmark categorization and note-taking features, check out [Archivy ](https://archivy.github.io/ ), [Memex ](https://github.com/WorldBrain/Memex ), [Polar ](https://getpolarized.io/ ), or [LinkAce ](https://www.linkace.org/ ).*
*If you need more advanced recursive spider/crawling ability beyond `--depth=1` , check out [Browsertrix ](https://github.com/webrecorder/browsertrix-crawler ), [Photon ](https://github.com/s0md3v/Photon ), or [Scrapy ](https://scrapy.org/ ) and pipe the outputted URLs into ArchiveBox.*
2019-03-13 04:45:01 +00:00
2021-04-08 10:39:23 +00:00
For more alternatives, see our [list here ](https://github.com/ArchiveBox/ArchiveBox/wiki/Web-Archiving-Community#Web-Archiving-Projects )...
2019-03-12 22:24:15 +00:00
2024-01-04 22:58:41 +00:00
ArchiveBox is neither the highest fidelity nor the simplest tool available for self-hosted archiving, rather it's a jack-of-all-trades that tries to do most things well by default. We encourage you to try these other tools made by our friends if ArchiveBox isn't suited to your needs.
2024-01-04 21:32:08 +00:00
< / details >
< br / >
2021-01-21 00:45:33 +00:00
< div align = "center" >
2021-01-20 22:05:05 +00:00
< br / >
2024-01-04 21:58:33 +00:00
< img src = "https://github.com/ArchiveBox/ArchiveBox/assets/511499/04808ac2-3133-44fd-8703-3387e06dc851" width = "100%" alt = "dependencies graphic" >
2021-01-21 00:45:33 +00:00
< / div >
2021-01-20 22:05:05 +00:00
2021-04-08 14:39:39 +00:00
## Internet Archiving Ecosystem
2019-03-30 20:23:51 +00:00
2020-07-23 16:32:40 +00:00
Whether you want to learn which organizations are the big players in the web archiving space, want to find a specific open-source tool for your web archiving need, or just want to see where archivists hang out online, our Community Wiki page serves as an index of the broader web archiving community. Check it out to learn about some of the coolest web archiving projects and communities on the web!
2019-03-12 22:24:15 +00:00
2024-01-04 21:32:08 +00:00
2024-01-04 20:29:38 +00:00
< img src = "https://github.com/ArchiveBox/ArchiveBox/assets/511499/78d8a725-97f4-47f5-b983-1f62843ddc51" width = "14%" align = "right" / >
2019-03-12 22:42:19 +00:00
2020-11-23 07:04:39 +00:00
- [Community Wiki ](https://github.com/ArchiveBox/ArchiveBox/wiki/Web-Archiving-Community )
2021-01-22 15:29:35 +00:00
- [The Master Lists ](https://github.com/ArchiveBox/ArchiveBox/wiki/Web-Archiving-Community#the-master-lists )
2020-07-23 16:32:40 +00:00
_Community-maintained indexes of archiving tools and institutions._
2021-01-22 15:29:35 +00:00
- [Web Archiving Software ](https://github.com/ArchiveBox/ArchiveBox/wiki/Web-Archiving-Community#web-archiving-projects )
2020-07-23 16:32:40 +00:00
_Open source tools and projects in the internet archiving space._
2021-01-22 15:29:35 +00:00
- [Reading List ](https://github.com/ArchiveBox/ArchiveBox/wiki/Web-Archiving-Community#reading-list )
2020-07-23 16:32:40 +00:00
_Articles, posts, and blogs relevant to ArchiveBox and web archiving in general._
2021-01-22 15:29:35 +00:00
- [Communities ](https://github.com/ArchiveBox/ArchiveBox/wiki/Web-Archiving-Community#communities )
2020-07-23 16:32:40 +00:00
_A collection of the most active internet archiving communities and initiatives._
2020-11-23 07:04:39 +00:00
- Check out the ArchiveBox [Roadmap ](https://github.com/ArchiveBox/ArchiveBox/wiki/Roadmap ) and [Changelog ](https://github.com/ArchiveBox/ArchiveBox/wiki/Changelog )
2023-10-12 07:22:47 +00:00
- Learn why archiving the internet is important by reading the "[On the Importance of Web Archiving](https://items.ssrc.org/parameters/on-the-importance-of-web-archiving/)" blog post.
2021-02-10 02:45:28 +00:00
- Reach out to me for questions and comments via [@ArchiveBoxApp ](https://twitter.com/ArchiveBoxApp ) or [@theSquashSH ](https://twitter.com/thesquashSH ) on Twitter
2021-04-08 14:00:19 +00:00
2024-01-04 21:32:08 +00:00
2021-04-08 14:36:07 +00:00
< br / >
**Need help building a custom archiving solution?**
2023-11-14 01:17:50 +00:00
> ✨ **[Hire the team that built Archivebox](https://zulip.archivebox.io/#narrow/stream/167-enterprise/topic/welcome/near/1191102) to work on your project.** ([@ArchiveBoxApp](https://twitter.com/ArchiveBoxApp))
2021-04-08 14:36:07 +00:00
2023-11-14 01:17:50 +00:00
< sup > (We also offer general software consulting across many industries)< / sup >
2020-07-23 16:32:40 +00:00
2021-01-20 22:03:34 +00:00
< br / >
2019-03-12 23:22:18 +00:00
---
2020-07-23 16:32:40 +00:00
2021-01-21 00:45:33 +00:00
< div align = "center" >
2024-01-04 20:29:38 +00:00
< img src = "https://github.com/ArchiveBox/ArchiveBox/assets/511499/897f7a88-1265-4aab-b80c-b1640afaad1f" width = "100%" alt = "documentation graphic" >
2021-01-21 00:45:33 +00:00
< / div >
2021-01-20 21:42:11 +00:00
2019-03-12 23:25:10 +00:00
# Documentation
2019-01-23 03:08:27 +00:00
2019-03-12 22:51:00 +00:00
< img src = "https://read-the-docs-guidelines.readthedocs-hosted.com/_images/logo-dark.png" width = "13%" align = "right" / >
2019-03-12 22:29:46 +00:00
2021-06-07 12:03:20 +00:00
We use the [GitHub wiki system ](https://github.com/ArchiveBox/ArchiveBox/wiki ) and [Read the Docs ](https://archivebox.readthedocs.io/en/latest/ ) (WIP) for documentation.
2019-01-01 01:16:16 +00:00
2020-11-23 07:04:39 +00:00
You can also access the docs locally by looking in the [`ArchiveBox/docs/` ](https://github.com/ArchiveBox/ArchiveBox/wiki/Home ) folder.
2019-01-01 02:01:20 +00:00
2019-03-12 23:25:10 +00:00
## Getting Started
2017-05-05 09:10:50 +00:00
2020-11-23 07:04:39 +00:00
- [Quickstart ](https://github.com/ArchiveBox/ArchiveBox/wiki/Quickstart )
- [Install ](https://github.com/ArchiveBox/ArchiveBox/wiki/Install )
- [Docker ](https://github.com/ArchiveBox/ArchiveBox/wiki/Docker )
- [Usage ](https://github.com/ArchiveBox/ArchiveBox/wiki/Usage )
- [Configuration ](https://github.com/ArchiveBox/ArchiveBox/wiki/Configuration )
- [Supported Sources ](https://github.com/ArchiveBox/ArchiveBox/wiki/Quickstart#2-get-your-list-of-urls-to-archive )
- [Supported Outputs ](https://github.com/ArchiveBox/ArchiveBox/wiki#can-save-these-things-for-each-site )
2024-01-04 21:32:08 +00:00
## Advanced
- [Troubleshooting ](https://github.com/ArchiveBox/ArchiveBox/wiki/Troubleshooting )
2020-11-23 07:04:39 +00:00
- [Scheduled Archiving ](https://github.com/ArchiveBox/ArchiveBox/wiki/Scheduled-Archiving )
- [Publishing Your Archive ](https://github.com/ArchiveBox/ArchiveBox/wiki/Publishing-Your-Archive )
2020-11-27 04:36:37 +00:00
- [Chromium Install ](https://github.com/ArchiveBox/ArchiveBox/wiki/Chromium-Install )
2024-01-04 21:32:08 +00:00
- [Cookies & Sessions Setup ](https://github.com/ArchiveBox/ArchiveBox/wiki/Chromium-Install#setting-up-a-chromium-user-profile )
2020-11-23 07:04:39 +00:00
- [Security Overview ](https://github.com/ArchiveBox/ArchiveBox/wiki/Security-Overview )
2022-04-12 22:24:24 +00:00
- [Upgrading or Merging Archives ](https://github.com/ArchiveBox/ArchiveBox/wiki/Upgrading-or-Merging-Archives )
2024-01-04 21:32:08 +00:00
## Developers
- [Developer Documentation ](https://github.com/ArchiveBox/ArchiveBox#archivebox-development )
2021-01-20 04:31:59 +00:00
- [Python API ](https://docs.archivebox.io/en/latest/modules.html ) (alpha)
- [REST API ](https://github.com/ArchiveBox/ArchiveBox/issues/496 ) (alpha)
2017-06-30 05:57:20 +00:00
2019-03-12 23:25:10 +00:00
## More Info
2017-06-30 05:57:20 +00:00
2024-01-04 21:32:08 +00:00
- [Bug Tracker ](https://github.com/ArchiveBox/ArchiveBox/issues )
2020-11-23 07:04:39 +00:00
- [Roadmap ](https://github.com/ArchiveBox/ArchiveBox/wiki/Roadmap )
2024-01-04 21:32:08 +00:00
- [Changelog ](https://github.com/ArchiveBox/ArchiveBox/releases )
2020-11-23 07:04:39 +00:00
- [Donations ](https://github.com/ArchiveBox/ArchiveBox/wiki/Donations )
- [Background & Motivation ](https://github.com/ArchiveBox/ArchiveBox#background--motivation )
- [Web Archiving Community ](https://github.com/ArchiveBox/ArchiveBox/wiki/Web-Archiving-Community )
2019-01-11 12:57:46 +00:00
2021-01-20 22:03:34 +00:00
< br / >
2019-01-11 12:57:46 +00:00
---
2021-01-21 00:45:33 +00:00
< div align = "center" >
2024-01-04 20:29:38 +00:00
< img src = "https://github.com/ArchiveBox/ArchiveBox/assets/511499/e895e79f-5c7d-429b-ad8a-7df2cc183ca3" width = "100%" alt = "development" >
2021-01-21 00:45:33 +00:00
< / div >
2021-01-20 22:03:34 +00:00
2020-10-10 20:00:53 +00:00
# ArchiveBox Development
2020-11-23 07:04:39 +00:00
All contributions to ArchiveBox are welcomed! Check our [issues ](https://github.com/ArchiveBox/ArchiveBox/issues ) and [Roadmap ](https://github.com/ArchiveBox/ArchiveBox/wiki/Roadmap ) for things to work on, and please open an issue to discuss your proposed implementation before working on things! Otherwise we may have to close your PR if it doesn't align with our roadmap.
2020-10-10 20:00:53 +00:00
2023-01-31 07:25:59 +00:00
For low hanging fruit / easy first tickets, see: < a href = "https://github.com/ArchiveBox/ArchiveBox/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22help+wanted%22" > ArchiveBox/Issues `#good first ticket` `#help wanted` </ a > .
2021-01-21 01:09:07 +00:00
2023-09-18 14:37:35 +00:00
**Python API Documentation:** https://docs.archivebox.io/en/dev/archivebox.html#module-archivebox.main
2023-02-19 22:02:18 +00:00
2020-10-10 20:00:53 +00:00
### Setup the dev environment
2021-04-08 10:03:46 +00:00
< details > < summary > < i > Click to expand...< / i > < / summary >
2021-04-08 10:01:04 +00:00
2021-01-20 03:02:35 +00:00
#### 1. Clone the main code repo (making sure to pull the submodules as well)
```bash
git clone --recurse-submodules https://github.com/ArchiveBox/ArchiveBox
cd ArchiveBox
git checkout dev # or the branch you want to test
2020-12-20 01:13:58 +00:00
git submodule update --init --recursive
2020-12-11 23:50:16 +00:00
git pull --recurse-submodules
2021-01-20 03:02:35 +00:00
```
#### 2. Option A: Install the Python, JS, and system dependencies directly on your machine
2020-10-10 20:00:53 +00:00
2021-01-20 03:02:35 +00:00
```bash
2020-10-10 20:00:53 +00:00
# Install ArchiveBox + python dependencies
2021-01-20 03:02:35 +00:00
python3 -m venv .venv & & source .venv/bin/activate & & pip install -e '.[dev]'
# or: pipenv install --dev && pipenv shell
2020-10-10 20:00:53 +00:00
# Install node dependencies
npm install
2021-04-08 10:47:45 +00:00
# or
archivebox setup
2020-10-10 20:00:53 +00:00
2021-01-20 03:02:35 +00:00
# Check to see if anything is missing
archivebox --version
# install any missing dependencies manually, or use the helper script:
2020-10-10 20:00:53 +00:00
./bin/setup.sh
2021-01-20 03:02:35 +00:00
```
#### 2. Option B: Build the docker container and use that for development instead
2020-10-31 20:33:09 +00:00
2021-01-20 03:02:35 +00:00
```bash
2020-10-31 20:33:09 +00:00
# Optional: develop via docker by mounting the code dir into the container
# if you edit e.g. ./archivebox/core/models.py on the docker host, runserver
# inside the container will reload and pick up your changes
docker build . -t archivebox
2021-10-28 15:01:34 +00:00
docker run -it \
-v $PWD/data:/data \
archivebox init --setup
2021-04-06 03:17:07 +00:00
docker run -it -p 8000:8000 \
2020-10-31 20:33:09 +00:00
-v $PWD/data:/data \
-v $PWD/archivebox:/app/archivebox \
archivebox server 0.0.0.0:8000 --debug --reload
2021-04-06 03:17:07 +00:00
# (remove the --reload flag and add the --nothreading flag when profiling with the django debug toolbar)
2023-05-06 04:47:02 +00:00
# When using --reload, make sure any files you create can be read by the user in the Docker container, eg with 'chmod a+rX'.
2020-10-10 20:00:53 +00:00
```
2021-04-08 10:01:04 +00:00
< / details >
2020-10-10 20:43:44 +00:00
### Common development tasks
2020-10-10 20:00:53 +00:00
2020-10-10 20:43:44 +00:00
See the `./bin/` folder and read the source of the bash scripts within.
2021-06-07 12:03:20 +00:00
You can also run all these in Docker. For more examples see the GitHub Actions CI/CD tests that are run: `.github/workflows/*.yaml` .
2020-10-10 20:00:53 +00:00
2021-01-29 01:49:59 +00:00
#### Run in DEBUG mode
2021-04-08 10:03:46 +00:00
< details > < summary > < i > Click to expand...< / i > < / summary >
2021-04-08 10:01:04 +00:00
2021-01-29 01:49:59 +00:00
```bash
archivebox config --set DEBUG=True
# or
archivebox server --debug ...
```
2022-04-13 00:24:44 +00:00
https://stackoverflow.com/questions/1074212/how-can-i-see-the-raw-sql-queries-django-is-running
2021-04-08 10:01:04 +00:00
< / details >
2021-06-07 12:03:20 +00:00
#### Install and run a specific GitHub branch
2021-01-30 07:38:44 +00:00
2021-04-08 10:03:46 +00:00
< details > < summary > < i > Click to expand...< / i > < / summary >
2021-04-08 10:01:04 +00:00
2024-01-04 21:32:08 +00:00
##### Use a Pre-Built Image
If you're looking for the latest `dev` Docker image, it's often available pre-built on Docker Hub, simply pull and use `archivebox/archivebox:dev` .
```bash
docker pull archivebox/archivebox:dev
docker run archivebox/archivebox:dev version
# verify the BUILD_TIME and COMMIT_HASH in the output are recent
```
##### Build Branch from Source
You can also build and run any branch yourself from source, for example to build & use `dev` locally:
2023-11-14 07:43:53 +00:00
```bash
2023-10-31 06:33:29 +00:00
# docker-compose.yml:
services:
archivebox:
image: archivebox/archivebox:dev
build: 'https://github.com/ArchiveBox/ArchiveBox.git#dev'
...
2024-01-04 21:32:08 +00:00
# or with plain Docker:
2021-01-30 07:38:44 +00:00
docker build -t archivebox:dev https://github.com/ArchiveBox/ArchiveBox.git#dev
2021-05-07 12:02:45 +00:00
docker run -it -v $PWD:/data archivebox:dev init --setup
2024-01-04 21:32:08 +00:00
# or with pip:
2021-05-07 12:02:45 +00:00
pip install 'git+https://github.com/pirate/ArchiveBox@dev'
npm install 'git+https://github.com/ArchiveBox/ArchiveBox.git#dev'
archivebox init --setup
2021-01-30 07:38:44 +00:00
```
2021-04-08 10:01:04 +00:00
< / details >
2020-10-10 20:43:44 +00:00
#### Run the linters
2020-10-10 20:00:53 +00:00
2021-04-08 10:03:46 +00:00
< details > < summary > < i > Click to expand...< / i > < / summary >
2021-04-08 10:01:04 +00:00
2020-10-10 20:43:44 +00:00
```bash
./bin/lint.sh
```
(uses `flake8` and `mypy` )
2020-10-10 20:00:53 +00:00
2021-04-08 10:01:04 +00:00
< / details >
2020-10-10 20:43:44 +00:00
#### Run the integration tests
2021-04-08 10:03:46 +00:00
< details > < summary > < i > Click to expand...< / i > < / summary >
2021-04-08 10:01:04 +00:00
2020-10-10 20:43:44 +00:00
```bash
./bin/test.sh
2020-10-10 20:00:53 +00:00
```
2020-10-10 20:43:44 +00:00
(uses `pytest -s` )
2020-10-10 20:00:53 +00:00
2021-04-08 10:01:04 +00:00
< / details >
2020-12-20 01:16:02 +00:00
#### Make migrations or enter a django shell
2021-04-08 10:03:46 +00:00
< details > < summary > < i > Click to expand...< / i > < / summary >
2021-04-08 10:01:04 +00:00
2021-01-30 07:38:44 +00:00
Make sure to run this whenever you change things in `models.py` .
2023-10-19 19:57:05 +00:00
2020-12-20 01:16:02 +00:00
```bash
cd archivebox/
./manage.py makemigrations
2021-01-20 03:02:35 +00:00
cd path/to/test/data/
2020-12-20 01:16:02 +00:00
archivebox shell
2021-01-30 13:25:34 +00:00
archivebox manage dbshell
2020-12-20 01:16:02 +00:00
```
2023-10-19 19:57:05 +00:00
2022-04-13 00:24:44 +00:00
(uses `pytest -s` )
https://stackoverflow.com/questions/1074212/how-can-i-see-the-raw-sql-queries-django-is-running
2020-12-20 01:16:02 +00:00
2021-04-08 10:01:04 +00:00
< / details >
2021-07-02 02:48:39 +00:00
#### Contributing a new extractor
2023-10-19 19:57:05 +00:00
< details > < summary > < i > Click to expand...< / i > < / summary >
< br / > < br / >
2021-07-02 02:48:39 +00:00
ArchiveBox [`extractors` ](https://github.com/ArchiveBox/ArchiveBox/blob/dev/archivebox/extractors/media.py ) are external binaries or Python/Node scripts that ArchiveBox runs to archive content on a page.
Extractors take the URL of a page to archive, write their output to the filesystem `archive/<timestamp>/<extractorname>/...` , and return an [`ArchiveResult` ](https://github.com/ArchiveBox/ArchiveBox/blob/dev/archivebox/core/models.py#:~:text=return%20qs-,class%20ArchiveResult,-(models.Model )%3A) entry which is saved to the database (visible on the `Log` page in the UI).
*Check out how we added ** [`archivebox/extractors/singlefile.py` ](https://github.com/ArchiveBox/ArchiveBox/blob/dev/archivebox/extractors/singlefile.py )** as an example of the process: [Issue #399 ](https://github.com/ArchiveBox/ArchiveBox/issues/399 ) + [PR #403 ](https://github.com/ArchiveBox/ArchiveBox/pull/403 ).*
< br / >
**The process to contribute a new extractor is like this:**
1. [Open an issue ](https://github.com/ArchiveBox/ArchiveBox/issues/new?assignees=&labels=changes%3A+behavior%2Cstatus%3A+idea+phase&template=feature_request.md&title=Feature+Request%3A+... ) with your propsoed implementation (please link to the pages of any new external dependencies you plan on using)
2. Ensure any dependencies needed are easily installable via a package managers like `apt` , `brew` , `pip3` , `npm`
(Ideally, prefer to use external programs available via `pip3` or `npm` , however we do support using any binary installable via package manager that exposes a CLI/Python API and writes output to stdout or the filesystem.)
3. Create a new file in [`archivebox/extractors/<extractorname>.py` ](https://github.com/ArchiveBox/ArchiveBox/blob/dev/archivebox/extractors ) (copy an existing extractor like [`singlefile.py` ](https://github.com/ArchiveBox/ArchiveBox/blob/dev/archivebox/extractors/singlefile.py ) as a template)
4. Add config settings to enable/disable any new dependencies and the extractor as a whole, e.g. `USE_DEPENDENCYNAME` , `SAVE_EXTRACTORNAME` , `EXTRACTORNAME_SOMEOTHEROPTION` in [`archivebox/config.py` ](https://github.com/ArchiveBox/ArchiveBox/blob/dev/archivebox/config.py )
5. Add a preview section to [`archivebox/templates/core/snapshot.html` ](https://github.com/ArchiveBox/ArchiveBox/blob/dev/archivebox/templates/core/snapshot.html ) to view the output, and a column to [`archivebox/templates/core/index_row.html` ](https://github.com/ArchiveBox/ArchiveBox/blob/dev/archivebox/templates/core/index_row.html ) with an icon for your extractor
6. Add an integration test for your extractor in [`tests/test_extractors.py` ](https://github.com/ArchiveBox/ArchiveBox/blob/dev/tests/test_extractors.py )
7. [Submit your PR for review! ](https://github.com/ArchiveBox/ArchiveBox/blob/dev/.github/CONTRIBUTING.md ) 🎉
8. Once merged, please document it in these places and anywhere else you see info about other extractors:
- https://github.com/ArchiveBox/ArchiveBox#output-formats
- https://github.com/ArchiveBox/ArchiveBox/wiki/Configuration#archive-method-toggles
- https://github.com/ArchiveBox/ArchiveBox/wiki/Install#dependencies
< br / > < br / >
< / details >
2020-10-10 20:43:44 +00:00
#### Build the docs, pip package, and docker image
2020-10-10 20:00:53 +00:00
2021-04-08 10:03:46 +00:00
< details > < summary > < i > Click to expand...< / i > < / summary >
2021-04-08 10:01:04 +00:00
2021-01-30 07:38:44 +00:00
(Normally CI takes care of this, but these scripts can be run to do it manually)
2020-10-10 20:43:44 +00:00
```bash
./bin/build.sh
# or individually:
./bin/build_docs.sh
./bin/build_pip.sh
2020-12-11 23:50:16 +00:00
./bin/build_deb.sh
./bin/build_brew.sh
2020-10-10 20:43:44 +00:00
./bin/build_docker.sh
2020-10-10 20:00:53 +00:00
```
2021-04-08 10:01:04 +00:00
< / details >
2020-10-10 20:43:44 +00:00
#### Roll a release
2021-04-08 10:03:46 +00:00
< details > < summary > < i > Click to expand...< / i > < / summary >
2021-04-08 10:01:04 +00:00
2021-01-30 07:38:44 +00:00
(Normally CI takes care of this, but these scripts can be run to do it manually)
2020-10-10 20:43:44 +00:00
```bash
./bin/release.sh
2020-10-10 20:00:53 +00:00
2021-01-20 03:02:35 +00:00
# or individually:
./bin/release_docs.sh
./bin/release_pip.sh
./bin/release_deb.sh
./bin/release_brew.sh
./bin/release_docker.sh
```
2020-10-10 20:00:53 +00:00
2021-04-08 10:01:04 +00:00
< / details >
---
2021-04-23 23:36:25 +00:00
## Further Reading
2021-04-08 09:33:00 +00:00
2021-04-23 23:36:25 +00:00
- Home: [ArchiveBox.io ](https://archivebox.io )
- Demo: [Demo.ArchiveBox.io ](https://demo.archivebox.io )
- Docs: [Docs.ArchiveBox.io ](https://docs.archivebox.io )
2021-05-07 13:43:30 +00:00
- Releases: [Github.com/ArchiveBox/ArchiveBox/releases ](https://github.com/ArchiveBox/ArchiveBox/releases )
2021-04-24 04:38:19 +00:00
- Wiki: [Github.com/ArchiveBox/ArchiveBox/wiki ](https://github.com/ArchiveBox/ArchiveBox/wiki )
- Issues: [Github.com/ArchiveBox/ArchiveBox/issues ](https://github.com/ArchiveBox/ArchiveBox/issues )
2023-05-27 13:08:04 +00:00
- Discussions: [Github.com/ArchiveBox/ArchiveBox/discussions ](https://github.com/ArchiveBox/ArchiveBox/discussions )
- Community Chat: [Zulip Chat (preferred) ](https://zulip.archivebox.io ) or [Matrix Chat (old) ](https://app.element.io/#/room/#archivebox:matrix.org )
- Social Media: [Twitter ](https://twitter.com/ArchiveBoxApp ), [LinkedIn ](https://www.linkedin.com/company/archivebox/ ), [YouTube ](https://www.youtube.com/@ArchiveBoxApp ), [Alternative.to ](https://alternativeto.net/software/archivebox/about/ ), [Reddit ](https://www.reddit.com/r/ArchiveBox/ )
2021-04-24 04:38:19 +00:00
- Donations: [Github.com/ArchiveBox/ArchiveBox/wiki/Donations ](https://github.com/ArchiveBox/ArchiveBox/wiki/Donations )
2021-04-08 09:33:00 +00:00
2020-10-10 20:00:53 +00:00
---
2019-01-23 03:18:59 +00:00
< div align = "center" >
2019-01-23 03:29:23 +00:00
< br / > < br / >
2019-01-23 03:35:00 +00:00
< img src = "https://raw.githubusercontent.com/Monadical-SAS/redux-time/HEAD/examples/static/jeremy.jpg" height = "40px" / >
< br / >
2021-02-10 02:56:40 +00:00
< i > < sub >
2023-11-14 01:17:50 +00:00
This project is maintained mostly in < a href = "https://docs.sweeting.me/s/blog#About" > my spare time< / a > with the help from generous < a href = "https://github.com/ArchiveBox/ArchiveBox/graphs/contributors" > contributors< / a > and < a href = "https://monadical.com" > Monadical Consulting< / a > .
2021-02-10 02:57:53 +00:00
< / sub >
2021-02-10 02:56:40 +00:00
< / i >
2019-03-12 22:12:36 +00:00
< br / > < br / >
2019-03-12 22:11:08 +00:00
2019-03-12 22:10:51 +00:00
< br / >
2021-06-07 12:03:20 +00:00
< a href = "https://github.com/sponsors/pirate" > Sponsor this project on GitHub< / a >
2020-07-23 16:32:40 +00:00
< br >
< br >
2019-01-23 04:07:10 +00:00
< a href = "https://www.patreon.com/theSquashSH" > < img src = "https://img.shields.io/badge/Donate_to_support_development-via_Patreon-%23DD5D76.svg?style=flat" / > < / a >
< br / >
2020-07-23 16:32:40 +00:00
2023-11-09 06:01:08 +00:00
< b > < sub > (网站存档 / 爬虫)< / sub > < / b >
2020-11-23 07:57:38 +00:00
< a href = "https://twitter.com/ArchiveBoxApp" > < img src = "https://img.shields.io/badge/Tweet-%40ArchiveBoxApp-blue.svg?style=flat" / > < / a >
2020-11-23 07:04:39 +00:00
< a href = "https://github.com/ArchiveBox/ArchiveBox" > < img src = "https://img.shields.io/github/stars/ArchiveBox/ArchiveBox.svg?style=flat&label=Star+on+Github" / > < / a >
2019-03-12 19:22:49 +00:00
2021-04-14 06:37:46 +00:00
< br / >
2021-04-23 23:36:25 +00:00
< br / >
< i > ✨ Have spare CPU/disk/bandwidth and want to help the world?< br / > Check out our < a href = "https://github.com/ArchiveBox/good-karma-kit" > Good Karma Kit< / a > ...< / i >
< br / >
2019-01-23 03:18:59 +00:00
< / div >
