deploy/compose/README.md (5)

10-11: Fix grammatical issues in section headers

The word "Setup" is incorrectly used as a noun in section headers. Use "Set up" (verb form) instead.

-### Setup a node for production
+### Set up a node for production
-### Setup a node for testing
+### Set up a node for testing

Also applies to: 14-14

🧰 Tools

🪛 LanguageTool

[grammar] ~10-~10: This sentence should probably be started with a verb instead of the noun ‘Setup’. If not, consider inserting a comma for better clarity.
Context: ... network communications. ## Setup ### Setup a node for production The `docker comp...

(SENT_START_NN_DT)

---

38-41: Enhance environment variable descriptions

The environment variable descriptions could be more precise:

• HOPRD_API_PORT: Specify if this port needs to be exposed externally
• HOPRD_IMAGE: Include example values for both stable and latest tags

-- `HOPRD_API_PORT`: Adjust REST API port, default is `3001`.
-- `HOPRD_P2P_PORT`: Adjust the p2p communication port, default is `9091`.
-- `HOPRD_IMAGE`: Change the image tag from `stable` to `latest`. Example: `europe-west3-docker.pkg.dev/hoprassociation/docker-images/hoprd:latest`.
+- `HOPRD_API_PORT`: Port for the REST API (default: `3001`). Only expose externally if remote access is needed.
+- `HOPRD_P2P_PORT`: Port for P2P communication (default: `9091`). Must be exposed for network connectivity.
+- `HOPRD_IMAGE`: Docker image tag to use:
+  - Stable: `europe-west3-docker.pkg.dev/hoprassociation/docker-images/hoprd:stable`
+  - Latest: `europe-west3-docker.pkg.dev/hoprassociation/docker-images/hoprd:latest`

🧰 Tools

🪛 LanguageTool

[uncategorized] ~38-~38: Loose punctuation mark.
Context: ...variables as needed: - HOPRD_API_PORT: Adjust REST API port, default is 3001...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~39-~39: Loose punctuation mark.
Context: ...t, default is 3001. - HOPRD_P2P_PORT: Adjust the p2p communication port, defa...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~40-~40: Loose punctuation mark.
Context: ...port, default is 9091. - HOPRD_IMAGE: Change the image tag from stable to `...

(UNLIKELY_OPENING_PUNCTUATION)

---

51-52: Improve metrics URL example formatting

The metrics URL example is very long and hard to read. Consider breaking it into multiple lines for better readability.

-Example: `https://prometheus-pushgateway.staging.hoprnet.link/metrics/job/node-chaos/hoprd_peer_id/12D3KooWBX5ENqYkKTevwiQXpTFYZTWs3S11bQiueX7QQqapTsaR/namespace/team/hoprd_network/rotsee/hoprd_address/0xb6b099780bdf1c1041783178b88be8c9449e75ab`
+Example:
+```
+https://prometheus-pushgateway.staging.hoprnet.link/metrics/
+  job/node-chaos/
+  hoprd_peer_id/12D3KooWBX5ENqYkKTevwiQXpTFYZTWs3S11bQiueX7QQqapTsaR/
+  namespace/team/
+  hoprd_network/rotsee/
+  hoprd_address/0xb6b099780bdf1c1041783178b88be8c9449e75ab
+```

---

80-80: Fix grammar in compound sentence

Add a comma before "so" as it connects two independent clauses.

-To start a node, ensure you are inside the compose folder so the profile functionality can be recognized.
+To start a node, ensure you are inside the compose folder, so the profile functionality can be recognized.

🧰 Tools

🪛 LanguageTool

[uncategorized] ~80-~80: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ensure you are inside the compose folder so the profile functionality can be recogn...

(COMMA_COMPOUND_SENTENCE_2)

---

[formatting] ~80-~80: Consider inserting a comma after an introductory phrase for better readability.
Context: ...rofile functionality can be recognized. In this case we will start Docker compose using the ...

(IN_THAT_CASE_COMMA)

---

Line range hint 122-129: Add monitoring system prerequisites

The monitoring system examples would benefit from information about system requirements and resource usage.

Add a note about system requirements:

The default hoprd API endpoint is available at [http://localhost:3001](http://localhost:3001), with `HOPRD_API_PORT=3001` as the configured port.

3. Run hopr node with a full internal monitoring system (Prometheus and Grafana)

+> Note: Running a full monitoring stack requires additional system resources:
+> - Minimum 2GB RAM recommended
+> - At least 10GB of disk space for metrics retention
+
```shell
COMPOSE_PROFILES=hoprd,metrics-vis docker compose up -d

</blockquote></details>
<details>
<summary>hopli/README.md (3)</summary><blockquote>

`252-255`: **Consider adding prerequisite information**

While the setup instructions are clear, it would be helpful to include:
- Required system dependencies (e.g., Rust, cargo)
- Minimum system requirements
- Expected build time for new users

---

`259-259`: **Security: Consider removing RUST_BACKTRACE in production**

Setting `RUST_BACKTRACE=full` in production could expose sensitive information in error messages. Consider adding a warning note about this.

---

`277-277`: **Add error handling guidance**

For the safe-module creation command, consider adding:
- Common error scenarios and their solutions
- How to verify successful execution
- Troubleshooting steps if the RPC provider is unavailable

</blockquote></details>

</blockquote></details>

<details>
<summary>📜 Review details</summary>

**Configuration used: .coderabbit.yaml**
**Review profile: CHILL**

<details>
<summary>📥 Commits</summary>

Reviewing files that changed from the base of the PR and between 5fcc89324a54b4e5557cadf65d96f53860fc3d7e and 27e8a216fd0b8c137ff3086dbb99916180346f4d.

</details>

<details>
<summary>⛔ Files ignored due to path filters (1)</summary>

* `vendor/cargo/windows-0.34.0/src/Windows/Win32/Security/Authentication/.DS_Store` is excluded by `!**/.DS_Store`, `!vendor/**`

</details>

<details>
<summary>📒 Files selected for processing (3)</summary>

* `deploy/compose/README.md` (4 hunks)
* `deploy/compose/hoprd_data/hoprd.cfg.yaml` (2 hunks)
* `hopli/README.md` (1 hunks)

</details>

<details>
<summary>🧰 Additional context used</summary>

<details>
<summary>🪛 LanguageTool</summary>

<details>
<summary>deploy/compose/README.md</summary>

[grammar] ~10-~10: This sentence should probably be started with a verb instead of the noun ‘Setup’. If not, consider inserting a comma for better clarity.
Context: ... network communications.  ## Setup  ### Setup a node for production  The `docker comp...

(SENT_START_NN_DT)

---

[grammar] ~14-~14: This sentence should probably be started with a verb instead of the noun ‘Setup’. If not, consider inserting a comma for better clarity.
Context: ...net.org/node/node-docker-compose).  ### Setup a node for testing  This guide will wal...

(SENT_START_NN_DT)

---

[uncategorized] ~38-~38: Loose punctuation mark.
Context: ...variables as needed:  - `HOPRD_API_PORT`: Adjust REST API port, default is `3001`...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~39-~39: Loose punctuation mark.
Context: ...t, default is `3001`. - `HOPRD_P2P_PORT`: Adjust the p2p communication port, defa...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~40-~40: Loose punctuation mark.
Context: ...port, default is `9091`. - `HOPRD_IMAGE`: Change the image tag from `stable` to `...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~46-~46: Loose punctuation mark.
Context: ...owing data:  - `<NODE_NAME_FOR_GRAFANA>`: Your node's name for easy identificatio...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~47-~47: Loose punctuation mark.
Context: ...xample: `node-chaos`. - `<NODE_PEER_ID>`: The PeerID, To get the PeerID from your...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~48-~48: Loose punctuation mark.
Context: ...for-rotsee-network).  - `<MY_NAMESPACE>`: Adjust the namespace to better categori...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~49-~49: Loose punctuation mark.
Context: ...stion: `team`. - `<NODE_NATIVE_ADDRESS>`: Native address, to get the native addre...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~59-~59: Loose punctuation mark.
Context: ...e following secrets:  - `HOPRD_PASSWORD`: Replace `<YOUR HOPRD IDENTITY PASSWORD>...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~61-~61: Loose punctuation mark.
Context: ...or-rotsee-network).  - `HOPRD_API_TOKEN`: Replace `<YOUR HOPRD API TOKEN>` with y...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~67-~67: Loose punctuation mark.
Context: ... the following fields:  - `host.address`: Set the public IP address of the machin...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~68-~68: Loose punctuation mark.
Context: ...where the node is running. - `host.port`: Use the P2P port which you configured i...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~69-~69: Loose punctuation mark.
Context: ...nvironment-variables). - `chain.network`: Change `dufour` to `rotsee`. - `chain.p...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~70-~70: Loose punctuation mark.
Context: ...`dufour` to `rotsee`. - `chain.provider`: Enter the RPC endpoint URL. If using a ...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~71-~71: Loose punctuation mark.
Context: ... localhost. - `safe_module.safe_address`: Enter the safe address created in a [1s...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~72-~72: Loose punctuation mark.
Context: ...network). - `safe_module.module_address`: Enter the module address created in a [...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~80-~80: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ensure you are inside the compose folder so the profile functionality can be recogn...

(COMMA_COMPOUND_SENTENCE_2)

---

[formatting] ~80-~80: Consider inserting a comma after an introductory phrase for better readability.
Context: ...rofile functionality can be recognized. In this case we will start Docker compose using the ...

(IN_THAT_CASE_COMMA)

</details>

</details>
<details>
<summary>🪛 Markdownlint (0.35.0)</summary>

<details>
<summary>deploy/compose/README.md</summary>

59-59: null
Link fragments should be valid

(MD051, link-fragments)

---

71-71: null
Link fragments should be valid

(MD051, link-fragments)

---

72-72: null
Link fragments should be valid

(MD051, link-fragments)

---

76-76: null
Link fragments should be valid

(MD051, link-fragments)

</details>

</details>
<details>
<summary>🪛 yamllint (1.35.1)</summary>

<details>
<summary>deploy/compose/hoprd_data/hoprd.cfg.yaml</summary>

[error] 38-38: no new line character at the end of file

(new-line-at-end-of-file)

</details>

</details>
<details>
<summary>🪛 Gitleaks (8.21.2)</summary>

<details>
<summary>hopli/README.md</summary>

261-261: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

</details>

</details>

</details>

<details>
<summary>🔇 Additional comments (1)</summary>

<details>
<summary>hopli/README.md (1)</summary>

`246-251`: **LGTM! Clear and well-structured introduction**

The new section provides a clear overview of the objectives and expected outcomes.

</details>

</details>

</details>

<!-- This is an auto-generated comment by CodeRabbit for review status -->

deploy/compose/README.md (4)

10-10: Fix grammatical error in heading

"Setup" is a noun, while "Set up" is the verb form. Since this is an action heading, it should use the verb form.

-### Setup a node for production
+### Set up a node for production

🧰 Tools

🪛 LanguageTool

[grammar] ~10-~10: This sentence should probably be started with a verb instead of the noun ‘Setup’. If not, consider inserting a comma for better clarity.
Context: ... network communications. ## Setup ### Setup a node for production The `docker comp...

(SENT_START_NN_DT)

---

14-14: Fix grammatical error in heading

Same issue as above - "Setup" should be "Set up" when used as a verb.

-### Setup a node for testing
+### Set up a node for testing

🧰 Tools

🪛 LanguageTool

[grammar] ~14-~14: This sentence should probably be started with a verb instead of the noun ‘Setup’. If not, consider inserting a comma for better clarity.
Context: ...net.org/node/node-docker-compose). ### Setup a node for testing This guide will wal...

(SENT_START_NN_DT)

---

76-76: Add example for local RPC provider configuration

When mentioning the http:// prefix requirement for local RPC providers, it would be helpful to include an example.

-- `chain.provider`: Enter the RPC endpoint URL. If using a local RPC endpoint, include the http:// prefix with the IP address or localhost.
+- `chain.provider`: Enter the RPC endpoint URL. If using a local RPC endpoint, include the http:// prefix with the IP address or localhost (e.g., `http://localhost:8545` or `http://127.0.0.1:8545`).

🧰 Tools

🪛 LanguageTool

[uncategorized] ~76-~76: Loose punctuation mark.
Context: ...dufour to rotsee. - chain.provider: Enter the RPC endpoint URL. If using a ...

(UNLIKELY_OPENING_PUNCTUATION)

---

86-86: Improve clarity and grammar in launch instructions

The sentence needs better punctuation and more explicit directory instructions.

-The Docker Compose setup uses profiles. To start a node, ensure you are inside the compose folder so the profile functionality can be recognized. In this case we will start Docker compose using the `hoprd` profile (HOPR node) and the `metrics-push` profile (to push metrics to prometheus).
+The Docker Compose setup uses profiles. To start a node, ensure you are in the `compose` directory, so the profile functionality can be recognized. In this case, we will start Docker Compose using the `hoprd` profile (HOPR node) and the `metrics-push` profile (to push metrics to prometheus).

🧰 Tools

🪛 LanguageTool

[uncategorized] ~86-~86: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ensure you are inside the compose folder so the profile functionality can be recogn...

(COMMA_COMPOUND_SENTENCE_2)

---

[formatting] ~86-~86: Consider inserting a comma after an introductory phrase for better readability.
Context: ...rofile functionality can be recognized. In this case we will start Docker compose using the ...

(IN_THAT_CASE_COMMA)

hopli/README.md (2)

268-273: Add verification steps for identity creation

Please add information about:

• Expected output of successful identity creation
• How to verify the identity file was created correctly
• Common troubleshooting steps

---

279-284: Add output format documentation

Please add:

• Example output of the identity read command
• Explanation of PeerID and native address formats
• How to use this information in subsequent steps

Configuration used: .coderabbit.yaml
Review profile: CHILL

-wget https://github.com/hoprnet/hoprnet/archive/refs/heads/master.zip && unzip master.zip "hoprnet-master/deploy/compose/*" -d extracted_files && mv extracted_files/hoprnet-master/deploy/compose . && rm -rf master.zip extracted_files
+git clone https://github.com/hoprnet/hoprnet.git && cp -r hoprnet/deploy/compose . && rm -rf hoprnet

deploy/compose/README.md (3)

10-14: Fix grammatical usage of "Setup" in headers

The word "Setup" is being used incorrectly as a verb in the section headers. When used as a verb phrase, it should be "Set up".

Apply these changes:

-### Setup a node for production
+### Set up a node for production
-### Setup a node for testing
+### Set up a node for testing

🧰 Tools

🪛 LanguageTool

[grammar] ~10-~10: This sentence should probably be started with a verb instead of the noun ‘Setup’. If not, consider inserting a comma for better clarity.
Context: ... network communications. ## Setup ### Setup a node for production The `docker comp...

(SENT_START_NN_DT)

---

[grammar] ~14-~14: This sentence should probably be started with a verb instead of the noun ‘Setup’. If not, consider inserting a comma for better clarity.
Context: ...net.org/node/node-docker-compose). ### Setup a node for testing This guide will wal...

(SENT_START_NN_DT)

---

57-62: Add security considerations for sensitive environment variables

The secrets configuration includes sensitive information like API tokens and passwords. Consider adding security recommendations:

• Warn about not committing .env-secrets to version control
• Recommend using a secure method to generate API tokens
• Add guidance on password complexity requirements

Add this section before the secrets configuration:

+> ⚠️ Security Note:
+> - Never commit `.env-secrets` to version control
+> - Use a secure random generator for API tokens
+> - Ensure passwords are strong (min. 12 chars, mixed case, numbers, symbols)
+
 Adjust the following secrets:

🧰 Tools

🪛 LanguageTool

[uncategorized] ~59-~59: Loose punctuation mark.
Context: ...e following secrets: - HOPRD_PASSWORD: Replace `...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~61-~61: Loose punctuation mark.
Context: ...or-rotsee-network). - HOPRD_API_TOKEN: Replace <YOUR HOPRD API TOKEN> with y...

(UNLIKELY_OPENING_PUNCTUATION)

🪛 Markdownlint (0.35.0)

59-59: null
Link fragments should be valid

(MD051, link-fragments)

---

86-89: Add error handling guidance

The launch instructions should include guidance on verifying successful startup and troubleshooting common issues.

Add error handling section:

 Execute command: `COMPOSE_PROFILES=hoprd,metrics-push docker compose up -d`

+### Verifying Successful Launch
+
+1. Check container status:
+   ```shell
+   docker compose ps
+   ```
+
+2. View logs for errors:
+   ```shell
+   docker compose logs hoprd
+   ```
+
+### Common Issues
+
+- If the node fails to start, check:
+  - Port conflicts (9091 already in use)
+  - Invalid configuration in hoprd.cfg.yaml
+  - Missing or incorrect identity file

🧰 Tools

🪛 LanguageTool

[uncategorized] ~86-~86: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ensure you are inside the compose folder so the profile functionality can be recogn...

(COMMA_COMPOUND_SENTENCE_2)

---

[formatting] ~86-~86: Consider inserting a comma after an introductory phrase for better readability.
Context: ...rofile functionality can be recognized. In this case we will start Docker compose using the ...

(IN_THAT_CASE_COMMA)

Configuration used: .coderabbit.yaml
Review profile: CHILL

deploy/compose/README.md (3)

10-14: Fix grammar in section headings

The word "Setup" should be "Set up" when used as a verb phrase in headings.

Apply these changes:

-### Setup a node for production
+### Set up a node for production

-### Setup a node for testing
+### Set up a node for testing

🧰 Tools

🪛 LanguageTool

[grammar] ~10-~10: This sentence should probably be started with a verb instead of the noun ‘Setup’. If not, consider inserting a comma for better clarity.
Context: ... network communications. ## Setup ### Setup a node for production The `docker comp...

(SENT_START_NN_DT)

---

[grammar] ~14-~14: This sentence should probably be started with a verb instead of the noun ‘Setup’. If not, consider inserting a comma for better clarity.
Context: ...net.org/node/node-docker-compose). ### Setup a node for testing This guide will wal...

(SENT_START_NN_DT)

---

26-30: Consider removing git clone instructions

As this guide is primarily for developers who already have the repository, the git clone instructions may be redundant.

Consider removing this section or adding a note that this step is only for new developers.

---

36-41: Improve formatting of environment variables documentation

The environment variables and secrets sections use inconsistent bullet point formatting.

Consider using a table format for better readability:

| Variable | Description | Default |
|----------|-------------|---------|
| `HOPRD_API_PORT` | REST API port | 3001 |
| `HOPRD_P2P_PORT` | P2P communication port | 9091 |
| `HOPRD_IMAGE` | Image tag (e.g., `stable` or `latest`) | - |

Also applies to: 57-62

🧰 Tools

🪛 LanguageTool

[uncategorized] ~38-~38: Loose punctuation mark.
Context: ...variables as needed: - HOPRD_API_PORT: Adjust REST API port, default is 3001...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~39-~39: Loose punctuation mark.
Context: ...t, default is 3001. - HOPRD_P2P_PORT: Adjust the p2p communication port, defa...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~40-~40: Loose punctuation mark.
Context: ...port, default is 9091. - HOPRD_IMAGE: Change the image tag from stable to `...

(UNLIKELY_OPENING_PUNCTUATION)

Configuration used: .coderabbit.yaml
Review profile: CHILL

-[1st step](#1-create-identity-and-make-it-eligible-for-rotsee-network)
+[1st step](#1-create-an-identity-and-make-it-eligible-for-the-rotsee-network)

deploy/compose/README.md (3)

10-14: Improve header grammar

The word "Setup" should be "Set up" when used as a verb phrase in headers.

Apply this change:

-### Setup a node for production
+### Set up a node for production
-### Setup a node for testing
+### Set up a node for testing

🧰 Tools

🪛 LanguageTool

[grammar] ~10-~10: This sentence should probably be started with a verb instead of the noun ‘Setup’. If not, consider inserting a comma for better clarity.
Context: ... network communications. ## Setup ### Setup a node for production The `docker comp...

(SENT_START_NN_DT)

---

[grammar] ~14-~14: This sentence should probably be started with a verb instead of the noun ‘Setup’. If not, consider inserting a comma for better clarity.
Context: ...net.org/node/node-docker-compose). ### Setup a node for testing This guide will wal...

(SENT_START_NN_DT)

---

36-49: Improve list formatting consistency

The environment variables section has inconsistent formatting in the lists. Some items have periods at the end while others don't.

Standardize the punctuation and formatting:

-  - `HOPRD_API_PORT`: Adjust REST API port, default is `3001`.
-  - `HOPRD_P2P_PORT`: Adjust the p2p communication port, default is `9091`.
-  - `HOPRD_IMAGE`: Change the image tag from `stable` to `latest`. Example: `europe-west3-docker.pkg.dev/hoprassociation/docker-images/hoprd:latest`.
+  - `HOPRD_API_PORT`: Adjust REST API port, default is `3001`
+  - `HOPRD_P2P_PORT`: Adjust the p2p communication port, default is `9091`
+  - `HOPRD_IMAGE`: Change the image tag from `stable` to `latest`. Example: `europe-west3-docker.pkg.dev/hoprassociation/docker-images/hoprd:latest`

🧰 Tools

🪛 LanguageTool

[uncategorized] ~38-~38: Loose punctuation mark.
Context: ...variables as needed: - HOPRD_API_PORT: Adjust REST API port, default is 3001...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~39-~39: Loose punctuation mark.
Context: ...t, default is 3001. - HOPRD_P2P_PORT: Adjust the p2p communication port, defa...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~40-~40: Loose punctuation mark.
Context: ...port, default is 9091. - HOPRD_IMAGE: Change the image tag from stable to `...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~46-~46: Loose punctuation mark.
Context: ...owing data: - <NODE_NAME_FOR_GRAFANA>: Your node's name for easy identificatio...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~47-~47: Loose punctuation mark.
Context: ...xample: node-chaos. - <NODE_PEER_ID>: The PeerID, To get the PeerID from your...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~48-~48: Loose punctuation mark.
Context: ...for-rotsee-network). - <MY_NAMESPACE>: Adjust the namespace to better categori...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~49-~49: Loose punctuation mark.
Context: ...stion: team. - <NODE_NATIVE_ADDRESS>: Native address, to get the native addre...

(UNLIKELY_OPENING_PUNCTUATION)

---

159-170: Enhance stopping services documentation

While the current documentation explains the profile matching requirement, it could be more explicit about potential issues.

Consider expanding the explanation:

-Important: You must use exactly the same `COMPOSE_PROFILES` values for the `docker compose down` command as you used for `up`. Using different profiles may leave containers running or fail to clean up resources properly.
+Important: When stopping services:
+
+1. You MUST use identical `COMPOSE_PROFILES` values for both `up` and `down` commands
+2. Mismatched profiles can cause:
+   - Orphaned containers that continue running
+   - Incomplete resource cleanup
+   - Network or volume resources remaining allocated
+
+❗ Pro tip: Save your startup command in a script or note to ensure you use matching profiles when stopping.

🧰 Tools

🪛 LanguageTool

[style] ~159-~159: ‘exactly the same’ might be wordy. Consider a shorter alternative.
Context: ...pping services Important: You must use exactly the same COMPOSE_PROFILES values for the `dock...

(EN_WORDINESS_PREMIUM_EXACTLY_THE_SAME)

Configuration used: .coderabbit.yaml
Review profile: CHILL

deploy/compose/README.md (1)

10-23: Add prerequisites section before setup instructions

While the setup sections are well-organized, consider adding a "Prerequisites" section before the setup instructions to list all required tools, dependencies, and system requirements.

 ## Setup
+
+## Prerequisites
+
+Before proceeding with the setup, ensure you have:
+- Git installed
+- Docker and Docker Compose installed
+- Access to a terminal/command prompt
+- Sufficient disk space for Docker images
+- Required ports available (3001, 9091, etc.)

 ### Setup a node for production

🧰 Tools

🪛 LanguageTool

[grammar] ~10-~10: This sentence should probably be started with a verb instead of the noun ‘Setup’. If not, consider inserting a comma for better clarity.
Context: ... network communications. ## Setup ### Setup a node for production The `docker comp...

(SENT_START_NN_DT)

---

[grammar] ~14-~14: This sentence should probably be started with a verb instead of the noun ‘Setup’. If not, consider inserting a comma for better clarity.
Context: ...net.org/node/node-docker-compose). ### Setup a node for testing This guide will wal...

(SENT_START_NN_DT)

hopli/README.md (1)

270-284: Improve code block formatting

Add language specifiers to code blocks and improve command formatting for better readability.

-```
+```shell
 hopli identity create --identity-directory "./new_identities" --identity-prefix nodes_ --number 1

- +shell
hopli safe-module create
--network ${HOPRD_NETWORK}
--contracts-root "./ethereum/contracts"
--provider-url https://gnosis.rpc-provider.prod.hoprnet.link
--identity-directory "./new_identities"
--allowance 10.5
--hopr-amount 1
--native-amount 0.1

-```
+```shell
hopli identity read --identity-directory "./new_identities" --identity-prefix nodes_

<details>
<summary>🧰 Tools</summary>

<details>
<summary>🪛 Markdownlint (0.35.0)</summary>

270-270: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

276-276: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

282-282: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

</details>

</details>

</blockquote></details>

</blockquote></details>

<details>
<summary>📜 Review details</summary>

**Configuration used: .coderabbit.yaml**
**Review profile: CHILL**

<details>
<summary>📥 Commits</summary>

Reviewing files that changed from the base of the PR and between c65603407b70cfa71d80d0ec4f8a7e708ca875eb and 7b6dcab99bdfc5f39b1dd2d3366eaa68564098bd.

</details>

<details>
<summary>📒 Files selected for processing (2)</summary>

* `deploy/compose/README.md` (3 hunks)
* `hopli/README.md` (1 hunks)

</details>

<details>
<summary>🧰 Additional context used</summary>

<details>
<summary>🪛 LanguageTool</summary>

<details>
<summary>deploy/compose/README.md</summary>

[grammar] ~10-~10: This sentence should probably be started with a verb instead of the noun ‘Setup’. If not, consider inserting a comma for better clarity.
Context: ... network communications.  ## Setup  ### Setup a node for production  The `docker comp...

(SENT_START_NN_DT)

---

[grammar] ~14-~14: This sentence should probably be started with a verb instead of the noun ‘Setup’. If not, consider inserting a comma for better clarity.
Context: ...net.org/node/node-docker-compose).  ### Setup a node for testing  This guide will wal...

(SENT_START_NN_DT)

---

[uncategorized] ~38-~38: Loose punctuation mark.
Context: ...variables as needed:  - `HOPRD_API_PORT`: Adjust REST API port, default is `3001`...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~39-~39: Loose punctuation mark.
Context: ...t, default is `3001`. - `HOPRD_P2P_PORT`: Adjust the p2p communication port, defa...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~40-~40: Loose punctuation mark.
Context: ...port, default is `9091`. - `HOPRD_IMAGE`: Change the image tag from `stable` to `...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~46-~46: Loose punctuation mark.
Context: ...owing data:  - `<NODE_NAME_FOR_GRAFANA>`: Your node's name for easy identificatio...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~47-~47: Loose punctuation mark.
Context: ...xample: `node-chaos`. - `<NODE_PEER_ID>`: The PeerID, To get the PeerID from your...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~48-~48: Loose punctuation mark.
Context: ...for-rotsee-network).  - `<MY_NAMESPACE>`: Adjust the namespace to better categori...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~49-~49: Loose punctuation mark.
Context: ...stion: `team`. - `<NODE_NATIVE_ADDRESS>`: Native address, to get the native addre...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~59-~59: Loose punctuation mark.
Context: ...e following secrets:  - `HOPRD_PASSWORD`: Replace `<YOUR HOPRD IDENTITY PASSWORD>...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~61-~61: Loose punctuation mark.
Context: ...or-rotsee-network).  - `HOPRD_API_TOKEN`: Replace `<YOUR HOPRD API TOKEN>` with y...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~67-~67: Loose punctuation mark.
Context: ...ssary changes:  - `services.hoprd.ports`: Add an additional UDP port under the po...

(UNLIKELY_OPENING_PUNCTUATION)

---

[style] ~67-~67: This phrase might be redundant. Consider either removing or replacing the adjective ‘additional’.
Context: ...ary changes:  - `services.hoprd.ports`: Add an additional UDP port under the ports variable to open a...

(ADD_AN_ADDITIONAL)

---

[uncategorized] ~73-~73: Loose punctuation mark.
Context: ... the following fields:  - `host.address`: Set the public IP address of the machin...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~74-~74: Loose punctuation mark.
Context: ...where the node is running. - `host.port`: Use the P2P port which you configured i...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~75-~75: Loose punctuation mark.
Context: ...nvironment-variables). - `chain.network`: Change `dufour` to `rotsee`. - `chain.p...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~76-~76: Loose punctuation mark.
Context: ...`dufour` to `rotsee`. - `chain.provider`: Enter the RPC endpoint URL. If using a ...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~77-~77: Loose punctuation mark.
Context: ... localhost. - `safe_module.safe_address`: Enter the safe address created in a [1s...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~78-~78: Loose punctuation mark.
Context: ...network). - `safe_module.module_address`: Enter the module address created in a [...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~86-~86: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ensure you are inside the compose folder so the profile functionality can be recogn...

(COMMA_COMPOUND_SENTENCE_2)

---

[formatting] ~86-~86: Consider inserting a comma after an introductory phrase for better readability.
Context: ...rofile functionality can be recognized. In this case we will start Docker compose using the ...

(IN_THAT_CASE_COMMA)

---

[style] ~159-~159: ‘exactly the same’ might be wordy. Consider a shorter alternative.
Context: ...pping services  Important: You must use exactly the same `COMPOSE_PROFILES` values for the `dock...

(EN_WORDINESS_PREMIUM_EXACTLY_THE_SAME)

</details>

</details>
<details>
<summary>🪛 Markdownlint (0.35.0)</summary>

<details>
<summary>deploy/compose/README.md</summary>

28-28: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

59-59: null
Link fragments should be valid

(MD051, link-fragments)

---

77-77: null
Link fragments should be valid

(MD051, link-fragments)

---

78-78: null
Link fragments should be valid

(MD051, link-fragments)

---

82-82: null
Link fragments should be valid

(MD051, link-fragments)

---

119-119: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

125-125: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

134-134: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

147-147: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

153-153: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

163-163: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

168-168: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

</details>
<details>
<summary>hopli/README.md</summary>

257-257: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

270-270: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

276-276: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

282-282: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

</details>

</details>

</details>

<details>
<summary>🔇 Additional comments (3)</summary>

<details>
<summary>deploy/compose/README.md (2)</summary>

`157-170`: **LGTM! Clear instructions for stopping services**

The section effectively communicates the critical requirement of using matching profiles and provides a clear example.

<details>
<summary>🧰 Tools</summary>

<details>
<summary>🪛 LanguageTool</summary>

[style] ~159-~159: ‘exactly the same’ might be wordy. Consider a shorter alternative.
Context: ...pping services  Important: You must use exactly the same `COMPOSE_PROFILES` values for the `dock...

(EN_WORDINESS_PREMIUM_EXACTLY_THE_SAME)

</details>
<details>
<summary>🪛 Markdownlint (0.35.0)</summary>

163-163: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

168-168: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

</details>

</details>

---

`71-78`: _:warning: Potential issue_

**Fix invalid link fragments and enhance configuration guidance**

The section contains invalid link fragments and could benefit from more specific guidance on the expected values.

```diff
-- `chain.provider`: Enter the RPC endpoint URL. If using a local RPC endpoint, include the http:// prefix with the IP address or localhost.
+- `chain.provider`: Enter the RPC endpoint URL (e.g., `http://localhost:8545` or `https://rpc.example.com`). If using a local RPC endpoint, include the `http://` prefix with the IP address or localhost.
-- `safe_module.safe_address`: Enter the safe address created in a [1st step](#1-create-identity-and-make-it-eligible-for-rotsee-network).
-- `safe_module.module_address`: Enter the module address created in a [1st step](#1-create-identity-and-make-it-eligible-for-rotsee-network).
+- `safe_module.safe_address`: Enter the safe address (0x-prefixed hex string) created in the [first step](#1-create-an-identity-and-make-it-eligible-for-the-rotsee-network).
+- `safe_module.module_address`: Enter the module address (0x-prefixed hex string) created in the [first step](#1-create-an-identity-and-make-it-eligible-for-the-rotsee-network).

Likely invalid or redundant comment.

🧰 Tools

🪛 LanguageTool

[uncategorized] ~73-~73: Loose punctuation mark.
Context: ... the following fields: - host.address: Set the public IP address of the machin...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~74-~74: Loose punctuation mark.
Context: ...where the node is running. - host.port: Use the P2P port which you configured i...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~75-~75: Loose punctuation mark.
Context: ...nvironment-variables). - chain.network: Change dufour to rotsee. - `chain.p...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~76-~76: Loose punctuation mark.
Context: ...dufour to rotsee. - chain.provider: Enter the RPC endpoint URL. If using a ...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~77-~77: Loose punctuation mark.
Context: ... localhost. - safe_module.safe_address: Enter the safe address created in a [1s...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~78-~78: Loose punctuation mark.
Context: ...network). - safe_module.module_address: Enter the module address created in a [...

(UNLIKELY_OPENING_PUNCTUATION)

🪛 Markdownlint (0.35.0)

77-77: null
Link fragments should be valid

(MD051, link-fragments)

---

78-78: null
Link fragments should be valid

(MD051, link-fragments)

hopli/README.md (1)

257-264: ⚠️ Potential issue

Enhance security of environment variable examples

The example contains sensitive information placeholders that should be made more secure and explicit.

 export PATH="./target/release:${PATH}"
 export RUST_BACKTRACE=full
 export HOPRD_NETWORK=rotsee
-export IDENTITY_PASSWORD=<your-secure-password-here> # Replace with your own secure password
-export PRIVATE_KEY=0x0000000000000000000000000000000000000000000000000000000000000000 # Replace with Deployer Private Key
-export MANAGER_PRIVATE_KEY=0x0000000000000000000000000000000000000000000000000000000000000000 # Replace with Manager Private Key
+export IDENTITY_PASSWORD='<CHANGE_ME>' # Replace with a strong password (min. 12 chars, mixed case, numbers, symbols)
+export PRIVATE_KEY='<DEPLOYER_PRIVATE_KEY>' # Replace with your 0x-prefixed 64-character deployer private key
+export MANAGER_PRIVATE_KEY='<MANAGER_PRIVATE_KEY>' # Replace with your 0x-prefixed 64-character manager private key
+
+# WARNING: Never commit or share your private keys and passwords!

Likely invalid or redundant comment.

🧰 Tools

🪛 Markdownlint (0.35.0)

257-257: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

deploy/compose/README.md (1)

28-30: Add language specifiers to code blocks

Code blocks should specify their language for proper syntax highlighting.

Add shell language specifier to code blocks:

-```
+```shell

Also applies to: 119-119, 125-125, 134-134, 147-147, 153-153, 163-165, 169-171

🧰 Tools

🪛 Markdownlint (0.35.0)

28-28: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

hopli/README.md (1)

257-264: Add language specifiers to code blocks

Code blocks should specify their language for proper syntax highlighting.

Add shell language specifier to code blocks:

-```
+```shell

Also applies to: 270-272, 276-278, 282-284

🧰 Tools

🪛 Markdownlint (0.35.0)

257-257: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

Configuration used: .coderabbit.yaml
Review profile: CHILL

-Example: `https://prometheus-pushgateway.staging.hoprnet.link/metrics/job/node-chaos/hoprd_peer_id/12D3KooWBX5ENqYkKTevwiQXpTFYZTWs3S11bQiueX7QQqapTsaR/namespace/team/hoprd_network/rotsee/hoprd_address/0xb6b099780bdf1c1041783178b88be8c9449e75ab`
+Example: `https://<pushgateway-url>/metrics/job/<node-name>/hoprd_peer_id/<peer-id>/namespace/<namespace>/hoprd_network/<network>/hoprd_address/<address>`

-hopli safe-module create --network ${HOPRD_NETWORK} --contracts-root "./ethereum/contracts"  --provider-url https://gnosis.rpc-provider.prod.hoprnet.link --identity-directory "./new_identities" --allowance 10.5 --hopr-amount 1 --native-amount 0.1
+# Set the provider URL as an environment variable
+export PROVIDER_URL='<RPC_PROVIDER_URL>' # Replace with your RPC provider URL
+
+hopli safe-module create \
+  --network ${HOPRD_NETWORK} \
+  --contracts-root "./ethereum/contracts" \
+  --provider-url ${PROVIDER_URL} \
+  --identity-directory "./new_identities" \
+  --allowance 10.5 \
+  --hopr-amount 1 \
+  --native-amount 0.1

-export IDENTITY_PASSWORD=<your-secure-password-here>
-export PRIVATE_KEY=0x0000000000000000000000000000000000000000000000000000000000000000
-export MANAGER_PRIVATE_KEY=0x0000000000000000000000000000000000000000000000000000000000000000
+export IDENTITY_PASSWORD='<REPLACE_WITH_SECURE_PASSWORD>'
+export PRIVATE_KEY='<REPLACE_WITH_DEPLOYER_PRIVATE_KEY>'
+export MANAGER_PRIVATE_KEY='<REPLACE_WITH_MANAGER_PRIVATE_KEY>'

deploy/compose/README.md (3)

10-14: Fix grammar in section headings

Change "Setup" to "Setting up" in the headings for better readability and grammatical correctness.

-### Setup a node for production
+### Setting up a node for production
-### Setup a node for testing
+### Setting up a node for testing

🧰 Tools

🪛 LanguageTool

[grammar] ~10-~10: This sentence should probably be started with a verb instead of the noun ‘Setup’. If not, consider inserting a comma for better clarity.
Context: ... network communications. ## Setup ### Setup a node for production The `docker comp...

(SENT_START_NN_DT)

---

[grammar] ~14-~14: This sentence should probably be started with a verb instead of the noun ‘Setup’. If not, consider inserting a comma for better clarity.
Context: ...net.org/node/node-docker-compose). ### Setup a node for testing This guide will wal...

(SENT_START_NN_DT)

---

67-67: Remove redundant wording

The phrase "Add an additional" is redundant.

-- `services.hoprd.ports`: Add an additional UDP port under the ports variable to open a session.
+- `services.hoprd.ports`: Add a UDP port under the ports variable to open a session.

🧰 Tools

🪛 LanguageTool

[uncategorized] ~67-~67: Loose punctuation mark.
Context: ...ssary changes: - services.hoprd.ports: Add an additional UDP port under the po...

(UNLIKELY_OPENING_PUNCTUATION)

---

[style] ~67-~67: This phrase might be redundant. Consider either removing or replacing the adjective ‘additional’.
Context: ...ary changes: - services.hoprd.ports: Add an additional UDP port under the ports variable to open a...

(ADD_AN_ADDITIONAL)

---

119-119: Add language specifiers to code blocks

Add shell language specifiers to the code blocks for better syntax highlighting.

-```
+```shell
COMPOSE_PROFILES=hoprd docker compose up -d

Also applies to: 125-125, 134-134, 147-147, 153-153, 163-163, 169-169

🧰 Tools

🪛 Markdownlint (0.37.0)

119-119: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

deploy/compose/README.md (1)

119-119: Add shell language identifier to code blocks

Add the shell language identifier to the code blocks for better syntax highlighting and documentation consistency.

Example:

-```
+```shell
COMPOSE_PROFILES=hoprd docker compose up -d

Also applies to: 125-125, 134-134, 147-147, 153-153, 163-165, 169-171

🧰 Tools

🪛 Markdownlint (0.37.0)

119-119: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro