Quickstart

Use this page to get oriented quickly before reading the full usage guide.

Read the key commands

The usage guide is anchored to these CLI help surfaces:

• mullgate --help
• mullgate setup --help
• mullgate proxy --help
• mullgate proxy relay --help
• mullgate config --help

Know the invocation forms

Mullgate has two operator-facing invocation forms:

1. installed mullgate command
2. packed release asset

This documentation uses installed mullgate ... examples by default. If you are using a release artifact instead, run the extracted mullgate binary with the same flags and subcommands shown here.

Simple mental model

A normal Mullgate workflow looks like this:

1. run mullgate setup
2. inspect generated configuration, region groups, and exposure details
3. export client-ready proxy lists when needed
4. inspect or probe relay candidates when you want a better exact exit
5. start the runtime with mullgate proxy start
6. verify behavior with mullgate proxy status and mullgate proxy doctor
7. access routes by hostname/direct host-and-port in published-routes, or by inline selector on one shared listener in inline-selector

Recommended first run

For a low-friction Linux proof, start with a local loopback setup using two routes. That gives you:

• one machine
• multiple route entrypoints
• hostname mapping through a generated hosts block
• a safe environment for verifying the CLI and runtime lifecycle

Once setup is saved, the next low-friction inspection path is usually:

mullgate proxy export --regions
mullgate proxy export --guided
mullgate proxy relay probe --country Sweden --count 2
mullgate proxy relay recommend --country Sweden --count 1

That gives you a guided proxies.txt flow with real country and region pick-lists, plus a relay-inspection path when you want to preview a faster exact exit instead of guessing.

If the goal is Tailscale or another trusted private network, the next step after setup is usually mullgate proxy access --mode private-network. If the goal is one stable host with country/city selection in the proxy URL, switch to --access-mode inline-selector.

See the full examples in Usage, Setup and Exposure, and Inline Selector Reference.

Important platform note

Linux is the fully supported runtime environment.

macOS and Windows support the CLI, path, and diagnostic surfaces, but Docker Desktop host networking differs from Linux, so the shipped multi-route runtime should not be treated as fully equivalent there.

For the exact support posture, see Platform Support.

Suggested next pages

1. Usage
2. Setup and Exposure
3. Inline Selector Reference
4. Troubleshooting
5. Commands
6. Architecture Overview