Update docker install readme

This commit is contained in:
Chloe Jung 2023-02-03 15:17:37 +13:00
parent 3c84738750
commit 9f601f59db

View file

@ -4,11 +4,8 @@
- [Docker engine download & - [Docker engine download &
install](https://docs.docker.com/engine/install/) install](https://docs.docker.com/engine/install/)
- [Docker compose download &
install](https://docs.docker.com/compose/install/)
### Set up the boltcard server ### Set up the boltcard server
- Run `chmod +x docker_init.sh`
- Run `./docker_init.sh` to set up the initial data - Run `./docker_init.sh` to set up the initial data
- Put the `tls.cert` file and `admin.macaroon` files in the project root directory - Put the `tls.cert` file and `admin.macaroon` files in the project root directory
@ -21,20 +18,32 @@ set up the server hosting firewall to allow open access to https (port 443) only
### service bring-up and running ### service bring-up and running
``` ```
$ sudo groupadd docker
$ sudo usermod -aG docker ${USER}
(log out & in again)
$ docker volume create caddy_data $ docker volume create caddy_data
// add -d for detached mode // add -d option for detached mode
$ docker-compose up -d $ docker compose up
``` ```
### stop docker ### stop docker
``` ```
$ docker-compose down $ docker compose down
``` ```
To delete the database and reset the docker volume, run `docker-compose down --volumes` To delete the database and reset the docker volume, run `docker-compose down --volumes`
*NOTE: caddy_data volume won't be removed even if you run `docker-compose down --volumes` because it's an external volume.* *NOTE: caddy_data volume won't be removed even if you run `docker-compose down --volumes` because it's an external volume.*
### check container logs
- [Docker Logs](https://docs.docker.com/engine/reference/commandline/logs/)
```
$ docker logs [OPTIONS] CONTAINER
```
Run `$ docker ps` to list containers and get container names/ids
#### running create bolt card command #### running create bolt card command
- `docker exec boltcard_main createboltcard/createboltcard` to see options - `docker exec boltcard_main createboltcard/createboltcard` to see options
- `docker exec boltcard_main createboltcard/createboltcard -enable -tx_max=1000 -day_max=10000 -name=card_1` for example - `docker exec boltcard_main createboltcard/createboltcard -enable -allow_neg_bal -tx_max=1000 -day_max=10000 -name=card_1` for example
- this will give you a one-time link in text and QR code form - this will give you a one-time link in text and QR code form