mirror of
https://github.com/bitvora/wot-relay.git
synced 2025-06-06 18:31:05 +00:00
338442006b
Introduced a Dockerfile to build the wot-relay application using the Golang image based on Debian Bookworm. Configured the working directory, cloned the repository, downloaded Go module dependencies, set environment variables, and built the Go application. Exposed port 3334 and set the command to run the executable. Added a Docker Compose file for streamlined service deployment, including environment variable configurations, volume binding for the database directory, and port mapping.
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:
- Create the file:
sudo nano /etc/systemd/system/wot-relay.service
- 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.
- Reload systemd to recognize the new service:
sudo systemctl daemon-reload
- Start the service:
sudo systemctl start wot-relay
- (Optional) Enable the service to start on boot:
sudo systemctl enable wot-relay
6. 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.