🍄 Fungi

A simple P2P network library for decentralized node connections

Discover public IP and port using STUN servers for direct connections

Signaling Server Setup • Client Installation • Usage • Customization

🖥️ Signaling Server Setup

Before using Fungi, set up a signaling server to track and share node information:

docker run -p 8000:8000 victorgoubet/fungi_server:v1

💡 Replace v1 with your desired release version.

🛠️ Client Installation

Choose between pip or Docker for client installation:

🐍 Option 1: pip Installation

1. Install Fungi:

pip install https://github.com/VictorGoubet/fungi/archive/refs/tags/v1.tar.gz

2. Configure the signaling server URL in utils/constants.py:

SERVER_URL = "http://localhost:8000"

3. Launch the client:

launch-fungi

🐳 Option 2: Docker Installation

Run the Fungi client container:

docker run -p 8080:8080 victorgoubet/fungi_client:v1

💡 Replace v1 with your desired release version.

🚀 Usage

After launching the client, navigate to http://localhost:8080 in your web browser.

🔧 Customization

To build your own signaling server Docker image, utilize the scripts in the server/scripts folder:

• 🐧 Linux: fungi/server/scripts/linux/
• 🍎 macOS: fungi/server/scripts/macos/
• 🪟 Windows: fungi/server/scripts/windows/