From c84a3a035f6d7ec57ce62a6ae1bfbda4c58e7a17 Mon Sep 17 00:00:00 2001 From: Ivan FB <128452529+Ivansete-status@users.noreply.github.com> Date: Mon, 12 Jan 2026 11:59:58 +0100 Subject: [PATCH] adjust some names to lmn (#184) --- ADVANCED.md | 4 +-- FAQ.md | 6 ++-- README.md | 28 +++++++++---------- docker-compose.yml | 4 +-- .../dashboards/nwaku-monitoring.json | 2 +- monitoring/configuration/grafana.ini | 2 +- run_node.sh | 4 +-- setup_wizard.sh | 2 +- 8 files changed, 26 insertions(+), 26 deletions(-) diff --git a/ADVANCED.md b/ADVANCED.md index 1d68218..2fedab7 100644 --- a/ADVANCED.md +++ b/ADVANCED.md @@ -6,9 +6,9 @@ Information for advances users 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`) -* `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_CRED_PATH` - path for peristing rln-relay credential * `RLN_RELAY_CRED_PASSWORD` - password for encrypting RLN credentials diff --git a/FAQ.md b/FAQ.md index cbb9948..c488f64 100644 --- a/FAQ.md +++ b/FAQ.md @@ -15,7 +15,7 @@ ### 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. -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: 1. `curl -X GET http://localhost:8645/health` 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? -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`, and then, there is no need to run `./register_rln.sh` again. diff --git a/README.md b/README.md index 749486c..dd59ff9 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# nwaku-compose +# logos-messaging-nim-compose -Ready‑to‑use **docker compose** stack for running your own [nwaku](https://github.com/waku-org/nwaku) node. +Ready‑to‑use **docker compose** stack for running your own [Logos Messaging](https://github.com/logos-messaging/logos-messaging-nim) node. ## πŸ“ Prerequisites @@ -35,7 +35,7 @@ Limit disk usage and (optionally) increase shared memory for better performance. ### πŸ–₯️ 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 @@ -58,13 +58,13 @@ The script is experimental, feedback and pull requests are welcome. ### πŸ“Œ 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. -----
-Monitor your nwaku node +Monitor your Logos Messaging node - **Metrics (Grafana):** 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:** See what’s happening inside your node in real time: ```bash - docker compose logs nwaku -f --tail 100 + docker compose logs logos-messaging-nim -f --tail 100 ``` - **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 - # get nwaku info + # get Logos Messaging 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/).
How to update to latest version -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 -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. 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` 3. `sudo rm -r keystore` 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 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` 3. `git pull origin master` 4. `docker-compose up -d` diff --git a/docker-compose.yml b/docker-compose.yml index cf150b1..888a7b8 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -24,7 +24,7 @@ x-pg-exporter-env: &pg_exp_env # Services definitions services: - nwaku: + logos-messaging-node: image: ${NWAKU_IMAGE:-harbor.status.im/wakuorg/nwaku:v0.37.0-beta} restart: on-failure ports: @@ -101,7 +101,7 @@ services: restart: on-failure:5 depends_on: - postgres-exporter - - nwaku + - logos-messaging-node grafana: image: docker.io/grafana/grafana:latest diff --git a/monitoring/configuration/dashboards/nwaku-monitoring.json b/monitoring/configuration/dashboards/nwaku-monitoring.json index 0480e66..d61a4dc 100644 --- a/monitoring/configuration/dashboards/nwaku-monitoring.json +++ b/monitoring/configuration/dashboards/nwaku-monitoring.json @@ -7413,7 +7413,7 @@ ] }, "timezone": "browser", - "title": "nwaku-monitoring", + "title": "logos-messaging-nim-monitoring", "uid": "yns_4vFVk", "version": 1 } \ No newline at end of file diff --git a/monitoring/configuration/grafana.ini b/monitoring/configuration/grafana.ini index f237726..cc4d6fc 100644 --- a/monitoring/configuration/grafana.ini +++ b/monitoring/configuration/grafana.ini @@ -1,4 +1,4 @@ -instance_name = nwaku dashboard +instance_name = logos-messaging-nim dashboard ;[dashboards.json] ;enabled = true diff --git a/run_node.sh b/run_node.sh index 145cdb2..01bcf4e 100755 --- a/run_node.sh +++ b/run_node.sh @@ -1,6 +1,6 @@ #!/bin/sh -echo "I am a nwaku node" +echo "I am a Logos Messaging node" if [ -n "${ETH_CLIENT_ADDRESS}" ] ; then 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-address=0.0.0.0\ --rest-port=8645\ - --rest-allow-origin="waku-org.github.io"\ + --rest-allow-origin="logos-messaging.github.io"\ --rest-allow-origin="localhost:*"\ --nat=extip:"${MY_EXT_IP}"\ --store=true\ diff --git a/setup_wizard.sh b/setup_wizard.sh index bbfc4f7..797a910 100755 --- a/setup_wizard.sh +++ b/setup_wizard.sh @@ -46,7 +46,7 @@ fi echocol "" echocol "╔══════════════════════════════════════════════════════════════════════════════╗" echocol "β•‘ β•‘" -echocol "β•‘ Welcome to nwaku-compose wizard β•‘" +echocol "β•‘ Welcome to logos-messaging-nim-compose wizard β•‘" echocol "β•‘ β•‘" echocol "β•šβ•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•" echocol ""