heierbtc/lnbits
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added umbrel/tor guide

Browse Source
This commit is contained in:
Ben Arc 2021-07-07 10:58:21 +01:00
parent ad64972ddf
commit b02952d99d
1 changed files with 15 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
docs/guide/installation.md
View File

@ -4,9 +4,7 @@ title: Basic installation
nav_order: 2 nav_order: 2
--- ---
# Basic installation
Basic installation
==================
Download this repo and install the dependencies: Download this repo and install the dependencies:
@ -31,10 +29,16 @@ Then you can 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. 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 # Additional guides
===================
### LNbits running on Umbrel behind Tor
If you want to run LNbits on your Umbrel but want it to be reached through clearnet, _Uxellodunum_ made an extensive [guide](https://community.getumbrel.com/t/guide-lnbits-without-tor/604) on how to do it.
### Docker installation
To install using docker you first need to build the docker image as: To install using docker you first need to build the docker image as:
``` ```
git clone https://github.com/lnbits/lnbits.git git clone https://github.com/lnbits/lnbits.git
cd lnbits/ # ${PWD} referred as <lnbits_repo> cd lnbits/ # ${PWD} referred as <lnbits_repo>
@ -42,27 +46,30 @@ docker build -t lnbits .
``` ```
You can launch the docker in a different directory, but make sure to copy `.env.example` from lnbits there You can launch the docker in a different directory, but make sure to copy `.env.example` from lnbits there
``` ```
cp <lnbits_repo>/.env.example .env cp <lnbits_repo>/.env.example .env
``` ```
and change the configuration in `.env` as required. 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. Then create the data directory for the user ID 1000, which is the user that runs the lnbits within the docker container.
``` ```
mkdir data mkdir data
sudo chown 1000:1000 ./data/ sudo chown 1000:1000 ./data/
``` ```
Then the image can be run as: 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 docker run --detach --publish 5000:5000 --name lnbits --volume ${PWD}/.env:/app/.env --volume ${PWD}/data/:/app/data lnbits
``` ```
Finally you can access your lnbits on your machine at port 5000. Finally you can access your lnbits on your machine at port 5000.
Additional guides # Additional guides
===================
## LNbits running on Umbrel behind Tor ## LNbits running on Umbrel behind Tor
If you want to run LNbits on your Umbrel but want it to be reached through clearnet, _Uxellodunum_ made an extensive [guide](https://community.getumbrel.com/t/guide-lnbits-without-tor/604) on how to do it. If you want to run LNbits on your Umbrel but want it to be reached through clearnet, _Uxellodunum_ made an extensive [guide](https://community.getumbrel.com/t/guide-lnbits-without-tor/604) on how to do it.