2018-12-23 13:01:12 +13:00
# ArchiveBox: Open source local web archiving <img src="https://nicksweeting.com/images/archive.png" height="22px"/> [![Github Stars](https://img.shields.io/github/stars/pirate/bookmark-archiver.svg)](https://github.com/pirate/ArchiveBox) [![Twitter URL](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/thesquashSH)
2017-07-01 06:17:41 +12:00
2018-12-22 12:44:22 +13:00
### (Recently [renamed](https://github.com/pirate/ArchiveBox/issues/108) from `Bookmark Archiver`)
2018-10-24 05:54:03 +13:00
2017-10-31 00:29:25 +13:00
"Your own personal Way-Back Machine"
2019-01-01 14:30:02 +13:00
💻 [Demo ](https://archive.sweeting.me ) | [Source ](https://github.com/pirate/ArchiveBox/tree/master ) | [Changelog ](https://github.com/pirate/ArchiveBox/wiki/Changelog ) | [Roadmap ](https://github.com/pirate/ArchiveBox/wiki/Roadmap )
2017-11-01 12:28:11 +13:00
2019-01-01 14:15:15 +13:00
▶️ [Quickstart ](https://github.com/pirate/ArchiveBox/wiki/Quickstart ) | [Details ](https://github.com/pirate/ArchiveBox/wiki ) | [Configuration ](https://github.com/pirate/ArchiveBox/wiki/Configuration ) | [Troubleshooting ](https://github.com/pirate/ArchiveBox/wiki/Troubleshooting )
2018-12-23 13:01:12 +13:00
2017-11-01 12:28:11 +13:00
---
2018-12-20 21:04:15 +13:00
Save an archived copy of the websites you visit (the actual *content* of each site, not just the list of links). Can archive entire browsing history, or just links matching a filter or bookmarks list.
2017-07-01 06:17:41 +12:00
2018-12-20 21:04:15 +13:00
ArchiveBox can import links from:
2018-06-11 10:32:51 +12:00
2018-09-21 04:32:41 +12:00
- < img src = "https://nicksweeting.com/images/bookmarks.png" height = "22px" /> Browser history or bookmarks (Chrome, Firefox, Safari, IE, Opera)
2017-10-31 00:29:25 +13:00
- < img src = "https://getpocket.com/favicon.ico" height = "22px" /> Pocket
- < img src = "https://pinboard.in/favicon.ico" height = "22px" /> Pinboard
2018-05-31 18:26:41 +12:00
- < img src = "https://nicksweeting.com/images/rss.svg" height = "22px" /> RSS or plain text lists
2017-10-31 00:29:25 +13:00
- Shaarli, Delicious, Instapaper, Reddit Saved Posts, Wallabag, Unmark.it, and more!
2018-06-11 10:32:51 +12:00
2018-06-12 04:39:31 +12:00
For each site, it outputs (configurable):
2018-06-11 10:32:51 +12:00
- Browsable static HTML archive (wget)
- PDF (Chrome headless)
- Screenshot (Chrome headless)
2018-10-24 05:10:36 +13:00
- HTML after 2s of JS running (Chrome headless)
2018-06-11 10:32:51 +12:00
- Favicon
- Submits URL to archive.org
- Index summary pages: index.html & index.json
2017-05-05 21:15:19 +12:00
2018-06-11 10:32:51 +12:00
The archiving is additive, so you can schedule `./archive` to run regularly and pull new links into the index.
2018-06-12 17:52:32 +12:00
All the saved content is static and indexed with json files, so it lives forever & is easily parseable, it requires no always-running backend.
2017-07-04 22:57:42 +12:00
2018-05-31 18:26:41 +12:00
[DEMO: archive.sweeting.me ](https://archive.sweeting.me )
2017-10-31 00:29:36 +13:00
2018-12-23 13:01:12 +13:00
[![ ](https://img.shields.io/badge/Donate-Patreon-%23DD5D76.svg )](https://www.patreon.com/theSquashSH)
2018-06-11 15:05:58 +12:00
< img src = "https://i.imgur.com/q3Oz9wN.png" width = "75%" alt = "Desktop Screenshot" align = "top" > < img src = "https://i.imgur.com/TG0fGVo.png" width = "25%" alt = "Mobile Screenshot" align = "top" > < br / >
2017-05-05 21:10:50 +12:00
2019-01-01 14:16:16 +13:00
# Documentation
We use the [Github wiki system ](https://github.com/pirate/ArchiveBox/wiki ) for documentation.
## Getting Started
2017-05-05 21:10:50 +12:00
2019-01-01 14:12:17 +13:00
- [Details & Motivation ](https://github.com/pirate/ArchiveBox/wiki )
- [Quickstart ](https://github.com/pirate/ArchiveBox/wiki/Quickstart )
- [Install ](https://github.com/pirate/ArchiveBox/wiki/Install )
2017-06-30 17:57:20 +12:00
2019-01-01 14:16:16 +13:00
## Reference
2017-06-30 17:57:20 +12:00
2019-01-01 14:12:17 +13:00
- [Configuration ](https://github.com/pirate/ArchiveBox/wiki/Configuration )
- [Chromium Install ](https://github.com/pirate/ArchiveBox/wiki/Chromium-Install )
- [Publishing Your Archive ](https://github.com/pirate/ArchiveBox/wiki/Publishing-Your-Archive )
- [Troubleshooting ](https://github.com/pirate/ArchiveBox/wiki/Troubleshooting )
2017-06-30 17:57:20 +12:00
2019-01-01 14:16:16 +13:00
## More Info
2017-06-30 17:57:20 +12:00
2019-01-01 14:12:17 +13:00
- [Roadmap ](https://github.com/pirate/ArchiveBox/wiki/Roadmap )
- [Changelog ](https://github.com/pirate/ArchiveBox/wiki/Changelog )
- [Donations ](https://github.com/pirate/ArchiveBox/wiki/Donations )
- [Web Archiving Community ](https://github.com/pirate/ArchiveBox/wiki/Web-Archiving-Community )