Skip to content

Commit

Permalink
docs(RREL-0017): clarify keys usage on registration
Browse files Browse the repository at this point in the history
  • Loading branch information
antomor committed Sep 21, 2023
1 parent dfd951a commit 18662c1
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -275,6 +275,12 @@ After this you will see several log entries indicating the registration progress
Relayer state: READY
```

> ### :warning: Warning
>
> Keep in mind that there are different ways to specify the keys during the registration steps.
> 1. If nothing is specified, the register scrips tries to retrieve the signer from the RPC accounts configured in the node; this method is enabled for development purposes only (Regtest)
> 2. The user could use either a private key or a mnemonic using the [custom environment variable method](https://github.com/rsksmart/rif-relay-server/blob/main/Readme.md#overrides) hence by specifying `REGISTER_PRIVATE_KEY` or `REGISTER_MNEMONIC` as environment variables (e.g.: `REGISTER_PRIVATE_KEY=0xabc123 npm run register` or `REGISTER_MNEMONIC=0xabc123 npm run register`).
### Execute as a Docker container

You can run the server as a Docker container. Docker and Docker compose should be installed and an RSK Node should be running.
Expand Down

0 comments on commit 18662c1

Please sign in to comment.