Skip to main content

A very simple archiving server for the `Hoardy-Web` WebExtension

Project description

What is hoardy-web-sas?

hoardy-web-sas: a very simple archiving server for the Hoardy-Web browser extension (also there).

I.e. this is the thing you run and then paste the URL of into Server URL setting in Hoardy-Web.

This thing is less than 200 lines of pure Python that only uses the Python's standard library and nothing else. You could be running it already.

Why does hoardy-web-sas exists?

This was made for easy Quickstart (also there) that also does reliable archiving.

Quickstart

Installation

  • You can run this without installing:
    ./hoardy-web-sas.py --help
    
  • Alternatively, install with:
    pip install hoardy-web-sas
    
    and run as
    hoardy-web-sas --help
    
  • Alternatively, install it via Nix
    nix-env -i -f ./default.nix
    hoardy-web-sas --help
    

Usage

usage: hoardy_web_sas.py [-h] [--version] [--host HOST] [--port PORT] [--root ROOT] [--uncompressed] [--default-profile NAME] [--ignore-profiles] [--no-print-cbors]

Simple archiving server for Hoardy-Web. Dumps each request to `<ROOT>/<profile>/<year>/<month>/<day>/<epoch>_<number>.wrr`.

optional arguments:
  -h, --help            show this help message and exit
  --version             show program's version number and exit
  --host HOST           listen on what host/IP (default: 127.0.0.1)
  --port PORT           listen on what port (default: 3210)
  --root ROOT           path to dump data into (default: pwebarc-dump)
  --uncompressed        dump new archivals to disk without compression; the default is to try to compress each new archive first
  --default-profile NAME
                        default profile to use when no `profile` query parameter is supplied by the extension (default: `default`)
  --ignore-profiles     ignore `profile` query parameter supplied by the extension and use the value of `--default-profile` instead
  --no-print-cbors      don't print parsed representations of newly archived CBORs to stdout even if `cbor2` module is available

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hoardy-web-sas-1.6.1.tar.gz (5.2 kB view hashes)

Uploaded Source

Built Distribution

hoardy_web_sas-1.6.1-py3-none-any.whl (5.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page