Mirrors/ArchiveBox
2
0
Fork 0
mirror of https://github.com/ArchiveBox/ArchiveBox synced 2024-11-22 12:13:05 +00:00
Code Issues Projects Releases Packages Wiki Activity
No description
127 commits 6 branches 78 tags 19 MiB
Python 70.1%
HTML 25.9%
Shell 2.5%
Dockerfile 0.9%
CSS 0.6%
Find a file
Nick Sweeting 432d5c2dbc default to fetching requisites
2017-07-04 03:29:42 -05:00
examples Add pinboard.json example file 2017-07-01 14:10:51 -07:00
.gitignore initial commiit 2017-05-05 05:00:30 -04:00
archive.py default to fetching requisites 2017-07-04 03:29:42 -05:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2017-06-16 13:38:28 -05:00
index_template.html fix permissions, output html, and timeouts 2017-06-15 18:49:16 -05:00
LICENSE Initial commit 2017-05-05 04:50:15 -04:00
README.md more troubleshooting help 2017-07-02 12:02:29 -05:00
screenshot.png move examples export files into directory 2017-06-15 18:54:59 -05:00
setup.sh Update setup.sh 2017-06-30 03:40:34 -05:00

README.md

Bookmark Archiver Twitter URL

▶️ Quickstart | Details | Configuration | Manual Setup | Troubleshooting | Changelog

Save an archived copy of all websites you star (the actual content of the sites, not just the list of bookmarks).

Supports: Browser Bookmarks (Chrome, Firefox, Safari, IE, Opera), Pocket, Pinboard, Shaarli, Delicious, Instapaper, Unmark.it, and more!

Outputs browsable static html archives of each site, a PDF, a screenshot, and a link to a copy on archive.org, all indexed in a nice html file.
(Your own personal Way-Back Machine) DEMO: sweeting.me/pocket

Quickstart

1. Get your bookmarks:

Follow the links here to find instructions for exporting bookmarks from each service.

(If any of these links are broken, please submit an issue and I'll fix it)

2. Create your archive:

git clone https://github.com/pirate/bookmark-archiver
cd bookmark-archiver/
./setup.sh
./archive.py ~/Downloads/bookmark_export.html   # replace this path with the path to your bookmarks export file

You can open service/index.html to view your archive. (favicons will appear next to each title once it has finished downloading)

If you have any trouble, see the Troubleshooting section at the bottom.

If you want something easier than running programs in the command-line, take a look at Pocket Premium (yay Mozilla!) and Pinboard Pro, which both offer easy-to-use bookmark archiving with full-text-search.

Details

archive.py is a script that takes a Pocket-format, Pinboard-format, or Netscape-format bookmark export file, and turns it into a browsable archive that you can store locally or host online.

The archiver produces a folder like pocket/ containing an index.html, and archived copies of all the sites, organized by starred timestamp. It's Powered by the headless Chromium and good 'ol wget. NEW: Also submits each link to save on archive.org!

For each sites it saves:

  • wget of site, e.g. en.wikipedia.org/wiki/Example.html with .html appended if not present
  • sreenshot.png 1440x900 screenshot of site using headless chrome
  • output.pdf Printed PDF of site using headless chrome
  • archive.org.txt A link to the saved site on archive.org

Large Exports & Estimated Runtime:

I've found it takes about an hour to download 1000 articles, and they'll take up roughly 1GB.
Those numbers are from running it single-threaded on my i5 machine with 50mbps down. YMMV.

You can run it in parallel by using the resume feature, or by manually splitting export.html into multiple files:

./archive.py export.html bookmarks 1498800000 &  # third argument is timestamp to resume downloading from
./archive.py export.html bookmarks 1498810000 &
./archive.py export.html bookmarks 1498820000 &
./archive.py export.html bookmarks 1498830000 &

Users have reported running it with 50k+ bookmarks with success (though it will take more RAM while running).

Configuration

You can tweak parameters via environment variables, or by editing archive.py directly:

env CHROME_BINARY=google-chrome-stable RESOLUTION=1440,900 FETCH_PDF=False ./archive.py ~/Downloads/bookmarks_export.html
  • Archive methods: FETCH_WGET, FETCH_PDF, FETCH_SCREENSHOT, FETCH_FAVICON, SUBMIT_ARCHIVE_DOT_ORG values: [True]/False
  • Screenshot: RESOLUTION values: [1440,900]/1024,768/...
  • Outputted Files: ARCHIVE_PERMISSIONS values: [755]/644/...
  • Path to Chrome: CHROME_BINARY values: [chromium-browser]//usr/local/bin/chromium-browser/...
  • Path to wget: WGET_BINARY values: [wget]//usr/local/bin/wget/...

(See defaults & more at the top of archive.py)

You can also tweak the outputted html index in index_template.html. It just uses python format strings (not a proper templating engine like jinja2), which is why the CSS is double-bracketed {{...}}.

Publishing Your Archive

The archive produced by ./archive.py is suitable for serving on any provider that can host static html (e.g. github pages!).

You can also serve it from a home server or VPS by uploading the archive folder to your web directory, e.g. /var/www/pocket and configuring your webserver.

Here's a sample nginx configuration that works to serve archive folders:

location /pocket/ {
    alias       /var/www/pocket/;
    index       index.html;                 # show the main index.html by default
    autoindex   on;                         # allow people to see a directory listing when clicking on "the Files" links
    try_files   $uri $uri/ $uri.html =404;  # append .html to links before 404ing in order to reach sites that wget appended .html to
}

Make sure you're not running any content as CGI or PHP, you only want to serve static files!

Urls look like: https://sweeting.me/archive/archive/1493350273/en.wikipedia.org/wiki/Dining_philosophers_problem

Security WARNING & Content Disclaimer

Hosting other people's site content has security implications for other sites on the same domain, make sure you understand the dangers of hosting other people's CSS & JS files on a shared domain. It's best to put this on a domain/subdomain of its own to slightly mitigate CSRF attacks.

You may also want to blacklist your archive in /robots.txt if you don't want to be publicly assosciated with all the links you archive via search engine results.

Be aware that some sites you archive may not allow you to rehost their content publicly for copyright reasons, it's up to you to host responsibly and respond to takedown requests appropriately.

Info & Motivation

This is basically an open-source version of Pocket Premium (which you should consider paying for!). I got tired of sites I saved going offline or changing their URLS, so I started archiving a copy of them locally now, similar to The Way-Back Machine provided by archive.org. Self hosting your own archive allows you to save PDFs & Screenshots of dynamic sites in addition to static html, something archive.org doesn't do.

Now I can rest soundly knowing important articles and resources I like wont dissapear off the internet.

My published archive as an example: sweeting.me/pocket.

Manual Setup

If you don't like sudo running random setup scripts off the internet (which you shouldn't), you can follow these manual setup instructions.

1. Install dependencies: chromium >= 59, wget >= 1.16, python3 >= 3.5 (google-chrome >= v59 also works well)

If you already have Google Chrome installed, or wish to use that instead of Chromium, follow the Google Chrome Instructions.

# On Mac:
brew cask install chromium  # If you already have Google Chrome/Chromium in /Applications/, skip this command
brew install wget python3

echo -e '#!/bin/bash\n/Applications/Chromium.app/Contents/MacOS/Chromium "$@"' > /usr/local/bin/chromium-browser  # see instructions for google-chrome below
chmod +x /usr/local/bin/chromium-browser

# On Ubuntu/Debian:
apt install chromium-browser python3 wget

# Check that everything worked:
chromium-browser --version && which wget && which python3 && which curl && echo "[√] All dependencies installed."

2. Get your bookmark export file:

Follow the instruction links above in the "Quickstart" section to download your bookmarks export file.

3. Run the archive script:

  1. Clone this repo git clone https://github.com/pirate/bookmark-archiver
  2. cd bookmark-archiver/
  3. ./archive.py ~/Downloads/bookmarks_export.html

You may optionally specify a third argument to archive.py export.html [pocket|pinboard|bookmarks] to enforce the use of a specific link parser.

If you have any trouble, see the Troubleshooting section at the bottom.

Google Chrome Instructions:

I recommend Chromium instead of Google Chrome, since it's open source and doesn't send your data to Google. Chromium may have some issues rendering some sites though, so you're welcome to try Google-chrome instead. It's also easier to use Google Chrome if you already have it installed, rather than downloading Chromium all over.

  1. Install & link google-chrome
# On Mac:
# If you already have Google Chrome in /Applications/, skip this brew command
brew cask install google-chrome
brew install wget python3

echo -e '#!/bin/bash\n/Applications/Google\ Chrome.app/Contents/MacOS/Google\ Chrome "$@"' > /usr/local/bin/google-chrome
chmod +x /usr/local/bin/google-chrome

# On Linux:
wget -q -O - https://dl-ssl.google.com/linux/linux_signing_key.pub | sudo apt-key add -
sudo sh -c 'echo "deb [arch=amd64] http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google-chrome.list'
apt update; apt install google-chrome-beta python3 wget
  1. Set the environment variable CHROME_BINARY to google-chrome before running:
env CHROME_BINARY=google-chrome ./archive.py ~/Downloads/bookmarks_export.html

If you're having any trouble trying to set up Google Chrome or Chromium, see the Troubleshooting section below.

Troubleshooting

Dependencies

Python:

On some Linux distributions the python3 package might not be recent enough. If this is the case for you, resort to installing a recent enough version manually.

add-apt-repository ppa:fkrull/deadsnakes && apt update && apt install python3.6

If you still need help, the official Python docs are a good place to start.

Chromium/Google Chrome:

archive.py depends on being able to access a chromium-browser/google-chrome executable. The executable used defaults to chromium-browser but can be manually specified with the environment variable CHROME_BINARY:

env CHROME_BINARY=/usr/local/bin/chromium-browser ./archive.py ~/Downloads/bookmarks_export.html
  1. Test to make sure you have Chrome on your $PATH with:
which chromium-browser || which google-chrome

If no executable is displayed, follow the setup instructions to install and link one of them.

  1. If a path is displayed, the next step is to check that it's runnable:
chromium-browser --version || google-chrome --version

If no version is displayed, try the setup instructions again, or confirm that you have permission to access chrome.

  1. If a version is displayed and it's >=59, make sure archive.py is running the right one:
env CHROME_BINARY=/path/from/step/1/chromium-browser ./archive.py bookmarks_export.html   # replace the path with the one you got from step 1

Wget & Curl:

If you're missing wget or curl, simply install them using apt or your package manager of choice. See the "Manual Setup" instructions for more details.

If wget times out or randomly fails to download some sites that you have confirmed are online, upgrade wget to the most recent version with brew upgrade wget or apt upgrade wget. There is a bug in versions <=1.19.1_1 that caused wget to fail for perfectly valid sites.

Archiving

No links parsed from export file:

Please open an issue with a description of where you got the export, and preferrably your export file attached (you can redact the links). We'll fix the parser to support your format.

Lots of skipped sites:

If you ran the archiver once, it wont re-download sites subsequent times, it will only download new links. If you haven't already run it, make sure you have a working internet connection and that the parsed URLs look correct. You can check the archive.py output or index.html to see what links it's downloading.

If you're still having issues, try deleting or moving the service/archive folder and running archive.py again.

Lots of errors:

Make sure you have all the dependencies installed and that you're able to visit the links from your browser normally. Open an issue with a description of the errors if you're still having problems.

Lots of broken links from the index:

Not all sites can be effectively archived with each method, that's why it's best to use a combination of wget, PDFs, and screenshots. If it seems like more than 10-20% of sites in the archive are broken, open an issue with some of the URLs that failed to be archived and I'll investigate.

Hosting the Archive

If you're having issues trying to host the archive via nginx, make sure you already have nginx running with SSL. If you don't, google around, there are plenty of tutorials to help get that set up. Open an issue if you have problem with a particular nginx config.

If you're getting many 404s when trying to visit links from the index, this is caused by wget appending .html to the end of all downloaded content if it doesn't already have it. I will be correcting the index links to account for this soon, but in the meantime use the nginx config above which automatically appends .html to links before 404-ing.

TODO

  • body text extraction using fathom
  • auto-tagging based on important extracted words
  • audio & video archiving with youtube-dl
  • full-text indexing with elasticsearch
  • video closed-caption downloading for full-text indexing video content
  • automatic text summaries of article with summarization library
  • feature image extraction
  • http support (from my https-only domain)
  • try wgetting dead sites from archive.org (https://github.com/hartator/wayback-machine-downloader)

Live Updating: (coming soon... maybe...)

It's possible to pull links via the pocket API or public pocket RSS feeds instead of downloading an html export. Once I write a script to do that, we can stick this in cron and have it auto-update on it's own.

For now you just have to download ril_export.html and run archive.py each time it updates. The script will run fast subsequent times because it only downloads new links that haven't been archived already.

Links

Changelog