Skip to content

mr-manuel/venus-os_ngrok

Repository files navigation

venus-os_ngrok - Remote access without port forwarding with Ngrok

GitHub repository: mr-manuel/venus-os_ngrok

Disclaimer

I wrote this script for myself. I'm not responsible, if you damage something using my script.

Purpose

I created this driver/packet for Venus OS that allows you to access a specific port on your Venus OS without the need to forward the port on your local router/firewall. It can for example be used to remote access the Venus OS device via SSH behind a mobile internet connection, VPN, firewall or anything else.

The driver is using ngrok as application to achieve that. Ngrok is like a router that forwards the port for you. In order to be able to do that, the application connects to a ngrok server, which is acting as a router, where then a dynamic port is opened for you. Then you can connect to the displayed hostname and port. For detailed informations on how ngrok works, visit their website.

In order to use ngrok you have to create a free account first.

Installation

⚠️ The Setup Helper/Packet Manager is required for all installation methods.

The driver can directly be installed via remote console/GIU with the Setup Helper/Packet Manager or by uploading it via SFTP to the directory /data/venus-os_ngrok and then running the setup file or by running this commands:

wget -O /tmp/venus-os_ngrok.zip https://github.com/mr-manuel/venus-os_ngrok/archive/refs/tags/latest.zip

unzip /tmp/venus-os_ngrok.zip -d /data

chmod +x /data/venus-os_ngrok/service/run /data/venus-os_ngrok/service/log/run /data/venus-os_ngrok/setup /data/venus-os_ngrok/venus-os_ngrok.py

bash /data/venus-os_ngrok/setup

The configuration is done via remote console/GUI.

Show screenshots

Ngrok - Services Ngrok - Page Ngrok - Page

Config

Access to the remote console/GUI → Settings → Services → Ngrok

Debugging

The logs can be checked with tail -n 100 -F /data/log/venus-os_ngrok/current | tai64nlocal

You can check, if ngrok is running by executing ps | grep ngrok

If you do not see anything in the logs you can increase the log level in /data/etc/venus-os_ngrok/venus-os_ngrok.py by changing level=logging.INFO to level=logging.DEBUG

Supporting/Sponsoring this project

You like the project and you want to support me?

About

This driver/package allows you to use ngrok on Venus OS and configure it over GUI. Ngrok allows you to access a specific port without forwarding the port.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published