Skip to content

GoodDay360/autorok

Repository files navigation

Autorok

Download

Autorok is a Rust-powered auto-configuration tool built on top of zrok that makes peer-to-peer connectivity effortless even without a public IP address.

Why Autorok?

Normally, two devices can't talk to each other directly unless at least one has a public IP. That's a dealbreaker if you're behind NAT, on a home network, or just don't want to mess with port forwarding.

Autorok solves this by automatically handling zrok's setup and configuration for you, letting you punch through that limitation with zero manual tunnel configuration.

What can you do with it?

  • Share a website running on your local machine with anyone, instantly.
  • Host a game server (e.g. Minecraft) and let friends join no public IP, no router config needed.
  • Connect peers directly for any service that normally requires public network access.
  • Backend Mode support: udp, tcp

How It Works

Autorok comes with a simple interactive CLI that handles all the zrok setup for you:

image

Getting a peer-to-peer connection running takes just four steps:

1. Get an environment token

Grab an environment token from https://api.zrok.io/.

image

This token is what links your environment so others using the same one can join your services. After that enable your token in autorok.

image

2. Host creates a service

The host defines what they want to expose, like a website or a game server, and creates a service for it through the CLI.

image

3. Host shares the service

Once created, the host shares the service.

image

4. Everyone else joins

Anyone using the same environment token can simply join that shared service and connect directly. No public IP required on either end.

image

That's it. No router settings, no dynamic DNS, no fiddling with firewalls. Just get a token, create, share, and join.

Build

  • Required Rust and Cargo to compile.
cargo build --release

About

Autorok is a Rust-powered auto-configuration tool built on top of zrok that makes peer-to-peer connectivity effortless even without a public IP address.

Topics

Resources

Stars

4 stars

Watchers

0 watching

Forks

Packages

 
 
 

Contributors

Languages