GCROK exposes your localhost to the world for easy testing and sharing! No need to mess with DNS or deploy just to have others test out your changes.
Great for working with browser testing tools like browserling or external api callback services like twilio which require a public url for callbacks.
$ git clone https://github.com/chp-lab/gcrok.git
Then save gcrok token only first time!
$ node ./gcrok.js --add-authtoken <your_gcrok_token>
e.g.
$ node ./gcrok.js --add-authtoken abcdefghijklmnopqrstuvwxyz
First Option (via bash, git bash) This must edit .env to matches with your setup:
$ npm run start-gcrok.sh
Ready to access your services!!
Or Secound Option (More flexibilities)
Save gcrok token only first time!
$ node ./gcrok.js --add-authtoken <your_gcrok_token>
Then start your gcrok tunnel
$ node ./gcrok.js --port <service_port> --subdomain <your_sub_domain>
$ node ./gcrok.js --port 3000 --subdomain my-sub-domain
Or edit .env file then
$ node ./gcrok.js
Note: subdomain cannot contain special character (~, _. ! @ etc.) Dash - is allow
Or Third Option (More Reliable) This gcrok pm2 will restart always and prevent gcrok down;
provide non-stop tunnels for your services!. This must edit .env to matches with your setup.
$ node ./gcrok.js --add-authtoken <your_gcrok_token>
(sudo) $ npm install pm2 -g
$ pm2 start gcrok-pm2.json
Done!
======
Optionals:
$ pm2 startup
-> auto start on boot
$ pm2 save
-> save current state of pm2
$ pm2 status
-> list pm2 services
$ pm2 logs gcrok
-> view pm2 logs of gcrok services
Mac: https://chp-s3.s3.ap-south-1.amazonaws.com/gcrok_releases/macOS/mac.zip
Windows: https://chp-s3.s3.ap-south-1.amazonaws.com/gcrok_releases/windows/windows.zip
Linux: https://chp-s3.s3.ap-south-1.amazonaws.com/gcrok_releases/linux/linux.zip
Download via wget:
$ wget https://chp-s3.s3.ap-south-1.amazonaws.com/gcrok_releases/macOS/mac.zip
Edit .env file to your setup
PORT=<service port number>
SUBDOMAIN=<your sub-domain>
Save gcrok token only first time!
$ node ./gcrok.js --add-authtoken <your_gcrok_token>
Then start gcrok with
$ ./gcrok
You can start gcrok binary via specific options instead of .env via:
Mac: $ ./gcrok --port <service_port> --subdomain <your_sub_domain>
e.g. $ ./gcrok --port 3000 --subdomain my-sub-domain
Windows:$ ./gcrok-windows --port 3000 --subdomain my-sub-domain
Linux: $ ./gcrok-linux --port 3000 --subdomain my-sub-domain
It's also support global running by set gcrok path to your environment variable.
MAC and Linux:
$ export PATH="$PATH:<your_gcrok_directory>"
e.g. export PATH="$PATH:$HOME/gcrok"
You can permanently export PATH by edit ~/.bashrc file by:
$ nano ~/.bashrc
Scroll to the last line and add
export PATH="$PATH:<your_gcrok_directory>"
e.g. export PATH="$PATH:$HOME/gcrok"
$ source ~/.bashrc
##### Complete ######
Windows: Add gcrok directory to environtment varible PATH. Re-open command windows.
Below are some common arguments. See ./gcrok --help for additional arguments
--subdomainrequest a named subdomain on the localtunnel server (default is random characters)--local-hostproxy to a hostname other than localhost
You may also specify arguments via env variables. E.x.
$ PORT=3000 ./gcrok ...
The gcrok client is also usable through an API (for test integration, automation, etc)
port(number) [required] The local port number to expose.subdomain(string) Request a specific subdomain on the proxy server. Note You may not actually receive this name depending on availability.host(string) URL for the upstream proxy server. Defaults tohttps://giantiot.com.localHost(string) Proxy to this hostname instead oflocalhost. This will also cause theHostheader to be re-written to this value in proxied requests.localHttps(boolean) Enable tunneling to local HTTPS server.localCert(string) Path to certificate PEM file for local HTTPS server.localKey(string) Path to certificate key file for local HTTPS server.localCa(string) Path to certificate authority file for self-signed certificates.allowInvalidCert(boolean) Disable certificate checks for your local HTTPS server (ignore cert/key/ca options).
Refer to tls.createSecureContext for details on the certificate options.
The tunnel instance returned to your callback emits the following events
| event | args | description |
|---|---|---|
| request | info | fires when a request is processed by the tunnel, contains method and path fields |
| error | err | fires when an error happens on the tunnel |
| close | fires when the tunnel has closed |
The tunnel instance has the following methods
| method | args | description |
|---|---|---|
| close | close the tunnel |
github.com/localtunnel MIT