Electrs
Electrs
Get Started with Apps!
Get Started with Apps!
App Version: 0.10.9
(Changelog)
Keywords: bitcoin, electrum, cryptocurrency, blockchain
Train: Community
Home Page: https://github.com/romanz/electrs/
Keywords: bitcoin, electrum, cryptocurrency, blockchain
Train: Community
Home Page: https://github.com/romanz/electrs/
Electrs Details
Added: 2025-04-24
Last Updated: 2025-05-07
Added: 2025-04-24
Last Updated: 2025-05-07
An efficient re-implementation of Electrum Server in Rust.
Run as Context- Electrs runs as non-root user.
Group: 1000 / electrs
User: 1000 / electrs
×
![Full Screenshot]()
App Metadata (Raw File)
{
"1.0.1": {
"healthy": true,
"supported": true,
"healthy_error": null,
"location": "/__w/apps/apps/trains/community/electrs/1.0.1",
"last_update": "2025-05-07 17:49:39",
"required_features": [],
"human_version": "0.10.9_1.0.1",
"version": "1.0.1",
"app_metadata": {
"app_version": "0.10.9",
"capabilities": [],
"categories": [
"financial"
],
"changelog_url": "https://github.com/romanz/electrs/blob/master/RELEASE-NOTES.md",
"date_added": "2025-04-24",
"description": "An efficient re-implementation of Electrum Server in Rust.",
"home": "https://github.com/romanz/electrs/",
"host_mounts": [],
"icon": "https://media.sys.truenas.net/apps/electrs/icons/icon.svg",
"keywords": [
"bitcoin",
"electrum",
"cryptocurrency",
"blockchain"
],
"lib_version": "2.1.17",
"lib_version_hash": "fac0bd3f679320fc7366687de39b822c1c53241b4aa0cb85080d6d6843322154",
"maintainers": [
{
"email": "dev@ixsystems.com",
"name": "truenas",
"url": "https://www.truenas.com/"
}
],
"name": "electrs",
"run_as_context": [
{
"description": "Electrs runs as non-root user.",
"gid": 1000,
"group_name": "electrs",
"uid": 1000,
"user_name": "electrs"
}
],
"screenshots": [],
"sources": [
"https://github.com/romanz/electrs",
"https://github.com/getumbrel/docker-electrs"
],
"title": "Electrs",
"train": "community",
"version": "1.0.1"
},
"schema": {
"groups": [
{
"name": "Electrs Configuration",
"description": "Configure Electrs"
},
{
"name": "Network Configuration",
"description": "Configure Network for Electrs"
},
{
"name": "Storage Configuration",
"description": "Configure Storage for Electrs"
},
{
"name": "Labels Configuration",
"description": "Configure Labels for Electrs"
},
{
"name": "Resources Configuration",
"description": "Configure Resources for Electrs"
}
],
"questions": [
{
"variable": "TZ",
"group": "Electrs Configuration",
"label": "Timezone",
"schema": {
"type": "string",
"default": "Etc/UTC",
"required": true,
"$ref": [
"definitions/timezone"
]
}
},
{
"variable": "electrs",
"label": "",
"group": "Electrs Configuration",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "use_installed_bitcoin_app",
"label": "Connect to Installed Bitcoin Node App",
"description": "Enabling this option will attempt to connect to the installed Bitcoin Node TrueNAS app.\nElectrs won't work if your node is pruned.\n",
"schema": {
"type": "boolean",
"default": true
}
},
{
"variable": "external_bitcoind_ip",
"label": "External Bitcoin Node RPC IP",
"schema": {
"type": "ipaddr",
"required": true,
"show_if": [
[
"use_installed_bitcoin_app",
"=",
false
]
]
}
},
{
"variable": "bitcoind_p2p_port",
"label": "Bitcoin Node P2P Port",
"schema": {
"type": "int",
"min": 1,
"max": 65535,
"default": 8333,
"required": true
}
},
{
"variable": "bitcoind_rpc_port",
"label": "Bitcoin Node RPC Port",
"schema": {
"type": "int",
"min": 1,
"max": 65535,
"default": 8332,
"required": true
}
},
{
"variable": "bitcoind_rpc_user",
"label": "Bitcoin Node RPC User",
"schema": {
"type": "string",
"default": "truenas",
"required": true
}
},
{
"variable": "bitcoind_rpc_password",
"label": "Bitcoin Node RPC Password",
"schema": {
"type": "string",
"required": true
}
},
{
"variable": "additional_flags",
"label": "Additional flags",
"description": "Additional commands can be provided here.\nIf you are unsure, leave this blank.\n",
"schema": {
"type": "list",
"items": [
{
"variable": "flag",
"label": "Flag",
"schema": {
"type": "string",
"required": true
}
}
]
}
}
]
}
},
{
"variable": "network",
"label": "",
"group": "Network Configuration",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "rpc_port",
"label": "RPC Port",
"description": "This port can be used by other apps to communicate with Electrs.\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": 50001,
"required": true,
"$ref": [
"definitions/port"
]
}
},
{
"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": "storage",
"label": "",
"group": "Storage Configuration",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "data",
"label": "Electrs Data Storage Location",
"description": "We recommend at least 70GB of free space.\n",
"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 Electrs.",
"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": [],
"$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": "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": "electrs",
"description": "electrs"
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"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 Electrs.",
"schema": {
"type": "int",
"default": 2,
"required": true
}
},
{
"variable": "memory",
"label": "Memory (in MB)",
"description": "Memory limit for Electrs.",
"schema": {
"type": "int",
"default": 4096,
"required": true
}
}
]
}
}
]
}
}
]
},
"readme": "<h1>Electrs</h1> <p><a href=\"https://github.com/romanz/electrs\">Electrs</a> is an efficient re-implementation of Electrum Server in Rust.</p>",
"changelog": null,
"chart_metadata": {
"app_version": "0.10.9",
"capabilities": [],
"categories": [
"financial"
],
"changelog_url": "https://github.com/romanz/electrs/blob/master/RELEASE-NOTES.md",
"date_added": "2025-04-24",
"description": "An efficient re-implementation of Electrum Server in Rust.",
"home": "https://github.com/romanz/electrs/",
"host_mounts": [],
"icon": "https://media.sys.truenas.net/apps/electrs/icons/icon.svg",
"keywords": [
"bitcoin",
"electrum",
"cryptocurrency",
"blockchain"
],
"lib_version": "2.1.17",
"lib_version_hash": "fac0bd3f679320fc7366687de39b822c1c53241b4aa0cb85080d6d6843322154",
"maintainers": [
{
"email": "dev@ixsystems.com",
"name": "truenas",
"url": "https://www.truenas.com/"
}
],
"name": "electrs",
"run_as_context": [
{
"description": "Electrs runs as non-root user.",
"gid": 1000,
"group_name": "electrs",
"uid": 1000,
"user_name": "electrs"
}
],
"screenshots": [],
"sources": [
"https://github.com/romanz/electrs",
"https://github.com/getumbrel/docker-electrs"
],
"title": "Electrs",
"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 create content or discuss this application in the TrueNAS Community forum.