XMRig
Get Started with Apps!
Keywords: monero, cryptocurrency, blockchain, privacy, mining
Train: Community
Home Page: https://xmrig.com
Added: 2026-02-19
Last Updated: 2026-02-20
A high performance, open source CPU/GPU miner.
Run as Context- Container [xmrig] runs as root user and group.
Group: 0 / Host group is [root]
User: 0 / Host user is [root]
Host Mounts
- /dev/hugepages : Hugepages device
- /dev/cpu : CPU device
App Metadata (Raw File)
{
"1.0.1": {
"healthy": true,
"supported": true,
"healthy_error": null,
"location": "/__w/apps/apps/trains/community/xmrig/1.0.1",
"last_update": "2026-02-20 08:44:04",
"required_features": [],
"human_version": "v6.25.0_1.0.1",
"version": "1.0.1",
"app_metadata": {
"app_version": "v6.25.0",
"capabilities": [],
"categories": [
"financial"
],
"changelog_url": "https://github.com/xmrig/xmrig/blob/master/CHANGELOG.md",
"date_added": "2026-02-19",
"description": "A high performance, open source CPU/GPU miner.",
"home": "https://xmrig.com",
"host_mounts": [
{
"description": "Hugepages device",
"host_path": "/dev/hugepages"
},
{
"description": "CPU device",
"host_path": "/dev/cpu"
}
],
"icon": "https://media.sys.truenas.net/apps/xmrig/icons/icon.svg",
"keywords": [
"monero",
"cryptocurrency",
"blockchain",
"privacy",
"mining"
],
"lib_version": "2.2.3",
"lib_version_hash": "b7b238e55723a15b606359bccee08d5b096f0fe93dffe876ea873e5a70b3d3a4",
"maintainers": [
{
"email": "dev@truenas.com",
"name": "truenas",
"url": "https://www.truenas.com/"
}
],
"name": "xmrig",
"run_as_context": [
{
"description": "Container [xmrig] 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://xmrig.com",
"https://github.com/xmrig/xmrig",
"https://github.com/MAGICGrants/xmrig-docker"
],
"title": "XMRig",
"train": "community",
"version": "1.0.1"
},
"schema": {
"groups": [
{
"name": "XMRig Configuration",
"description": "Configure XMRig"
},
{
"name": "Network Configuration",
"description": "Configure Network for XMRig"
},
{
"name": "Storage Configuration",
"description": "Configure Storage for XMRig"
},
{
"name": "Labels Configuration",
"description": "Configure Labels for XMRig"
},
{
"name": "Resources Configuration",
"description": "Configure Resources for XMRig"
}
],
"questions": [
{
"variable": "TZ",
"group": "XMRig Configuration",
"label": "Timezone",
"schema": {
"type": "string",
"default": "Etc/UTC",
"required": true,
"$ref": [
"definitions/timezone"
]
}
},
{
"variable": "xmrig",
"label": "",
"group": "XMRig Configuration",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "use_remote_pool",
"label": "Use Remote Pool",
"description": "Leaving this disabled will attempt to use your installed XMRig.\nIf you do not run the XMRig app, you need to specify a pool address.\n",
"schema": {
"type": "boolean",
"default": false
}
},
{
"variable": "remote_pool_address",
"label": "Pool Address",
"description": "The address of the pool you want to use. Example: pool.example.com:3333\n",
"schema": {
"type": "uri",
"required": true,
"show_if": [
[
"use_remote_pool",
"=",
true
]
]
}
},
{
"variable": "local_xmrig_port",
"label": "XMRig Port",
"description": "The port your XMRig app is listening on.",
"schema": {
"type": "int",
"min": 1,
"max": 65535,
"default": 3333,
"required": true,
"show_if": [
[
"use_remote_pool",
"=",
false
]
]
}
},
{
"variable": "pool_username",
"label": "Pool Username",
"schema": {
"type": "string",
"required": false
}
},
{
"variable": "pool_password",
"label": "Pool Password",
"schema": {
"type": "string",
"required": false,
"private": true
}
},
{
"variable": "autodetect_algorithm",
"label": "Autodetect Algorithm",
"description": "Leave this enabled if your pool supports algorithm negotiation.\nOtherwise, you need to specify an algorithm.</br>\nIf you're using the P2Pool TrueNAS app, leave this enabled.\n",
"schema": {
"type": "boolean",
"default": true
}
},
{
"variable": "algorithm",
"label": "Algorithm",
"description": "Reference: https://xmrig.com/docs/algorithms\n",
"schema": {
"type": "string",
"required": true,
"show_if": [
[
"autodetect_algorithm",
"=",
false
]
]
}
},
{
"variable": "autodetect_coin",
"label": "Autodetect Coin",
"description": "Leave this enabled if your pool supports algorithm negotiation.\nOtherwise, you need to specify a coin.</br>\nIf you're using the P2Pool TrueNAS app, leave this enabled.\n",
"schema": {
"type": "boolean",
"default": true
}
},
{
"variable": "coin",
"label": "Coin",
"description": "Reference: https://xmrig.com/docs/miner/config/pool#coin\n",
"schema": {
"type": "string",
"required": true,
"show_if": [
[
"autodetect_coin",
"=",
false
]
]
}
},
{
"variable": "cpu_threads",
"label": "CPU Threads",
"description": "The number of CPU threads to use for mining.</br>\nIMPORTANT: You need to adjust the resource limits to your needs in the Resources Configuration section.\n",
"schema": {
"type": "int",
"min": 1,
"max": 100,
"default": 1,
"required": true
}
},
{
"variable": "cpu_priority",
"label": "CPU Priority",
"description": "The priority of the XMRig process.",
"schema": {
"type": "int",
"default": 1,
"required": true,
"enum": [
{
"value": 0,
"description": "Idle"
},
{
"value": 1,
"description": "Low"
},
{
"value": 2,
"description": "Normal"
},
{
"value": 3,
"description": "High"
},
{
"value": 4,
"description": "Higher"
},
{
"value": 5,
"description": "Critical"
}
]
}
},
{
"variable": "use_1gb_huge_pages",
"label": "Use 1GB Huge Pages",
"description": "Only available for the RandomX algorithm.</br>\nThis increases the hashrate by 1-3% (depends on CPU) and increases memory requirements\nto 3GB (3 pages) per NUMA node.\n",
"schema": {
"type": "boolean",
"default": false
}
},
{
"variable": "use_msr_mod",
"label": "Use MSR Mod",
"description": "Only available for the RandomX algorithm.</br>\nEnabling this may increase the hashrate by 10-30%, but will grant XMRig privileged\naccess to the host.\n",
"schema": {
"type": "boolean",
"default": false
}
},
{
"variable": "use_proxy",
"label": "Use SOCKS5 Proxy",
"schema": {
"type": "boolean",
"default": false
}
},
{
"variable": "use_arti_app_proxy",
"label": "Use Arti App Proxy",
"description": "If you have the Arti app installed, enable this to use it as a proxy.",
"schema": {
"type": "boolean",
"default": false,
"show_if": [
[
"use_proxy",
"=",
true
]
]
}
},
{
"variable": "arti_app_proxy_port",
"label": "Arti App Proxy Port",
"schema": {
"type": "int",
"min": 1,
"max": 65535,
"default": 9150,
"required": true,
"show_if": [
[
"use_proxy",
"=",
true
],
[
"use_arti_app_proxy",
"=",
true
]
]
}
},
{
"variable": "proxy_host",
"label": "Proxy Host",
"schema": {
"type": "string",
"required": true,
"show_if": [
[
"use_proxy",
"=",
true
],
[
"use_arti_app_proxy",
"=",
false
]
]
}
},
{
"variable": "proxy_port",
"label": "Proxy Port",
"schema": {
"type": "int",
"min": 1,
"max": 65535,
"required": true,
"show_if": [
[
"use_proxy",
"=",
true
],
[
"use_arti_app_proxy",
"=",
false
]
]
}
},
{
"variable": "donate_percentage",
"label": "Donate Percentage",
"description": "The percentage of your hashrate to donate to the XMRig developers.",
"schema": {
"type": "int",
"min": 1,
"max": 100,
"default": 1,
"required": true
}
}
]
}
},
{
"variable": "network",
"label": "",
"group": "Network Configuration",
"schema": {
"type": "dict",
"attrs": [
{
"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": "xmrig",
"description": "xmrig"
}
]
}
},
{
"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\u2019s 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": "config",
"label": "Config Storage",
"description": "You can edit the xmrig.json config file directly, any options set above will always be applied, on startup.",
"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": "xmrig_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": "additional_storage",
"label": "Additional Storage",
"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.</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": [],
"$ref": [
"normalize/acl"
]
}
}
]
}
},
{
"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": "xmrig",
"description": "xmrig"
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"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 XMRig.",
"schema": {
"type": "int",
"default": 2,
"required": true
}
},
{
"variable": "memory",
"label": "Memory (in MB)",
"description": "Memory limit for XMRig.",
"schema": {
"type": "int",
"default": 4096,
"required": true
}
}
]
}
}
]
}
}
]
},
"readme": "<h1>XMRig</h1> <p><a href=\"https://xmrig.com\">XMRig</a> is a high performance, open source CPU/GPU miner.</p>",
"changelog": null,
"chart_metadata": {
"app_version": "v6.25.0",
"capabilities": [],
"categories": [
"financial"
],
"changelog_url": "https://github.com/xmrig/xmrig/blob/master/CHANGELOG.md",
"date_added": "2026-02-19",
"description": "A high performance, open source CPU/GPU miner.",
"home": "https://xmrig.com",
"host_mounts": [
{
"description": "Hugepages device",
"host_path": "/dev/hugepages"
},
{
"description": "CPU device",
"host_path": "/dev/cpu"
}
],
"icon": "https://media.sys.truenas.net/apps/xmrig/icons/icon.svg",
"keywords": [
"monero",
"cryptocurrency",
"blockchain",
"privacy",
"mining"
],
"lib_version": "2.2.3",
"lib_version_hash": "b7b238e55723a15b606359bccee08d5b096f0fe93dffe876ea873e5a70b3d3a4",
"maintainers": [
{
"email": "dev@truenas.com",
"name": "truenas",
"url": "https://www.truenas.com/"
}
],
"name": "xmrig",
"run_as_context": [
{
"description": "Container [xmrig] 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://xmrig.com",
"https://github.com/xmrig/xmrig",
"https://github.com/MAGICGrants/xmrig-docker"
],
"title": "XMRig",
"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.


