{"id":18011346,"url":"https://github.com/joaquimley/ngrok-install","last_synced_at":"2026-03-03T18:01:31.260Z","repository":{"id":93731189,"uuid":"246690353","full_name":"JoaquimLey/ngrok-install","owner":"JoaquimLey","description":"A simple self-sufficient script that installs a ngrok ssh tunnel service that runs on boot for the raspberry pi","archived":false,"fork":false,"pushed_at":"2020-03-12T22:14:03.000Z","size":38,"stargazers_count":7,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-22T02:03:05.678Z","etag":null,"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"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/JoaquimLey.png","metadata":{"files":{"readme":"README.MD","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.MD","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":null,"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":["https://paypal.me/joaquimley"]}},"created_at":"2020-03-11T22:14:09.000Z","updated_at":"2023-07-07T08:24:00.000Z","dependencies_parsed_at":"2023-03-20T15:32:37.924Z","dependency_job_id":null,"html_url":"https://github.com/JoaquimLey/ngrok-install","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JoaquimLey%2Fngrok-install","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JoaquimLey%2Fngrok-install/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JoaquimLey%2Fngrok-install/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JoaquimLey%2Fngrok-install/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JoaquimLey","download_url":"https://codeload.github.com/JoaquimLey/ngrok-install/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245681574,"owners_count":20655221,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["autostart-script","ngrok","ngrok-client","ngrok-server","raspberry","raspberry-pi","raspberrypi","remote-control","remote-ssh","script","ssh","ssh-client","ssh-server","ssh-tunnel","systemd"],"created_at":"2024-10-30T03:09:42.900Z","updated_at":"2026-03-03T18:01:26.240Z","avatar_url":"https://github.com/JoaquimLey.png","language":"Shell","funding_links":["https://paypal.me/joaquimley"],"categories":[],"sub_categories":[],"readme":"# ngrok-install\nA simple self-sufficient script that installs a ngrok ssh tunnel service that runs on boot for the raspberry pi:\n\n## Install\n\nYou'll need your account's `AUTH_TOKEN` get it on your ngrok's dashboard: \n- https://dashboard.ngrok.com/auth\n\nOn your Pi's shell\n1. Copy/Download the `install.sh` file\n2. Give permission:\n\n```bash\nsudo chmod 755 install.sh\n```\n3. Run\n\n```bash\nsudo ./install.sh \u003cAUTH_TOKEN\u003e \u003cREGION\u003e\n```\n- `REGION` argument is optional (defaults to `us`)\n\nAfter the installation is complete you can delete the `install.sh` file.\nIf you get erros from linux complaining about read-only file system try to run:\n```\nsudo mount -o remount,rw /\n```\n\n----------------------\n\n## Uninstall\nTo stop/remove ngrok from your pi\n\nOn your Pi's shell\n1. Copy/Download the `uninstall.sh` file\n2. Give permission:\n\n```bash\nsudo chmod 755 uninstall.sh\n```\n3. Run\n\n```bash\nsudo ./uninstall.sh\n```\n\n---------------------\n\n## Alias\nI've written an alias to make it simple to connect to ngrok tunnels.\n\nOn your local machine's `bash`/`zshrc` add:\n```\nalias ngrok='function _f() { ssh -p \"$1\" pi@0.tcp.\"${2:-eu}\".ngrok.io } ; _f'\n```\n\n### Connect using the alias\nOpen the terminal and run:\n```\nngrok PORT REGION\n```\n\n_Since I'm in Europe I've defaulted the alias to `eu`, depending on your region you can change:\n`\"${2:-eu}\"` to your choice of default region, e.g: `\"${2:-us}\"`_\n\nNow to ssh into any of my pi's I just run\n\n```bash\n# 11223 is the PORT number\nngrok 11223\n\n# Same as (depending on your default value)\nngrok 11223 eu\n\n# If I wish to connect to my non-default region, e.g us\nngrok 11223 us\n```\n\n### Misc\n- You can find the config files in the [manual](manual/) folder if you wish to do it manually.\n- Special thanks: https://github.com/vincenthsu/systemd-ngrok\n- I'm not affiliated with ngrok.com or inconshreveable.com\n\n### License\n\n\tCopyright © 2020 Joaquim Ley\n\n\tLicensed under the Apache License, Version 2.0 (the \"License\");\n\tyou may not use this file except in compliance with the License.\n\tYou may obtain a copy of the License at\n\n\thttp://www.apache.org/licenses/LICENSE-2.0\n\n\tUnless required by applicable law or agreed to in writing, software\n\tdistributed under the License is distributed on an \"AS IS\" BASIS,\n\tWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or \n\timplied.\n\tSee the License for the specific language governing permissions and\n\tlimitations under the License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoaquimley%2Fngrok-install","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjoaquimley%2Fngrok-install","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoaquimley%2Fngrok-install/lists"}