From aea9956bc0dd6655e6f34ca33594efa14866e867 Mon Sep 17 00:00:00 2001 From: HolgerHatGarKeineNode <123783602+HolgerHatGarKeineNode@users.noreply.github.com> Date: Fri, 6 Sep 2024 17:54:55 +0000 Subject: [PATCH] Update README.md --- README.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 913b902..706eb58 100644 --- a/README.md +++ b/README.md @@ -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`.