Chmod +x single-file To use Firefox instead of Chrome, you must download the Selenium WebDriver component (i.e. Geckodriver for Firefox). Make sure it can be found through the PATH environment variable or the cli folder. Otherwise you will need to set the -web-driver-executable-path option to help WebDriver locating the executable. Cybercriminals have been found using the legitimate browser extension tool SingleFile as a part of their latest phishing campaign. The web extension is used as the obfuscation method to avoid detection. What is SingleFile - SingleFiles is an extension available for Google Chrome and Mozilla Firefox. It allows users to save a webpage as a single.

ArchiveBox is a powerful, self-hosted internet archiving solution to collect, save, and view sites you want to preserve offline.

You can set it up as a command-line tool, web app, and desktop app (alpha), on Linux, macOS, and Windows.

You can feed it 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 input formats for a full list.

It saves snapshots of the URLs you feed it in several formats: HTML, PDF, PNG screenshots, WARC, and more out-of-the-box, with a wide variety of content extracted and preserved automatically (article text, audio/video, git repos, etc.). See output formats for a full list.

The goal is to sleep soundly knowing the part of the internet you care about will be automatically preserved in durable, easily accessable formats for decades after it goes down.

📦 Get ArchiveBox with docker-compose / docker / apt / brew / pip3 (see Quickstart below).

🔢 Example usage: adding links to archive.

🔢 Example usage: viewing the archived content.

Key Features

• Free & open source, doesn’t require signing up for anything, stores all data locally
• Powerful, intuitive command line interface with modular optional dependencies
• Comprehensive documentation, active development, and rich community
• Extracts a wide variety of content out-of-the-box: media (youtube-dl), articles (readability), code (git), etc.
• Supports scheduled/realtime importing from many types of sources
• Uses standard, durable, long-term formats like HTML, JSON, PDF, PNG, and WARC
• Usable as a oneshot CLI, self-hosted web UI, Python API (BETA), REST API (ALPHA), or desktop app (ALPHA)
• Saves all pages to archive.org as well by default for redundancy (can be disabled for local-only mode)
• Planned: support for archiving content requiring a login/paywall/cookies (working, but ill-advised until some pending fixes are released)
• Planned: support for running JS during archiving to adblock, autoscroll, modal-hide, thread-expand…

🖥 Supported OSs: Linux/BSD, macOS, Windows (Docker/WSL) 👾 CPUs: amd64, x86, arm8, arm7 ^(raspi>=3)

⬇️ Initial Setup

(click to expand your preferred ► distribution below for full setup instructions)

Get ArchiveBox with docker-compose on macOS/Linux/Windows ✨ (highly recommended)

1. Install Docker and Docker Compose on your system (if not already installed).
2. Download the docker-compose.yml file into a new empty directory (can be anywhere).
3. Run the initial setup and create an admin user.
4. Optional: Start the server then login to the Web UI http://127.0.0.1:8000 ⇢ Admin.

See below for more usage examples using the CLI, Web UI, or filesystem/SQL/Python manage your archive.

Get ArchiveBox with docker on macOS/Linux/Windows

1. Install Docker on your system (if not already installed).
2. Create a new empty directory and initalize your collection (can be anywhere).
3. Optional: Start the server then login to the Web UI http://127.0.0.1:8000 ⇢ Admin.

See below for more usage examples using the CLI, Web UI, or filesystem/SQL/Python manage your archive.

Get ArchiveBox with apt on Ubuntu/Debian

1. Add the ArchiveBox repository to your sources.
   
2. Install the ArchiveBox package using apt.
3. Create a new empty directory and initalize your collection (can be anywhere).
4. Optional: Start the server then login to the Web UI http://127.0.0.1:8000 ⇢ Admin.

See below for more usage examples using the CLI, Web UI, or filesystem/SQL/Python manage your archive.

Get ArchiveBox with brew on macOS

1. Install Homebrew on your system (if not already installed).
2. Install the ArchiveBox package using brew.
3. Create a new empty directory and initalize your collection (can be anywhere).
4. Optional: Start the server then login to the Web UI http://127.0.0.1:8000 ⇢ Admin.

See below for more usage examples using the CLI, Web UI, or filesystem/SQL/Python manage your archive.

Get ArchiveBox with pip on any platform

1. Install Python >= v3.7 and Node >= v14 on your system (if not already installed).
2. Install the ArchiveBox package using pip3.
3. Create a new empty directory and initalize your collection (can be anywhere).
4. Optional: Start the server then login to the Web UI http://127.0.0.1:8000 ⇢ Admin.

See below for more usage examples using the CLI, Web UI, or filesystem/SQL/Python manage your archive.

Get ArchiveBox with a paid hosting solution

• (for larger setups, get a quote)

None of these hosting providers are officially endorsed:
_{(most still require manual setup or manual periodic updating using the methods above)}

• (USD $29-250/mo, pricing)
• (USD $5-50+/mo, 🎗 referral link, instructions)
• (USD $2.5-50+/mo, 🎗 referral link, instructions)
• (USD $10-50+/mo, instructions)
• (USD $60-200+/mo)

_{Referral links marked 🎗 provide $5-10 of free credit for new users and help pay for our demo server hosting costs.}

For more discussion on managed and paid hosting options see here: Issue #531.

docker-compose is the recommended way to run ArchiveBox. It includes everything out-of-the-box and provides the fastest setup.
It’s also the easiest way to keep all the dependencies isolated from the rest of your system and up-to-date over-time.

➡️ Next Steps

• Import URLs from some of the supported Input Formats or view the supported Output Formats…
• Tweak your UI or archiving behavior Configuration or read about some of the Caveats and troubleshooting steps…
• Read about the Dependencies used for archiving or the Archive Layout on disk…
• Or check out our full Documentation or Community Wiki…

Usage

⚡️ CLI Usage

• archivebox setup/init/config/status/manage to administer your collection
• archivebox add/schedule/remove/update/list/shell/oneshot to manage Snapshots in the archive
• archivebox schedule to pull in fresh URLs in regularly from boorkmarks/history/Pocket/Pinboard/RSS/etc.

🖥 Web UI Usage

🗄 SQL/Python/Filesystem Usage

Input Formats

ArchiveBox supports many input formats for URLs, including Pocket & Pinboard exports, Browser bookmarks, Browser history, plain text, HTML, markdown, and more!

Click these links for instructions on how to propare your links from these sources:

• TXT, RSS, XML, JSON, CSV, SQL, HTML, Markdown, or any other text-based format…
• Browser history or browser bookmarks (see instructions for: Chrome, Firefox, Safari, IE, Opera, and more…)
• Pocket, Pinboard, Instapaper, Shaarli, Delicious, Reddit Saved, Wallabag, Unmark.it, OneTab, and more…

See the Usage: CLI page for documentation and examples.

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.

Output Formats

Inside each Snapshot folder, ArchiveBox save these different types of extractor outputs as plain files:

./archive/<timestamp>/*

• Index:index.html & index.json HTML and JSON index files containing metadata and details
• Title, Favicon, Headers Response headers, site favicon, and parsed site title
• SingleFile:singlefile.html HTML snapshot rendered with headless Chrome using SingleFile
• 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
• Article Text:article.html/json Article text extraction using Readability & Mercury
• Archive.org Permalink:archive.org.txt A link to the saved site on archive.org
• Audio & Video:media/ all audio/video files + playlists, including subtitles & metadata with youtube-dl
• Source Code:git/ clone of any repository found on github, bitbucket, or gitlab links
• More coming soon! See the Roadmap…

It does everything out-of-the-box by default, but you can disable or tweak individual archive methods via environment variables / config.

Configuration

ArchiveBox can be configured via environment variables, by using the archivebox config CLI, or by editing the ArchiveBox.conf config file directly.

^{These methods also work the same way when run inside Docker, see the Docker Configuration wiki page for details.}

The config loading logic with all the options defined is here: archivebox/config.py.

Most options are also documented on the Configuration Wiki page.

Most Common Options to Tweak

Dependencies

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 with everything preinstalled for the best experience.

To achieve high fidelity archives in as many situations as possible, ArchiveBox depends on a variety of 3rd-party tools and libraries that specialize in extracting different types of content. These optional dependencies used for archiving sites include:

• 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)
• curl (for fetching headers, favicon, and posting to Archive.org)
• youtube-dl (for audio, video, and subtitles)
• 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.

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.

Installing directly on Windows without Docker or WSL/WSL2/Cygwin is not officially supported, but some advanced users have reported getting it working.

Archive Layout

All of ArchiveBox’s state (including the index, snapshot data, and config file) is stored in a single folder called the “ArchiveBox data folder”. All archivebox CLI commands must be run from inside this folder, and you first create it by running archivebox init.

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), and the archive snapshots are organized by date-added timestamp in the ./archive/ subfolder.

Each snapshot subfolder ./archive/<timestamp>/ includes a static index.json and index.html describing its contents, and the snapshot extrator outputs are plain files within the folder.

Static Archive Exporting

You can export the main index to browse it statically without needing to run a server.

Note about large exports: 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.

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.

Caveats

Archiving Private Content

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.

Singlefile Firefox Extension

Security Risks of Viewing Archived JS

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 page for more details.

Saving Multiple Snapshots of a Single URL

First-class support for saving multiple snapshots of each site over time will be added eventually (along with the ability to view diffs of the changes between runs). For now ArchiveBox is designed to only archive each unique URL with each extractor type once. The workaround to take multiple snapshots of the same URL is to make them slightly different by adding a hash:

The button in the Admin UI is a shortcut for this hash-date workaround.

Storage Requirements

Because ArchiveBox is designed to ingest a firehose of browser history and bookmark feeds to a local disk, it can be much more disk-space intensive than a centralized service like the Internet Archive or Archive.today. 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.

Disk usage can be reduced by using a compressed/deduplicated filesystem like ZFS/BTRFS, or by turning off extractors methods you don’t need. 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 spinning HDD.

Screenshots

The aim of ArchiveBox is to enable more of the internet to be archived 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.

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.

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.

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/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.

Comparison to Other Projects

Singlefile Firefox Download

▶ Check out our community page for an index of web archiving initiatives and projects.

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.

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).

Comparison With Centralized Public Archives

Not all content is suitable to be archived in a centralized collection, wehther because it’s private, copyrighted, too large, or too complex. ArchiveBox hopes to fill that gap.

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.

Comparison With Other Self-Hosted Archiving Options

ArchiveBox differentiates itself from similar self-hosted projects by providing both a comprehensive CLI interface for managing your archive, a Web UI that can be used either indepenently or together with the CLI, and a simple on-disk data format that can be used without either.

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. It can be as simple or advanced as you want, and is designed to do everything out-of-the-box but be tuned to suit your needs.

If you want better fidelity for very complex interactive pages with heavy JS/streams/API requests, check out ArchiveWeb.page and ReplayWeb.page.

If you want more bookmark categorization and note-taking features, check out Archivy, Memex, Polar, or LinkAce.

If you need more advanced recursive spider/crawling ability beyond --depth=1, check out Browsertrix, Photon, or Scrapy and pipe the outputted URLs into ArchiveBox.

For more alternatives, see our list here…

Internet Archiving Ecosystem

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!

• Community Wiki
  • The Master Lists
    Community-maintained indexes of archiving tools and institutions.
  • Web Archiving Software
    Open source tools and projects in the internet archiving space.
  • Reading List
    Articles, posts, and blogs relevant to ArchiveBox and web archiving in general.
  • Communities
    A collection of the most active internet archiving communities and initiatives.
• Check out the ArchiveBox Roadmap and Changelog
• Learn why archiving the internet is important by reading the “On the Importance of Web Archiving” blog post.
• Reach out to me for questions and comments via @ArchiveBoxApp or @theSquashSH on Twitter

Need help building a custom archiving solution?

✨ Hire the team that helps build Archivebox to work on your project. (we’re @MonadicalSAS on Twitter)

^{(They also do general software consulting across many industries)}

We use the Github wiki system and Read the Docs (WIP) for documentation.

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

Getting Started

Reference

• Python API (alpha)
• REST API (alpha)

More Info

All contributions to ArchiveBox are welcomed! Check our issues and 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.

Low hanging fruit / easy first tickets:

Setup the dev environment

Click to expand...

#### 1. Clone the main code repo (making sure to pull the submodules as well)```bashgit clone --recurse-submodules https://github.com/ArchiveBox/ArchiveBoxcd ArchiveBoxgit checkout dev # or the branch you want to testgit submodule update --init --recursivegit pull --recurse-submodules```#### 2. Option A: Install the Python, JS, and system dependencies directly on your machine```bash# Install ArchiveBox + python dependenciespython3 -m venv .venv && source .venv/bin/activate && pip install -e '.[dev]'# or: pipenv install --dev && pipenv shell# Install node dependenciesnpm install# orarchivebox setup# Check to see if anything is missingarchivebox --version# install any missing dependencies manually, or use the helper script:./bin/setup.sh```#### 2. Option B: Build the docker container and use that for development instead```bash# 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 changesdocker build . -t archiveboxdocker run -it archivebox init --setupdocker run -it -p 8000:8000 -v $PWD/data:/data -v $PWD/archivebox:/app/archivebox archivebox server 0.0.0.0:8000 --debug --reload# (remove the --reload flag and add the --nothreading flag when profiling with the django debug toolbar)```

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.

Singlefile Firefox Latest

Run in DEBUG mode

Click to expand...

```basharchivebox config --set DEBUG=True# orarchivebox server --debug ...```

Build and run a Github branch

Click to expand...

```bashdocker build -t archivebox:dev https://github.com/ArchiveBox/ArchiveBox.git#devdocker run -it -v $PWD:/data archivebox:dev ...```

Singlefile Firefox Web

Run the linters

Click to expand...

```bash./bin/lint.sh```(uses `flake8` and `mypy`)

Run the integration tests

Click to expand...

```bash./bin/test.sh```(uses `pytest -s`)

Make migrations or enter a django shell

Click to expand...

Make sure to run this whenever you change things in `models.py`.```bashcd archivebox/./manage.py makemigrationscd path/to/test/data/archivebox shellarchivebox manage dbshell```(uses `pytest -s`)

Build the docs, pip package, and docker image

Click to expand...

(Normally CI takes care of this, but these scripts can be run to do it manually)```bash./bin/build.sh# or individually:./bin/build_docs.sh./bin/build_pip.sh./bin/build_deb.sh./bin/build_brew.sh./bin/build_docker.sh```

Roll a release

Click to expand...

(Normally CI takes care of this, but these scripts can be run to do it manually)```bash./bin/release.sh# or individually:./bin/release_docs.sh./bin/release_pip.sh./bin/release_deb.sh./bin/release_brew.sh./bin/release_docker.sh```

Further Reading

• Home: ArchiveBox.io
• Demo: Demo.ArchiveBox.io
• Docs: Docs.ArchiveBox.io
• Releases: Releases.ArchiveBox.io
• Wiki: Github.com/ArchiveBox/ArchiveBox/wiki
• Issues: Github.com/ArchiveBox/ArchiveBox/issues
• Forum: Github.com/ArchiveBox/ArchiveBox/discussions
• Donations: Github.com/ArchiveBox/ArchiveBox/wiki/Donations

Author:Gildas-Lormeau
Date: 12/23/2020 07:00 PM
Size: Size Varies
License: Open Source
Requires: 10|8|7
Downloads: 1242 times

SingleFile for Chrome, Firefox, and Edge is a CLI tool capable of helping you to save a complete web page into a single HTML file.

SingleFile will save a complete page (with all CSS, images, fonts, frames, etc., included) as a single HTML file that can be accessed later. This add-on/extension can be utilized by those with limited bandwidth, allowing them to save interesting browser URLs instead of repeatedly downloading them.

Related Posts

• download SingleFile for Chrome, Firefox, and Edge

  Author: Gildas-Lormeau Date: 11/19/2020 11:08 PM Size: Size Varies License: Open Source Requires: 10|8|7 Downloads:…

• download SingleFile for Chrome, Firefox, and Edge

  Author: Gildas-Lormeau Date: 11/24/2020 07:33 PM Size: Size Varies License: Open Source Requires: 10|8|7 Downloads:…

• download SingleFile for Chrome, Firefox, and Edge

  Author: Gildas-Lormeau Date: 12/03/2020 01:27 PM Size: Size Varies License: Open Source Requires: 10|8|7 Downloads:…