Open source self-hosted web archiving https://github.com/ArchiveBox/ArchiveBox

Find a file

Nick Sweeting 7e791e143f Update README.md		2019-01-22 23:07:47 -05:00
.github	better issue template	2019-01-22 19:16:09 -05:00
archivebox	add chrome user agent example in config	2019-01-20 14:08:33 -05:00
bin	install youtubedl in setup	2019-01-12 03:14:07 -05:00
docs@d8ed24c6df	update docs version	2019-01-20 14:08:49 -05:00
etc	fix etc nginx and Docker config	2019-01-16 09:20:15 -05:00
.dockerignore	fix etc nginx and Docker config	2019-01-16 09:20:15 -05:00
.gitignore	Update .gitignore	2018-12-31 20:57:12 -05:00
.gitmodules	add docs	2018-12-31 20:59:36 -05:00
_config.yml	Set theme jekyll-theme-merlot	2019-01-10 14:00:41 -05:00
archive	fix the setup/archive symlinks	2018-12-21 22:10:25 +00:00
CNAME	Create CNAME	2018-12-31 21:18:34 -05:00
docker-compose.yml	fix etc nginx and Docker config	2019-01-16 09:20:15 -05:00
Dockerfile	fix etc nginx and Docker config	2019-01-16 09:20:15 -05:00
LICENSE	Initial commit	2017-05-05 04:50:15 -04:00
README.md	Update README.md	2019-01-22 23:07:47 -05:00
setup	clean up binaries in PATH	2018-12-21 18:21:03 -05:00

README.md

ArchiveBox
_{The open-source self-hosted web archive}

"Your own personal Way-Back Machine" (网站存档 / 爬虫)

ArchiveBox archives a copy of websites you choose into a local static HTML folder.
You can use it to archive and browse content you care about long after it's deleted or moved off the internet.

If you run it on a schedule to import your history or bookmarks continusously, you can rest soundly knowing that the slice of the internet you care about can be preserved long after the servers go down or the links break.

Because modern websites are complicated and often rely on dynamic content, ArchiveBox saves the sites in a number of formats beyond what sites sites like Archive.org and Archive.is are capable of saving. ArchiveBox uses wget to save the html, youtube-dl for media, and a full instance of Chrome headless for PDF, Screenshot, and DOM dumps to greatly improve redundancy. Using multiple methods in conjunction with the most popular browser on the market ensures we can execute almost all the JS out there, and archive even the most difficult sites in at least one format.

Can import links from:

Browser history or bookmarks (Chrome, Firefox, Safari, IE, Opera)
RSS or plain text lists
Pocket, Pinboard, Instapaper
Shaarli, Delicious, Reddit Saved Posts, Wallabag, Unmark.it, and any other text with links in it!

Can save these things for each site:

example.com/page-name.html wget clone of the site, with .html appended if not present
output.pdf Printed PDF of site using headless chrome
screenshot.png 1440x900 screenshot of site using headless chrome
output.html DOM Dump of the HTML after rendering using headless chrome
archive.org.txt A link to the saved site on archive.org
warc/ for the html + gzipped warc file .gz
media/ any mp4, mp3, subtitles, and metadata found using youtube-dl
git/ clone of any repository for github, bitbucket, or gitlab links
favicon.ico favicon of the site
index.json JSON index containing link info and archive details
index.html HTML index containing link info and archive details (optional fancy or simple index)

The archiving is additive, so you can schedule ./archive to run regularly and pull new links into the index. All the saved content is static and indexed with JSON files, so it lives forever & is easily parseable, it requires no always-running backend.

DEMO: archive.sweeting.me

To get started, you can install automatically, follow the manual instructions, or use Docker.

git clone https://github.com/pirate/ArchiveBox.git
cd ArchiveBox
./setup

# Export your bookmarks, then run the archive command to start archiving!
./archive ~/Downloads/firefox_bookmarks.html

# Or to add just one page to your archive
echo 'https://example.com' | ./archive

Documentation

_{(Recently renamed from Bookmark Archiver)}

We use the Github wiki system for documentation.

You can also access the docs locally by looking in the ArchiveBox/docs/ folder.

Getting Started

Reference

More Info

Background & Motivation

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 would the library of Alexandria or a collection of art.

Whether it's to resist censorship by saving articles before they get taken down or editied, or to save that collection of early 2010's flash games you love to play, having the tools to archive the internet enable to you save some of the content you care about before it dissapears.

The balance between the permanence and ephemeral nature of the internet is what makes it beautiful, I don't think everything should be preserved, and but I do think people should be able to decide for themselves and effectively archive content in a format that will survive being passed down to historians and archivists through many generations.

You can read more about why web archiving is important, discover the community, or reach out to me on Twitter for questions and comments.