diff --git a/my-electrs-repo/Dockerfile b/Dockerfile-electrs similarity index 91% rename from my-electrs-repo/Dockerfile rename to Dockerfile-electrs index 4e344aa..0d84d1e 100644 --- a/my-electrs-repo/Dockerfile +++ b/Dockerfile-electrs @@ -10,6 +10,7 @@ RUN apt install -y \ cargo RUN git clone https://github.com/romanz/electrs +RUN git checkout v0.9.10 WORKDIR electrs RUN ls -la RUN cargo build --locked --release diff --git a/README.md b/README.md index fbe6248..a027ec8 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,14 @@ First, clone this repo where you would like to run your node. ### Building electrs -TODO: explain +Since there is no good `electrs` docker image out there, we roll our own one +for this project. The file is `Dockerfile-electrs`. To build the image, run the +following command: + +```bash +docker build -t my-electrs:latest -f Dockerfile-electrs . +``` + ### Environment and configuration files @@ -43,12 +50,24 @@ not make any changes if you are following these instructions. Inside `data/lnbits`, you will need to place a `.env` file. Pay attention: this file is specific for LNbits and is unrelated to the other `.env` file that sits -on the root of this repo. TODO: make template in +on the root of this repo. The best place to get an example is [the official +LNbits repository](https://github.com/lnbits/lnbits). -### Smoke testing +### Running and Smoke testing -TODO: describe how to check that everything is warning. +To run, execute a simple `docker compose up -d`. + +Once you get everything running, here is how you can check on the health of the +different services: + +- All: check if the containers are running. +- Bitcoin: check the logs. You should see Bitcoin updating its tip with as new + blocks are found. +- Electrs: connect from Sparrow or another wallet. +- Mempool: visit the page. +- LNbits: visit the page, perhaps make a small transaction if you want to be + dead sure everything is up and running. ## Upgrading versions of the different services