https://github.com/lnbits/ngrok

https://github.com/lnbits/ngrok

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/lnbits/ngrok
• Owner: lnbits
• Created: 2023-02-16T17:21:04.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-02-17T09:06:49.000Z (almost 2 years ago)
• Last Synced: 2024-08-03T06:05:00.700Z (4 months ago)
• Language: Python
• Size: 3.91 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-lnbits - Ngrok - Get a clearnet Ngrok url for your LNbits (Uncategorized / Uncategorized)

README

        
Ngrok

Serve lnbits over https for free using ngrok




How it works


When enabled, ngrok creates a tunnel to ngrok.io with https support and tells you the https web address where you can access your lnbits instance. If you are not the first user to enable it, it doesn't create a new one, it just tells you the existing one. Useful for creating/managing/using lnurls, which must be served either via https or via tor. Note that if you restart your device, your device will generate a new url. If anyone is using your old one for wallets, lnurls, etc., whatever they are doing will stop working.

Installation


Check the Extensions page on your instance of lnbits. If you have copy of lnbits with ngrok as one of the built in extensions, click Enable -- that's the only thing you need to do to install it.

If your copy of lnbits does not have ngrok as one of the built in extensions, stop lnbits, create go into your lnbits folder, and run this command: ./venv/bin/pip install pyngrok. Then go into the lnbits subdirectory and the extensions subdirectory within that. (So lnbits > lnbits > extensions.) Create a new subdirectory in there called freetunnel, download this repository as a zip file, and unzip it in the freetunnel directory. If your unzipper creates a new "freetunnel" subdirectory, take everything out of there and put it in the freetunnel directory you created. Then go back to the top level lnbits directory and run these commands:

```

./venv/bin/quart assets

./venv/bin/quart migrate

./venv/bin/hypercorn -k trio --bind 0.0.0.0:5000 'lnbits.app:create_app()'

```

Optional: set up an ngrok.com account


The default setup makes a tunnel on a random subdomain, and the session times out after 24h or a certain bandwith limit. You can set up an account at ngrok.com; a free plan removes the timeout, and a paid plan lets you choose a custom subdomain (or even use your own domain). For this, get an auth token from ngrok.com, and then set it up as `NGROK_AUTHTOKEN` environment variable on your `.env` file e.g., if your auth token is xxxx, add a line NGROK_AUTHTOKEN=xxxx.