pyngrok is a Python wrapper for ngrok

Not sure if this is a pyngrok issue or not, but it's something I'm running into and wanted to bring it to your attention. Feel free to close if it's a Python or ngrok binary issue, or if it's too much of a niche problem. It's more of just an OS housekeeping issue than a functional problem.

Describe the Bug I have a long running application that always keeps an ngrok tunnel open using pyngrok. The tunnel occasionally drops and my application will automatically start a new one. Sometimes the ngrok process itself fails to respond, so the process is killed and then relaunched automatically with the next connect(). Over time, zombie ngrok processes accumulate (on linux) and remain in the process tree until the Python application (the parent process) is terminated or restarted.

Steps to Reproduce I run a timer thread to check for connection every few minutes and restart the tunnel when necessary, but it can probably also be simulated with a loop and delay. ngrok.connect() kill ngrok process externally with linux kill statement (simulating a crash of the ngrok binary) ngrok.disconnect() will result in a ngrok.exception.PyngrokNgrokURLError ngrok.get_tunnels() will result in a ngrok.exception.PyngrokNgrokURLError ngrok.kill() leaves defunct zombie process ngrok.connect() starts new ngrok process

Restarting the Python program clears out all of the zombie ngrok processes (as it should).

Expected Behavior Defunct ngrok processes should be removed by the calling process (Python?) at the time the child process exits.

Environment

• OS: Linux Raspbian on ARM
• Python Version: 3.5
• pyngrok Version: 4.1.5

Additional Context I'm not sure why the ngrok process randomly stops responding, but it happens at least every few days. Also, this is running on a Raspberry Pi

Describe the Bug Traceback (most recent call last): File "HiddenEye.py", line 49, in <module> server_menu.server_selection(port) File "/home/ghost/Desktop/88888/HiddenEye-dev/Defs/ActionManager/Server/server_menu.py", line 47, in server_selection server_runner.start_ngrok(port) # FIXED File "/home/ghost/Desktop/88888/HiddenEye-dev/Defs/ActionManager/Server/server_runner.py", line 88, in start_ngrok ngrok.connect(port) File "/usr/local/lib/python3.8/dist-packages/pyngrok/ngrok.py", line 183, in connect api_url = get_ngrok_process(ngrok_path, config_path, auth_token, region).api_url File "/usr/local/lib/python3.8/dist-packages/pyngrok/ngrok.py", line 135, in get_ngrok_process return process.get_process(ngrok_path, config_path, auth_token, region) File "/usr/local/lib/python3.8/dist-packages/pyngrok/process.py", line 147, in get_process return _start_process(ngrok_path, config_path, auth_token, region) File "/usr/local/lib/python3.8/dist-packages/pyngrok/process.py", line 270, in _start_process raise PyngrokNgrokError("The ngrok process errored on start.", ngrok_process.startup_logs, pyngrok.exception.PyngrokNgrokError: The ngrok process errored on start.

Environment

• Tested on:

1. Parrot Linux
2. Arch Linux Server

• pyngrok Version: 2.1.5

Additional Context Maybe i did something wrong with HiddenEye, but i can't solve this problem on my own. Tried everything i can, should be working. Works great on my own machine but some of users have this error.

Describe the Bug Hey Alex,

I'm looking to build a flask server /w Ngrok and using Pyngrok. I have an issue that is probably very easy but can't seem to figure it. It's throwing out an error for me when I'm trying to build a tunnel. I've configured my yml file with my api key. Simply:

from pyngrok import ngrok
public_url = ngrok.connect()

Stack trace shows:

Traceback (most recent call last):
  File "<input>", line 1, in <module>
  File "C:\Users\*Redact*\PycharmProjects\GithubListener\venv\lib\site-packages\pyngrok\ngrok.py", line 158, in connect
    api_url = get_ngrok_process(ngrok_path, config_path).api_url
  File "C:\Users\*Redact*\PycharmProjects\GithubListener\venv\lib\site-packages\pyngrok\ngrok.py", line 117, in get_ngrok_process
    return process.get_process(ngrok_path, config_path)
  File "C:\Users\*Redact*\PycharmProjects\GithubListener\venv\lib\site-packages\pyngrok\process.py", line 84, in get_process
    return _start_process(ngrok_path, config_path)
  File "C:\Users\*Redact*\PycharmProjects\GithubListener\venv\lib\site-packages\pyngrok\process.py", line 197, in _start_process
    raise PyngrokNgrokError("The ngrok process was unable to start.", errors)
pyngrok.exception.PyngrokNgrokError: The ngrok process was unable to start.

Environment

• Windows 10
• Python 3.7
• Pyngrok 5.1

Hi Alex,

Thank you for responding to me here: https://stackoverflow.com/questions/68766528/pyngrok-retrying-failed-connections?noredirect=1#comment121546605_68766528

As for my code, I have a Flask server which calls this function here to automatically start an ngrok tunnel:

# Function to start ngrok instance e.g. when restart button on Admin page is hit
def startngroktunnel():
    ngrokFile = os.path.abspath("ngrok.yml")
    ngrokConfig = conf.PyngrokConfig(config_path=ngrokFile)
    http_tunnel = ngrok.connect(name='merakihud', pyngrok_config=ngrokConfig)

my YAML file:

authtoken: <hidden>
tunnels:
  merakihud:
    addr: 5001
    proto: http
    root_cas: trusted
    bind_tls: true

Stack trace / log:

vlad@ubuntu:~/fujiwara-api/app$ python3 webhook.py 
t=2021-08-16T11:00:39+0900 lvl=eror msg="failed to reconnect session" obj=csess id=eeb66655d762 err="x509: certificate signed by unknown authority"
Traceback (most recent call last):
  File "webhook.py", line 11, in <module>
    appsc.startngroktunnel()
  File "/home/vlad/fujiwara-api/app/app_startchecks.py", line 112, in startngroktunnel
    http_tunnel = ngrok.connect(name='merakihud', pyngrok_config=ngrokConfig)
  File "/home/vlad/.local/lib/python3.8/site-packages/pyngrok/ngrok.py", line 251, in connect
    api_url = get_ngrok_process(pyngrok_config).api_url
  File "/home/vlad/.local/lib/python3.8/site-packages/pyngrok/ngrok.py", line 162, in get_ngrok_process
    return process.get_process(pyngrok_config)
  File "/home/vlad/.local/lib/python3.8/site-packages/pyngrok/process.py", line 295, in get_process
    return _start_process(pyngrok_config)
  File "/home/vlad/.local/lib/python3.8/site-packages/pyngrok/process.py", line 472, in _start_process
    raise PyngrokNgrokError("The ngrok process errored on start: {}.".format(ngrok_process.startup_error),
pyngrok.exception.PyngrokNgrokError: The ngrok process errored on start: x509: certificate signed by unknown authority.

Basically this script works on other systems, its just this one and I'm quite sure its my company trying to prevent reverse proxy tunnels through the use of a cloud DNS system to block requests (I'm going to test this also by manually changing my DNS Settings in my Ubuntu VM) and this only started being blocked recently from what I can tell.

ngrok application stdout log

vlad@ubuntu:~/fujiwara-api/app$ ngrok start --log=stdout -config ngrok.yml merakihud
INFO[08-16|11:10:08] open config file                         path=/home/vlad/fujiwara-api/app/ngrok.yml err=nil
t=2021-08-16T11:10:08+0900 lvl=info msg="starting web service" obj=web addr=127.0.0.1:4040
t=2021-08-16T11:10:09+0900 lvl=eror msg="failed to reconnect session" obj=csess id=c11a09a2aae0 err="x509: certificate signed by unknown authority"
t=2021-08-16T11:10:09+0900 lvl=eror msg="failed to reconnect session" obj=csess id=c11a09a2aae0 err="x509: certificate signed by unknown authority"
t=2021-08-16T11:10:10+0900 lvl=eror msg="failed to reconnect session" obj=csess id=c11a09a2aae0 err="Get \"https://dns.google.com/resolve?cd=true&name=tunnel.us.ngrok.com&type=A\": x509: certificate signed by unknown authority"
t=2021-08-16T11:10:13+0900 lvl=info msg="tunnel session started" obj=tunnels.session
t=2021-08-16T11:10:13+0900 lvl=info msg="client session established" obj=csess id=c11a09a2aae0
t=2021-08-16T11:10:13+0900 lvl=info msg="started tunnel" obj=tunnels name=merakihud addr=http://localhost:5001 url=https://444b23cd36ff.ngrok.io

As you can see, it swaps to dns.google.com to resolve the tunnel then magically it comes up, I find pyngrok stops before it hits this fallback and so I can't get the tunnel up otherwise. Any help would be much appreciated!

whenever i use the ngrok provided by this package;- located in /home/me/miniconda3/bin/ngrok, I only get the results of ngrok help no matter what command i put in.

It appeared to be the source of a bug resulting in a PyNgrokError being thrown.

I would very much like that when I save the file in .pyw format and run it there is a way to hide the ngrok window. If there is already a method I would like to know. Thank you so much

Describe the Bug When tunneling a local directory, the generated name in ngrok.py:163: "name": name if name else "{}-{}-{}".format(proto, port, uuid.uuid4()), apparently creates a name that the ngrok api is not able to process correctly, specifically for listing tunnel info or deleting tunnel.

Steps to Reproduce

from pyngrok import ngrok
from time import sleep

ngrok.set_auth_token(SECRET_KEY)
public_url = ngrok.connect('file:///')

print(public_url)
sleep(5)
ngrok.disconnect(public_url)

Above code generates error at disconnect attempt: pyngrok.exception.PyngrokNgrokHTTPError: ngrok client exception, API returned 404: {"status_code":404,"msg":"Not Found","details":{"path":"/api/tunnels/http-file:///-d207771d-59de-4d1b-838c-b56751d14661 (http)"}}

Using the api directly with the generated URI to get tunnel info: http://127.0.0.1:4040/api/tunnels/http-file:%2F%2F%2F-d207771d-59de-4d1b-838c-b56751d14661 results in:

<Error>
<StatusCode>404</StatusCode>
<Message>Not Found</Message>
</Error>

Removing the "port" portion of the name fixes it:

from pyngrok import ngrok
from time import sleep
import uuid

ngrok.set_auth_token(SECRET_KEY)
public_url = ngrok.connect('file:///', name='http-{}'.format(uuid.uuid4()))

print(public_url)
sleep(5)
ngrok.disconnect(public_url)

Expected Behavior ngrok.disconnect() should not generate errors with a valid public_url

Environment

• OS: Linux Mint 19.3
• Python Version: 3.7.5
• pyngrok Version: 4.1.3

Additional Context N/A

Describe the Bug Not sure if this is a bug or feature, but if a tunnel gets dropped due to loss of internet connection, get_tunnels() still retains the invalid tunnel.

Steps to Reproduce

url = ngrok.connect()
  <drop internet connection>
ngrok.disconnect(url)
  <ngrok client exception, URLError: timed out>
  <reconnect internet connection>
url = ngrok.connect()
len(ngrok.get_tunnels()) == 2

Expected Behavior If disconnect() on a tunnel fails with a "session closed" error, it should be removed from the list.
get_tunnels() should ideally return the same results as the web interface.

Environment

• OS: Linux Mint 19.3
• Python Version: 3.7.5
• pyngrok Version: 4.1.5

Additional Context The only way I know to clear out dropped tunnels is to use ngrok.kill() and start over. I'm open to other suggestions if there are alternatives.

Edit: This may be an ngrok issue - calling the api directly still shows the tunnels as well. Pulling up tunnel status on the account in the web admin does not though. Is there a way to clear these out in the api?

Describe the Bug I have a paid version of ngrok and thus a reserved hostname for region in. When I try to connect ngrok tunnel following

public_url = ngrok.connect(options={'hostname':'example.com'}) I get following region error as default region is us:

Traceback (most recent call last):
  File "main.py", line 25, in <module>
    public_url = ngrok.connect(options={'region': 'in','hostname':'example.com'})
  File "/usr/local/lib/python3.6/dist-packages/pyngrok/ngrok.py", line 178, in connect
    tunnel = NgrokTunnel(api_request("{}/api/{}".format(api_url, "tunnels"), "POST", data=options, timeout=timeout))
  File "/usr/local/lib/python3.6/dist-packages/pyngrok/ngrok.py", line 314, in api_request
    status_code, e.msg, e.hdrs, response_data)
pyngrok.exception.PyngrokNgrokHTTPError: ngrok client exception, API returned 502: {"error_code":103,"status_code":502,"msg":"failed to start tunnel","details":{"err":"This name is reserved in a different region.\nFailed to bind the domain 'example.com' in the region 'us' because it is reserved\nin the 'in' region.\n\nTry connecting to a different region: https://ngrok.com/docs#global-usage\r\n\r\nERR_NGROK_322\r\n"}}

Steps to Reproduce public_url = ngrok.connect(options={'hostname':'example.com'}) Pass options with reserved hostname with region other than us

Expected Behavior There should be a function like ngrok.set_region("<REGION>") like we have ngrok.set_auth_token("<NGROK_AUTH_TOKEN>")

Describe the Bug It was working fine before Dec 2020 but in Jan 2021. I'm not able to create a tunnel.

Before, I was able to create tunnel and then use it for streamlit app. But now, I'm not able too cause whenever the link gets generated and I open it then it says Tunnel XXXXXX.ngrok.io not found.

Steps to Reproduce I tried both ways:

1. Downloading the zip file in colab and then creating tunnel
2. Installing the pyngrok and then creating tunnel

but neither of them is working.

Expected Behavior It should be able to create a tunnel.

Environment

• OS: Linux (Colab)
• Python Version: 3.6.9
• pyngrok Version: 5.0.1

Additional Context You can try it here: https://colab.research.google.com/drive/1BZFSfzLGiZ-1inZ8S9xQPCQFVemzPrpO?usp=sharing

The region is not being selected on a tcp tunnel despite setting it in the options

host = ngrok.connect(8080, proto='tcp', options={'region': 'in'}) this would be equivalent to ngrok tcp -region=in 8080

Expected Behavior This should lead to the creation of a tcp tunnel with region in, but this is instead created with the US (default) region

Environment

• Windows 10
• Python Version: 3.8.2
• pyngrok Version: 2.0.3

The connection still opens in the default location, the US every time. No errors are being thrown, but the tcp tunnel just opens with the us region