adjust some names to lmn (#184)

This commit is contained in:
Ivan FB 2026-01-12 11:59:58 +01:00 committed by GitHub
parent 020ee766c5
commit c84a3a035f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
8 changed files with 26 additions and 26 deletions

View File

@ -6,9 +6,9 @@ Information for advances users
There are multiple environment variables you can configure to modify behaviour of the Waku node: There are multiple environment variables you can configure to modify behaviour of the Waku node:
* `NWAKU_IMAGE` - the image you want to use for the nwaku container (e.g. `NWAKU_IMAGE=statusteam/nim-waku:v0.19.0-rc.0`). You can see the available tags in [docker hub](https://hub.docker.com/r/waku-org/nwaku). * `NWAKU_IMAGE` - the image you want to use for the nwaku container (e.g. `NWAKU_IMAGE=statusteam/nim-waku:v0.19.0-rc.0`). You can see the available tags in [docker hub](https://hub.docker.com/r/wakuorg/nwaku/tags).
* `DOMAIN` - domain name pointing to the IP address of your node, when configured the run script will request SSL certs from Let's Encrypt and run Waku node with WebSockets Secure (WSS) options enabled (e.g. `DOMAIN=waku.example.com`) * `DOMAIN` - domain name pointing to the IP address of your node, when configured the run script will request SSL certs from Let's Encrypt and run Waku node with WebSockets Secure (WSS) options enabled (e.g. `DOMAIN=waku.example.com`)
* `NODEKEY` - this env variable allows you to provide a node key as described in [operators documentation](https://github.com/waku-org/nwaku/blob/master/docs/operators/how-to/configure-key.md) (e.g. `NODEKEY=9f439983aa4851346cfe6e17585e426f482871a43626812e23490895cd602c11`) * `NODEKEY` - this env variable allows you to provide a node key as described in [operators documentation](https://github.com/logos-messaging/logos-messaging-nim/blob/master/docs/operators/how-to/configure-key.md) (e.g. `NODEKEY=9f439983aa4851346cfe6e17585e426f482871a43626812e23490895cd602c11`)
* `RLN_RELAY_ETH_CLIENT_ADDRESS` (**mandatory**) - URL to an HTTP Ethereum node URL on the same network as the contract address. If you're not running your own node, you can get the URL at Infura with the following [instructions](https://docs.infura.io/networks/ethereum/how-to/choose-a-network) * `RLN_RELAY_ETH_CLIENT_ADDRESS` (**mandatory**) - URL to an HTTP Ethereum node URL on the same network as the contract address. If you're not running your own node, you can get the URL at Infura with the following [instructions](https://docs.infura.io/networks/ethereum/how-to/choose-a-network)
* `RLN_RELAY_CRED_PATH` - path for peristing rln-relay credential * `RLN_RELAY_CRED_PATH` - path for peristing rln-relay credential
* `RLN_RELAY_CRED_PASSWORD` - password for encrypting RLN credentials * `RLN_RELAY_CRED_PASSWORD` - password for encrypting RLN credentials

6
FAQ.md
View File

@ -15,7 +15,7 @@
### Does my node work properly? ### Does my node work properly?
Your node should have at least 40 connected peers, and you should see some traffic in and out, in the Grafana board. Your node should have at least 40 connected peers, and you should see some traffic in and out, in the Grafana board.
1. Run `docker ps` and check that the `wakuorg/nwaku` container is not continuously restarting 1. Run `docker ps` and check that the `logos-messaging/logos-messaging-nim` container is not continuously restarting
2. Use the following commands to check the node better: 2. Use the following commands to check the node better:
1. `curl -X GET http://localhost:8645/health` 1. `curl -X GET http://localhost:8645/health`
2. `curl -X GET http://localhost:8645/debug/v1/info` 2. `curl -X GET http://localhost:8645/debug/v1/info`
@ -50,9 +50,9 @@ http://5.196.26.230:3000/d/yns_4vFVk/nwaku-monitoring?orgId=1&refresh=1m
### How to migrate my setup to another server? ### How to migrate my setup to another server?
1. Clone [nwaku-compose](https://github.com/waku-org/nwaku-compose) in the new server. 1. Clone [logos-messaging-nim-compose](https://github.com/logos-messaging/logos-messaging-nim-compose) in the new server.
2. Move your `keystore` folder (`nwaku-compose/keystore/`) from your current setup to the new server. 2. Move your `keystore` folder (`logos-messaging-nim-compose/keystore/`) from your current setup to the new server.
That folder was created when you executed `./register_rln.sh`, That folder was created when you executed `./register_rln.sh`,
and then, there is no need to run `./register_rln.sh` again. and then, there is no need to run `./register_rln.sh` again.

View File

@ -1,6 +1,6 @@
# nwaku-compose # logos-messaging-nim-compose
Readytouse **docker compose** stack for running your own [nwaku](https://github.com/waku-org/nwaku) node. Readytouse **docker compose** stack for running your own [Logos Messaging](https://github.com/logos-messaging/logos-messaging-nim) node.
## 📝 Prerequisites ## 📝 Prerequisites
@ -35,7 +35,7 @@ Limit disk usage and (optionally) increase shared memory for better performance.
### 🖥️ 3. Start your node ### 🖥️ 3. Start your node
Start all processes: nwaku node, database and grafana for metrics. Start all processes: Logos Messaging node, database and grafana for metrics.
``` ```
docker compose up -d docker compose up -d
@ -58,13 +58,13 @@ The script is experimental, feedback and pull requests are welcome.
</details> </details>
### 📌 Note ### 📌 Note
RLN membership is your access key to The Waku Network. It is registered on-chain, enabling your nwaku node to send messages in a decentralized and privacy-preserving way while adhering to rate limits. Messages exceeding the rate limit will not be relayed by other peers. RLN membership is your access key to The Waku Network. It is registered on-chain, enabling your Logos Messaging node to send messages in a decentralized and privacy-preserving way while adhering to rate limits. Messages exceeding the rate limit will not be relayed by other peers.
If you just want to relay traffic (not publish), you don't need to perform the registration. If you just want to relay traffic (not publish), you don't need to perform the registration.
----- -----
<details> <details>
<summary>Monitor your nwaku node </summary> <summary>Monitor your Logos Messaging node </summary>
- **Metrics (Grafana):** - **Metrics (Grafana):**
Open [localhost:3000](http://localhost:3000/d/yns_4vFVk/nwaku-monitoring) to view node metrics. Open [localhost:3000](http://localhost:3000/d/yns_4vFVk/nwaku-monitoring) to view node metrics.
@ -72,37 +72,37 @@ If you just want to relay traffic (not publish), you don't need to perform the r
- **Live logs:** - **Live logs:**
See whats happening inside your node in real time: See whats happening inside your node in real time:
```bash ```bash
docker compose logs nwaku -f --tail 100 docker compose logs logos-messaging-nim -f --tail 100
``` ```
- **Use the REST API** - **Use the REST API**
Your nwaku node exposes a [REST API](https://waku-org.github.io/waku-rest-api/) to interact with it. Your Logos Messaging node exposes a [REST API](https://logos-messaging.github.io/logos-messaging-rest-api/) to interact with it.
``` ```
# get nwaku version # get Logos Messaging version
curl http://127.0.0.1:8645/debug/v1/version curl http://127.0.0.1:8645/debug/v1/version
# get nwaku info # get Logos Messaging info
curl http://127.0.0.1:8645/debug/v1/info curl http://127.0.0.1:8645/debug/v1/info
``` ```
For advanced documentation, refer to [ADVANCED.md](https://waku-org.github.io/waku-rest-api/). For advanced documentation, refer to [ADVANCED.md](https://logos-messaging.github.io/logos-messaging-rest-api/).
</details> </details>
<details> <details>
<summary>How to update to latest version</summary> <summary>How to update to latest version</summary>
We regularly announce new available versions in our [Discord](https://discord.waku.org/) server. We regularly announce new available versions in our [Discord](https://discord.gg/XDJsVn2e) server.
### From `v0.35.1` or older ### From `v0.35.1` or older
Please review the latest https://github.com/waku-org/nwaku-compose/blob/master/.env.example env var template file and update your .env accordingly. Please review the latest https://github.com/logos-messaging/logos-messaging-nim-compose/blob/master/.env.example env var template file and update your .env accordingly.
Also, move your Sepolia RPC client (e.g., Infura) to a Linea Sepolia RPC client. Also, move your Sepolia RPC client (e.g., Infura) to a Linea Sepolia RPC client.
You will need to delete the `keystore` folder and register your membership again before using the new version by running the following commands: You will need to delete the `keystore` folder and register your membership again before using the new version by running the following commands:
1. `cd nwaku-compose` ( go into the root's repository folder ) 1. `cd logos-messaging-nim-compose` ( go into the root's repository folder )
2. `docker-compose down` 2. `docker-compose down`
3. `sudo rm -r keystore` 3. `sudo rm -r keystore`
4. `git pull origin master` 4. `git pull origin master`
@ -112,7 +112,7 @@ You will need to delete the `keystore` folder and register your membership again
### From `v0.36.0` or newer ### From `v0.36.0` or newer
Updating the node is as simple as running the following: Updating the node is as simple as running the following:
1. `cd nwaku-compose` ( go into the root's repository folder ) 1. `cd logos-messaging-nim-compose` ( go into the root's repository folder )
2. `docker-compose down` 2. `docker-compose down`
3. `git pull origin master` 3. `git pull origin master`
4. `docker-compose up -d` 4. `docker-compose up -d`

View File

@ -24,7 +24,7 @@ x-pg-exporter-env: &pg_exp_env
# Services definitions # Services definitions
services: services:
nwaku: logos-messaging-node:
image: ${NWAKU_IMAGE:-harbor.status.im/wakuorg/nwaku:v0.37.0-beta} image: ${NWAKU_IMAGE:-harbor.status.im/wakuorg/nwaku:v0.37.0-beta}
restart: on-failure restart: on-failure
ports: ports:
@ -101,7 +101,7 @@ services:
restart: on-failure:5 restart: on-failure:5
depends_on: depends_on:
- postgres-exporter - postgres-exporter
- nwaku - logos-messaging-node
grafana: grafana:
image: docker.io/grafana/grafana:latest image: docker.io/grafana/grafana:latest

View File

@ -7413,7 +7413,7 @@
] ]
}, },
"timezone": "browser", "timezone": "browser",
"title": "nwaku-monitoring", "title": "logos-messaging-nim-monitoring",
"uid": "yns_4vFVk", "uid": "yns_4vFVk",
"version": 1 "version": 1
} }

View File

@ -1,4 +1,4 @@
instance_name = nwaku dashboard instance_name = logos-messaging-nim dashboard
;[dashboards.json] ;[dashboards.json]
;enabled = true ;enabled = true

View File

@ -1,6 +1,6 @@
#!/bin/sh #!/bin/sh
echo "I am a nwaku node" echo "I am a Logos Messaging node"
if [ -n "${ETH_CLIENT_ADDRESS}" ] ; then if [ -n "${ETH_CLIENT_ADDRESS}" ] ; then
echo "ETH_CLIENT_ADDRESS variable was renamed to RLN_RELAY_ETH_CLIENT_ADDRESS" echo "ETH_CLIENT_ADDRESS variable was renamed to RLN_RELAY_ETH_CLIENT_ADDRESS"
@ -133,7 +133,7 @@ exec /usr/bin/wakunode\
--rest-admin=true\ --rest-admin=true\
--rest-address=0.0.0.0\ --rest-address=0.0.0.0\
--rest-port=8645\ --rest-port=8645\
--rest-allow-origin="waku-org.github.io"\ --rest-allow-origin="logos-messaging.github.io"\
--rest-allow-origin="localhost:*"\ --rest-allow-origin="localhost:*"\
--nat=extip:"${MY_EXT_IP}"\ --nat=extip:"${MY_EXT_IP}"\
--store=true\ --store=true\

View File

@ -46,7 +46,7 @@ fi
echocol "" echocol ""
echocol "╔══════════════════════════════════════════════════════════════════════════════╗" echocol "╔══════════════════════════════════════════════════════════════════════════════╗"
echocol "║ ║" echocol "║ ║"
echocol "║ Welcome to nwaku-compose wizard ║" echocol "║ Welcome to logos-messaging-nim-compose wizard ║"
echocol "║ ║" echocol "║ ║"
echocol "╚══════════════════════════════════════════════════════════════════════════════╝" echocol "╚══════════════════════════════════════════════════════════════════════════════╝"
echocol "" echocol ""