manifest.yaml

id: fedimint-gateway
title: "Fedimint Gateway"
version: 0.3.1
release-notes: |
  - Initial release for Fedimint Gateway
license: MIT
wrapper-repo: "https://github.com/kodylow/gateway-start9"
upstream-repo: "https://github.com/fedimint/fedimint"
support-site: "https://github.com/fedimint/fedimint/issues"
marketing-site: "https://fedimint.org"
build: ["make"]
description:
  short: A Lightning Gateway for Fedimints
  long: |
    Fedimint Gateway lets you connect your lightning node to different Fedimints to earn routing fees for swapping ecash <> lightning. The Gateway runs alongside your LND node and connect to multiple Fedimints and provides a UI for managing liquidity across them.
assets:
  license: LICENSE
  icon: icon.png
  instructions: instructions.md
main:
  type: docker
  image: main
  entrypoint: "docker_entrypoint.sh"
  args: []
  mounts:
    main: /root
    lnd: /mnt/lnd
    gatewayd: /gateway_data/gatewayd
    gateway-ui: /gateway_data/gateway-ui
health-checks:
  web-ui:
    name: Web Interface
    success-message: The Fedimint Gateway is ready to visit in a web browser
    type: script
config: ~
properties: ~
volumes:
  main:
    type: data
  compat:
    type: assets
  lnd:
    type: pointer
    package-id: lnd
    volume-id: main
    path: /public
    readonly: true
  gatewayd:
    type: data
  gateway-ui:
    type: data
interfaces:
  main:
    name: User Interface
    description: The UI for Fedimint Gateway
    tor-config:
      port-mapping:
        80: "3001"
        # 8175: "8175"
    lan-config:
      443:
        ssl: true
        internal: 3001
      # 8175:
      #   ssl: true
      #   internal: 8175
    ui: true
    protocols:
      - tcp
      - http
dependencies:
  lnd:
    version: ">=0.17.0 <0.19.0"
    description: Used to communicate with the Lightning Network.
    requirement:
      type: required
    config: ~
backup:
  create:
    type: script
  restore:
    type: script
migrations:
  from:
    "*":
      type: script
      args: ["from"]
  to:
    "*":
      type: script
      args: ["to"]