If you’d prefer to skip the boilerplate setup, you can clone the complete example from the ngrok-samples collection.
In that case, you’ll just need to reserve a domain and add your auth token as described below to get started.
What you’ll need
- An ngrok account.
- Your ngrok auth token.
- Rust installed on your machine. You can check this by running
rustc --version
in your terminal.
1. Start your app or service
Start up the app or service you’d like to put online. This is the app that your agent endpoint will forward online traffic to. If you don’t have an app to work with, you can set up a basic HTTP server at port8080
.
First, create a directory for your Rust project and navigate into it:
src/main.rs
with the following code to set up a basic HTTP server:
ngrok-rust-server/src/main.rs
2. Install the Rust SDK
Open a new terminal, then run the following commands to create a new Rust project install the Rust SDK:Cargo.toml
file to include the necessary dependencies:
ngrok-rust-demo/Cargo.toml
3. Create your endpoint
Create your agent endpoint, which will forward public traffic to your app. In thengrok-rust-demo
directory you created in the previous step, add the following code to your src/main.rs
file.
This example:
- Starts an Agent endpoint that forwards from your reserved domain to your service running on port
8080
. - Secures the endpoint with a Traffic Policy that requires authentication via Google OAuth.
This example uses ngrok’s default Google OAuth application.
To use your own, see the OAuth Traffic Policy Action documentation.
ngrok-rust-demo/src/main.rs
4. Test your endpoint
Test your endpoint by running the following terminal command, swapping in your auth token:What’s next?
In this guide, you learned how to use the Rust SDK to an create agent endpoint that forwards traffic to your localhost. You saw one way to implement a traffic policy directly in your codebase, including an action that adds authentication to your app with no configuration required. What else can you do with these features?- Dig deeper into traffic policies, which enable you to grant conditional access, send custom headers, rewrite URLs, and more with your endpoints.
- Learn more about the Agent SDKs to understand how the Rust SDK works under the hood.
- Check out the ngrok Rust SDK repo for more code examples.
- If your use case calls for a centrally managed, always-on endpoint, instead of one that’s only available when an agent is running, you should proceed to getting started with Cloud Endpoints.