MineOS


Get Started with Apps!
Keywords: minecraft
Train: Community
Home Page: https://github.com/hexparrot/mineos-node
Added: 2024-08-02
Last Updated: 2025-04-23
MineOS is a server front-end to ease managing Minecraft administrative tasks.
Run as Context- MineOS runs as root user.
Group: 0 / root
User: 0 / root

Security Capabilities
- MineOS requires this ability to change ownership of files.
- MineOS requires this ability to bypass file permissions.
- MineOS requires this ability to bypass file permissions for it's sub-processes.
- MineOS requires this ability to switch group for sub-processes.
- MineOS requires this ability to switch user for sub-processes.
App Metadata (Raw File)
{
"1.1.10": {
"healthy": true,
"supported": true,
"healthy_error": null,
"location": "/__w/apps/apps/trains/community/mineos/1.1.10",
"last_update": "2025-04-23 17:40:39",
"required_features": [],
"human_version": "latest_1.1.10",
"version": "1.1.10",
"app_metadata": {
"app_version": "latest",
"capabilities": [
{
"description": "MineOS requires this ability to change ownership of files.",
"name": "CHOWN"
},
{
"description": "MineOS requires this ability to bypass file permissions.",
"name": "DAC_OVERRIDE"
},
{
"description": "MineOS requires this ability to bypass file permissions for it's sub-processes.",
"name": "FOWNER"
},
{
"description": "MineOS requires this ability to switch group for sub-processes.",
"name": "SETGID"
},
{
"description": "MineOS requires this ability to switch user for sub-processes.",
"name": "SETUID"
}
],
"categories": [
"games"
],
"changelog_url": "https://github.com/hexparrot/mineos-node/releases",
"date_added": "2024-08-02",
"description": "MineOS is a server front-end to ease managing Minecraft administrative tasks.",
"home": "https://github.com/hexparrot/mineos-node",
"host_mounts": [],
"icon": "https://media.sys.truenas.net/apps/mineos/icons/icon.png",
"keywords": [
"minecraft"
],
"lib_version": "2.1.16",
"lib_version_hash": "dac15686f882b9ce65b8549a3d5c0ed7bafe2df7a9028880d1a99b0ff4af1eff",
"maintainers": [
{
"email": "dev@ixsystems.com",
"name": "truenas",
"url": "https://www.truenas.com/"
}
],
"name": "mineos",
"run_as_context": [
{
"description": "MineOS runs as root user.",
"gid": 0,
"group_name": "root",
"uid": 0,
"user_name": "root"
}
],
"screenshots": [
"https://media.sys.truenas.net/apps/mineos/screenshots/screenshot1.png"
],
"sources": [
"https://hub.docker.com/r/hexparrot/mineos/",
"https://github.com/hexparrot/mineos-node"
],
"title": "MineOS",
"train": "community",
"version": "1.1.10"
},
"schema": {
"groups": [
{
"name": "MineOS Configuration",
"description": "Configure MineOS"
},
{
"name": "User and Group Configuration",
"description": "Configure User and Group for MineOS"
},
{
"name": "Network Configuration",
"description": "Configure Network for MineOS"
},
{
"name": "Storage Configuration",
"description": "Configure Storage for MineOS"
},
{
"name": "Labels Configuration",
"description": "Configure Labels for MineOS"
},
{
"name": "Resources Configuration",
"description": "Configure Resources for MineOS"
}
],
"questions": [
{
"variable": "mineos",
"label": "",
"group": "MineOS Configuration",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "username",
"label": "Username",
"description": "The username for MineOS.",
"schema": {
"type": "string",
"required": true,
"valid_chars": "^[a-zA-Z0-9]+$",
"valid_chars_error": "Username can only contain alphanumeric characters [0-9, a-z, A-Z].\n"
}
},
{
"variable": "password",
"label": "Password",
"description": "The password for MineOS.",
"schema": {
"type": "string",
"required": true,
"private": true
}
},
{
"variable": "stop_grace_period",
"label": "Stop Grace Period",
"description": "The time in seconds given to MineOS to stop before it is killed.\nKilling a MineOS server without a grace period can cause data corruption.\n",
"schema": {
"type": "int",
"min": 30,
"default": 600,
"required": true
}
},
{
"variable": "additional_envs",
"label": "Additional Environment Variables",
"description": "Configure additional environment variables for MineOS.",
"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 MineOS files will be owned by.",
"schema": {
"type": "int",
"min": 568,
"default": 568,
"required": true
}
},
{
"variable": "group",
"label": "Group ID",
"description": "The group id that MineOS 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": "web_port",
"label": "WebUI Port",
"description": "The port for MineOS WebUI",
"schema": {
"type": "int",
"default": 30052,
"required": true,
"$ref": [
"definitions/port"
]
}
},
{
"variable": "additional_ports",
"label": "Additional Ports",
"description": "Additional ports for MineOS.</br>\nEach port will be mapped to the same port on the host. </br>\nBoth TCP and UDP will be mapped.\n",
"schema": {
"type": "list",
"default": [],
"items": [
{
"variable": "port",
"label": "Port",
"schema": {
"type": "int",
"required": true,
"$ref": [
"definitions/port"
]
}
}
]
}
},
{
"variable": "use_https",
"label": "Use HTTPS",
"description": "Enable HTTPS for MineOS WebUI.</br>\nIf enabled, and you don't specify a certificate, </br>\na self-signed certificate will be generated.\n",
"schema": {
"type": "boolean",
"default": false
}
},
{
"variable": "certificate_id",
"label": "Certificate ID",
"description": "The certificate to use for MineOS WebUI",
"schema": {
"show_if": [
[
"use_https",
"=",
true
]
],
"type": "int",
"null": true,
"$ref": [
"definitions/certificate"
]
}
}
]
}
},
{
"variable": "storage",
"label": "",
"group": "Storage Configuration",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "data",
"label": "MineOS Data Storage",
"description": "The path to store MineOS Data.",
"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": "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",
"description": "Additional storage for MineOS.",
"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": "mineos",
"description": "mineos"
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"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 Mineos.",
"schema": {
"type": "int",
"default": 2,
"required": true
}
},
{
"variable": "memory",
"label": "Memory (in MB)",
"description": "Memory limit for Mineos.",
"schema": {
"type": "int",
"default": 4096,
"required": true
}
}
]
}
}
]
}
}
]
},
"readme": "<h1>MineOS</h1> <p><a href=\"https://github.com/hexparrot/mineos-node\">MineOS</a> is a server front-end to ease managing Minecraft administrative tasks.</p>",
"changelog": null,
"chart_metadata": {
"app_version": "latest",
"capabilities": [
{
"description": "MineOS requires this ability to change ownership of files.",
"name": "CHOWN"
},
{
"description": "MineOS requires this ability to bypass file permissions.",
"name": "DAC_OVERRIDE"
},
{
"description": "MineOS requires this ability to bypass file permissions for it's sub-processes.",
"name": "FOWNER"
},
{
"description": "MineOS requires this ability to switch group for sub-processes.",
"name": "SETGID"
},
{
"description": "MineOS requires this ability to switch user for sub-processes.",
"name": "SETUID"
}
],
"categories": [
"games"
],
"changelog_url": "https://github.com/hexparrot/mineos-node/releases",
"date_added": "2024-08-02",
"description": "MineOS is a server front-end to ease managing Minecraft administrative tasks.",
"home": "https://github.com/hexparrot/mineos-node",
"host_mounts": [],
"icon": "https://media.sys.truenas.net/apps/mineos/icons/icon.png",
"keywords": [
"minecraft"
],
"lib_version": "2.1.16",
"lib_version_hash": "dac15686f882b9ce65b8549a3d5c0ed7bafe2df7a9028880d1a99b0ff4af1eff",
"maintainers": [
{
"email": "dev@ixsystems.com",
"name": "truenas",
"url": "https://www.truenas.com/"
}
],
"name": "mineos",
"run_as_context": [
{
"description": "MineOS runs as root user.",
"gid": 0,
"group_name": "root",
"uid": 0,
"user_name": "root"
}
],
"screenshots": [
"https://media.sys.truenas.net/apps/mineos/screenshots/screenshot1.png"
],
"sources": [
"https://hub.docker.com/r/hexparrot/mineos/",
"https://github.com/hexparrot/mineos-node"
],
"title": "MineOS",
"train": "community",
"version": "1.1.10"
}
}
}
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.