Portainer Agent
Portainer Agent
Get Started with Apps!
Get Started with Apps!
App Version:
2.45.3
(Changelog)
Keywords: docker, compose, container
Train: Community
Home Page: https://www.portainer.io
Keywords: docker, compose, container
Train: Community
Home Page: https://www.portainer.io
Portainer Agent Details
Added: 2026-10-26
Last Updated: 2026-10-26
Added: 2026-10-26
Last Updated: 2026-10-26
Agent that allows a Portainer Server to manage this Docker host
Run as Context- Container [portainer-agent] runs as root user and group.
Group: 0 / Host group is [root]
User: 0 / Host user is [root]
×
![Full Screenshot]()
Host Mounts
- /var/run/docker.sock : Docker socket
App Metadata (Raw File)
{
"1.0.1": {
"healthy": true,
"supported": true,
"healthy_error": null,
"location": "/__w/apps/apps/trains/community/portainer-agent/1.0.1",
"last_update": "2026-10-26 18:02:25",
"required_features": [],
"human_version": "2.45.3_1.0.1",
"version": "1.0.1",
"app_metadata": {
"app_version": "2.45.3",
"capabilities": [],
"categories": [
"management"
],
"changelog_url": "https://github.com/portainer/portainer/releases",
"date_added": "2026-10-26",
"description": "Agent that allows a Portainer Server to manage this Docker host",
"home": "https://www.portainer.io",
"host_mounts": [
{
"description": "Docker socket",
"host_path": "/var/run/docker.sock"
}
],
"icon": "https://media.sys.truenas.net/apps/portainer-agent/icons/icon.png",
"keywords": [
"docker",
"compose",
"container"
],
"lib_version": "2.3.17",
"lib_version_hash": "b02a8040f1971a601638300b595bbd5b72f0664ba13fdf7759c212867caeed24",
"maintainers": [
{
"email": "dev@truenas.com",
"name": "truenas",
"url": "https://www.truenas.com/"
}
],
"name": "portainer-agent",
"run_as_context": [
{
"description": "Container [portainer-agent] runs as root user and group.",
"gid": 0,
"group_name": "Host group is [root]",
"uid": 0,
"user_name": "Host user is [root]"
}
],
"screenshots": [],
"sources": [
"https://apps.truenas.com/catalog/portainer-agent_community/",
"https://docs.portainer.io/admin/environments/add/docker/agent",
"https://docs.portainer.io/admin/environments/add/docker/edge",
"https://github.com/portainer/agent",
"https://hub.docker.com/r/portainer/agent"
],
"title": "Portainer Agent",
"train": "community",
"version": "1.0.1"
},
"schema": {
"groups": [
{
"name": "Portainer Agent Configuration",
"description": "Configure Portainer Agent"
},
{
"name": "Network Configuration",
"description": "Configure Network for Portainer Agent"
},
{
"name": "Storage Configuration",
"description": "Configure Storage for Portainer Agent"
},
{
"name": "Labels Configuration",
"description": "Configure Labels for Portainer Agent"
},
{
"name": "Resources Configuration",
"description": "Configure Resources for Portainer Agent"
}
],
"questions": [
{
"variable": "portainer_agent",
"label": "",
"group": "Portainer Agent Configuration",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "mode",
"label": "Mode",
"description": "How the Portainer Server connects to this agent.</br>\n- Agent: The Portainer Server connects to the agent port.</br>\n- Edge Agent Standard: The agent connects out to the Portainer Server, the agent port is not used.</br>\n- Edge Agent Async: Like Standard, but the agent only polls the Portainer Server for changes. Requires Portainer Business Edition.\n",
"schema": {
"type": "string",
"default": "agent",
"required": true,
"enum": [
{
"value": "agent",
"description": "Agent"
},
{
"value": "edge",
"description": "Edge Agent Standard"
},
{
"value": "edge_async",
"description": "Edge Agent Async"
}
]
}
},
{
"variable": "agent_secret",
"label": "Agent Secret",
"description": "The shared secret used to secure the connection to the Portainer Server.</br>\nOnly required if the Portainer Server is configured with a custom AGENT_SECRET.\n",
"schema": {
"type": "string",
"default": "",
"private": true
}
},
{
"variable": "edge",
"label": "Edge Configuration",
"description": "Create an Edge Agent environment in Portainer to get the Edge ID and Edge Key.",
"schema": {
"type": "dict",
"show_if": [
[
"mode",
"!=",
"agent"
]
],
"attrs": [
{
"variable": "id",
"label": "Edge ID",
"description": "The Edge ID from the Portainer Server.",
"schema": {
"type": "string",
"default": "",
"required": true
}
},
{
"variable": "key",
"label": "Edge Key",
"description": "The Edge Key from the Portainer Server.",
"schema": {
"type": "string",
"default": "",
"required": true,
"private": true
}
},
{
"variable": "insecure_poll",
"label": "Allow Self-Signed Certificates",
"description": "Enable if the Portainer Server uses a self-signed certificate.",
"schema": {
"type": "boolean",
"default": false
}
}
]
}
},
{
"variable": "additional_envs",
"label": "Additional Environment Variables",
"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"
}
}
]
}
}
]
}
}
]
}
},
{
"variable": "network",
"label": "",
"group": "Network Configuration",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "agent_port",
"label": "Agent Port",
"description": "The port the Portainer Server uses to reach this agent.</br>\nOnly used in Agent mode.\n",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "bind_mode",
"label": "Port Bind Mode",
"description": "The port bind mode.</br>\n- Publish: The port will be published on the host for external access.</br>\n- Expose: The port will be exposed for inter-container communication.</br>\n- None: The port will not be exposed or published.</br>\nNote: If the Dockerfile defines an EXPOSE directive,\nthe port will still be exposed for inter-container communication regardless of this setting.\n",
"schema": {
"type": "string",
"default": "published",
"enum": [
{
"value": "published",
"description": "Publish port on the host for external access"
},
{
"value": "exposed",
"description": "Expose port for inter-container communication"
},
{
"value": "",
"description": "None"
}
]
}
},
{
"variable": "port_number",
"label": "Port Number",
"schema": {
"type": "int",
"default": 30538,
"min": 1,
"max": 65535,
"required": true
}
},
{
"variable": "host_ips",
"label": "Host IPs",
"description": "IPs on the host to bind this port",
"schema": {
"type": "list",
"show_if": [
[
"bind_mode",
"=",
"published"
]
],
"default": [],
"items": [
{
"variable": "host_ip",
"label": "Host IP",
"schema": {
"type": "string",
"required": true,
"$ref": [
"definitions/node_bind_ip"
]
}
}
]
}
}
]
}
},
{
"variable": "networks",
"label": "Networks",
"description": "The docker networks to join",
"schema": {
"type": "list",
"show_if": [
[
"host_network",
"=",
false
]
],
"default": [],
"items": [
{
"variable": "network",
"label": "Network",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "name",
"label": "Name",
"description": "The name of the network to join.</br>\nThe network must already exist.\n",
"schema": {
"type": "string",
"default": "",
"required": true
}
},
{
"variable": "containers",
"label": "Containers",
"description": "The containers to add to this network.",
"schema": {
"type": "list",
"items": [
{
"variable": "container",
"label": "Container",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "name",
"label": "Container Name",
"schema": {
"type": "string",
"required": true,
"enum": [
{
"value": "portainer-agent",
"description": "portainer-agent"
}
]
}
},
{
"variable": "config",
"label": "Container Network Configuration",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "aliases",
"label": "Aliases (Optional)",
"description": "The network aliases to use for this container on this network.",
"schema": {
"type": "list",
"default": [],
"items": [
{
"variable": "alias",
"label": "Alias",
"schema": {
"type": "string"
}
}
]
}
},
{
"variable": "interface_name",
"label": "Interface Name (Optional)",
"description": "The network interface name to use for this network",
"schema": {
"type": "string"
}
},
{
"variable": "mac_address",
"label": "MAC Address (Optional)",
"description": "The MAC address to use for this network interface.",
"schema": {
"type": "string"
}
},
{
"variable": "ipv4_address",
"label": "IPv4 Address (Optional)",
"description": "The IPv4 address to use for this network interface.",
"schema": {
"type": "string"
}
},
{
"variable": "ipv6_address",
"label": "IPv6 Address (Optional)",
"description": "The IPv6 address to use for this network interface.",
"schema": {
"type": "string"
}
},
{
"variable": "gw_priority",
"label": "Gateway Priority (Optional)",
"description": "Indicates the priority of the gateway for this network interface.",
"schema": {
"type": "int",
"null": true
}
},
{
"variable": "priority",
"label": "Priority (Optional)",
"description": "Indicates in which order Compose connects the service's containers to its networks.",
"schema": {
"type": "int",
"null": true
}
}
]
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"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": "data",
"label": "Data Storage",
"description": "The path to store Portainer Agent data, such as the Edge Key.",
"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.\n",
"schema": {
"type": "string",
"required": true,
"default": "ix_volume",
"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)"
}
]
}
},
{
"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,
"hidden": true,
"default": "data"
}
},
{
"variable": "acl_entries",
"label": "ACL Configuration",
"schema": {
"type": "dict",
"show_if": [
[
"acl_enable",
"=",
true
]
],
"attrs": []
}
}
]
}
},
{
"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": "additional_storage",
"label": "Additional Storage",
"schema": {
"type": "list",
"default": [],
"items": [
{
"variable": "storage_entry",
"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.</br>\nNFS Share: Is a NFS share that is mounted to as a volume.\n",
"schema": {
"type": "string",
"required": true,
"default": "ix_volume",
"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)"
},
{
"value": "nfs",
"description": "NFS Share (Mounts a volume to a NFS 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,
"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": "nfs_config",
"label": "NFS Configuration",
"description": "The configuration for the NFS dataset.",
"schema": {
"type": "dict",
"show_if": [
[
"type",
"=",
"nfs"
]
],
"attrs": [
{
"variable": "server",
"label": "Server",
"description": "The server to mount the NFS share.",
"schema": {
"type": "string",
"required": true
}
},
{
"variable": "path",
"label": "Path",
"description": "The path to mount the NFS share.",
"schema": {
"type": "string",
"required": true
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"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": "portainer-agent",
"description": "portainer-agent"
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"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 Portainer Agent.",
"schema": {
"type": "int",
"default": 2,
"required": true
}
},
{
"variable": "memory",
"label": "Memory (in MB)",
"description": "Memory limit for Portainer Agent.",
"schema": {
"type": "int",
"default": 4096,
"required": true
}
}
]
}
}
]
}
}
]
},
"readme": "<h1>Portainer Agent</h1> <p>The <a href=\"https://github.com/portainer/agent\">Portainer Agent</a> lets a Portainer Server manage the Docker host it runs on.</p>",
"changelog": null,
"chart_metadata": {
"app_version": "2.45.3",
"capabilities": [],
"categories": [
"management"
],
"changelog_url": "https://github.com/portainer/portainer/releases",
"date_added": "2026-10-26",
"description": "Agent that allows a Portainer Server to manage this Docker host",
"home": "https://www.portainer.io",
"host_mounts": [
{
"description": "Docker socket",
"host_path": "/var/run/docker.sock"
}
],
"icon": "https://media.sys.truenas.net/apps/portainer-agent/icons/icon.png",
"keywords": [
"docker",
"compose",
"container"
],
"lib_version": "2.3.17",
"lib_version_hash": "b02a8040f1971a601638300b595bbd5b72f0664ba13fdf7759c212867caeed24",
"maintainers": [
{
"email": "dev@truenas.com",
"name": "truenas",
"url": "https://www.truenas.com/"
}
],
"name": "portainer-agent",
"run_as_context": [
{
"description": "Container [portainer-agent] runs as root user and group.",
"gid": 0,
"group_name": "Host group is [root]",
"uid": 0,
"user_name": "Host user is [root]"
}
],
"screenshots": [],
"sources": [
"https://apps.truenas.com/catalog/portainer-agent_community/",
"https://docs.portainer.io/admin/environments/add/docker/agent",
"https://docs.portainer.io/admin/environments/add/docker/edge",
"https://github.com/portainer/agent",
"https://hub.docker.com/r/portainer/agent"
],
"title": "Portainer Agent",
"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 Market 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.