wayback

README

Wayback

wabarc/wayback is a tool that supports running as a command-line tool and docker container, purpose to snapshot webpage to time capsules.

Installation

$ go get -u github.com/wabarc/wayback/cmd/wayback

Using Snapcraft (on GNU/Linux)

$ sudo snap install wayback

See more on release

Feature

• Running as CLI command or Docker container
• Running with telegram bot
• Serve as Tor hidden service

Usage

Command line

$ wayback -h

A CLI tool for wayback webpages.

Usage:
  wayback [flags]

Examples:
  wayback https://www.wikipedia.org
  wayback https://www.fsf.org https://www.eff.org
  wayback --ia https://www.fsf.org
  wayback --ia --is -d telegram -t your-telegram-bot-token
  WAYBACK_SLOT=pinata WAYBACK_APIKEY=YOUR-PINATA-APIKEY \
    WAYBACK_SECRET=YOUR-PINATA-SECRET wayback --ip https://www.fsf.org

Flags:
  -c, --chatid string      Telegram channel id.
  -d, --daemon strings     Run as daemon service, e.g. telegram, web
      --debug              Enable debug mode. (default false)
  -h, --help               help for wayback
      --ia                 Wayback webpages to Internet Archive.
      --ip                 Wayback webpages to IPFS. (default false)
      --ipfs-host string   IPFS daemon host, do not require, unless enable ipfs. (default "127.0.0.1")
  -m, --ipfs-mode string   IPFS mode. (default "pinner")
  -p, --ipfs-port uint     IPFS daemon port. (default 5001)
      --is                 Wayback webpages to Archive Today.
  -t, --token string       Telegram Bot API Token.
      --tor                Snapshot webpage via Tor proxy.
      --tor-key string     The private key for Tor service.
  -v, --version            version for wayback

Examples

Wayback one or more url to Internet Archive and archive.today:

$ wayback https://www.wikipedia.org

$ wayback https://www.fsf.org https://www.eff.org

Wayback url to Internet Archive or archive.today or IPFS:

// Internet Archive
$ wayback --ia https://www.fsf.org

// archive.today
$ wayback --is https://www.fsf.org

// IPFS
$ wayback --ip https://www.fsf.org

For the IPFS, also can use a specific pinner service:

$ export WAYBACK_SLOT=pinata
$ export WAYBACK_APIKEY=YOUR-PINATA-APIKEY
$ export WAYBACK_SECRET=YOUR-PINATA-SECRET
$ wayback --ip https://www.fsf.org

// or

$ WAYBACK_SLOT=pinata WAYBACK_APIKEY=YOUR-PINATA-APIKEY \
$ WAYBACK_SECRET=YOUR-PINATA-SECRET wayback --ip https://www.fsf.org

TIP: more details about pinner service.

With telegram bot:

$ wayback --ia --is --ip -d telegram -t your-telegram-bot-token

Publish message to your Telegram channel at the same time:

$ wayback --ia --is --ip -d telegram -t your-telegram-bot-token -c your-telegram-channel-name

Also can run with debug mode:

$ wayback -d telegram -t YOUR-BOT-TOKEN --debug

Both serve on Telegram and Tor hidden service:

$ wayback -d telegram -t YOUT-BOT-TOKEN -d web

Configuration Parameters

Wayback can use command flags and environment variables.

DEBUG

Toggle debug mode (display all logging).

Disabled by default.

LOG_TIME

Display the date and time in log messages.

default: true

WAYBACK_IPFS_HOST

IPFS daemon service's host, do not require, unless enable ipfs.

default "127.0.0.1". (same as flag --ipfs-host).

WAYBACK_IPFS_PORT

IPFS daemon port.

default 5001. (same as flag --ipfs-port).

WAYBACK_IPFS_MODE

IPFS mode for preserve webpage.

default: "pinner". (same as flag --ipfs-mode).

WAYBACK_USE_TOR

Snapshot webpage via Tor proxy. (same as flag --tor).

default: false

WAYBACK_ENABLE_IA

Enable Internet Archive.

default: true

WAYBACK_ENABLE_IS

Enable Archive Today (archive.is).

default: true

WAYBACK_ENABLE_IP

Enable IPFS.

default: false

WAYBACK_TELEGRAM_TOKEN

Telegram Bot API Token.

default: "" (same as flag --token).

WAYBACK_TELEGRAM_CHANNEL

The chatid which publish message.

default: "" (same as flag --chatid).

WAYBACK_TOR_PRIVKEY

The private key for Tor service.

default: "" (same as flag --tor-key).

WAYBACK_TOR_LOCAL_PORT

Local port of Tor service.

default: 0

WAYBACK_TOR_REMOTE_PORTS

Remote ports of Tor hidden service, e.g. WAYBACK_TOR_REMOTE_PORTS=80,81.

default: 80

Docker/Podman

$ docker pull wabarc/wayback
$ docker run -d wabarc/wayback -d telegram -t YOUR-BOT-TOKEN # without telegram channel
$ docker run -d wabarc/wayback -d telegram -t YOUR-BOT-TOKEN -c YOUR-CHANNEL-USERNAME # with telegram channel

Deploy on Heroku

See: wabarc/on-heroku

TODO

Archive.org and Archive.today are currently supported, the next step mind support the followings platform:

• IPFS
• ZeroNet

Telegram bot

• Bots: An introduction for developers
• How do I create a bot?
• An example bot
• An example channel

Related projects

• duty-machine
• ipfs-pinner
• on-heroku

License

This software is released under the terms of the GNU General Public License v3.0. See the LICENSE file for details.

Documentation

Index

• type Archived
• type Broker
• type Handle
  • func (h *Handle) IA() Archived
  • func (h *Handle) IP() Archived
  • func (h *Handle) IS() Archived

Types

type Archived

type Archived map[string]string

type Broker

type Broker interface {
	IA() Archived
	IS() Archived
	IP() Archived
}

type Handle

type Handle struct {
	URLs []string

	Opts *config.Options
}

func (*Handle) IA

func (h *Handle) IA() Archived

func (*Handle) IP

func (h *Handle) IP() Archived

func (*Handle) IS

func (h *Handle) IS() Archived