KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #ai-agents #developer-tools #codex #claude-code #mcp #rust #deepseek-harness #typescript #ai-agent #cli

tunnelsats

★ 40 Open GitHub ↗

Tunnel⚡Sats: Pre-configured VPN for Lightning Nodes

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

![TunnelSats Banner](https://raw.githubusercontent.com/Tunnelsats/tunnelsats/main/docs/assets/guide_header.webp)

# TunnelSats: Hybrid Lightning Node Setup

> **Privacy-focused VPN tunnels for Lightning nodes.** Run your node hybrid (clearnet + Tor) without exposing your home IP.

---

## ⚡ Quick Start

**New to TunnelSats?** Get up and running in 3 steps:

1. **Subscribe** at [tunnelsats.com](https://tunnelsats.com) and download your WireGuard config
2. **Run the installer** on your node:
   ```bash
   wget -O tunnelsats.sh https://github.com/tunnelsats/tunnelsats/raw/main/scripts/tunnelsats.sh
   sudo bash tunnelsats.sh install
   ```
3. **Configure your node** with the VPN settings from the installer output

👉 **[See full installation guide and compatibility matrix →](./scripts/)**

---

## Why Hybrid Mode?

The Lightning Network needs **fast, reliable, discoverable** nodes for efficient routing. While Tor provides privacy, it can be slow and unreliable. TunnelSats solves this by:

- ⚡ **Clearnet Speed** – Direct connections for faster routing
- 🔒 **VPN Privacy** – Your home IP stays hidden
- 🧅 **Tor Fallback** – Maintains .onion connectivity
- 🛡️ **Split Tunneling** – Only Lightning traffic goes through VPN

---

## Supported Platforms

| Platform | Type | LND | CLN | Installation Method |
|:---|:---|:---:|:---:|:---|
| **Umbrel** (umbrelOS 1.0+) | Docker App | ✅ | ✅ | **Native Umbrel App** ([Community App Store](https://github.com/Tunnelsats/ts-umbrel-app) / Official Review Pending) |
| **StartOS** (StartOS 0.3.5 & 0.4.0+) | Service Package | ✅ | ✅ | **Native `.s9pk` Package** ([tunnelsats-startos repo](https://github.com/Tunnelsats/tunnelsats-startos) / Official Store Pending) |
| **RaspiBlitz** (v1.11+) | Systemd | ✅ | ✅ | Host Script (`tunnelsats.sh`) |
| **Bare Metal** (Debian/Ubuntu) | Systemd | ✅ | ✅ | Host Script (`tunnelsats.sh`) |
| **myNode** (v0.3+) | Systemd | ⚠️ | ⚠️ | Host Script (`tunnelsats.sh` - Experimental) |

> ℹ️ **Security Architecture Note**:
> The `tunnelsats.sh` bash installer is designed for bare-metal / systemd nodes (RaspiBlitz, RaspiBolt, MiniBolt, myNode).
> Due to the strict container sandboxing and security infrastructure of **Umbrel** and **StartOS**, manual host script execution is unsupported on those platforms — please use their respective native App / Service installations.

See [scripts/README.md](./scripts/) for detailed compatibility info.

---

## Subscription & Renewal

### New Subscription
1. Visit [tunnelsats.com](https://tunnelsats.com)
2. Select a server location close to you
3. Choose duration (1-12 months)
4. Pay the Lightning invoice
5. Download your WireGuard config

### Renewal
- **Web**: [tunnelsats.com](https://tunnelsats.com) → Renew Subscription
- **Dashboard**: Log in → My Dashboard → Renew
- **API**: [api.tunnelsats.com](https://api.tunnelsats.com)

Your existing configuration remains valid after renewal – no changes needed!

---

## Uninstallation

To remove TunnelSats and restore your original configuration:

```bash
sudo bash tunnelsats.sh uninstall
```

---

## Development & Contribution

### Local Setup
This repository uses Git hooks to maintain script integrity. To set up your local development environment:

1.  **Initialize hooks**:
    ```bash
    chmod +x scripts/hooks-install.sh
    ./scripts/hooks-install.sh
    ```
    This will automatically configure the `pre-commit` and `post-rewrite` hooks to keep the `scripts/tunnelsats.sh.sha256` file in sync.

---

## Development & Contribution

### Local Setup
This repository uses Git hooks to maintain script integrity. To set up your local development environment:

---

## Support

- 💬 **Telegram**: [Tunnel⚡Sats Group](https://tunnelsats.com/join-telegram)
- 📖 **Guide**: [tunnelsats.com/guide](https://tunnelsats.com/guide)
- ❓ **FAQ**: [tunnelsats.com/faq](https://tunnelsats.com/faq)
- 🐛 **Issues**: [GitHub Issues](https://github.com/tunnelsats/tunnelsats/issues)

---

## Credits

Built with ⚡ by [@ziggie1984](https://github.com/ziggie1984), [@TrezorHannes](https://github.com/TrezorHannes), and [@blckbx](https://github.com/blckbx).

Special thanks to [@LightRider5](https://github.com/LightRider5) ([lnvpn.net](https://lnvpn.net)) for inspiration and support.

tunnelsats

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README