ngrok 0.6.0

A minimal ngrok wrapper
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

# ngrok   ![Build] [![Crate]](https://crates.io/crates/ngrok) [![Docs]](https://docs.rs/ngrok/)

[build]: https://github.com/nkconnor/ngrok/workflows/tests/badge.svg
[crate]: https://img.shields.io/crates/v/ngrok
[docs]: https://docs.rs/ngrok/badge.svg

A minimal and concise [`ngrok`](https://ngrok.com/) wrapper for Rust. The library has many use cases, for example:
- open public HTTP tunnels to your development server(s) for integrations tests
- simplified networking and development on devices like a Raspberry Pi

TCP support, while not available, should be trivial to support.

This has been tested with Linux and we assume that it does not work on Windows (contributions
welcome!).

## Getting Started

```toml
[dependencies]
ngrok = "0.6.0"
```

## Usage

```rust
use ngrok;

fn main() -> std::io::Result<()> {
    let tunnel = ngrok::builder()
        .https()
        .port(3030)
        .run()?;

    let public_url: url::Url = tunnel.public_url()?;

    println!("Tunnel is open at {:?}", public_url);

    Ok(())
}
```

This assumes that `ngrok` is on your path. To change this, use the `.executable()` method in the builder when
creating your tunnel.

## License

Licensed under either of <a href="LICENSE-APACHE">Apache License, Version
2.0</a> or <a href="LICENSE-MIT">MIT license</a> at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in `ngrok` by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.