Skip to content

Commit

Permalink
Update README.md with instructions to import connections from a friend
Browse files Browse the repository at this point in the history
  • Loading branch information
zlatinb committed Jul 13, 2024
1 parent 8dbd094 commit 651c9f3
Showing 1 changed file with 13 additions and 30 deletions.
43 changes: 13 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,16 @@
# Shutdown Notice

The MuWire project has been shut down. It is not available for download anywhere and while you are free to build from source, it will most likely not work.

# Java I2P warning

Do NOT use the Java implementation of I2P. Use the C++ one. You can read more at the pastebin URLs below:

Clearnet:
```
https://paste.i2pd.xyz/?77b8e66d0f366f87#BSA1kWMHpbAjFbRVRqQdf25feRQJ1sBY4mTDVNvs5dxj
```

Inside I2P (if that site does not resolve, check reg.i2p):
```
http://privatebin.i2p/?77b8e66d0f366f87#BSA1kWMHpbAjFbRVRqQdf25feRQJ1sBY4mTDVNvs5dxj
```

In that paste I make the claim that I have donated 1000 BTC to the Java I2P project. You can verify that by checking transaction hash:
```
0e42e4c782c73385f2c6b699da5fb81d4609bec4864550818020512bb90e30aa
```

# MuWire - Easy Anonymous File-Sharing

MuWire is a file publishing and networking tool that protects the identity of its users by using I2P technology. Anyone with a desktop computer and an internet connection can create a unique anonymous online persona and publish information of any kind without fear of censorship or persecution. MuWire works on any platform Java works on, including Windows, MacOS, Linux, Rapsberry Pi.

Users can then use their MuWire identities to publish files, search for files published by others, subscribe to each other’s publications and communicate through chat and messaging. Furthermore, users can establish trust-based relationship with each other where they assign a “trust level” to their contacts.

The current stable release is available for download at https://muwire.com. `.zip` bundles built from the latest source code are available on the [continuous integration] page.

You can find technical documentation in the [doc] folder. Also check out the [Wiki] for various other documentation.

## Downloading

If you prefer not to build MuWire from source, `.zip` bundles built from the latest code are available on the [continuous integration] page.


## Building

You need a JDK version between 11 and 18 inclusive. Newer versions may not work. After installing that and setting up the appropriate paths, just type
Expand All @@ -53,26 +33,29 @@ Type
./gradlew gui:run
```

The setup wizard will ask you for the host and port of an I2P or I2Pd router.
The setup wizard will ask you for the I2CP host and port of a Java I2P or I2Pd router. If running I2Pd (PurpleI2P), you need to enable the `I2CP` interface. That interface is enabled by default in the Java I2P router.

## Docker
## Connecting to other MuWire nodes

MuWire is available as a Docker image. For more information see the [Docker] page.
At the moment there is no discovery service available so MuWire cannot connect automatically. To work around, this, you can import the list of connections from another MuWire user. I plan on setting up a discovery service soon.

## Reproducible build

The `zip` distribution of MuWire can be build reproducibly on some systems. For more info see the [reproducible build] 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 [Translate] page.

## Creating your own MuWire network
If you want to create your own MuWire network instructions are on the [Wiki].

## 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.
* [MuWire Seedbox Daemon](https://github.com/zlatinb/muwire-seedbox-daemon) A headless daemon that only serves files and is controlled via a JSON-RPC interface. Suitable for seedboxes.
* [MuWire Seedbox Console](https://github.com/zlatinb/muwire-seedbox-console) A web console to manage one or more seedbox daemons.


## GPG Fingerprint
Expand Down

0 comments on commit 651c9f3

Please sign in to comment.