goodmorningbitcoin/wot-relay
1
0
Fork 0
mirror of https://github.com/bitvora/wot-relay.git synced 2025-06-06 18:31:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #8 from bitvora/dev-updateReadme

Browse Source 
update readme with better .env paths
This commit is contained in:
Barry Deen 2024-09-07 13:31:12 -04:00 committed by GitHub
commit 62aac83d0a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 24 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -5,6 +5,7 @@ WOT Relay is a Nostr relay that saves all the notes that people you follow, and
## Prerequisites ## Prerequisites
- **Go**: Ensure you have Go installed on your system. You can download it from [here](https://golang.org/dl/). - **Go**: Ensure you have Go installed on your system. You can download it from [here](https://golang.org/dl/).
- **Build Essentials**: If you're using Linux, you may need to install build essentials. You can do this by running `sudo apt install build-essential`.
## Setup Instructions ## Setup Instructions
@ -33,7 +34,9 @@ Open the `.env` file and set the necessary environment variables. Example variab
RELAY_NAME="YourRelayName" RELAY_NAME="YourRelayName"
RELAY_PUBKEY="YourPublicKey" RELAY_PUBKEY="YourPublicKey"
RELAY_DESCRIPTION="Your relay description" RELAY_DESCRIPTION="Your relay description"
DB_PATH="/path/to/your/database" DB_PATH="/home/ubuntu/wot-relay/db" # any path you would like the database to be saved.
INDEX_PATH="/home/ubuntu/wot-relay/templates/index.html" # path to the index.html file
STATIC_PATH="/home/ubuntu/wot-relay/templates/static" # path to the static folder
``` ```
### 4. Build the project ### 4. Build the project
@ -115,6 +118,7 @@ To start the project using Docker Compose, follow these steps:
# in background # in background
docker compose up --build -d docker compose up --build -d
``` ```
6. For updating the relay, run the following command: 6. For updating the relay, run the following command:
```sh ```sh