From b53db465c0e7236c819605a48dfa1d4d695131ae Mon Sep 17 00:00:00 2001 From: supertestnet <58400631+supertestnet@users.noreply.github.com> Date: Sat, 3 Jul 2021 09:06:40 -0400 Subject: [PATCH] Update README.md --- lnbits/extensions/ngrok/README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/lnbits/extensions/ngrok/README.md b/lnbits/extensions/ngrok/README.md index 73f9b631..0d085cfb 100644 --- a/lnbits/extensions/ngrok/README.md +++ b/lnbits/extensions/ngrok/README.md @@ -1,17 +1,17 @@ -

Free Tunnel

+

Ngrok

Serve lnbits over https for free using ngrok

How it works

-When enabled, Free Tunnel creates a tunnel to ngrok 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. +When enabled, ngrok creates a tunnel to ngrok 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 Free Tunnel as one of the built in extensions, click Enable -- that's the only thing you need to do to install it. +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 Free Tunnel 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: +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