vincenthsu / systemd-ngrok

Automatically start ngrok by systemd

Installation

1. Clone this repository to the target machine (eg: Raspberry Pi)
2. Get your authtoken from ngrok website
3. Inspect and modify the configuration file ngrok.yml, by default this config will use Asia Pacific region to serve both HTTP and TCP tunnels
4. Run sudo ./install.sh <your_authtoken>, replace <your_authtoken> with the token you've obtained before from ngrok website.
5. You're good to go!

Acknowledgements

Ngrok architecture auto detection was contributed by David Eleazar.

systemd-ngrok's Issues

Service gone after network error

I installed ngrok and got it working on a Raspberry Pi using this library, but unfortunately it seems that if the network connection goes down for a few hours and then comes back, ngrok will not reconnect. If I run service --status-all I don't see the ngrok service.

Install.sh for Raspberry PI

Hi,
This is not a real issues. it's an issue with a solution.
I followed the instructions to manually install systemd-ngrok on my raspberry PI 3, but I had some problems.
It's easier to run the install.sh, but it's for Linux X64.
I edited the install.sh to make it work on a raspberry and attached you find the zip archive that includes 2 files:

• install_RPi3.sh : it's the install file to install systemd-ngrok on a Raspberry Pi 3.

• ngrok.yml: the ngrok.yml file to support the free version of ngrok for a simple http tunneling with the region setting turned on (EU in my case).

It works on Raspbian Buster Lite: I make it available to be tested by other RPi users.
I suspect that it works on other RPi versions: I don't see a reason why it should not.

Instructions for RPi:
Download the zip file and extract the files.
chmod +x install_RPi3.sh
Run:
sudo ./install_RPi3.sh <your-auth-key>
edit the "ngrok.yml" for your needs - https://ngrok.com/docs .
sudo nano /opt/ngrok/ngrok.yml
Ctrl+O to save the file, Ctrl+X to quit Nano.

--optional
Overwrite the ngrok.yml file in /opt/ngrok/ with that one in the zip archive for a simple http tunnel on port 80. SSH is not exposed.

Job done.
Ciao
Davide

Install_RPi3.zip

Perhaps include .yml docs from ngrok?

Hi there, thanks for the useful library.

Perhaps it could be useful to include the YAML configuration docs in the README?

https://ngrok.com/docs#tunnel-definitions

This is in case someone wants to add some .yml configurations that aren't specified in your example config file. (I had to use this for example to look up remote_addr.

Thanks again!

The install script doesn't download the latest stable version of the ngrok agent

The install.sh script downloads the ngrok agent from URL https://bin.equinox.io/c/4VmDzA7iaHb/ngrok-stable-linux-$ARCH.zip - I'm not sure who manages that "mirror", but it doesn't point to the latest stable version of the ngrok agent: for example, it downloads v2.3.40 in case of the ARM64 architecture, although there are stable v3 agents available for some time (e.g. https://bin.equinox.io/c/bNyj1mQVY4c/ngrok-v3-stable-linux-arm64.tgz)

It works stock but not with VNC port

This is working great until I try to add a port for VNC to the yml file
If I add under ssh port entry:
vnc:
proto: tcp
addr: 5900

It fails to load ngrok at start up?
Is this protocol not allowed, perhaps?

I'm a using a paid version so i need to use different prompts

I have to use this promt --remote-addr=<YOUR_ADDRESS> how should i configure to run this?

Why git clone again in install.sh

https://github.com/vincenthsu/systemd-ngrok/blob/master/install.sh#L13
doesnt make sense to me, since I assume I have the repo already cloned when executing install.sh

systemctl failed

Hi, i want to make a mc server and I follow a tutorial from hardware haven.
But after following the step and installing i have the error.
● ngrok.service - ngrok
Loaded: loaded (/lib/systemd/system/ngrok.service; enabled; vendor preset: enabled)
Active: activating (auto-restart) (Result: exit-code) since Thu 2023-08-03 20:21:45 UTC; 1s ago
Process: 3829 ExecStart=/opt/ngrok/ngrok start --all --config /opt/ngrok/ngrok.yml (code=exited, status=1/FAILURE)
Main PID: 3829 (code=exited, status=1/FAILURE)
CPU: 32ms
Edit: here is the video: https://www.youtube.com/watch?v=SZmc5uoNCko&t=13s

Not Working

I followed all instructions and its just not working...

ngrok works if i ssh into my pi and issue the command but ngrok isnt running on startup. Using a Raspi 4B