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
* experiment: verify in channel (#215)
* Change volume mapping so .config folder is created inside node folder and not on root (#214)
* Update main.go to fix Q logo (#213)
Q logo is not appearing correctly on the terminal while running node. Added a new line character after "Signature check passed" to fix it
* switched get node info response to use masterClock frame for maxFrame field (#212)
* fix: keys file remains null (#217)
* Revert "Change volume mapping so .config folder is created inside node folder…" (#218)
This reverts commit 27f50a9.
* Docker split take 2 (#219)
* split runtime docker files into a docker subfolder
* split DOCKER-README.md
* updated docker instructions
* add restore command
* add image update related tasks
* add command to test if P2P port is visible
* Remove bootstrap peer (#189)
* Change bootstrap servers to DHT-only peers (#187)
* support voucher file-based claims (#183)
* Change bootstrap servers to DHT-only peers
Changing my bootstrap servers to DHT-only peers with somewhat lower
specs. One of the new ones is in the US and the other one is in
Switzerland. Both use reliable providers and have 10Gbps network
interfaces.
---------
Co-authored-by: Cassandra Heart <7929478+CassOnMars@users.noreply.github.com>
* Don't run self-test in DHT-only mode (#186)
* support voucher file-based claims (#183)
* Don't run self-test in DHT-only mode
The node tries to create a self-test when ran with the `-dht-only`
flag, but it doesn't load the KZG ceremony data in DHT-only mode
which leads to a crash.
Don't run self-test when the `-dht-only` flag is set.
I tested by starting a node locally with and without existing
self-test and with the `-dht-only` flag.
---------
Co-authored-by: Cassandra Heart <7929478+CassOnMars@users.noreply.github.com>
* Embed json files in binary (#182)
* Embed ceremony.json in binary
* Embed retroactive_peers.json in binary
* Signers build and verification tasks (#181)
* add signers specific Taskfile
* add verify tasks
* move signer task under signer folder
* create docker image specific for signers
* map current user into docker image and container
* ignore node-tmp-*
* add verify:build:internal
* prevent tasks with docker commands from being run inside a container
* rename *:internal to *:container
* add README.md
* add pem files to git
* Updating Q Guide link (#173)
* Update README.md
Updated link to Quilibrium guide to new website
* Update README.md
---------
Co-authored-by: littleblackcloud <163544315+littleblackcloud@users.noreply.github.com>
Co-authored-by: Agost Biro <5764438+agostbiro@users.noreply.github.com>
Co-authored-by: Cassandra Heart <7929478+CassOnMars@users.noreply.github.com>
Co-authored-by: Demipoet <161999657+demipoet@users.noreply.github.com>
* Signer related fixes (#220)
* add pems 16 and 17
* remove .bin extension from generated binaries
* no more json files to copy to docker image
* feat: recalibrate self-test on the fly (#221)
* fix: switch RPC for peer and node info (#222)
* replace binaries with patch build
* add digests
* Signatory #13 added
* Signatory #4 added (#223)
* Signatory #14 added
* Signatory #17 added
* Signatory #12 added
* Signatory #3 added
* Signatory #2 added
* Signatory #16 added
* Signatory #1 added
* Signatory #8 added
* remove binaries, release ready
---------
Co-authored-by: AvAcalho <158583728+AvAcalho@users.noreply.github.com>
Co-authored-by: Ravish Ahmad <ravishahmad16@gmail.com>
Co-authored-by: luk <luk@luktech.dev>
Co-authored-by: Marius Scurtescu <marius.scurtescu@gmail.com>
Co-authored-by: littleblackcloud <163544315+littleblackcloud@users.noreply.github.com>
Co-authored-by: Agost Biro <5764438+agostbiro@users.noreply.github.com>
Co-authored-by: Demipoet <161999657+demipoet@users.noreply.github.com>
Co-authored-by: 0xOzgur <29779769+0xOzgur@users.noreply.github.com>
> You can use the `task build` command instead. See the [Task](#task) section below.
14
+
Use latest version instead of `1.4.16`.
59
15
60
-
The image that is built is light and safe. It is based on Alpine Linux with the Quilibrium node binary, not the
16
+
The image that is built is light and safe. It is based on Alpine Linux with the Quilibrium node binary, no
61
17
source code, nor the Go development environment. The image also has the `grpcurl` tool that can be used to
62
18
query the gRPC interface.
63
19
64
20
### Task
65
21
66
-
You can also use the [Task](https://taskfile.dev/) tool, it a simple build tool that takes care of extracting
67
-
parameters, building the image and running the container. The tasks are all defined in [Taskfile.yaml](Taskfile.yaml).
22
+
You can also use the [Task](https://taskfile.dev/) tool, it is a simple build tool that takes care of extracting
23
+
parametersand building the image. The tasks are all defined in [Taskfile.yaml](Taskfile.yaml).
68
24
69
25
You can optionally create an `.env` file, in the same repository root folder to override specific parameters. Right now
70
26
only one optional env var is supported and that is `QUILIBRIUM_IMAGE_NAME`, if you want to change the default
71
-
image name from `quilibrium` to something else. If you are pushing your images to Github then you have to follow the
72
-
Github naming convention and use a name like `ghcr.io/mscurtescu/ceremonyclient`.
27
+
image name from `quilibrium` to something else. If you are pushing your images to GitHub then you have to follow the
28
+
GitHub naming convention and use a name like `ghcr.io/mscurtescu/ceremonyclient`.
73
29
74
-
Bellow there are example interaction with `Task`.
30
+
Bellow there are example interactions with `Task`.
75
31
76
32
The node version is extracted from [node/main.go](node/main.go). This version string is used to tag the image. The git
77
-
repo, branch and commit are read throught the `git` command and depend on the current state of your working
78
-
directory (one what branch and at what commit you are). These last three values are used to label the image.
33
+
repo, branch and commit are read through the `git` command and depend on the current state of your working
34
+
directory (on what branch and at what commit you are). These last three values are used to label the image.
79
35
80
36
List tasks:
81
37
```shell
@@ -94,134 +50,4 @@ task build
94
50
95
51
## Run
96
52
97
-
You can run Quilibrium on the same machine where you built the image, from the same repository root
98
-
folder where [docker-compose.yml](docker-compose.yml) is.
99
-
100
-
You can also copy `docker-compose.yml` to a new folder on a server and run it there. In this case you
101
-
have to have a way to push your image to a Docker image repo and then pull that image on the server.
102
-
Github offers such an image repo and a way to push and pull images using special authentication
103
-
tokens. See
104
-
[Working with the Container registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry).
105
-
106
-
Run Quilibrium in a container:
107
-
```shell
108
-
docker compose up -d
109
-
```
110
-
111
-
> [!TIP]
112
-
> You can alternatively use the `task up` command. See the [Task](#task-1) section above.
113
-
114
-
A `.config/` subfolder will be created under the current folder, this is mapped inside the container.
115
-
Make sure you backup `config.yml` and `keys.yml`.
116
-
117
-
### Task
118
-
119
-
Similarly to building the image you can also use `Task`.
120
-
121
-
Start the container through docker compose:
122
-
```shell
123
-
task up
124
-
```
125
-
126
-
Show the logs through docker compose:
127
-
```shell
128
-
task logs
129
-
```
130
-
131
-
Drop into a shell inside the running container:
132
-
```shell
133
-
task shell
134
-
```
135
-
136
-
Stop the running container(s):
137
-
```shell
138
-
task down
139
-
```
140
-
141
-
Backup the critical configuration:
142
-
```shell
143
-
task backup
144
-
```
145
-
146
-
The above command will create a `backup.tar.gz` archive in the current folder, you still have to copy this
147
-
file from the server into a safe location. The command adds the `config.yml` and `keys.yml` files from
148
-
the `.config/` subfolder to the archive, with the ownership of the current user.
149
-
150
-
### Resource management
151
-
To ensure that your client performs optimally within a specific resource configuration, you can specify
152
-
resource limits and reservations in the node configuration as illustrated below.
153
-
154
-
This configuration helps in deploying the client with controlled resource usage, such as CPU and memory,
155
-
to avoid overconsumption of resources in your environment.
156
-
157
-
The [docker-compose.yml](docker-compose.yml) file already specifies resources following the currently
158
-
recommended hardware requirements.
159
-
160
-
```yaml
161
-
services:
162
-
node:
163
-
# Some other configuration sections here
164
-
deploy:
165
-
resources:
166
-
limits:
167
-
cpus: '4'# Maximum CPU count that the container can use
168
-
memory: '16G'# Maximum memory that the container can use
169
-
reservations:
170
-
cpus: '2'# CPU count that the container initially requests
171
-
memory: '8G'# Memory that the container initially request
172
-
```
173
-
174
-
175
-
### Customizing docker-compose.yml
176
-
177
-
If you want to change certain parameters in [docker-compose.yml](docker-compose.yml) it is better not
178
-
to edit the file directly as new versions pushed through git would overwrite your changes. A more
179
-
flexible solution is to create another file called `docker-compose.override.yml` right next to it
180
-
and specifying the necessary overriding changes there.
181
-
182
-
For example:
183
-
```yaml
184
-
services:
185
-
node:
186
-
image: ghcr.io/mscurtescu/ceremonyclient
187
-
restart: on-failure:7
188
-
```
189
-
190
-
The above will override the image name and also the restart policy.
191
-
192
-
To check if your overrides are being picked up run the following command:
193
-
```shell
194
-
docker compose config
195
-
```
196
-
197
-
This will output the merged and canonical compose file that will be used to run the container(s).
198
-
199
-
200
-
## Interact with a running container
201
-
202
-
Drop into a shell inside a running container:
203
-
```shell
204
-
docker compose exec -it node sh
205
-
```
206
-
207
-
Watch the logs:
208
-
```shell
209
-
docker compose logs -f
210
-
```
211
-
212
-
Get the node related info (peer id, version, max frame and balance):
213
-
```shell
214
-
docker compose exec node node -node-info
215
-
```
216
-
217
-
Run the DB console:
218
-
```shell
219
-
docker compose exec node node -db-console
220
-
```
221
-
222
-
Run the Quilibrium client:
223
-
```shell
224
-
docker compose exec node qclient help
225
-
docker compose exec node qclient token help
226
-
docker compose exec node qclient token balance
227
-
```
53
+
In order to run a Quilibrium node using the docker image follow the instructions in the [docker](docker) subfolder.
0 commit comments