Netboot.xyz
Netboot.xyz
Get Started with Apps!
Get Started with Apps!
App Version: 0.7.5
(Changelog)
Keywords: tftp, network, pxe, netboot, netbootxyz, netboot.xyz
Train: Community
Home Page: https://netboot.xyz
Keywords: tftp, network, pxe, netboot, netbootxyz, netboot.xyz
Train: Community
Home Page: https://netboot.xyz
Netboot.xyz Details
Added: 2024-08-02
Last Updated: 2025-05-12
Added: 2024-08-02
Last Updated: 2025-05-12
netboot.xyz lets you PXE boot various operating system installers or utilities from a single tool over the network.
Run as Context- Netboot.xyz runs as root user.
Group: 0 / root
User: 0 / root
Screenshots
×
![Full Screenshot]()
Security Capabilities
- TFTP requires this ability to set permissions for sub-processes.
- TFTP requires this ability to set permissions for sub-processes.
- TFTP requires this ability to set permissions for sub-processes.
- TFTP requires this ability to switch user for sub-processes.
- TFTP requires this ability to switch group for sub-processes.
- TFTP requires this ability to spawn child processes.
- TFTP requires this ability to bind to port 69 for TFTP.
- TFTP requires this ability to kill sub-processes.
App Metadata (Raw File)
{
"1.1.13": {
"healthy": true,
"supported": true,
"healthy_error": null,
"location": "/__w/apps/apps/trains/community/netbootxyz/1.1.13",
"last_update": "2025-05-12 13:53:28",
"required_features": [],
"human_version": "0.7.5_1.1.13",
"version": "1.1.13",
"app_metadata": {
"app_version": "0.7.5",
"capabilities": [
{
"description": "TFTP requires this ability to set permissions for sub-processes.",
"name": "CHOWN"
},
{
"description": "TFTP requires this ability to set permissions for sub-processes.",
"name": "DAC_OVERRIDE"
},
{
"description": "TFTP requires this ability to set permissions for sub-processes.",
"name": "FOWNER"
},
{
"description": "TFTP requires this ability to switch user for sub-processes.",
"name": "SETUID"
},
{
"description": "TFTP requires this ability to switch group for sub-processes.",
"name": "SETGID"
},
{
"description": "TFTP requires this ability to spawn child processes.",
"name": "SYS_CHROOT"
},
{
"description": "TFTP requires this ability to bind to port 69 for TFTP.",
"name": "NET_BIND_SERVICE"
},
{
"description": "TFTP requires this ability to kill sub-processes.",
"name": "KILL"
}
],
"categories": [
"networking"
],
"changelog_url": "https://github.com/netbootxyz/docker-netbootxyz/tags",
"date_added": "2024-08-02",
"description": "netboot.xyz lets you PXE boot various operating system installers or utilities from a single tool over the network.",
"home": "https://netboot.xyz",
"host_mounts": [],
"icon": "https://media.sys.truenas.net/apps/netbootxyz/icons/icon.png",
"keywords": [
"tftp",
"network",
"pxe",
"netboot",
"netbootxyz",
"netboot.xyz"
],
"lib_version": "2.1.16",
"lib_version_hash": "dac15686f882b9ce65b8549a3d5c0ed7bafe2df7a9028880d1a99b0ff4af1eff",
"maintainers": [
{
"email": "dev@ixsystems.com",
"name": "truenas",
"url": "https://www.truenas.com/"
}
],
"name": "netbootxyz",
"run_as_context": [
{
"description": "Netboot.xyz runs as root user.",
"gid": 0,
"group_name": "root",
"uid": 0,
"user_name": "root"
}
],
"screenshots": [
"https://media.sys.truenas.net/apps/netbootxyz/screenshots/screenshot1.jpg"
],
"sources": [
"https://github.com/netbootxyz/docker-netbootxyz",
"https://netboot.xyz"
],
"title": "Netboot.xyz",
"train": "community",
"version": "1.1.13"
},
"schema": {
"groups": [
{
"name": "Netboot.xyz Configuration",
"description": "Configure Netboot.xyz"
},
{
"name": "User and Group Configuration",
"description": "Configure User and Group for Netboot.xyz"
},
{
"name": "Network Configuration",
"description": "Configure Network for Netboot.xyz"
},
{
"name": "Storage Configuration",
"description": "Configure Storage for Netboot.xyz"
},
{
"name": "Labels Configuration",
"description": "Configure Labels for Netboot.xyz"
},
{
"name": "Resources Configuration",
"description": "Configure Resources for Netboot.xyz"
}
],
"questions": [
{
"variable": "TZ",
"group": "Netboot.xyz Configuration",
"label": "Timezone",
"schema": {
"type": "string",
"default": "Etc/UTC",
"required": true,
"$ref": [
"definitions/timezone"
]
}
},
{
"variable": "netbootxyz",
"label": "",
"group": "Netboot.xyz Configuration",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "tftpd_opts",
"label": "TFTPD Options",
"description": "Additional options for the TFTPD service.",
"schema": {
"type": "list",
"default": [],
"items": [
{
"variable": "opt",
"label": "Option",
"schema": {
"type": "string",
"required": true
}
}
]
}
},
{
"variable": "additional_envs",
"label": "Additional Environment Variables",
"description": "Configure additional environment variables for Netboot.xyz.",
"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 Netboot.xyz files will be owned by.",
"schema": {
"type": "int",
"min": 568,
"default": 568,
"required": true
}
},
{
"variable": "group",
"label": "Group ID",
"description": "The group id that Netboot.xyz 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": "tftp_port",
"label": "TFTP Port",
"description": "The TFTP port for netboot.xyz.",
"schema": {
"type": "int",
"default": 31009,
"required": true,
"show_if": [
[
"host_network",
"=",
false
]
],
"$ref": [
"definitions/port"
]
}
},
{
"variable": "web_http_port",
"label": "Web HTTP Port",
"description": "The HTTP port for the netboot.xyz Portal.",
"schema": {
"type": "int",
"default": 31010,
"required": true,
"$ref": [
"definitions/port"
]
}
},
{
"variable": "web_assets_port",
"label": "Web Assets Port",
"description": "The Assets port for the netboot.xyz, configures the NGINX_PORT variable on the container.",
"schema": {
"type": "int",
"default": 31011,
"required": true,
"$ref": [
"definitions/port"
]
}
},
{
"variable": "host_network",
"label": "Host Network",
"description": "Bind to the host network. It's recommended to keep this disabled.\n",
"schema": {
"type": "boolean",
"default": true
}
}
]
}
},
{
"variable": "storage",
"label": "",
"group": "Storage Configuration",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "config",
"label": "Netboot.xyz Config Storage",
"description": "The path to store Netboot.xyz Config.",
"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,
"immutable": 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,
"immutable": true,
"hidden": true,
"default": "config"
}
},
{
"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": "assets",
"label": "Netboot.xyz Assets Storage",
"description": "The path to store Netboot.xyz Assets.",
"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,
"immutable": 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,
"immutable": true,
"hidden": true,
"default": "assets"
}
},
{
"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",
"description": "Additional storage for Netboot.xyz.",
"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": "netboot",
"description": "netboot"
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"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 Netboot.xyz.",
"schema": {
"type": "int",
"default": 2,
"required": true
}
},
{
"variable": "memory",
"label": "Memory (in MB)",
"description": "Memory limit for Netboot.xyz.",
"schema": {
"type": "int",
"default": 4096,
"required": true
}
}
]
}
}
]
}
}
]
},
"readme": "<h1>Netboot.xyz</h1> <p><a href=\"https://netboot.xyz\">netboot.xyz</a> lets you PXE boot various operating system installers or utilities from a single tool over the network.</p>",
"changelog": null,
"chart_metadata": {
"app_version": "0.7.5",
"capabilities": [
{
"description": "TFTP requires this ability to set permissions for sub-processes.",
"name": "CHOWN"
},
{
"description": "TFTP requires this ability to set permissions for sub-processes.",
"name": "DAC_OVERRIDE"
},
{
"description": "TFTP requires this ability to set permissions for sub-processes.",
"name": "FOWNER"
},
{
"description": "TFTP requires this ability to switch user for sub-processes.",
"name": "SETUID"
},
{
"description": "TFTP requires this ability to switch group for sub-processes.",
"name": "SETGID"
},
{
"description": "TFTP requires this ability to spawn child processes.",
"name": "SYS_CHROOT"
},
{
"description": "TFTP requires this ability to bind to port 69 for TFTP.",
"name": "NET_BIND_SERVICE"
},
{
"description": "TFTP requires this ability to kill sub-processes.",
"name": "KILL"
}
],
"categories": [
"networking"
],
"changelog_url": "https://github.com/netbootxyz/docker-netbootxyz/tags",
"date_added": "2024-08-02",
"description": "netboot.xyz lets you PXE boot various operating system installers or utilities from a single tool over the network.",
"home": "https://netboot.xyz",
"host_mounts": [],
"icon": "https://media.sys.truenas.net/apps/netbootxyz/icons/icon.png",
"keywords": [
"tftp",
"network",
"pxe",
"netboot",
"netbootxyz",
"netboot.xyz"
],
"lib_version": "2.1.16",
"lib_version_hash": "dac15686f882b9ce65b8549a3d5c0ed7bafe2df7a9028880d1a99b0ff4af1eff",
"maintainers": [
{
"email": "dev@ixsystems.com",
"name": "truenas",
"url": "https://www.truenas.com/"
}
],
"name": "netbootxyz",
"run_as_context": [
{
"description": "Netboot.xyz runs as root user.",
"gid": 0,
"group_name": "root",
"uid": 0,
"user_name": "root"
}
],
"screenshots": [
"https://media.sys.truenas.net/apps/netbootxyz/screenshots/screenshot1.jpg"
],
"sources": [
"https://github.com/netbootxyz/docker-netbootxyz",
"https://netboot.xyz"
],
"title": "Netboot.xyz",
"train": "community",
"version": "1.1.13"
}
}
}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 create content or discuss this application in the TrueNAS Community forum.