yatima3d/tz-archiver repository overview

⁠tz-archiver-cli (Dockerized)

Docker image for tz-archiver-cli⁠, a tool that archives Tezos wallet activity and IPFS content to the Internet Archive.

This Docker image is built with Python 3.10 and comes pre-installed with all required dependencies for tz-archiver-cli (requests, python-dotenv, wayback-utils). No additional setup is needed. Just provide your Internet Archive credentials and, optionally, a Tezos wallet address.

⁠🐳 Supported Platforms

• linux/amd64
• linux/arm64 (e.g., Raspberry Pi 3/4/5, Apple M1/M2)

⁠🚀 Quick Start

⁠Run with a Tezos wallet

Use the following command to archive activity for a specific Tezos wallet. Replace "TezosWallet" with your Wallet Address:

docker run --rm \
  -d \
  --name tzarchiver \
  -e ARCHIVE_ACCESS=yourArchiveAccessKey \
  -e ARCHIVE_SECRET=yourArchiveSecretKey \
  yatima3d/tz-archiver:latest \
  -w TezosWallet

⁠Run in spider mode (no wallet)

To crawl IPFS objects in spider mode without a wallet:

docker run --rm \
  -d \
  --name tzarchiver \
  -e ARCHIVE_ACCESS=yourArchiveAccessKey \
  -e ARCHIVE_SECRET=yourArchiveSecretKey \
  yatima3d/tz-archiver:latest

⁠Persist data with a mounted volume

Remove "-w TezosWallet" to run in spider mode.

docker run --rm \
  -e ARCHIVE_ACCESS=yourArchiveAccessKey \
  -e ARCHIVE_SECRET=yourArchiveSecretKey \
  -v $(pwd)/data:/app/src/data \
  yatima3d/tz-archiver:latest 
  -w TezosWallet

⁠📦 Docker Compose Usage

Save one of the following two files with the name docker-compose.yml, depending on whether you want to archive the contents of a wallet or run in spider mode.

Launch it with:

docker compose up

Wallet mode:

### Compose file with a Tezos wallet
version: "3.9"
services:
  tz-archiver:
    image: yatima3d/tz-archiver:latest
    environment:
      ARCHIVE_ACCESS: "yourArchiveAccessKey"
      ARCHIVE_SECRET: "yourArchiveSecretKey"
    command: ["-w", "TezosWallet"]
    volumes:
      - ./data:/app/src/data

Spider Mode:

### Compose file in spider mode (no wallet)
version: "3.9"
services:
  tz-archiver:
    image: yatima3d/tz-archiver:latest
    environment:
      ARCHIVE_ACCESS: "yourArchiveAccessKey"
      ARCHIVE_SECRET: "yourArchiveSecretKey"
    volumes:
      - ./data:/app/src/data

⁠🔑 Environment Variables

• ARCHIVE_ACCESS: Internet Archive S3 access key
• ARCHIVE_SECRET: Internet Archive S3 secret key

Both are required for uploading to Internet Archive.

⁠📝 Notes

• Data processed by the container (logs) is stored inside the container unless volumes are mounted.
• Mounting a volume is recommended to persist processed data logs.