2020-05-04 17:20:36 +02:00
---
layout: default
parent: For developers
title: Installation
nav_order: 1
---
2021-06-09 16:07:42 +01:00
# Installation
2020-05-04 17:20:36 +02:00
2019-12-13 17:56:19 +01:00
The application uses [Pipenv][pipenv] to manage Python packages.
2020-06-12 20:58:37 +02:00
While in development, you will need to install all dependencies:
2022-01-14 09:36:18 +00:00
```sh
git clone https://github.com/lnbits/lnbits-legend.git
cd lnbits-legend/
pipenv shell
# pipenv --python 3.8 shell (if you wish to use a version of Python higher than 3.7)
pipenv install --dev
# pipenv --python 3.8 install --dev (if you wish to use a version of Python higher than 3.7)
2022-01-14 09:38:04 +00:00
# If any of the modules fails to install, try checking and upgrading your setupTool module
# pip install -U setuptools
2022-01-14 09:37:27 +00:00
```
2021-01-02 22:55:52 +01:00
2020-10-02 14:53:55 -03:00
You will need to copy `.env.example` to `.env` , then set variables there.
2019-12-13 17:56:19 +01:00
2020-06-12 20:58:37 +02:00
2019-12-13 17:56:19 +01:00
2020-09-03 19:53:22 +02:00
You might also need to install additional packages, depending on the [backend wallet ](../guide/wallets.md ) you use.
2020-10-13 10:31:53 +02:00
E.g. when you want to use LND you have to `pipenv run pip install lndgrpc` and `pipenv run pip install purerpc` .
2020-06-12 20:58:37 +02:00
2020-09-03 19:53:22 +02:00
Take a look at [Polar][polar] for an excellent way of spinning up a Lightning Network dev environment.
2020-05-04 17:20:36 +02:00
2021-06-09 16:07:42 +01:00
## Running the server
2019-12-13 17:56:19 +01:00
2021-11-09 22:45:45 +00:00
LNbits uses [FastAPI][fastapi] as an application server.
Before running the server for the first time, make sure to create the data folder and edit the .env file:
2021-06-20 06:30:32 +02:00
2021-11-09 22:41:24 +00:00
mkdir data
2021-11-09 22:45:45 +00:00
cp .env.example .env
sudo nano .env
2021-06-20 06:30:32 +02:00
To then run the server, use:
2020-06-12 20:58:37 +02:00
2021-11-09 22:44:11 +00:00
pipenv run python -m uvicorn lnbits.__main__:app --reload
2019-12-13 17:56:19 +01:00
2022-01-14 10:10:52 +00:00
**Note**: We reccomend using < a href = "https://caddyserver.com/docs/install #debian -ubuntu-raspbian" > Caddy</ a > for a reverse-proxy, if you want to serve your install through a domain, alternatively you can use [ngrok ](https://ngrok.com/ ).
