Package: archivebox-likn
ArchiveBoxOpen-source self-hosted web archiving.▶️Quickstart|Demo|GitHub|Documentation|Info & Motivation|Community|Roadmap"Your own personal internet archive" (网站存档 / 爬虫)
curl -sSL 'https://get.archivebox.io' | shArchiveBox 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 acommand-line tool,web app, anddesktop app(alpha), on Linux, macOS, and Windows.You can feed it URLs one at a time, or schedule regular importsfrom browser bookmarks or history, feeds like RSS, bookmark services like Pocket/Pinboard, and more. Seeinput formatsfor 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.). Seeoutput formatsfor 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 accessible formatsfor decadesafter it goes down.Demo|Screenshots|Usage. . . . . . . . . . . . . . . . . . . . . . . . . . . .📦  Get ArchiveBox withdocker/apt/brew/pip3/nix/ etc. (see Quickstart below).# Get ArchiveBox with Docker or Docker Compose (recommended)dockerrun-v$PWD/data:/data-itarchivebox/archivebox:devinit--setup# Or install with your preferred package manager (see Quickstart below for apt, brew, and more)pip3installarchivebox# Or use the optional auto setup script to install itcurl-sSL'https://get.archivebox.io'|sh🔢 Example usage: adding links to archive.archiveboxadd'https://example.com'# add URLs one at a timearchiveboxadd<~/Downloads/bookmarks.json# or pipe in URLs in any text-based formatarchiveboxschedule--every=day--depth=1https://example.com/rss.xml# or auto-import URLs regularly on a schedule🔢 Example usage: viewing the archived content.archiveboxserver0.0.0.0:8000# use the interactive web UIarchiveboxlist'https://example.com'# use the CLI commands (--help for more)ls./archive/*/index.json# or browse directly via the filesystemKey FeaturesFree & open source, doesn't require signing up online, stores all data locallyPowerful, intuitive command line interfacewithmodular optional dependenciesComprehensive documentation,active development, andrich communityExtracts a wide variety of content out-of-the-box:media (youtube-dl or yt-dlp), articles (readability), code (git), etc.Supports scheduled/realtime importingfrommany types of sourcesUses standard, durable, long-term formatslike HTML, JSON, PDF, PNG, and WARCUsable as a oneshot CLI,self-hosted web UI,Python API(BETA),REST API(ALPHA), ordesktop app(ALPHA)Saves all pages to archive.org as wellby default for redundancy (can bedisabledfor local-only mode)Advanced users: support for archivingcontent requiring login/paywall/cookies(see wiki security caveats!)Planned: support for runningJS during archivingto adblock,autoscroll,modal-hide,thread-expand...Quickstart🖥  Supported OSs:Linux/BSD, macOS, Windows (Docker/WSL)👾  CPUs:amd64, x86, arm8, arm7(raspi>=3)✳️  Easy Setupdocker-compose(macOS/Linux/Windows)👈  recommended(click to expand)👍 Docker Compose is recommended for the easiest install/update UX + best security + all theextrasworking out-of-the-box.InstallDockerandDocker Composeon your system (if not already installed).Download thedocker-compose.ymlfile into a new empty directory (can be anywhere).mkdir ~/archivebox && cd ~/archivebox
curl -O 'https://raw.githubusercontent.com/ArchiveBox/ArchiveBox/master/docker-compose.yml'Run the initial setup and create an admin user.docker compose run archivebox init --setupOptional: Start the server then login to the Web UIhttp://127.0.0.1:8000⇢ Admin.docker compose up
# completely optional, CLI can always be used without running a server
# docker compose run [-T] archivebox [subcommand] [--args]Seebelowfor more usage examples using the CLI, Web UI, or filesystem/SQL/Python to manage your archive.docker(macOS/Linux/Windows)InstallDockeron your system (if not already installed).Create a new empty directory and initialize your collection (can be anywhere).mkdir ~/archivebox && cd ~/archivebox
docker run -v $PWD:/data -it archivebox/archivebox init --setupOptional: Start the server then login to the Web UIhttp://127.0.0.1:8000⇢ Admin.docker run -v $PWD:/data -p 8000:8000 archivebox/archivebox
# completely optional, CLI can always be used without running a server
# docker run -v $PWD:/data -it [subcommand] [--args]Seebelowfor more usage examples using the CLI, Web UI, or filesystem/SQL/Python to manage your archive.bashauto-setup script(macOS/Linux)InstallDockeron your system (optional, highly recommended but not required).Run the automatic setup script.curl -sSL 'https://get.archivebox.io' | shSeebelowfor more usage examples using the CLI, Web UI, or filesystem/SQL/Python to manage your archive.Seesetup.shfor the source code of the auto-install script.See"Against curl | sh as an install method"blog post for my thoughts on the shortcomings of this install method.🛠  Package Manager Setupapt(Ubuntu/Debian)Add the ArchiveBox repository to your sources.# On Ubuntu == 20.04, add the sources automatically:
sudo apt install software-properties-common
sudo add-apt-repository -u ppa:archivebox/archivebox# On Ubuntu >= 20.10 or <= 19.10, or other Debian-style systems, add the sources manually:
echo "deb http://ppa.launchpad.net/archivebox/archivebox/ubuntu focal main" | sudo tee /etc/apt/sources.list.d/archivebox.list
sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys C258F79DCC02E369
sudo apt updateInstall the ArchiveBox package usingapt.sudo apt install archivebox
sudo python3 -m pip install --upgrade --ignore-installed archivebox   # pip needed because apt only provides a broken older version of DjangoCreate a new empty directory and initialize your collection (can be anywhere).mkdir ~/archivebox && cd ~/archivebox
archivebox init --setup           # if any problems, install with pip insteadNote: If you encounter issues with NPM/NodeJS,install a more recent version.Optional: Start the server then login to the Web UIhttp://127.0.0.1:8000⇢ Admin.archivebox server 0.0.0.0:8000
# completely optional, CLI can always be used without running a server
# archivebox [subcommand] [--args]Seebelowfor more usage examples using the CLI, Web UI, or filesystem/SQL/Python to manage your archive.See thedebian-archiveboxrepo for more details about this distribution.brew(macOS)InstallHomebrewon your system (if not already installed).Install the ArchiveBox package usingbrew.brew tap archivebox/archivebox
brew install archiveboxCreate a new empty directory and initialize your collection (can be anywhere).mkdir ~/archivebox && cd ~/archivebox
archivebox init --setup         # if any problems, install with pip insteadOptional: Start the server then login to the Web UIhttp://127.0.0.1:8000⇢ Admin.archivebox server 0.0.0.0:8000
# completely optional, CLI can always be used without running a server
# archivebox [subcommand] [--args]Seebelowfor more usage examples using the CLI, Web UI, or filesystem/SQL/Python to manage your archive.See thehomebrew-archiveboxrepo for more details about this distribution.pip(macOS/Linux/Windows)InstallPython >= v3.7andNode >= v14on your system (if not already installed).Install the ArchiveBox package usingpip3.pip3 install archiveboxCreate a new empty directory and initialize your collection (can be anywhere).mkdir ~/archivebox && cd ~/archivebox
archivebox init --setup
# install any missing extras like wget/git/ripgrep/etc. manually as neededOptional: Start the server then login to the Web UIhttp://127.0.0.1:8000⇢ Admin.archivebox server 0.0.0.0:8000
# completely optional, CLI can always be used without running a server
# archivebox [subcommand] [--args]Seebelowfor more usage examples using the CLI, Web UI, or filesystem/SQL/Python to manage your archive.See thepip-archiveboxrepo for more details about this distribution.pacman/pkg/nix(Arch/FreeBSD/NixOS/more)Arch:yay -S archivebox(contributed by@imlonghao)FreeBSD:curl -sSL 'https://get.archivebox.io' | sh(usespkg+pip3under-the-hood)Nix:nix-env --install archivebox(contributed by@siraben)More:contribute another distribution...!Seebelowfor usage examples using the CLI, Web UI, or filesystem/SQL/Python to manage your archive.🎗  Other Optionsdocker+electronDesktop App(macOS/Linux/Windows)InstallDockeron your system (if not already installed).Download a binary release for your OS or build the native app from sourcemacOS:ArchiveBox.app.zipLinux:ArchiveBox.deb(alpha:build manually)Windows:ArchiveBox.exe(beta:build manually)✨ Alpha (contributors wanted!): for more info, see the:Electron ArchiveBoxrepo.Paid hosting solutions (cloud VPS)(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)(from USD $2.6/mo)(USD $5-50+/mo,🎗  referral link,instructions)(USD $2.5-50+/mo,🎗  referral link,instructions)(USD $10-50+/mo,instructions)(USD $60-200+/mo)(USD $60-200+/mo)Referral links marked 🎗 provide $5-10 of free credit for new users and help pay for ourdemo serverhosting costs.For more discussion on managed and paid hosting options see here:Issue #531.➡️  Next StepsImport URLs from some of the supportedInput Formatsor view the supportedOutput Formats...Tweak your UI or archiving behaviorConfigurationor read about some of theCaveatsand troubleshooting steps...Read about theDependenciesused for archiving, theUpgrading Process, or theArchive Layouton disk...Or check out our fullDocumentationorCommunity Wiki...Usage⚡️  CLI Usage# archivebox [subcommand] [--args]# docker-compose run archivebox [subcommand] [--args]# docker run -v $PWD:/data -it [subcommand] [--args]archiveboxinit--setup# safe to run init multiple times (also how you update versions)archivebox--version
archiveboxhelparchivebox setup/init/config/status/manageto administer your collectionarchivebox add/schedule/remove/update/list/shell/oneshotto manage Snapshots in the archivearchivebox scheduleto pull in fresh URLs regularly frombookmarks/history/Pocket/Pinboard/RSS/etc.🖥  Web UI Usagearchiveboxmanagecreatesuperuser# set an admin passwordarchiveboxserver0.0.0.0:8000# open http://127.0.0.1:8000 to view it# you can also configure whether or not login is required for most featuresarchiveboxconfig--setPUBLIC_INDEX=False
archiveboxconfig--setPUBLIC_SNAPSHOTS=False
archiveboxconfig--setPUBLIC_ADD_VIEW=False🗄  SQL/Python/Filesystem Usagesqlite3./index.sqlite3# run SQL queries on your indexarchiveboxshell# explore the Python API in a REPLls./archive/*/index.html# or inspect snapshots on the filesystem. . . . . . . . . . . . . . . . . . . . . . . . . . . .DEMO:https://demo.archivebox.ioUsage|Configuration|CaveatsOverviewInput FormatsArchiveBox 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 prepare your links from these sources:TXT, RSS, XML, JSON, CSV, SQL, HTML, Markdown, orany other text-based format...Browser historyorbrowser bookmarks(see instructions for:Chrome,Firefox,Safari,IE,Opera,and more...)Browser extensionarchivebox-exporter(realtime archiving from Chrome/Chromium/Firefox)Pocket,Pinboard,Instapaper,Shaarli,Delicious,Reddit Saved,Wallabag,Unmark.it,OneTab,and more...# archivebox add --helparchiveboxadd'https://example.com/some/page'archiveboxadd<~/Downloads/firefox_bookmarks_export.html
archiveboxadd--depth=1'https://news.ycombinator.com#2020-12-12'echo'http://example.com'|archiveboxaddecho'any_text_with [urls](https://example.com) in it'|archiveboxadd# if using Docker, add -i when piping stdin:# echo 'https://example.com' | docker run -v $PWD:/data -i archivebox/archivebox add# if using Docker Compose, add -T when piping stdin / stdout:# echo 'https://example.com' | docker compose run -T archivebox addSee theUsage: CLIpage for documentation and examples.It also includes a built-in scheduled import feature witharchivebox scheduleand browser bookmarklet, so you can pull in URLs from RSS feeds, websites, or the filesystem regularly/on-demand.Output FormatsInside each Snapshot folder, ArchiveBox saves these different types of extractor outputs as plain files:./archive/<timestamp>/*Index:index.html&index.jsonHTML and JSON index files containing metadata and detailsTitle,Favicon,HeadersResponse headers, site favicon, and parsed site titleSingleFile:singlefile.htmlHTML snapshot rendered with headless Chrome using SingleFileWget Clone:example.com/page-name.htmlwget clone of the site withwarc/<timestamp>.gzChrome HeadlessPDF:output.pdfPrinted PDF of site using headless chromeScreenshot:screenshot.png1440x900 screenshot of site using headless chromeDOM Dump:output.htmlDOM Dump of the HTML after rendering using headless chromeArticle Text:article.html/jsonArticle text extraction using Readability & MercuryArchive.org Permalink:archive.org.txtA link to the saved site on archive.orgAudio & Video:media/all audio/video files + playlists, including subtitles & metadata with youtube-dl (or yt-dlp)Source Code:git/clone of any repository found on GitHub, Bitbucket, or GitLab linksMore coming soon! See theRoadmap...It does everything out-of-the-box by default, but you can disable or tweakindividual archive methodsvia environment variables / config.ConfigurationArchiveBox can be configured via environment variables, by using thearchivebox configCLI, or by editing theArchiveBox.confconfig file directly.archiveboxconfig# view the entire configarchiveboxconfig--getCHROME_BINARY# view a specific valuearchiveboxconfig--setCHROME_BINARY=chromium# persist a config using CLI# ORechoCHROME_BINARY=chromium>>ArchiveBox.conf# persist a config using file# ORenvCHROME_BINARY=chromiumarchivebox...# run with a one-off configThese methods also work the same way when run inside Docker, see theDocker Configurationwiki page for details.The config loading logic with all the options defined is here:archivebox/config.py.Most options are also documented on theConfiguration Wiki page.Most Common Options to Tweak# e.g. archivebox config --set TIMEOUT=120TIMEOUT=120# default: 60    add more seconds on slower networksCHECK_SSL_VALIDITY=True# default: False True = allow saving URLs w/ bad SSLSAVE_ARCHIVE_DOT_ORG=False# default: True  False = disable Archive.org savingMAX_MEDIA_SIZE=1500m# default: 750m  raise/lower youtubedl output sizePUBLIC_INDEX=True# default: True  whether anon users can view indexPUBLIC_SNAPSHOTS=True# default: True  whether anon users can view pagesPUBLIC_ADD_VIEW=False# default: False whether anon users can add new URLsDependenciesFor better security, easier updating, and to avoid polluting your host system with extra dependencies,it is strongly recommended to use the officialDocker imagewith everything pre-installed 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-dloryt-dlp(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.# install python3 and archivebox with your system package manager# apt/brew/pip/etc install ... (see Quickstart instructions above)archiveboxsetup# auto install all the extractors and extrasarchivebox--version# see info and check validity of installed dependenciesInstalling directly onWindows without Docker or WSL/WSL2/Cygwin is not officially supported(I cannot respond to Windows support tickets), but some advanced users have reported getting it working.For detailed information about upgrading ArchiveBox and its dependencies, see:https://github.com/ArchiveBox/ArchiveBox/wiki/Upgrading-or-Merging-ArchivesArchive LayoutAll of ArchiveBox's state (including the index, snapshot data, and config file) is stored in a single folder called the "ArchiveBox data folder". AllarchiveboxCLI commands must be run from inside this folder, and you first create it by runningarchivebox init.The on-disk layout is optimized to be easy to browse by hand and durable long-term. The main index is a standardindex.sqlite3database 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../index.sqlite3ArchiveBox.confarchive/...1617687755/index.htmlindex.jsonscreenshot.pngmedia/some_video.mp4warc/1617687755.warc.gzgit/somerepo.git...Each snapshot subfolder./archive/<timestamp>/includes a staticindex.jsonandindex.htmldescribing its contents, and the snapshot extractor outputs are plain files within the folder.Static Archive ExportingYou 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 thearchivebox listcommand to export specific Snapshots or ranges.# archivebox list --helparchiveboxlist--html--with-headers>index.html# export to static html tablearchiveboxlist--json--with-headers>index.json# export to json blobarchiveboxlist--csv=timestamp,url,title>index.csv# export to csv spreadsheet# (if using Docker Compose, add the -T flag when piping)# docker compose run -T archivebox list --html --filter-type=search snozzberries > index.jsonThe paths in the static exports are relative, make sure to keep them next to your./archivefolder when backing them up or viewing them.CaveatsArchiving Private ContentIf 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.# don't save private content to ArchiveBox, e.g.:archiveboxadd'https://docs.google.com/document/d/12345somePrivateDocument'archiveboxadd'https://vimeo.com/somePrivateVideo'# without first disabling saving to Archive.org:archiveboxconfig--setSAVE_ARCHIVE_DOT_ORG=False# disable saving all URLs in Archive.org# restrict the main index, Snapshot content, and Add Page to authenticated users as-needed:archiveboxconfig--setPUBLIC_INDEX=False
archiveboxconfig--setPUBLIC_SNAPSHOTS=False
archiveboxconfig--setPUBLIC_ADD_VIEW=False# if extra paranoid or anti-Google:archiveboxconfig--setSAVE_FAVICON=False# disable favicon fetching (it calls a Google API passing the URL's domain part only)archiveboxconfig--setCHROME_BINARY=chromium# ensure it's using Chromium instead of ChromeSecurity Risks of Viewing Archived JSBe 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 andtypical CSRF/CORS/XSS/CSP protections do not work to prevent cross-site request attacks. See theSecurity Overviewpage andIssue #239for more details.# visiting an archived page with malicious JS:https://127.0.0.1:8000/archive/1602401954/example.com/index.html# example.com/index.js can now make a request to read everything from:https://127.0.0.1:8000/index.html
https://127.0.0.1:8000/archive/*# then example.com/index.js can send it off to some evil serverThe admin UI is also served from the same origin as replayed JS, so malicious pages could also potentially use your ArchiveBox login cookies to perform admin actions (e.g. adding/removing links, running extractors, etc.). We are planning to fix this security shortcoming in a future version by using separate ports/origins to serve the Admin UI and archived content (seeIssue #239).Note: Only thewgetextractor method executes archived JS when viewing snapshots, all other archive methods produce static output that does not execute JS on viewing. If you are worried about these issues ^ you should disable the wget extractor method usingarchivebox config --set SAVE_WGET=False.Saving Multiple Snapshots of a Single URLFirst-class support for saving multiple snapshots of each site over time will beadded eventually(along with the ability to view diffs of the changes between runs). For nowArchiveBox 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:archiveboxadd'https://example.com#2020-10-24'...
archiveboxadd'https://example.com#2020-10-25'Thebutton in the Admin UI is a shortcut for this hash-date workaround.Storage RequirementsBecause 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 usingSAVE_MEDIA=Trueand whether you lowerMEDIA_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/FATas they may not be able to handle more than 50k directory entries in thearchive/folder.Try to keep theindex.sqlite3file on local drive (not a network mount)or SSD for maximum performance, however thearchive/folder can be on a network mount or spinning HDD.ScreenshotsBackground & MotivationArchiveBox aims to enable more of the internet to be saved from deterioration 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.Image fromWTF is Link Rot?...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 inseveral different formatsbeyond 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▶Check out ourcommunity pagefor 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 ArchivesNot all content is suitable to be archived in a centralized collection, whether 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 OptionsArchiveBox differentiates itself fromsimilar self-hosted projectsby providing both a comprehensive CLI interface for managing your archive, a Web UI that can be used either independently 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 outArchiveWeb.pageandReplayWeb.page.If you want more bookmark categorization and note-taking features, check outArchivy,Memex,Polar, orLinkAce.If you need more advanced recursive spider/crawling ability beyond--depth=1, check outBrowsertrix,Photon, orScrapyand pipe the outputted URLs into ArchiveBox.For more alternatives, see ourlist here...Internet Archiving EcosystemWhether 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 WikiThe Master ListsCommunity-maintained indexes of archiving tools and institutions.Web Archiving SoftwareOpen source tools and projects in the internet archiving space.Reading ListArticles, posts, and blogs relevant to ArchiveBox and web archiving in general.CommunitiesA collection of the most active internet archiving communities and initiatives.Check out the ArchiveBoxRoadmapandChangelogLearn 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@ArchiveBoxAppor@theSquashSHon TwitterNeed help building a custom archiving solution?✨Hire the team that helps build Archiveboxto work on your project.(@MonadicalSAS)(They also do general software consulting across many industries)DocumentationWe use theGitHub wiki systemandRead the Docs(WIP) for documentation.You can also access the docs locally by looking in theArchiveBox/docs/folder.Getting StartedQuickstartInstallDockerReferenceUsageConfigurationSupported SourcesSupported OutputsScheduled ArchivingPublishing Your ArchiveChromium InstallSecurity OverviewTroubleshootingUpgrading or Merging ArchivesPython API(alpha)REST API(alpha)More InfoTicketsRoadmapChangelogDonationsBackground & MotivationWeb Archiving CommunityArchiveBox DevelopmentAll contributions to ArchiveBox are welcomed! Check ourissuesandRoadmapfor 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.For low hanging fruit / easy first tickets, see:ArchiveBox/Issues#good first ticket#help wanted.Python API Documentation:https://docs.archivebox.io/en/master/archivebox.html#module-archivebox.mainSetup the dev environmentClick to expand...1. Clone the main code repo (making sure to pull the submodules as well)gitclone--recurse-submoduleshttps://github.com/ArchiveBox/ArchiveBoxcdArchiveBox
gitcheckoutdev# or the branch you want to testgitsubmoduleupdate--init--recursive
gitpull--recurse-submodules2. Option A: Install the Python, JS, and system dependencies directly on your machine# Install ArchiveBox + python dependenciespython3-mvenv.venv&&source.venv/bin/activate&&pipinstall-e'.[dev]'# or: pipenv install --dev && pipenv shell# Install node dependenciesnpminstall# orarchiveboxsetup# Check to see if anything is missingarchivebox--version# install any missing dependencies manually, or use the helper script:./bin/setup.sh2. Option B: Build the docker container and use that for development instead# 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 changesdockerbuild.-tarchivebox
dockerrun-it\-v$PWD/data:/data\archiveboxinit--setup
dockerrun-it-p8000:8000\-v$PWD/data:/data\-v$PWD/archivebox:/app/archivebox\archiveboxserver0.0.0.0:8000--debug--reload# (remove the --reload flag and add the --nothreading flag when profiling with the django debug toolbar)# When using --reload, make sure any files you create can be read by the user in the Docker container, eg with 'chmod a+rX'.Common development tasksSee 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 in DEBUG modeClick to expand...archiveboxconfig--setDEBUG=True# orarchiveboxserver--debug...https://stackoverflow.com/questions/1074212/how-can-i-see-the-raw-sql-queries-django-is-runningInstall and run a specific GitHub branchClick to expand...# docker:dockerbuild-tarchivebox:devhttps://github.com/ArchiveBox/ArchiveBox.git#dev
dockerrun-it-v$PWD:/dataarchivebox:devinit--setup# bare metal:pipinstall'git+https://github.com/pirate/ArchiveBox@dev'npminstall'git+https://github.com/ArchiveBox/ArchiveBox.git#dev'archiveboxinit--setupRun the lintersClick to expand..../bin/lint.sh(usesflake8andmypy)Run the integration testsClick to expand..../bin/test.sh(usespytest -s)Make migrations or enter a django shellClick to expand...Make sure to run this whenever you change things inmodels.py.cdarchivebox/
./manage.pymakemigrationscdpath/to/test/data/
archiveboxshell
archiveboxmanagedbshell(usespytest -s)https://stackoverflow.com/questions/1074212/how-can-i-see-the-raw-sql-queries-django-is-runningContributing a new extractorClick to expand...ArchiveBoxextractorsare external binaries or Python/Node scripts that ArchiveBox runs to archive content on a page.Extractors take the URL of a page to archive, write their output to the filesystemarchive/<timestamp>/<extractorname>/..., and return anArchiveResultentry which is saved to the database (visible on theLogpage in the UI).Check out how we addedarchivebox/extractors/singlefile.pyas an example of the process:Issue #399+PR #403.The process to contribute a new extractor is like this:Open an issuewith your propsoed implementation (please link to the pages of any new external dependencies you plan on using)Ensure any dependencies needed are easily installable via a package managers likeapt,brew,pip3,npm(Ideally, prefer to use external programs available viapip3ornpm, however we do support using any binary installable via package manager that exposes a CLI/Python API and writes output to stdout or the filesystem.)Create a new file inarchivebox/extractors/<extractorname>.py(copy an existing extractor likesinglefile.pyas a template)Add config settings to enable/disable any new dependencies and the extractor as a whole, e.g.USE_DEPENDENCYNAME,SAVE_EXTRACTORNAME,EXTRACTORNAME_SOMEOTHEROPTIONinarchivebox/config.pyAdd a preview section toarchivebox/templates/core/snapshot.htmlto view the output, and a column toarchivebox/templates/core/index_row.htmlwith an icon for your extractorAdd an integration test for your extractor intests/test_extractors.pySubmit your PR for review!🎉Once merged, please document it in these places and anywhere else you see info about other extractors:https://github.com/ArchiveBox/ArchiveBox#output-formatshttps://github.com/ArchiveBox/ArchiveBox/wiki/Configuration#archive-method-toggleshttps://github.com/ArchiveBox/ArchiveBox/wiki/Install#dependenciesBuild the docs, pip package, and docker imageClick to expand...(Normally CI takes care of this, but these scripts can be run to do it manually)./bin/build.sh# or individually:./bin/build_docs.sh
./bin/build_pip.sh
./bin/build_deb.sh
./bin/build_brew.sh
./bin/build_docker.shRoll a releaseClick to expand...(Normally CI takes care of this, but these scripts can be run to do it manually)./bin/release.sh# or individually:./bin/release_docs.sh
./bin/release_pip.sh
./bin/release_deb.sh
./bin/release_brew.sh
./bin/release_docker.shFurther ReadingHome:ArchiveBox.ioDemo:Demo.ArchiveBox.ioDocs:Docs.ArchiveBox.ioReleases:Github.com/ArchiveBox/ArchiveBox/releasesWiki:Github.com/ArchiveBox/ArchiveBox/wikiIssues:Github.com/ArchiveBox/ArchiveBox/issuesDiscussions:Github.com/ArchiveBox/ArchiveBox/discussionsCommunity Chat:Zulip Chat (preferred)orMatrix Chat (old)Social Media:Twitter,LinkedIn,YouTube,Alternative.to,RedditDonations:Github.com/ArchiveBox/ArchiveBox/wiki/DonationsThis project is maintained mostly inmy spare timewith the help from generouscontributorsandMonadical(✨hire themfor dev work!).Sponsor this project on GitHub✨ Have spare CPU/disk/bandwidth and want to help the world?Check out ourGood Karma Kit...