Newt
Get Started with Apps!
Keywords: tunneling, proxy, wireguard, pangolin
Train: Community
Home Page: https://github.com/fosrl/newt
Added: 2025-05-09
Last Updated: 2025-05-20
Newt is a fully user space WireGuard tunnel client and TCP/UDP proxy, designed to securely expose private resources controlled by Pangolin. By using Newt, you don't need to manage complex WireGuard tunnels and NATing.
Run as Context- Newt runs as any non-root user.
Group: 568 / newt
User: 568 / newt
App Metadata (Raw File)
{
"1.0.1": {
"healthy": true,
"supported": true,
"healthy_error": null,
"location": "/__w/apps/apps/trains/community/newt/1.0.1",
"last_update": "2025-05-20 13:10:10",
"required_features": [],
"human_version": "1.1.3_1.0.1",
"version": "1.0.1",
"app_metadata": {
"app_version": "1.1.3",
"capabilities": [],
"categories": [
"networking"
],
"changelog_url": "https://github.com/fosrl/newt/releases",
"date_added": "2025-05-09",
"description": "Newt is a fully user space WireGuard tunnel client and TCP/UDP proxy, designed to securely expose private resources controlled by Pangolin. By using Newt, you don't need to manage complex WireGuard tunnels and NATing.",
"home": "https://github.com/fosrl/newt",
"host_mounts": [],
"icon": "https://media.sys.truenas.net/apps/newt/icons/icon.svg",
"keywords": [
"tunneling",
"proxy",
"wireguard",
"pangolin"
],
"lib_version": "2.1.23",
"lib_version_hash": "59e54688cf43e573fe96d939c5a9e9a7ae74d5441ff00daa81fe9aa8d52249b9",
"maintainers": [
{
"email": "dev@ixsystems.com",
"name": "truenas",
"url": "https://www.truenas.com/"
}
],
"name": "newt",
"run_as_context": [
{
"description": "Newt runs as any non-root user.",
"gid": 568,
"group_name": "newt",
"uid": 568,
"user_name": "newt"
}
],
"screenshots": [],
"sources": [
"https://github.com/fosrl/newt",
"https://hub.docker.com/r/fosrl/newt"
],
"title": "Newt",
"train": "community",
"version": "1.0.1"
},
"schema": {
"groups": [
{
"name": "Newt Configuration",
"description": "Configure Newt"
},
{
"name": "User and Group Configuration",
"description": "Configure User and Group for Newt"
},
{
"name": "Network Configuration",
"description": "Configure Network for Newt"
},
{
"name": "Storage Configuration",
"description": "Configure Storage for Newt"
},
{
"name": "Labels Configuration",
"description": "Configure labels for Newt"
},
{
"name": "Resources Configuration",
"description": "Configure Resources for Newt"
}
],
"questions": [
{
"variable": "TZ",
"group": "Newt Configuration",
"label": "Timezone",
"schema": {
"type": "string",
"default": "Etc/UTC",
"required": true,
"$ref": [
"definitions/timezone"
]
}
},
{
"variable": "newt",
"label": "",
"group": "Newt Configuration",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "pangolin_endpoint",
"label": "Pangolin Endpoint",
"description": "The endpoint for the Pangolin service.",
"schema": {
"type": "uri",
"default": "",
"required": true
}
},
{
"variable": "newt_id",
"label": "Newt ID",
"description": "The ID for the newt connection.",
"schema": {
"type": "string",
"default": "",
"required": true
}
},
{
"variable": "newt_secret",
"label": "Newt Secret",
"description": "The secret for the newt connection.",
"schema": {
"type": "string",
"default": "",
"required": true,
"private": true
}
},
{
"variable": "additional_envs",
"label": "Additional Environment Variables",
"description": "Configure additional environment variables for newt.",
"schema": {
"type": "list",
"default": [],
"items": [
{
"variable": "env",
"label": "Environment Variable",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "name",
"label": "Name",
"schema": {
"type": "string",
"required": true
}
},
{
"variable": "value",
"label": "Value",
"schema": {
"type": "string",
"required": true
}
}
]
}
}
]
}
}
]
}
},
{
"variable": "run_as",
"label": "",
"group": "User and Group Configuration",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "user",
"label": "User ID",
"description": "The user id that Newt files will be owned by.",
"schema": {
"type": "int",
"min": 568,
"default": 568,
"required": true
}
},
{
"variable": "group",
"label": "Group ID",
"description": "The group id that Newt files will be owned by.",
"schema": {
"type": "int",
"min": 568,
"default": 568,
"required": true
}
}
]
}
},
{
"variable": "network",
"label": "",
"group": "Network Configuration",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "host_network",
"label": "Host Network",
"description": "Bind to the host network. It's recommended to keep this disabled.\n",
"schema": {
"type": "boolean",
"default": false
}
}
]
}
},
{
"variable": "storage",
"label": "",
"group": "Storage Configuration",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "additional_storage",
"label": "Additional Storage",
"description": "Additional storage for Nginx Proxy Manager.",
"schema": {
"type": "list",
"default": [],
"items": [
{
"variable": "storageEntry",
"label": "Storage Entry",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "type",
"label": "Type",
"description": "ixVolume: Is dataset created automatically by the system.</br>\nHost Path: Is a path that already exists on the system.</br>\nSMB Share: Is a SMB share that is mounted to as a volume.\n",
"schema": {
"type": "string",
"required": true,
"default": "ix_volume",
"immutable": true,
"enum": [
{
"value": "host_path",
"description": "Host Path (Path that already exists on the system)"
},
{
"value": "ix_volume",
"description": "ixVolume (Dataset created automatically by the system)"
},
{
"value": "cifs",
"description": "SMB/CIFS Share (Mounts a volume to a SMB share)"
}
]
}
},
{
"variable": "read_only",
"label": "Read Only",
"description": "Mount the volume as read only.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"variable": "mount_path",
"label": "Mount Path",
"description": "The path inside the container to mount the storage.",
"schema": {
"type": "path",
"required": true
}
},
{
"variable": "host_path_config",
"label": "Host Path Configuration",
"schema": {
"type": "dict",
"show_if": [
[
"type",
"=",
"host_path"
]
],
"attrs": [
{
"variable": "acl_enable",
"label": "Enable ACL",
"description": "Enable ACL for the storage.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"variable": "acl",
"label": "ACL Configuration",
"schema": {
"type": "dict",
"show_if": [
[
"acl_enable",
"=",
true
]
],
"attrs": [],
"$ref": [
"normalize/acl"
]
}
},
{
"variable": "path",
"label": "Host Path",
"description": "The host path to use for storage.",
"schema": {
"type": "hostpath",
"show_if": [
[
"acl_enable",
"=",
false
]
],
"required": true
}
}
]
}
},
{
"variable": "ix_volume_config",
"label": "ixVolume Configuration",
"description": "The configuration for the ixVolume dataset.",
"schema": {
"type": "dict",
"show_if": [
[
"type",
"=",
"ix_volume"
]
],
"$ref": [
"normalize/ix_volume"
],
"attrs": [
{
"variable": "acl_enable",
"label": "Enable ACL",
"description": "Enable ACL for the storage.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"variable": "dataset_name",
"label": "Dataset Name",
"description": "The name of the dataset to use for storage.",
"schema": {
"type": "string",
"required": true,
"immutable": true,
"default": "storage_entry"
}
},
{
"variable": "acl_entries",
"label": "ACL Configuration",
"schema": {
"type": "dict",
"show_if": [
[
"acl_enable",
"=",
true
]
],
"attrs": []
}
}
]
}
},
{
"variable": "cifs_config",
"label": "SMB Configuration",
"description": "The configuration for the SMB dataset.",
"schema": {
"type": "dict",
"show_if": [
[
"type",
"=",
"cifs"
]
],
"attrs": [
{
"variable": "server",
"label": "Server",
"description": "The server to mount the SMB share.",
"schema": {
"type": "string",
"required": true
}
},
{
"variable": "path",
"label": "Path",
"description": "The path to mount the SMB share.",
"schema": {
"type": "string",
"required": true
}
},
{
"variable": "username",
"label": "Username",
"description": "The username to use for the SMB share.",
"schema": {
"type": "string",
"required": true
}
},
{
"variable": "password",
"label": "Password",
"description": "The password to use for the SMB share.",
"schema": {
"type": "string",
"required": true,
"private": true
}
},
{
"variable": "domain",
"label": "Domain",
"description": "The domain to use for the SMB share.",
"schema": {
"type": "string"
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"variable": "labels",
"label": "",
"group": "Labels Configuration",
"schema": {
"type": "list",
"default": [],
"items": [
{
"variable": "label",
"label": "Label",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "key",
"label": "Key",
"schema": {
"type": "string",
"required": true
}
},
{
"variable": "value",
"label": "Value",
"schema": {
"type": "string",
"required": true
}
},
{
"variable": "containers",
"label": "Containers",
"description": "Containers where the label should be applied",
"schema": {
"type": "list",
"items": [
{
"variable": "container",
"label": "Container",
"schema": {
"type": "string",
"required": true,
"enum": [
{
"value": "newt",
"description": "newt"
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"variable": "resources",
"label": "",
"group": "Resources Configuration",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "limits",
"label": "Limits",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "cpus",
"label": "CPUs",
"description": "CPUs limit for Newt.",
"schema": {
"type": "int",
"default": 2,
"required": true
}
},
{
"variable": "memory",
"label": "Memory (in MB)",
"description": "Memory limit for Newt.",
"schema": {
"type": "int",
"default": 4096,
"required": true
}
}
]
}
}
]
}
}
]
},
"readme": "<h1>Newt</h1> <p><a href=\"https://github.com/fosrl/newt\">Newt</a> - Newt is a fully user space WireGuard tunnel client and TCP/UDP proxy, designed to securely expose private resources controlled by Pangolin. By using Newt, you don't need to manage complex WireGuard tunnels and NATing.</p>",
"changelog": null,
"chart_metadata": {
"app_version": "1.1.3",
"capabilities": [],
"categories": [
"networking"
],
"changelog_url": "https://github.com/fosrl/newt/releases",
"date_added": "2025-05-09",
"description": "Newt is a fully user space WireGuard tunnel client and TCP/UDP proxy, designed to securely expose private resources controlled by Pangolin. By using Newt, you don't need to manage complex WireGuard tunnels and NATing.",
"home": "https://github.com/fosrl/newt",
"host_mounts": [],
"icon": "https://media.sys.truenas.net/apps/newt/icons/icon.svg",
"keywords": [
"tunneling",
"proxy",
"wireguard",
"pangolin"
],
"lib_version": "2.1.23",
"lib_version_hash": "59e54688cf43e573fe96d939c5a9e9a7ae74d5441ff00daa81fe9aa8d52249b9",
"maintainers": [
{
"email": "dev@ixsystems.com",
"name": "truenas",
"url": "https://www.truenas.com/"
}
],
"name": "newt",
"run_as_context": [
{
"description": "Newt runs as any non-root user.",
"gid": 568,
"group_name": "newt",
"uid": 568,
"user_name": "newt"
}
],
"screenshots": [],
"sources": [
"https://github.com/fosrl/newt",
"https://hub.docker.com/r/fosrl/newt"
],
"title": "Newt",
"train": "community",
"version": "1.0.1"
}
}
}
Support, maintenance, and documentation for applications within the Community catalog is handled by the TrueNAS community. The TrueNAS Applications Portal hosts but does not validate or maintain any linked resources associated with this app.
There currently aren’t any resources available for this application!
Please help the TrueNAS community add resources here or discuss this application in the TrueNAS Community forum.