Skip to content

Commit fea18fb

Browse files
committed
Add some documentation to config values
1 parent 512a14a commit fea18fb

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,10 @@ This package includes the following services:
2828

2929
The setup wizard provides options for users to configure the package. These values need to be filled:
3030

31-
- `KEYPER_NAME`
32-
- `SHUTTER_API_NODE_PRIVATEKEY`
33-
- `ETHEREUM_WS`
34-
- `SHUTTER_PUSH_METRICS_ENABLED`
35-
- `PUSHGATEWAY_URL`
36-
- `PUSHGATEWAY_USERNAME`
37-
- `PUSHGATEWAY_PASSWORD`
31+
- `KEYPER_NAME`: a unique name for your keyper so it can be identified in the network.
32+
- `SHUTTER_API_NODE_PRIVATEKEY`: A privatekey for an ethereum externally owned account.
33+
- `ETHEREUM_WS`: An ethereum websocket RPC url. This can either point to an external RPC, or an RPC node running on your dappnode.
34+
- `SHUTTER_PUSH_METRICS_ENABLED`: A boolean flag deciding whether metrics will be pushed (see values below).
35+
- `PUSHGATEWAY_URL`: You don't need to change the default here.
36+
- `PUSHGATEWAY_USERNAME`: A username for the push gateway from above.
37+
- `PUSHGATEWAY_PASSWORD`: A password for the push gateway from above.

0 commit comments

Comments
 (0)