wabarc/initium

Wayback Archiver documentation repo

Initium for Wayback Archiver

"initium" in Latin, Wayback Archiver documentation repo

This repository is a work in progress.

Indiscriminate Censor's Hand is the starting point of the Wayback Archiver. It aims to make the Wayback Machine easier to use and focus on information dissemination.

This organization is a place to bring together all of the Wayback Archiver repositories, and to work together on making it better. This repository is the center of that organization.

Table of Contents

• How it works
• Repositories
  • Code-free repositories
  • Wayback Archiver
  • Modules
• Registries
• License

How it works

Repositories

The Wayback Archiver organization on GitHub contains many different repositories. For the most part, these fall into three categories:

1. Wayback, wayback webpages to the Wayback Machine, and the decentralized web;
2. Archiver, archiving and store webpages to third-party repositories;
3. Various non-code repositories.

Code-free repositories

• The initium documentation repo, which you're in right now.
• project-template which is a template for creating a code repository.
• The artwork for open-licensed wabarc-related artwork.

Wayback Archiver

• wayback - The main repo for wayback and publish the messages.
• archiver - Archiving webpages from the published messages by Wayback Bot.
• playback - Playback archived URLs from Internte Archiver, archive.today and beyond.

Modules

• archive.org - A Golang package for request Internet Archive to archive webpages.
• archive.is - A Golang package for request Archive.today to archive webpages.
• broker - Distribute webpages to the third party repository.
• cairn - A JavaScript library for snapshot webpages written in TypeScript. The most important module used by archiver.
• distributor - GitHub actions for distributing webpages using broker.
• imgbb - A command-line tool and Go package interface for upload images to ImgBB.
• ipfs-pinner - Pin file to IPFS pinning service, required by wbipfs.
• memento - A Golang and Command-Line Interface to Time Travel Service (Memento), required by playback.
• packer - Part of the module required by archiver using to pack webpages to file, inherits from archiver.
• screenshot - Capture webpage and save as image using chromedp.
• telegra.ph - A command-line tool and Go package interface for wayback webpage to Telegraph.
• wbipfs - A Golang package and CLI tool to transfer file to IPFS.

Other repositories include:

• snapshot - A Golang package and CLI for snapshot webpages using chromedp.
• prattein - Website for Wayback Bot published messages, alias Telegram channel.
• sitemap - Generate sitemap for prattein.
• on-heroku - Which is a script tool to deploy wayback service as heroku app.
• on-github - Host wayback service on GitHub using Actions.
• heroku-schedule - Scheduling for the Heroku app using GitHub Actions.
• helper - Helper functions for Golang projects.
• logger - Logger for Golang projects.
• golang-chromium - Docker image bundling Golang and Chromium.
• githooks - Git hooks for development.
• heva - Create/update Heroku Config Vars.

Registries

Wayback Archiver accounts are also maintained on these registries:

• GitHub @wabarc
• GitLab @wabarc
• npm @wabarc
• DockerHub @wabarc

License

This repository is only for documents. All of these are licensed under the Creative Commons Zero v1.0 Universal license, see the LICENSE file for details.