Nominating Presidential Muppets
Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

@nuxtjs/localtunnel

1.1.3 • Public • Published

Local Tunnel

npm npm (scoped with tag)

localtunnel 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/localtunnel dependency using yarn or npm to your project
  • Add @nuxtjs/localtunnel to modules section of nuxt.config.js
  modules: [
    // Simple usage
    '@nuxtjs/localtunnel',
    
    // With options
    ['@nuxtjs/localtunnel', { 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.localtunnel.me for external access

Options

subdomain

  • Default: process.env.npm_package_name

Request a named subdomain on the localtunnel server (default is random characters)

local_host

  • Default: nuxt listening ip (auto detected)

Proxy to a hostname other than localhost

remote_host

Use another localtunnel server, instead of localtunnel.me

Keywords

none

Install

npm i @nuxtjs/localtunnel

DownloadsWeekly Downloads

246

Version

1.1.3

License

MIT

Unpacked Size

6.87 kB

Total Files

5

Last publish

Collaborators

  • avatar
  • avatar
  • avatar
  • avatar