Skip to content

Robotizing/MiceWeb

Repository files navigation

MiceWeb

The legacy Web gives us the familiar addressing system. Let's use it. However, data should be available as long as possible.

Features:

  • Save web page by URL to local MiceWeb library, stored in IPFS MFS.
  • Support following URL schemes: http, https, gopher, gemini, ftp, ftps, ipfs, ipns, git.
  • Share saved versions.

Installation (macOS, Linux, BSD):

  1. Install Git, IPFS CLI.

  2. Open a terminal and run git clone https://github.com/Robotizing/MiceWeb && MiceWeb/install.sh (also, there is update.sh available).

  3. Optionally, install wget, curl, gemget, jq, yq, htmlq, torsocks, Wayback Machine Downloader, yt-dlp, ffmpeg and ffprobe, and also ZeroNet.


Installation (Windows):

  1. Install WSL, Cygwin, Git Bash, or some other tool that enables Bash functionality in Windows.

  2. Follow the above section.


Usage:

Open a terminal and run miceweb help to get acquainted.

List snapshots (clickable), and save:

miceweb http://example.com

List URLs, stored in the MiceWeb library:

miceweb urls


Advanced:

Run miceweb commands to see the possibilities.

Save pages:

miceweb save http://www.example.com/page.htm

miceweb save urls collection.txt

miceweb save urls "$HOME/Library/Application Support/com.operasoftware.Opera/Bookmarks" --format=json

Present saved versions:

miceweb present http://www.example.com/page.htm

miceweb present urls collection.txt --grep=stackoverflow.com


Development:

The target is to create portable tool, not spending many resources to support different platforms, so using Bash seems a good solutuon. See also testssl.sh Coding Style to get into the spirit.


Configuration:

MiceWeb uses ZERONET_PATH environment variable to work with ZeroNet.

IPFS Reprovider.Strategy determines privacy level.

It's possible to have several libraries on a single machine by running several ipfs nodes.


Community:

Run miceweb talks, and welcome to MiceWeb Talks.


Notes:

MiceWeb tries to do best to save web pages. However, you still have to check saved snapshots of important pages.

Construct RatBrowser to save browser-generated pages. Use SaveSites to save web sites entirely.