Update README.md

This commit is contained in:
HolgerHatGarKeineNode 2024-09-06 17:54:55 +00:00 committed by GitHub
parent 3877f9456c
commit aea9956bc0
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -91,13 +91,23 @@ sudo systemctl start wot-relay
sudo systemctl enable wot-relay
```
### 6. Start the Project with Docker Compose (optional)
### 6. Start the Project with Docker Compose
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. Run the following command:
3. Edit the `docker-compose.yml` file to update the environment variables as needed:
```yaml
environment:
RELAY_NAME: "utxo WoT relay"
RELAY_PUBKEY: "YOURPUBKEY"
RELAY_DESCRIPTION: "Only notes in utxo WoT"
DB_PATH: "./db"
```
4. Run the following command:
```sh
docker-compose up --build
@ -105,6 +115,7 @@ To start the project using Docker Compose, follow these steps:
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`.