Crate ngrok

source ·
Expand description

The ngrok Agent SDK MIT licensed Apache-2.0 licensed Continuous integration

Website | API Docs (main)

ngrok is a simplified API-first ingress-as-a-service that adds connectivity, security, and observability to your apps.

ngrok-rust, our native and idiomatic crate for adding a public internet address with secure ingress traffic directly into your Rust apps 🦀. If you’ve used ngrok in the past, you can think of ngrok-rust as the ngrok agent packaged as a Rust crate.

ngrok-rust lets developers serve Rust services on the internet in a single statement without setting up low-level network primitives like IPs, NAT, certificates, load balancers, and even ports! Applications using ngrok-rust listen on ngrok’s global ingress network for TCP and HTTP traffic. ngrok-rust listeners are usable with hyper Servers, and connections implement tokio’s AsyncRead and AsyncWrite traits. This makes it easy to add ngrok-rust into any application that’s built on hyper, such as the popular axum HTTP framework.

See /ngrok/examples/ for example usage, or the tests in /ngrok/src/

For working with the ngrok API, check out the ngrok Rust API Client Library.

If you’re looking for the agent wrapper, it’s over here. See for tips on migrating.


Add ngrok to the [dependencies] section of your Cargo.toml:


ngrok = "0.13"


Alternatively, with cargo add:

$ cargo add ngrok


Create a simple HTTP server using ngrok and axum:


name = "ngrok-axum-example"
version = "0.1.0"
edition = "2021"

ngrok = { version="0.13", features=["axum"] }
tokio = { version = "1.26", features = ["full"] }
axum = "0.6"
anyhow = "1.0"


use std::net::SocketAddr;

use axum::{
use ngrok::prelude::*;

async fn main() -> anyhow::Result<()> {
    // build our application with a single route
    let app = Router::new().route(
            |ConnectInfo(remote_addr): ConnectInfo<SocketAddr>| async move {
                format!("Hello, {remote_addr:?}!\r\n")

    let tun = ngrok::Session::builder()
        // Read the token from the NGROK_AUTHTOKEN environment variable
        // Connect the ngrok session
        // Start a tunnel with an HTTP edge

    println!("Tunnel started on URL: {:?}", tun.url());

    // Instead of binding a local port like so:
    // axum::Server::bind(&"".parse().unwrap())
    // Run it with an ngrok tunnel instead!



This project is licensed under either of

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.


  • Tunnel and endpoint configuration types.
  • A prelude of traits for working with ngrok types.
  • Types for working with the ngrok session.
  • Types for working with ngrok tunnels.


  • A connection from an ngrok tunnel.
  • An ngrok session.