Skip to content

Latest commit

 

History

History
 
 

ngrok

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
CHANGELOG.md
CHANGELOG.md
 
 
README.md
README.md
 
 
index.js
index.js
 
 
package.json
package.json
 
 

README.md

ngrok 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. learn more

Features

  • Secure https for all tunnels
  • Show your work to anyone
  • Use the API to test web hooks
  • Test your UI in cloud browsers

Note This module is only enabled in dev mode.

Setup

  • Add @nuxtjs/ngrok dependency using yarn or npm to your project
  • Add @nuxtjs/ngrok to modules section of nuxt.config.js
  modules: [
    // Simple usage
    '@nuxtjs/ngrok',

    // With options
    ['@nuxtjs/ngrok', { subdomain: 'foobar' }],
  ]

Usage

(For more information see here)

On next dev, you will something like this in terminal that can be shared with the world:

> Open http://127.0.0.1:3000
> Open https://starter.ngrok.me for external access

Options

proto

  • Default: http
  • http | tcp | tls

addr

  • Default: process.env.npm_package_name

auth

  • http basic authentication for tunnel

subdomain

  • reserved tunnel name https://EXAMPLE.ngrok.io

authtoken

  • your authtoken from ngrok.com

region

  • Default: us
  • one of ngrok regions (us, eu, au, ap)

configPath

  • ~/git/project/ngrok.yml
  • custom path for ngrok config file

Inspired by @nuxtjs/localtunnel