You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+11-7Lines changed: 11 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# SSV stack
1
+
# SSV Stack
2
2
DISCLAIMER: SSV stack is an example repository how you can run SSV node with monitoring stack. It is not recommended to use it in production.
3
3
4
4
It includes Prometheus, which scrapes the SSV node and Grafana which has dashboard for the SSV node.
@@ -28,22 +28,26 @@ The minimum you need to change is:
28
28
29
29
Check the `ssv.example.env` file for details for all the others settings you can adjust.
30
30
31
+
32
+
### SSV node private key
33
+
#### Generate New Key
34
+
This example generates a new ssv node private key which is encrypted by a newly generated random password. Both files will be in the `./ssv-node-data` directory.
35
+
#### Use Existing Key
36
+
If you want to use your own private key, you can go to the `./ssv-node-data`folder and put in your private_key and password files such as: `./ssv-node-data/private_key` and `./ssv-node-data/password`. You might need to create the `./ssv-node-data` directory if it does not exist.
37
+
31
38
### Run the stack
32
-
run in foreground
39
+
Run in foreground
33
40
```bash
34
41
docker compose up
35
42
```
36
-
or run in background
43
+
Run in background
37
44
```bash
38
45
docker compose up -d
39
46
```
40
47
41
-
###Access Grafana
48
+
## Access Grafana
42
49
Open your browser and go to [http://localhost:3000](http://localhost:3000) and login with `admin`/`admin`. You can change the password later.
43
50
44
51
In the `Dashboards` section you should be able to find the `SSV Operational` dashboard. Unless the node is registered with the SSV network and has validators, some of the dashboard's columns might be empty.
45
52
46
53
**WARNING**: Grafana and Prometheus is running only on the `localhost` by default. You should change the password and/or restrict access to it. If you expose Grafana and Prometheus to the internet, you should be extra careful and make sure they are secured.
47
-
48
-
## SSV node private key
49
-
This example generates a new ssv node private key which is encrypted by newly generated random password. Both files are persisted in the `./ssv-node-data` directory. If you want to use your own private key, you can replace the `./ssv-node-data/private_key` and `./ssv-node-data/password` files with your own. You might need to create dir if it does not exist.
0 commit comments