Unne

Getting Started ​

Prerequisites ​

  • A VPS or server with a public IP address
  • A domain with wildcard DNS configured (*.yourdomain.com → server IP)

Quick Setup ​

1. Set Up the Server ​

On your VPS:

bash
# One-line install (auto-detects OS/arch, runs setup)
curl -fsSL https://unne.site/server/install | sudo bash

Or download manually from GitHub Releases.

The setup wizard will ask for:

  • Server domain (e.g., unne.site)
  • Control port (default: 8222)
  • HTTP proxy port (default: 8223)
  • Admin panel settings
  • Admin credentials

Then create a user and a token for your computer in the admin panel (Users → user → Devices & tokens).

2. Configure DNS ​

Point a wildcard DNS record to your server:

*.unne.site → YOUR_SERVER_IP

3. Install the Unne App ​

On your computer, pick one:

  • Desktop app — download Unne for macOS or Unne for Windows and open it. On first launch it asks for your server, port and token, then offers to install itself.
  • Command line — curl -fsSL https://unne.site/cli/install | bash (Windows: irm https://unne.site/cli/install.ps1 | iex), then run unne setup and enter your server address, port and token.

4. Create Your First Tunnel ​

In the app: New tunnel → enter the local port → Create tunnel.

Or in a terminal:

bash
# Start a local web server (example)
python3 -m http.server 8080

# In another terminal, create a tunnel
unne http 8080

Your local server is now accessible at https://random.unne.site.

What's Next? ​

© 2026 Unne. Released under the MIT License.