newt-connector

Connect private networks to a Pangolin server using Newt tunnels.

Updated Oct 31, 2024
One-click install
npx skills add https://github.com/thesammykins/dotfiles --skill newt-connector
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: newt-connector
Source: https://github.com/thesammykins/dotfiles/tree/main/.agents/skills/newt-connector
Command: npx skills add https://github.com/thesammykins/dotfiles --skill newt-connector

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Connect private networks to the Pangolin server by configuring and maintaining a tunnel that exposes local services securely.

Core Features & Use Cases

  • Dynamic mapping: Bridges local services (e.g., Docker containers, localhost endpoints) to public Pangolin endpoints without manual port forwarding.
  • NAT traversal & keep-alive: Ensures persistent connectivity across home or private networks with changing topologies.
  • Use Case: When you need to securely connect a Homelab or private network to a Pangolin Server for remote access and monitoring.

Quick Start

Run the docker-based Newt connector with your Pangolin URL and enrollment token to establish the initial tunnel.

Frequently Asked Questions about newt-connector

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I expose local Docker containers to a public URL without port forwarding?

You can expose local Docker containers by configuring Newt tunnels that bridge private networks to a Pangolin server, dynamically mapping local services to public endpoints without manual port forwarding. This enables secure remote access to Homelab setups.

Does the Newt connector support NAT traversal for private networks with changing topologies?

Yes, the Newt connector supports NAT traversal and keep-alive mechanisms to ensure persistent connectivity across private networks. This maintains stable tunnel connections even when home or private network topologies change.

What do I need to set up a Newt tunnel to a Pangolin server?

You need an enrollment token, a Pangolin URL, and a containerized Newt setup with host networking to establish the tunnel. These components connect your private network to the Pangolin server for secure remote access.

How does tunneling local services to Pangolin work for Homelab remote access?

Tunneling local services to Pangolin works by connecting private networks to the server and configuring tunnels that expose local endpoints. It maps Docker containers or localhost endpoints to public Pangolin endpoints for remote monitoring.

Why do I need host networking for the Docker-based Newt connector?

Host networking is required for the containerized Newt setup to properly traverse NAT and bridge local services. It allows the connector to access network interfaces directly, ensuring dynamic mapping of local endpoints to public Pangolin URLs.

Can I use Newt and Pangolin to monitor a private network remotely?

Yes, you can securely connect a Homelab or private network to a Pangolin server for remote access and monitoring. The Newt connector maintains a tunnel that exposes local services publicly without manual port forwarding.