From 558f3acfcb41814d0484138adfe3f55a18565703 Mon Sep 17 00:00:00 2001 From: TS Date: Fri, 19 Mar 2021 12:27:41 +0100 Subject: [PATCH] changes configuration of environment for Dockerfile and adds the installation procedure to the documentation --- .env.example | 2 +- docs/guide/installation.md | 29 +++++++++++++++++++++++++++++ 2 files changed, 30 insertions(+), 1 deletion(-) diff --git a/.env.example b/.env.example index 1c6a446fa..cc70644c1 100644 --- a/.env.example +++ b/.env.example @@ -8,7 +8,7 @@ PORT=5000 LNBITS_SITE_TITLE=LNbits LNBITS_ALLOWED_USERS="" LNBITS_DEFAULT_WALLET_NAME="LNbits wallet" -LNBITS_DATA_FOLDER="." +LNBITS_DATA_FOLDER="./data" LNBITS_DISABLED_EXTENSIONS="amilk" LNBITS_FORCE_HTTPS=true LNBITS_SERVICE_FEE="0.0" diff --git a/docs/guide/installation.md b/docs/guide/installation.md index eabef16e9..2f580d8ee 100644 --- a/docs/guide/installation.md +++ b/docs/guide/installation.md @@ -17,6 +17,7 @@ cd lnbits/ python3 -m venv venv ./venv/bin/pip install -r requirements.txt cp .env.example .env +mkdir data ./venv/bin/quart assets ./venv/bin/quart migrate ./venv/bin/hypercorn -k trio --bind 0.0.0.0:5000 'lnbits.app:create_app()' @@ -29,3 +30,31 @@ Now modify the `.env` file with any settings you prefer and add a proper [fundin Then you can run restart it and it will be using the new settings. You might also need to install additional packages or perform additional setup steps, depending on the chosen backend. See [the short guide](./wallets.md) on each different funding source. + +Docker installation +=================== + +To install using docker you first need to build the docker image as: +``` +git clone https://github.com/lnbits/lnbits.git +cd lnbits/ # ${PWD} refered as +docker build -t lnbits . +``` + +You can launch the docker in a different directory, but make sure to copy `.env.example` from lnbits there +``` +cp /.env.example .env +``` +and change the configuration in `.env` as required. + +Then create the data directory for the user ID 1000, which is the user that runs the lnbits within the docker container. +``` +mkdir data +sudo chown 1000:1000 ./data/ +``` + +Then the image can be run as: +``` +docker run --detach --publish 5000:5000 --name lnbits --volume ${PWD}/.env:/app/.env --volume ${PWD}/data/:/app/data lnbits +`` +Finally you can access the lnbits on your machine port 5000.