synapse-ng

Getting Started

This guide provides a detailed walkthrough of how to set up and run a Synapse-NG node. You can choose between a quick and easy Docker setup or a manual setup for local development.

Prerequisites

Before you begin, make sure you have the following software installed:

Docker & Docker Compose: For the recommended setup.
Python 3.10+: For manual setup and local development.
jq: A command-line JSON processor used by the test scripts.

Docker Setup (Recommended)

The easiest way to get started with Synapse-NG is by using Docker. This method will set up a 3-node network with a single command.

Clone the repository:

git clone https://github.com/fabriziosalmi/synapse-ng.git
cd synapse-ng

Start the network:
```
docker-compose up --build -d
```
This command will build the Docker images and start three Synapse-NG nodes in the background.
Verify the network status:
```
curl http://localhost:8001/state | jq '.global.nodes | length'
```
You should see an output of 3, indicating that all three nodes are running and have formed a network.
Run the test suite:
```
./test_suite.sh
```
This will run the complete test suite to ensure that everything is working correctly.

Manual Setup (Local Development)

If you want to do local development or run a node without Docker, you can follow these manual setup instructions.

Install dependencies:
```
pip3 install -r requirements.txt
```

Generate a node identity:

python3 -c "
from app.identity import generate_identity
import os
os.makedirs('data/node-1', exist_ok=True)
generate_identity('data/node-1')
print('✅ Identity generated')
"

This will create a new identity for your node and store it in the data/node-1 directory.

Start the node:
```
export NODE_ID="node-1"
export HTTP_PORT=8000
python3 app/main.py
```
This will start a single Synapse-NG node on your local machine.

This site is open source. Improve this page.