It does everything out-of-the-box by default, but you can disable or tweak [individual archive methods](https://github.com/pirate/ArchiveBox/wiki/Configuration) via environment variables or config file.
- If you're importing URLs with secret tokens in them (e.g Google Docs, CodiMD notepads, etc), you may want to disable some of these methods to avoid leaking private URLs to 3rd party APIs during the archiving process. See the [Security Overview](https://github.com/pirate/ArchiveBox/wiki/Security-Overview#stealth-mode) page for more details.
+ ## Dependencies
- ## Key Features
+ You don't need to install all the dependencies, ArchiveBox will automatically enable the relevant modules based on whatever you have available, but it's recommended to use the official [Docker image](https://github.com/pirate/ArchiveBox/wiki/Docker) with everything preinstalled.
- - [**Free & open source**](https://github.com/pirate/ArchiveBox/blob/master/LICENSE), doesn't require signing up for anything, stores all data locally
- - [**Few dependencies**](https://github.com/pirate/ArchiveBox/wiki/Install#dependencies) and [simple command line interface](https://github.com/pirate/ArchiveBox/wiki/Usage#CLI-Usage)
- - [**Comprehensive documentation**](https://github.com/pirate/ArchiveBox/wiki), [active development](https://github.com/pirate/ArchiveBox/wiki/Roadmap), and [rich community](https://github.com/pirate/ArchiveBox/wiki/Web-Archiving-Community)
- - **Doesn't require a constantly-running server**, proxy, or native app
- - Easy to set up **[scheduled importing](https://github.com/pirate/ArchiveBox/wiki/Scheduled-Archiving) from multiple sources**
- - Uses common, **durable, [long-term formats](#saves-lots-of-useful-stuff-for-each-imported-link)** like HTML, JSON, PDF, PNG, and WARC
- - ~~**Suitable for paywalled / [authenticated content](https://github.com/pirate/ArchiveBox/wiki/Configuration#chrome_user_data_dir)** (can use your cookies)~~ (do not do this until v0.5 is released with some security fixes)
- - Can [**run scripts during archiving**](https://github.com/pirate/ArchiveBox/issues/51) to [scroll pages](https://github.com/pirate/ArchiveBox/issues/80), [close modals](https://github.com/pirate/ArchiveBox/issues/175), expand comment threads, etc.
- - Can also [**mirror content to 3rd-party archiving services**](https://github.com/pirate/ArchiveBox/wiki/Configuration#submit_archive_dot_org) automatically for redundancy
+ If you so choose, you can also install ArchiveBox and its dependencies directly on any Linux or macOS systems using the [automated setup script](https://github.com/pirate/ArchiveBox/wiki/Quickstart) or the [system package manager](https://github.com/pirate/ArchiveBox/wiki/Install).
- ## Background & Motivation
+ ArchiveBox is written in Python 3 so it requires `python3` and `pip3` available on your system. It also uses a set of optional, but highly recommended external dependencies for archiving sites: `wget` (for plain HTML, static files, and WARC saving), `chromium` (for screenshots, PDFs, JS execution, and more), `youtube-dl` (for audio and video), `git` (for cloning git repos), and `nodejs` (for readability and singlefile), and more.
+
+ ## Caveats
+
+ If you're importing URLs containing secret slugs or pages with private content (e.g Google Docs, CodiMD notepads, etc), you may want to disable some of the extractor modules to avoid leaking private URLs to 3rd party APIs during the archiving process.
+
+ Be aware that malicious archived JS can also read the contents of other pages in your archive due to snapshot CSRF and XSS protections being imperfect. See the [Security Overview](https://github.com/pirate/ArchiveBox/wiki/Security-Overview#stealth-mode) page for more details.
+
+ Support for saving multiple snapshots of each site over time will be [added soon](https://github.com/pirate/ArchiveBox/issues/179) (along with the ability to view diffs of the changes between runs). For now ArchiveBox is designed to only archive each URL with each extractor type once.
+
+ ---
+
+ # Setup
+
+ ## Docker
+
+ ```bash
+ # Docker
+ mkdir data && cd data
+ docker run -v $PWD:/data -it nikisweeting/archivebox init
+ docker run -v $PWD:/data -it nikisweeting/archivebox add 'https://example.com'
+ docker run -v $PWD:/data -it nikisweeting/archivebox manage createsuperuser
+ docker run -v $PWD:/data -it -p 8000:8000 nikisweeting/archivebox server 0.0.0.0:8000
+
+ open http://127.0.0.1:8000
+ ```
+
+ ```bash
+ # Docker Compose
+ # first download: https://github.com/pirate/ArchiveBox/blob/master/docker-compose.yml
+ docker-compose run archivebox init
+ docker-compose run archivebox add 'https://example.com'
+ docker-compose run archivebox manage createsuperuser
+ docker-compose up
+ open http://127.0.0.1:8000
+ ```
+
+ ## Bare Metal
+ ```bash
+ # Bare Metal
+ # Use apt on Ubuntu/Debian, brew on mac, or pkg on BSD
+ # You may need to add a ppa with a more recent version of nodejs
+ apt install python3 python3-pip python3-dev git curl wget youtube-dl chromium-browser
+
+ # Install Node + NPM
+ curl -s https://deb.nodesource.com/gpgkey/nodesource.gpg.key | apt-key add - \
+ && echo 'deb https://deb.nodesource.com/node_14.x $(lsb_release -cs) main' >> /etc/apt/sources.list \
+ && apt-get update -qq \
+ && apt-get install -qq -y --no-install-recommends nodejs
+
+ # Make a directory to hold your collection
+ mkdir data && cd data # (doesn't have to be called data)
+
+ # Install python package (or do this in a .venv if you want)
+ pip install --upgrade archivebox
+
+ # Install node packages (needed for SingleFile, Readability, and Puppeteer)
+ npm install --prefix data 'git+https://github.com/pirate/ArchiveBox.git'
+
+ archivebox init
+ archivebox add 'https://example.com' # add URLs via args or stdin
+
+ # or import an RSS/JSON/XML/TXT feed/list of links
+ curl https://getpocket.com/users/USERNAME/feed/all | archivebox add
+ archivebox add --depth=1 https://example.com/table-of-contents.html
+ ```
+
+ Once you've added your first links, open `data/index.html` in a browser to view the static archive.
+
+ You can also start it as a server with a full web UI to manage your links:
+
+ ```bash
+ archivebox manage createsuperuser
+ archivebox server
+ ```
+
+ You can visit `http://127.0.0.1:8000` in your browser to access it.
+
+
+ ---
+
+
+

+
+
+ ---
+
+ # 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 preserve our books, paintings, and music in physical libraries long after the originals go out of print or fade into obscurity.
@@ -218,6 +262,11 @@ Description:
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.
+ Because modern websites are complicated and often rely on dynamic content,
+ ArchiveBox archives the sites in **several different formats** beyond what public archiving services like Archive.org and Archive.is are capable of saving. 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.
+
+ All the archived links are stored by date bookmarked in `./archive/
`, and everything is indexed nicely with JSON & HTML files. The intent is for all the content to be viewable with common software in 50 - 100 years without needing to run ArchiveBox in a VM.
+
## Comparison to Other Projects
▶ **Check out our [community page](https://github.com/pirate/ArchiveBox/wiki/Web-Archiving-Community) for an index of web archiving initiatives and projects.**
@@ -238,8 +287,6 @@ Description:
## Learn more
-
-
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!

@@ -263,21 +310,10 @@ Description:

- We use the [Github wiki system](https://github.com/pirate/ArchiveBox/wiki) and [Read the Docs](https://archivebox.readthedocs.io/en/latest/) for documentation.
+ We use the [Github wiki system](https://github.com/pirate/ArchiveBox/wiki) and [Read the Docs](https://archivebox.readthedocs.io/en/latest/) (WIP) for documentation.
You can also access the docs locally by looking in the [`ArchiveBox/docs/`](https://github.com/pirate/ArchiveBox/wiki/Home) folder.
- You can build the docs by running:
-
- ```python
- cd ArchiveBox
- pipenv install --dev
- sphinx-apidoc -o docs archivebox
- cd docs/
- make html
- # then open docs/_build/html/index.html
- ```
-
## Getting Started
- [Quickstart](https://github.com/pirate/ArchiveBox/wiki/Quickstart)
@@ -295,15 +331,82 @@ Description:
- [Chromium Install](https://github.com/pirate/ArchiveBox/wiki/Install-Chromium)
- [Security Overview](https://github.com/pirate/ArchiveBox/wiki/Security-Overview)
- [Troubleshooting](https://github.com/pirate/ArchiveBox/wiki/Troubleshooting)
+ - [Python API](https://docs.archivebox.io/en/latest/modules.html)
+ - REST API (coming soon...)
## More Info
+ - [Tickets](https://github.com/pirate/ArchiveBox/issues)
- [Roadmap](https://github.com/pirate/ArchiveBox/wiki/Roadmap)
- [Changelog](https://github.com/pirate/ArchiveBox/wiki/Changelog)
- [Donations](https://github.com/pirate/ArchiveBox/wiki/Donations)
- [Background & Motivation](https://github.com/pirate/ArchiveBox#background--motivation)
- [Web Archiving Community](https://github.com/pirate/ArchiveBox/wiki/Web-Archiving-Community)
+ ---
+
+ # ArchiveBox Development
+
+ All contributions to ArchiveBox are welcomed! Check our [issues](https://github.com/pirate/ArchiveBox/issues) and [Roadmap](https://github.com/pirate/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.
+
+ ### Setup the dev environment
+
+ ```python3
+ git clone https://github.com/pirate/ArchiveBox
+ cd ArchiveBox
+ git checkout master # or the branch you want to test
+ git pull
+
+ # Install ArchiveBox + python dependencies
+ python3 -m venv .venv && source .venv/bin/activate && pip install -e .[dev]
+ # or
+ pipenv install --dev && pipenv shell
+
+ # Install node dependencies
+ npm install
+
+ # Optional: install the extractor dependencies
+ ./bin/setup.sh
+ ```
+
+ ### Common development tasks
+
+ See the `./bin/` folder and read the source of the bash scripts within.
+ You can also run all these in Docker. For more examples see the Github Actions CI/CD tests that are run: `.github/workflows/*.yaml`.
+
+ #### Run the linters
+
+ ```bash
+ ./bin/lint.sh
+ ```
+ (uses `flake8` and `mypy`)
+
+ #### Run the integration tests
+
+ ```bash
+ ./bin/test.sh
+ ```
+ (uses `pytest -s`)
+
+ #### Build the docs, pip package, and docker image
+
+ ```bash
+ ./bin/build.sh
+
+ # or individually:
+ ./bin/build_docs.sh
+ ./bin/build_pip.sh
+ ./bin/build_docker.sh
+ ```
+
+ #### Roll a release
+
+ ```bash
+ ./bin/release.sh
+ ```
+ (bumps the version, builds, and pushes a release to PyPI, Docker Hub, and Github Packages)
+
+
---
diff --git a/archivebox.egg-info/SOURCES.txt b/archivebox.egg-info/SOURCES.txt
index d186b2fb..5c78bd8c 100644
--- a/archivebox.egg-info/SOURCES.txt
+++ b/archivebox.egg-info/SOURCES.txt
@@ -45,6 +45,7 @@ archivebox/core/models.py
archivebox/core/settings.py
archivebox/core/tests.py
archivebox/core/urls.py
+archivebox/core/utils.py
archivebox/core/views.py
archivebox/core/welcome_message.py
archivebox/core/wsgi.py
@@ -60,7 +61,9 @@ archivebox/extractors/archive_org.py
archivebox/extractors/dom.py
archivebox/extractors/favicon.py
archivebox/extractors/git.py
+archivebox/extractors/headers.py
archivebox/extractors/media.py
+archivebox/extractors/mercury.py
archivebox/extractors/pdf.py
archivebox/extractors/readability.py
archivebox/extractors/screenshot.py
@@ -88,7 +91,10 @@ archivebox/themes/admin/app_index.html
archivebox/themes/admin/base.html
archivebox/themes/admin/login.html
archivebox/themes/default/add_links.html
+archivebox/themes/default/base.html
archivebox/themes/default/main_index.html
+archivebox/themes/default/core/snapshot_list.html
+archivebox/themes/default/static/add.css
archivebox/themes/default/static/admin.css
archivebox/themes/default/static/archive.png
archivebox/themes/default/static/bootstrap.min.css
@@ -103,6 +109,7 @@ archivebox/themes/default/static/spinner.gif
archivebox/themes/legacy/favicon.ico
archivebox/themes/legacy/link_details.html
archivebox/themes/legacy/main_index.html
+archivebox/themes/legacy/main_index_minimal.html
archivebox/themes/legacy/main_index_row.html
archivebox/themes/legacy/robots.txt
archivebox/themes/legacy/static/archive.png
diff --git a/bin/build_docker.sh b/bin/build_docker.sh
old mode 100644
new mode 100755
diff --git a/bin/build_docs.sh b/bin/build_docs.sh
old mode 100644
new mode 100755
diff --git a/bin/build_pip.sh b/bin/build_pip.sh
old mode 100644
new mode 100755
diff --git a/docs b/docs
index 96bab842..604d30ec 160000
--- a/docs
+++ b/docs
@@ -1 +1 @@
-Subproject commit 96bab842f25e794190c7513a84ff542fe749d95e
+Subproject commit 604d30ec22e9182b5d41b982140b884c53883039