ngrok 0.2.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

# ngrok   ![Build] ![Crate]

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

A minimal [ngrok](https://ngrok.com/) wrapper for Rust. Only tested on Linux,
assuming it does not work with Windows (contributions welcome!).

## Getting Started

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

## Usage

```rust
use ngrok;

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

    let tunnel: url::Url = ngrok.tunnel()?.http();

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

    Ok(())
}
```

## 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.