add .dockerignore and docker instructions (#56)

* add .dockerignore

* add docker specific readme

* update restart policy to unless-stopped
This commit is contained in:
Marius Scurtescu 2024-02-20 15:13:43 -08:00 committed by GitHub
parent 9fc46fff2f
commit 27aa02383c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 57 additions and 1 deletions

6
.dockerignore Normal file
View File

@ -0,0 +1,6 @@
.config
**/.idea
**/.vscode
github.env
Taskfile.yaml

50
DOCKER-README.md Normal file
View File

@ -0,0 +1,50 @@
# Quilibrium Docker Instructions
## Build
Build the docker image:
```shell
docker build -t quilibrium -t quilibrium:1.2.9 .
```
Use latest version instead of `1.2.9`.
## Run
Run Quilibrium in a container:
```shell
docker compose up -d
```
A `.config/` subfolder will be created under the current folder, this is mapped inside the container.
Make sure you backup `config.ym` and `keys.yml`.
## Intereact with a running cotainer
Drop into a shell inside a running container:
```shell
docker compose exec -it node sh
```
Watch the logs:
```shell
docker compose logs
```
Get the Peer ID:
```shell
docker compose exec node go run ./... -peer-id
```
Get the token ballance:
```shell
docker compose exec node go run ./... -balance
```
Run the DB console:
```shell
docker compose exec node go run ./... -db-console
```

View File

@ -6,7 +6,7 @@ services:
node:
build: ./
image: quilibrium
restart: always
restart: unless-stopped
environment:
- DEFAULT_LISTEN_GRPC_MULTIADDR=/ip4/0.0.0.0/tcp/8337
- DEFAULT_LISTEN_REST_MULTIADDR=/ip4/0.0.0.0/tcp/8338