Giter Club home page Giter Club logo

ex_grok's Introduction

ExGrok

Low dependencies ngrok wrapper.

Tiny wrapper that will take care about ngrok connection for your Phoenix web applications you're working on and want to share with broader audience without need of deploying it.

Installation

The package can be installed as:

  1. Add ex_grok to your list of dependencies in mix.exs:
```elixir
def deps do
  [{:ex_grok, "~> 0.1.0"}]
end
```
  1. Ensure ex_grok is started before your application:
```elixir
def application do
  [applications: [:ex_grok]]
end
```

Configuration

By default ex_grok will try to establish connection only in dev environment. It is easy to change this behaviour by enabling it in config/config.exs file:

config :ex_grok, enabled: true

ngrok provides couple possible connection options, ex_grok however, makes use of http only at the moment.

It will try to use global ngrok command exposing port 4000 (default port that Phoenix uses in development), but it can be changed in config/config.exs:

config :ex_grok, :command,
  executable: "path/to/ngrok",
  port: "3040"

Usage

Once your application is up and running, and ngrok connection has been established successfully, the available urls will be reported in logs:

20:48:28.447 [info]  ngrok connection established - http://12345678.ngrok.io, https://12345678.ngrok.io

The same information can be obtained with ExGrok.connection/1:

iex> ExGrok.connection()
%ExGrok.Connection{http: "http://12345678.ngrok.io",
                   https: "https://12345678.ngrok.io"}

ex_grok's People

Contributors

pdawczak avatar

Watchers

 avatar  avatar

ex_grok's Issues

Support better cleanup in case of `ExGrok.Ngrok` crash

GenServer documentation mentions that once gen_server managing port is taken down, it automatically closes the port.

This turns to be true, however, it looks like ngrok itself needs a bit of time to shutdown nicely (probably it performs self cleanup when trying to close connection).

This in turn appears to be a problem for starting new gen_server in its place as it can't start properly due to still ongoing ngrok connection (this is very flakey, in some rare cases ngrok is able to disappear before exceeding restarting attempts and the whole app doesn't crash).

The only solution to problem appears to try to kill -9 ngrok process on gen_server crash to avoid this problem.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.