ceremonyclient/docker/README.md
Cassandra Heart 13bac91367
v1.4.18-patch-1 (#216)
* 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 27f50a92c6f5e340fd4106da828c6e8cdc12116b.

* 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>
2024-05-27 00:10:15 -05:00

5.0 KiB

Quilibrium Docker Instructions

Install Docker on a Server

Important

You have to install Docker Engine on your server, you don't want to install Docker Desktop.

The official Linux installation instructions start here:
https://docs.docker.com/engine/install/

For Ubuntu you can start here:
https://docs.docker.com/engine/install/ubuntu/

While there are several installation methods, you really want to use the apt repository, this way you get automatic updates.

Make sure you also follow the Linux post-installation steps:
https://docs.docker.com/engine/install/linux-postinstall/

Install Docker on a Desktop

For a Linux desktop follow the server installation steps above, do not install Docker Desktop for Linux unless you know what you are doing.

For Mac and Windows follow the corresponding Docker Desktop installation links from the top of:
https://docs.docker.com/engine/install/

Running a Node

Copy docker-compose.yml to a new folder on a server. The official Docker image provided by Quilibrium Network will be pulled.

A .config/ subfolder will be created in this folder, this will hold both configuration and the node storage.

Optionally you can also copy Taskfile.yaml and .env.example to the server, if you are planning to use them. See below.

New Instance

If you are starting a brand new node then simply run Quilibrium in a container with:

docker compose up -d

A .config/ subfolder will be created under the current folder, this is mapped inside the container.

Important

Once the node is running (the -node-info command shows a balance) make sure you backup config.yml and keys.yml.

Restore Previous Instance

If you have both config.yml and keys.yml backed up from a previous instance then follow these steps to restore them:

  1. Create an empty .config/ subfolder.
  2. Copy config.yml and keys.yml to .config/.
  3. Start the node with:
    docker compose up -d
    

Task

You can also use the Task tool, it is a simple build tool that takes care of running complex commands and intereacting with the container. The tasks are all defined in Taskfile.yaml.

You can optionally create an .env file, in the same folder to override specific parameters. Right now only one optional env var is supported with Task and that is QUILIBRIUM_IMAGE_NAME, if you want to change the default image name from quilibrium to something else. If you are pushing your images to GitHub, for example, then you have to follow the GitHub naming convention and use a name like ghcr.io/mscurtescu/ceremonyclient. See the .env.example sample file, and keep in mind that .env is shared with docker-compose.yml.

Bellow there are example interactions with Task.

Start the container through docker compose:

task up

Show the logs through docker compose:

task logs

Drop into a shell inside the running container:

task shell

Stop the running container(s):

task down

Backup the critical configuration:

task backup

The above command will create a backup.tar.gz archive in the current folder, you still have to copy this file from the server into a safe location. The command adds the config.yml and keys.yml files from the .config/ subfolder to the archive, with the ownership of the current user.

Customizing docker-compose.yml

If you want to change certain parameters in docker-compose.yml it is better not to edit the file directly as new versions pushed through git would overwrite your changes. A more flexible solution is to create another file called docker-compose.override.yml right next to it and specifying the necessary overriding changes there.

For example:

services:
  node:
    image: ghcr.io/mscurtescu/ceremonyclient
    restart: on-failure:7

The above will override the image name and also the restart policy.

You can optionally create an .env file, in the same folder to override specific parameters. See the .env.example sample file, and keep in mind that .env is shared with Taskfile.yaml. You can customize the image name and port mappings.

To check if your overrides are being picked up run the following command:

docker compose config

This will output the merged and canonical compose file that will be used to run the container(s).

Interact with a running container

Drop into a shell inside a running container:

docker compose exec -it node sh

Watch the logs:

docker compose logs -f

Get the node related info (peer id, version, max frame and balance):

docker compose exec node node -node-info

Run the DB console:

docker compose exec node node -db-console

Run the Quilibrium client:

docker compose exec node qclient help
docker compose exec node qclient token help
docker compose exec node qclient token balance