Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/JoaquimLey/ngrok-install
A simple self-sufficient script that installs a ngrok ssh tunnel service that runs on boot for the raspberry pi
https://github.com/JoaquimLey/ngrok-install
autostart-script ngrok ngrok-client ngrok-server raspberry raspberry-pi raspberrypi remote-control remote-ssh script ssh ssh-client ssh-server ssh-tunnel systemd
Last synced: 2 months ago
JSON representation
A simple self-sufficient script that installs a ngrok ssh tunnel service that runs on boot for the raspberry pi
- Host: GitHub
- URL: https://github.com/JoaquimLey/ngrok-install
- Owner: JoaquimLey
- License: other
- Created: 2020-03-11T22:14:09.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2020-03-12T22:14:03.000Z (almost 5 years ago)
- Last Synced: 2024-11-22T16:12:13.562Z (3 months ago)
- Topics: autostart-script, ngrok, ngrok-client, ngrok-server, raspberry, raspberry-pi, raspberrypi, remote-control, remote-ssh, script, ssh, ssh-client, ssh-server, ssh-tunnel, systemd
- Language: Shell
- Homepage:
- Size: 37.1 KB
- Stars: 7
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.MD
- Funding: .github/FUNDING.yml
- License: LICENSE.MD
Awesome Lists containing this project
README
# ngrok-install
A simple self-sufficient script that installs a ngrok ssh tunnel service that runs on boot for the raspberry pi:
## Install
You'll need your account's `AUTH_TOKEN` get it on your ngrok's dashboard:
- https://dashboard.ngrok.com/auth
On your Pi's shell
1. Copy/Download the `install.sh` file
2. Give permission:
```bash
sudo chmod 755 install.sh
```
3. Run
```bash
sudo ./install.sh
```
- `REGION` argument is optional (defaults to `us`)
After the installation is complete you can delete the `install.sh` file.
If you get erros from linux complaining about read-only file system try to run:
```
sudo mount -o remount,rw /
```
----------------------
## Uninstall
To stop/remove ngrok from your pi
On your Pi's shell
1. Copy/Download the `uninstall.sh` file
2. Give permission:
```bash
sudo chmod 755 uninstall.sh
```
3. Run
```bash
sudo ./uninstall.sh
```
---------------------
## Alias
I've written an alias to make it simple to connect to ngrok tunnels.
On your local machine's `bash`/`zshrc` add:
```
alias ngrok='function _f() { ssh -p "$1" [email protected]."${2:-eu}".ngrok.io } ; _f'
```
### Connect using the alias
Open the terminal and run:
```
ngrok PORT REGION
```
_Since I'm in Europe I've defaulted the alias to `eu`, depending on your region you can change:
`"${2:-eu}"` to your choice of default region, e.g: `"${2:-us}"`_
Now to ssh into any of my pi's I just run
```bash
# 11223 is the PORT number
ngrok 11223
# Same as (depending on your default value)
ngrok 11223 eu
# If I wish to connect to my non-default region, e.g us
ngrok 11223 us
```
### Misc
- You can find the config files in the [manual](manual/) folder if you wish to do it manually.
- Special thanks: https://github.com/vincenthsu/systemd-ngrok
- I'm not affiliated with ngrok.com or inconshreveable.com
### License
Copyright © 2020 Joaquim Ley
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied.
See the License for the specific language governing permissions and
limitations under the License.