Newt Blueprint Generator
Generate and validate Pangolin Newt blueprint configurations in YAML or Docker Labels format.
Overview
This skill provides expert assistance for creating, validating, and managing Pangolin Newt blueprint configurations. It supports both YAML configuration files and Docker Compose label-based configurations.
When to Use
Use this skill when you need to:
- Create Pangolin blueprint configurations
- Generate YAML configuration files for Newt
- Create Docker Compose files with Pangolin labels
- Configure proxy resources (HTTP, TCP, UDP)
- Set up client resources for Pangolin Olm
- Configure authentication (SSO, basic auth, pincode, password)
- Validate blueprint configurations
- Troubleshoot blueprint validation errors
- Convert between YAML and Docker Labels formats
Installation
/plugin install newt-blueprint-generatorUsage
Triggering the Skill
The skill automatically activates when you mention:
- "Newt blueprint"
- "Pangolin blueprint"
- "Generate blueprint configuration"
- "Create proxy resource"
- "Pangolin YAML config"
- "Docker labels for Pangolin"
Example Prompts
Simple Web Application:
Create a Newt blueprint for a web app running on localhost:8080 accessible at app.example.comTCP Database:
Generate a blueprint for exposing a PostgreSQL database on port 5432Docker Compose Setup:
Create a Docker Compose file with Pangolin labels for an nginx service at nginx.example.comSecured Resource:
Generate a blueprint with SSO authentication for secure.example.comMulti-Target Resource:
Create a blueprint with multiple backend targets for load balancing
Features
Comprehensive Blueprint Generation
- HTTP Proxy Resources: Full domain-based routing with headers, rules, and authentication
- TCP/UDP Proxy Resources: Raw port-based proxying for databases, game servers, etc.
- Client Resources: Olm client resources for SSH, RDP, and other protocols
- Authentication: SSO, basic auth, pincode, and password authentication
- Access Control: IP, CIDR, path, and country-based rules
Validation
The skill automatically validates:
- Protocol-specific requirements (HTTP vs TCP/UDP)
- Unique constraints (
full-domain,proxy-port) - Authentication compatibility (HTTP only)
- Target method requirements
- Port ranges (1-65535)
- Email format for SSO users
Format Support
- YAML Configuration: Standalone files for Newt CLI or API
- Docker Labels: Embedded in Docker Compose files
Configuration Examples
HTTP Proxy Resource (YAML)
proxy-resources:
web-app:
name: Web Application
protocol: http
full-domain: app.example.com
headers:
- name: X-Custom-Header
value: custom-value
targets:
- hostname: localhost
port: 8080
method: httpsTCP Proxy Resource (YAML)
proxy-resources:
database:
name: PostgreSQL Database
protocol: tcp
proxy-port: 5432
targets:
- hostname: localhost
port: 5432Docker Compose with Labels
services:
nginx:
image: nginx:latest
labels:
- pangolin.proxy-resources.web.name=Web Server
- pangolin.proxy-resources.web.full-domain=web.example.com
- pangolin.proxy-resources.web.protocol=http
- pangolin.proxy-resources.web.targets[0].method=httpCommon Validation Errors
The skill helps you resolve common errors:
| Error | Cause | Solution |
|---|---|---|
| Duplicate 'full-domain' | Same domain used twice | Use unique subdomains |
| Duplicate 'proxy-port' | Same port used twice | Assign unique ports |
| Missing 'method' field | HTTP target without method | Add method: http/https/h2c |
| Auth on TCP/UDP | Auth not supported | Remove auth or use HTTP |
| Admin in sso-roles | Reserved role | Remove "Admin" from roles |
Best Practices
- Use Descriptive IDs: Name resources clearly (e.g.,
web-app-prod,db-backup) - Enable Authentication: Secure HTTP resources with SSO or password
- Document Ports: Keep track of port assignments to avoid conflicts
- Explicit Sites: Specify
sitefor multi-site deployments - Path Matching: Use
prefixfor broad matches,exactfor specific endpoints - Validate Before Deploy: Test configurations locally before production
Version History
- v1.0.0 (2025-01-20): Initial release with full Pangolin blueprint support
Resources
Support
For issues or questions:
- Pangolin GitHub: https://github.com/fosrl/pangolin
- Pangolin Slack: https://pangolin.net/slack
- Pangolin Discord: https://pangolin.net/discord
License
This skill follows the same license as the Skills marketplace repository.