manifest.yaml

id: electrs
title: "electrs"
version: 0.10.5
release-notes: |
  * Update upstream electrs to [v0.10.5](https://github.com/romanz/electrs/blob/master/RELEASE-NOTES.md#0105-may-18-2024)
  * Bump allowable Bitcoin Core version range
  * Update Rust base
license: mit
wrapper-repo: "https://github.com/Start9Labs/electrs-startos"
upstream-repo: "https://github.com/romanz/electrs"
support-site: "https://github.com/romanz/electrs/issues"
marketing-site: "https://github.com/romanz/electrs"
build: ["make"]
description:
  short: An efficient re-implementation of Electrum Server in Rust
  long: |
    An efficient re-implementation of Electrum Server, inspired by ElectrumX, Electrum Personal Server and bitcoincore-indexd. The motivation behind this project is to enable a user to self host an Electrum server, with required hardware resources not much beyond those of a full node. The server indexes the entire Bitcoin blockchain, and the resulting index enables fast queries for any given user wallet, allowing the user to keep real-time track of balances and transaction history using the Electrum wallet. Since it runs on the users own machine, there is no need for the wallet to communicate with external Electrum servers, thus preserving the privacy of the users addresses and balances.
assets:
  license: LICENSE
  icon: icon.png
  instructions: instructions.md
main:
  type: docker
  image: main
  entrypoint: "docker_entrypoint.sh"
  args: []
  mounts:
    main: /data
health-checks:
  electrum:
    name: Electrum RPC Interface
    success-message: The electrum RPC interface is alive and responding to basic commands.
    type: docker
    image: main
    entrypoint: "check-electrum.sh"
    args: []
    inject: true
    system: false
    io-format: json
  synced:
    name: Sync Status
    success-message: The indexes are built and the electrum interface is fully operational. You may now connect a wallet.
    type: docker
    image: main
    entrypoint: "check-synced.sh"
    args: []
    inject: true
    system: false
    io-format: json
config:
  get:
    type: script
  set:
    type: script
properties:
  type: script
volumes:
  main:
    type: data
interfaces:
  electrum:
    name: Electrum Interface
    description: Do not use the URL below.  Instead, look in electrs' Properties section for your electrum server address.
    tor-config:
      port-mapping:
        50001: "50001"
    # lan-config:
    #   443:
    #     ssl: true
    #     internal: 50001
    ui: false
    protocols:
      - tcp
      - json-rpc
alerts:
  install: "INSTABILITY WARNING: Electrs uses up to 1GB of RAM when syncing. Please make sure you have at least this much free RAM before starting Electrs, or you will cause your system to become unresponsive! This is especially risky if running alongside services that consume a lot of RAM on a 4GB system!"
  start: "INSTABILITY WARNING: Electrs uses up to 1GB of RAM when syncing. Please make sure you have at least this much free RAM before starting Electrs, or you will cause your system to become unresponsive! This is especially risky if running alongside services that consume a lot of RAM on a 4GB system!"
dependencies:
  bitcoind:
    version: ">=0.21.1.2 <29.0.0"
    requirement:
      type: "required"
    description: Needed for peer interface and rpc interface.
    config:
      check:
        type: script
      auto-configure:
        type: script
backup:
  create:
    type: script
  restore:
    type: script
migrations:
  from:
    "*":
      type: script
      args: ["from"]
  to:
    "*":
      type: script
      args: ["to"]