manifest.yaml

id: jam
title: Jam
version: 0.3.0
release-notes: |
  * Update Jam to [v0.3.0](https://github.com/joinmarket-webui/jam/releases/tag/v0.3.0) (via [jam-docker](https://github.com/joinmarket-webui/jam-docker))
license: MIT
wrapper-repo: "https://github.com/Start9Labs/jam-startos"
upstream-repo: "https://github.com/joinmarket-webui/jam-docker"
support-site: "https://github.com/joinmarket-webui/jam/issues"
marketing-site: "https://jamapp.org"
build: ["make"]
description:
  short: Jam - A friendly UI for JoinMarket
  long: |
    Jam is a web UI for JoinMarket with focus on user-friendliness.
    It aims to provide sensible defaults and be easy to use for beginners while still providing the features advanced users expect.
assets:
  license: LICENSE
  icon: icon.png
  instructions: instructions.md
main:
  type: docker
  image: main
  entrypoint: "tini"
  args: ["-g", "--", "docker_entrypoint.sh"]
  mounts:
    main: /data
    jam: /root/.joinmarket
health-checks:
  web-ui:
    name: Jam UI
    success-message: Jam is ready to visit in a web browser
    type: script
  api:
    name: Jam API
    success-message: The Jam API is accessible and responding
    type: docker
    image: main
    entrypoint: "check-api.sh"
    args: []
    system: false
    io-format: json
config:
  get:
    type: script
  set:
    type: script
properties:
  type: script
volumes:
  main:
    type: data
  jam:
    type: data
  compat:
    type: assets
interfaces:
  main:
    name: Jam Web UI
    description: Specifies the interface to listen on for HTTP connections.
    tor-config:
      port-mapping:
        80: "80"
    lan-config:
      443:
        ssl: true
        internal: 80
    ui: true
    protocols:
      - tcp
      - http
dependencies:
  bitcoind:
    version: ">=0.23.0.1 <29.0.0"
    requirement:
      type: required
    description: Used to subscribe to new block events from a full archival node.
    config:
      check:
        type: script
      auto-configure:
        type: script
alerts:
  install: |
    WARNING: If you have an older version of Jam running, this install will stop all active liquidity offers. You will need to manually restart your offers after the install is complete.
  start: |
    It may take some time for the Jam API to initialize over the Tor network, please be patient.
migrations:
  from:
    "*":
      type: script
      args: ["from"]
  to:
    "*":
      type: script
      args: ["to"]
backup:
  create:
    type: docker
    image: compat
    system: true
    entrypoint: /mnt/assets/backup.sh
    args:
      - create
      - /data/start9
      - /root/.joinmarket
    mounts:
      BACKUP: "/mnt/backup"
      compat: "/mnt/assets"
      main: "/data/start9"
      jam: "/root/.joinmarket"
  restore:
    type: docker
    image: compat
    system: true
    entrypoint: /mnt/assets/backup.sh
    args:
      - restore
      - /data/start9
      - /root/.joinmarket
    mounts:
      BACKUP: "/mnt/backup"
      compat: "/mnt/assets"
      main: "/data/start9"
      jam: "/root/.joinmarket"