v0.4 (first Django release)

[pirate]

The v0.4 Release

A bunch of big changes:

• pip install archivebox is now available
• beginnings of transition to Django while maintaining a mostly backwards-compatible CLI
• using argparse instead of hand-written CLI system: see archivebox/cli/archivebox.py
• new subcommands-based CLI for archivebox (see below)

For more info, see: https://github.com/pirate/ArchiveBox/wiki/Roadmap

Released in this version:

Install Methods:

• ✅ pip/pipenv install archivebox [--dev]
• ✅ docker run nikisweeting/archivebox / docker-compose up
• ❌ apt/brew/pkg/yum/nix/etc install archivebox (maybe later)

Note: apt, brew are now available as of v0.5

Command Line Interface:

• ✅ archivebox
• ✅ archivebox version
• ✅ archivebox help
• ✅ archivebox init
• ✅ archivebox status
• ✅ archivebox add
• ✅ archivebox remove
• ✅ archivebox update
• ✅ archivebox list
• ✅ archivebox schedule
• ✅ archivebox config
• ✅ archivebox server
• ✅ archivebox shell
• ✅ archivebox manage
• ❌ archivebox oneshot (released later in v0.5)
• ❌ archivebox export (use archivebox list --json > index.json)
• ❌ archivebox proxy (too complex)

Web UI:

• ✅ / Main index
• ✅ /add Page to add new links to the archive (but needs improvement)
• ✅ /archive/<timestamp>/ Snapshot details page
• ✅ /archive/<timestamp>/<url> live wget archive of page
• ✅ /archive/<timestamp>/<extractor> get a specific extractor output for a given snapshot
• ✅ /archive/<url> shortcut to view most recent snapshot of given url
• ✅ /archive/<url_hash> shortcut to view most recent snapshot of given url
• ✅ /admin Admin interface to view and edit archive data

Python API:

• ✅ from archivebox import add, remove, info, config, etc...
• ✅ from archivebox.core.models import Snapshot, User, etc...
• ✅ from archivebox.extractors import media, wget, screenshot, etc...
• ✅ from archivebox.index import json, sql, html, etc...
• ✅ from archivebox.parsers import pinboard_rss, pocket_html, generic_json, etc...

(Red ❌ features are still unfinished and will be released in later versions)

[pirate]

🌅 v0.4 is officially released.

• https://pypi.org/project/archivebox/
• https://hub.docker.com/r/nikisweeting/archivebox
• https://archivebox.readthedocs.io/en/latest/
• https://github.com/pirate/ArchiveBox/releases

Enjoy!

pip install archivebox

cd path/to/your/archive/folder

archivebox init  # will safely upgrade an existing repo, or create a new one if the directory is empty
archviebox add 'https://example.com'
archviebox add 'https://getpocket.com/users/USERNAME/feed/all' --depth=1
archivebox status
archivebox server
archivebox help

Or if you prefer docker:

docker run -v $PWD:/data archivebox init
docker run -v $PWD:/data archivebox add 'https://example.com'
docker run -v $PWD:/data -p 8000 archivebox server

version: '3.7'

services:
    archivebox:
        image: nikisweeting/archivebox:latest
        command: server 0.0.0.0:8000
        ports:
            - 8000:8000
        environment:
            - USE_COLOR=True
            # any other config you want here...
        volumes:
            - ./data:/data

Screenshots

[benoitjpnet]

Awesome! 🎉

What are the update instructions coming from previous version?

[pirate]

@benpro if you run archivebox it'll guide you through the whole upgrade process 👍 :

pip install archivebox
archivebox

cd path/to/your/archive/folder
archivebox init   # or docker run -v $PWD:/data nikisweeting/archivebox init