|
2 | 2 |
|
3 | 3 | This repository contains the docker compose configuration to run a gnosis Keyper. |
4 | 4 |
|
| 5 | +--- |
| 6 | + |
| 7 | +## Table of Contents |
| 8 | + |
| 9 | +- [Prerequisites](#prerequisites) |
| 10 | + - [Gnosis beacon and execution clients](#gnosis-beacon-and-execution-clients) |
| 11 | + - [System requirements](#system-requirements) |
| 12 | + - [Software](#software) |
| 13 | +- [Installation](#installation) |
| 14 | +- [Setting Up Logging](#setting-up-logging) |
| 15 | +- [Running the Keyper Node](#running-the-keyper-node) |
| 16 | +- [Backups](#backups) |
| 17 | +- [Updating](#updating) |
| 18 | +- [Version History](#version-history) |
| 19 | +- [Contract Deployments](#contract-deployments) |
| 20 | + |
| 21 | +--- |
| 22 | + |
5 | 23 | ## Prerequisites |
6 | 24 |
|
7 | 25 | ### Gnosis beacon and execution clients |
@@ -77,20 +95,12 @@ git checkout gnosis/2024.11.1 |
77 | 95 |
|
78 | 96 | The default value points to a pushgateway operated by the Shutter Network team. To gain access please ask for credentials in the Shutter Network Discourse forum. |
79 | 97 | - Logs collection (optional): |
80 | | - - To push logs to loki/vmlogs server: |
81 | | - - Define the url for the server to push logs to, with `LOKI_URL`. The default value points to the logging server operated by the Shutter Network Team. To gain access please ask for credentials in the Shutter Network Discourse forum. |
82 | | - - Use the `docker-compose.loki.yml` file, which overrides logging, as shown under the running and update sections. |
| 98 | + - To push logs to loki/vmlogs server: |
| 99 | + - Define the url for the server to push logs to, with `LOKI_URL`. The default value points to the logging server operated by the Shutter Network Team. To gain access please ask for credentials in the Shutter Network Discourse forum. |
| 100 | + - Use the `docker-compose.loki.yml` file, which overrides logging, as shown under the running and update sections. |
83 | 101 |
|
84 | 102 | > *) **NOTE**: The `example-mainnet.env` file is a template for Gnosis mainnet deployment. If you want to deploy a Keyper for the Chiado testnet instead, use the `example-chiado.env` file. |
85 | 103 |
|
86 | | -## Running |
87 | | - |
88 | | -You start your Keyper node by running |
89 | | - |
90 | | -``` |
91 | | -docker compose up -d |
92 | | -``` |
93 | | - |
94 | 104 | ## Setting Up Logging |
95 | 105 |
|
96 | 106 | To enable log pushing to a Loki/VmLogs server, follow these steps: |
@@ -119,6 +129,20 @@ For more details, refer to the [Docker driver client | Grafana Loki documentatio |
119 | 129 |
|
120 | 130 | > **IMPORTANT:** If logging is enabled, make sure to use the correct `docker compose` commands as noted below. |
121 | 131 |
|
| 132 | +## Running the Keyper Node |
| 133 | + |
| 134 | +### **Without Pushing Logs** |
| 135 | +To start the Keyper node run: |
| 136 | +```sh |
| 137 | +docker compose up -d |
| 138 | +``` |
| 139 | + |
| 140 | +### **With Log Pushing Enabled** |
| 141 | +> **IMPORTANT:** Logging requires additional configuration steps. Follow the [Logging Setup](#setting-up-logging) section before running the following command: |
| 142 | +```sh |
| 143 | +docker compose -f docker-compose.yml -f docker-compose.loki.yml up -d |
| 144 | +``` |
| 145 | + |
122 | 146 | ## Backups |
123 | 147 |
|
124 | 148 | Once your Keyper is up and running, you should regularly back up the following: |
|
0 commit comments