manifest.yaml

id: monerod
title: "Monero"
version: 0.18.3.4
release-notes: |
  * Update to latest upstream [sethforprivacy Monero docker image](https://github.com/sethforprivacy/simple-monerod-docker)
  * Includes Monero 0.18.3.4 ([Release Notes](https://github.com/monero-project/monero/releases/tag/v0.18.3.4))
  * Add features to monero-startos: expose daemon rpc interface, monero-wallet-rpc, (optional rpc credentials for both), and zmq interfaces
  * If Monero gets stuck in a "Stopping..." state, please restart your server via System > Restart
license: BSD-3
wrapper-repo: https://github.com/kn0wmad/monerod-startos
upstream-repo: https://github.com/monero-project/monero
support-site: https://github.com/monero-project/monero
marketing-site: https://getmonero.org
build: ["make"]
description:
  short: A Monero Full Node
  long: Monero is a private, secure, untraceable, decentralised digital currency. You are your bank, you control your funds, and nobody can trace your transfers unless you allow them to do so.  This is a headless (no GUI) server, used via an external Monero wallet of your choice over LAN or Tor.
assets:
  license: LICENSE
  icon: icon.png
  instructions: docs/instructions.md
main:
  type: docker
  image: main
  entrypoint: "tini"
  args: ["-p", "SIGTERM", "-g", "--", "docker_entrypoint.sh"]
  mounts:
    main: /data/.bitmonero
  io-format: yaml
health-checks:
  rpc-api:
    name: RPC Interface
    success-message: Monero RPC is ready and accepting requests
    type: docker
    image: main
    entrypoint: check-rpc.sh
    args: []
    io-format: json
    inject: true
    system: false
  sync:
    name: Sync Status
    success-message: Blockchain is synced
    type: docker
    image: main
    entrypoint: check-sync.sh
    args: []
    io-format: json
    inject: true
    system: false
config:
  get:
    type: script
  set:
    type: script
dependencies: {}
volumes:
  main:
    type: data
interfaces:
  peer:
    name: Peer Interface
    #description: Listens for incoming connections from peers on the Monero network
    description: Do not use the URL below.  Instead, look in Monero's Properties section for your interface addresses.
    tor-config:
      port-mapping:
        18080: "18080"
    ui: false
    protocols:
      - tcp
      - monero
  rpc-restricted:
    name: RPC Interface
    #description: Listens for JSON-RPC commands
    description: Do not use the URL below.  Instead, look in Monero's Properties section for your interface addresses.
    tor-config:
      port-mapping:
        18089: "18089"
    lan-config:
      443:
        ssl: true
        internal: 18089
    ui: false
    protocols:
      - tcp
      - http
      - json-rpc
  rpc-wallet:
    name: Wallet RPC Interface
    #description: Listens for JSON-RPC commands
    description: Do not use the URL below.  Instead, look in Monero's Properties section for your interface addresses.
    tor-config:
      port-mapping:
        28088: "28088"
    lan-config:
      28088:
        ssl: true
        internal: 28088
    ui: false
    protocols:
      - tcp
      - http
      - json-rpc
  zmq:
    name: ZeroMQ Interface
    #description: Listens for subscriptions to the ZeroMQ raw block and raw transaction event streams
    description: Do not use the URL below.  Instead, look in Monero's Properties section for your interface addresses.
    tor-config:
      port-mapping:
        18082: "18082"
    ui: false
    protocols:
      - tcp
      - zmq
  zmq-pubsub:
    name: ZeroMQ Pub-Sub Interface
    #description: Listens for subscriptions to the ZeroMQ raw block and raw transaction event streams
    description: Do not use the URL below.  Instead, look in Monero's Properties section for your interface addresses.
    tor-config:
      port-mapping:
        18083: "18083"
    ui: false
    protocols:
      - tcp
      - zmq
alerts:
  uninstall: Uninstalling Monero will result in permanent loss of data. Without a backup, any funds stored on your node's default hot wallet will be lost forever. If you are unsure, we recommend making a backup, just to be safe.
  restore: Restoring Monero will overwrite its current data. You will lose any transactions recorded in watch-only wallets, and any funds you have received to the hot wallet since the last backup.
backup:
  create:
    type: script
  restore:
    type: script
actions: {}
properties:
  type: script
migrations:
  from:
    "*":
      type: script
      args: ["from"]
  to:
    "*":
      type: script
      args: ["to"]