ngrok

View Source Ngrok (ngrok v1.1.0)

By including this supervisor in your application, an Ngrok process will be started when your application starts and stopped when your application stops

options

 Options

  • port (integer / required) - The port to tunnel.
  • protocol (atom / default: https) - The protocol to tunnel. (http / https / tcp / tls)
  • additional_arguments ([String.t()] / default: []) - Additional options to pass to ngrok.
  • name (Supervisor name / default: Ngrok) - Name of the supervisor in your application.
  • api_url (url / default: http://localhost:4040/api/tunnels) - The URL of Ngrok's API (used to retrieve its settings).
  • sleep_between_attempts (timeout (ms) / default: 200) - The amount of sleep (in ms) to put between attempts to connect to Ngrok

config

 Config 

config :ngrok,
    # The name / path of the Ngrok executable
    executable: "ngrok"

Link to this section Summary

Types

destination_port()
protocol()
start_opts()
strict_name()

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

public_url(name \\ __MODULE__)

Retrieves the public URL of the Ngrok tunnel

start_link(opts)

Link to this section Types

Link to this type

destination_port()

View Source 
@type destination_port() :: pos_integer()
Link to this type

protocol()

View Source 
@type protocol() :: :http | :https | :tcp | :tls
Link to this type

start_opts()

View Source 
@type start_opts() :: [
  port: destination_port(),
  additional_arguments: [String.t()],
  protocol: protocol(),
  api_url: String.t(),
  sleep_between_attempts: timeout(),
  name: strict_name()
]
Link to this type

strict_name()

View Source 
@type strict_name() :: atom() | {:global, atom()}

Link to this section Functions

Link to this function

child_spec(init_arg)

View Source

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function

public_url(name \\ __MODULE__)

View Source 
@spec public_url(name :: strict_name()) :: String.t()

Retrieves the public URL of the Ngrok tunnel

example

 Example 

Ngrok.public_url # => http://(.*).ngrok.io/
Link to this function

start_link(opts)

View Source 
@spec start_link(opts :: start_opts()) :: Supervisor.on_start()