3.2 KiB
The GitHub repo is mirrored from the in-I2P GitLab repo. Please open PRs and issues at http://git.idk.i2p/zlatinb/muwire
MuWire - Easy Anonymous File-Sharing
MuWire is an easy to use file-sharing program which offers anonymity using I2P technology. It works on any platform Java works on, including Windows,MacOS,Linux.
The current stable release - 0.7.1 is avaiable for download at https://muwire.com. The latest plugin build and instructions how to install the plugin are available inside I2P at http://muwire.i2p.
You can find technical documentation in the doc folder. Also check out the Wiki for various other documentation.
Building
You need JDK 9 or newer. After installing that and setting up the appropriate paths, just type
./gradlew clean assemble
If you want to run the unit tests, type
./gradlew clean build
If you want to build binary bundles that do not depend on Java or I2P, see the muwire-pkg project
Running the GUI
Type
./gradlew gui:run
The setup wizard will ask you for the host and port of an I2P or I2Pd router.
Running the CLI
Look inside cli-lanterna/build/distributions. Untar/unzip one of the shadow files and then run the jar contained inside by typing java -jar cli-lanterna-x.y.z-all.jar in a terminal. The CLI will ask you about the router host and port on startup, no need to edit any files. However, the CLI does not have an options window yet, so if you need to change any options you will need to edit the configuration files. The CLI options are documented here cli options
The CLI is under active development and doesn't have all the features of the GUI.
Running the Web UI / Plugin
There is a Web-based UI under development. It is intended to be run as a plugin to the Java I2P router. Instructions how to build it are available at the wiki Plugin page.
Docker
MuWire is available as a Docker image. For more information see the Docker page.
Translations
If you want to help translate MuWire, instructions are on the wiki https://github.com/zlatinb/muwire/wiki/Translate
Related Projects
MuWire Tracker Daemon
The MuWire Tracker Daemon (or mwtrackerd for short) is a project to bring functionality similar to BitTorrent tracking to MuWire. For more info see the Tracker page.
MuCats
MuCats is a project to create a website for hosting hashes of files shared on the MuWire network. For more info see the MuCats project.
GPG Fingerprint
471B 9FD4 5517 A5ED 101F C57D A728 3207 2D52 5E41
You can find the full key at https://keybase.io/zlatinb