WOT Relay

WOT Relay is a Nostr relay that saves all the notes that people you follow, and people they follow are posting.

Prerequisites

• Go: Ensure you have Go installed on your system. You can download it from here.

Setup Instructions

Follow these steps to get the WOT Relay running on your local machine:

1. Clone the repository

git clone https://github.com/bitvora/wot-relay.git
cd wot-relay

2. Copy .env.example to .env

You'll need to create an .env file based on the example provided in the repository.

cp .env.example .env

3. Set your environment variables

Open the .env file and set the necessary environment variables. Example variables include:

RELAY_NAME="YourRelayName"
RELAY_PUBKEY="YourPublicKey"
RELAY_DESCRIPTION="Your relay description"
DB_PATH="/path/to/your/database"

4. Build the project

Run the following command to build the relay:

go build

5. Create a Systemd Service (optional)

To have the relay run as a service, create a systemd unit file. Here's an example:

1. Create the file:

sudo nano /etc/systemd/system/wot-relay.service

2. Add the following contents:

[Unit]
Description=WOT Relay Service
After=network.target

[Service]
ExecStart=/path/to/wot-relay
WorkingDirectory=/path/to/wot-relay
Restart=always
EnvironmentFile=/path/to/.env

[Install]
WantedBy=multi-user.target

Replace /path/to/ with the actual paths where you cloned the repository and stored the .env file.

3. Reload systemd to recognize the new service:

sudo systemctl daemon-reload

4. Start the service:

sudo systemctl start wot-relay

5. (Optional) Enable the service to start on boot:

sudo systemctl enable wot-relay

6. Start the Project with Docker Compose (optional)

To start the project using Docker Compose, follow these steps:

1. Ensure Docker and Docker Compose are installed on your system.

2. Navigate to the project directory.

3. Edit the docker-compose.yml file to update the environment variables as needed:

   environment:
       RELAY_NAME: "utxo WoT relay"
       RELAY_PUBKEY: "YOURPUBKEY"
       RELAY_DESCRIPTION: "Only notes in utxo WoT"
       DB_PATH: "./db"
   

4. Run the following command:

   docker-compose up --build
   

This will build the Docker image and start the wot-relay service as defined in the docker-compose.yml file. The application will be accessible on port 3334.

7. Access the relay

Once everything is set up, the relay will be running on localhost:3334.

http://localhost:3334

License

This project is licensed under the MIT License.