Documentation Updates (#202)
Updates for user manager and subdomains extensions Co-authored-by: Tiago Vasconcelos <tvasconcelos@gmail.com>
This commit is contained in:
parent
a1e12fcd0e
commit
2e8145faac
4 changed files with 86 additions and 62 deletions
|
|
@ -5,15 +5,11 @@ title: Installation
|
|||
nav_order: 1
|
||||
---
|
||||
|
||||
|
||||
Installation
|
||||
============
|
||||
# Installation
|
||||
|
||||
Download the latest stable release https://github.com/lnbits/lnbits/releases
|
||||
|
||||
|
||||
Application dependencies
|
||||
------------------------
|
||||
## Application dependencies
|
||||
|
||||
The application uses [Pipenv][pipenv] to manage Python packages.
|
||||
While in development, you will need to install all dependencies:
|
||||
|
|
@ -24,7 +20,7 @@ $ pipenv install --dev
|
|||
```
|
||||
|
||||
If any of the modules fails to install, try checking and upgrading your setupTool module.
|
||||
`pip install -U setuptools`
|
||||
`pip install -U setuptools`
|
||||
|
||||
If you wish to use a version of Python higher than 3.7:
|
||||
|
||||
|
|
@ -41,9 +37,7 @@ E.g. when you want to use LND you have to `pipenv run pip install lndgrpc` and `
|
|||
|
||||
Take a look at [Polar][polar] for an excellent way of spinning up a Lightning Network dev environment.
|
||||
|
||||
|
||||
Running the server
|
||||
------------------
|
||||
## Running the server
|
||||
|
||||
LNbits uses [Quart][quart] as an application server.
|
||||
|
||||
|
|
@ -51,12 +45,18 @@ LNbits uses [Quart][quart] as an application server.
|
|||
$ pipenv run python -m lnbits
|
||||
```
|
||||
|
||||
Frontend
|
||||
--------
|
||||
**Note**: You'll need to use _https_ for some endpoints and/or extensions. You can use [ngrok](https://ngrok.com/) for that. Follow the installation instructions on the website and when it's all set you can run:
|
||||
|
||||
```sh
|
||||
$ ./nrok http 5000
|
||||
```
|
||||
|
||||
this will give you an _https_ tunnel for the _localhost_, use that URL for navigating to LNBits.
|
||||
|
||||
## Frontend
|
||||
|
||||
The frontend uses [Vue.js and Quasar][quasar].
|
||||
|
||||
|
||||
[quart]: https://pgjones.gitlab.io/
|
||||
[pipenv]: https://pipenv.pypa.io/
|
||||
[polar]: https://lightningpolar.com/
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue