ipwb

(β˜… 655)

InterPlanetary Wayback: A distributed and persistent archive replay system using IPFS

  • .coveragerc
  • .dockerignore
  • .gitattributes
  • .gitignore
  • Dockerfile
  • entrypoint.sh
  • evaluation.sh
  • LICENSE
  • package.json
  • README.md
  • release.sh
  • requirements.txt
  • setup.cfg
  • setup.py
  • test-requirements.txt

# Installation Guide

1. Get the code
git clone https://github.com/oduwsdl/ipwb

Downloads the entire project code from GitHub to your computer.

cd ipwb

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
$ docker container run -it --rm -p 2016:2016 oduwsdl/ipwb

Type this command into your terminal and run it.

$ docker container run -it --rm -v /path/to/data:/data oduwsdl/ipwb ipwb index -o /data/cdxj/custom.cdxj /data/warc/custom.warc.gz

Type this command into your terminal and run it.

$ docker container run -it --rm -v /path/to/data:/data -p 2016:2016 oduwsdl/ipwb ipwb replay /data/cdxj/custom.cdxj

Type this command into your terminal and run it.

$ docker image build -t oduwsdl/ipwb .

Type this command into your terminal and run it.

$ docker image build --build-arg SKIPTEST=true -t oduwsdl/ipwb .

Type this command into your terminal and run it.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

4. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
$ pip install ipwb

Installs the Python libraries listed in requirements.txt (or similar).

$ pip install ./

Installs the Python libraries listed in requirements.txt (or similar).

βœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

// repository documentation