manifest.yaml

id: ride-the-lightning
title: Ride the Lightning
version: 0.15.4
release-notes: |
  * Update RTL to 0.15.4 [Release Notes](https://github.com/Ride-The-Lightning/RTL/releases/tag/v0.15.4)
  * Fix CLN dependency auto-configure
license: MIT
wrapper-repo: https://github.com/Start9Labs/ride-the-lightning-wrapper
upstream-repo: https://github.com/Ride-The-Lightning/RTL
support-site: https://github.com/Ride-The-Lightning/RTL/issues
marketing-site: https://twitter.com/RTL_App
build: ["make"]
description:
  short: "A full function, device agnostic, web user interface for managing lightning node operations"
  long: "A full function, device agnostic, web user interface for managing lightning node operations. It talks directly to the LND or CLN node running on your StartOS server and is accessible from any Tor-enabled Browser!"
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
    c-lightning: "/mnt/c-lightning"
health-checks:
  main:
    name: Web UI
    success-message: RTL is ready to visit in a web browser
    type: docker
    image: main
    entrypoint: check-web.sh
    args: []
    io-format: json
    inject: true
config:
  get:
    type: script
  set:
    type: script
properties:
  type: script
volumes:
  main:
    type: data
  compat:
    type: assets
  lnd:
    type: pointer
    package-id: lnd
    volume-id: main
    path: /public
    readonly: true
  c-lightning:
    type: pointer
    package-id: c-lightning
    volume-id: main
    path: /public
    readonly: true
interfaces:
  main:
    name: Browser Interface
    description: The main RTL browser interface
    tor-config:
      port-mapping:
        80: "80"
    lan-config:
      443:
        ssl: true
        internal: 80
    ui: true
    protocols:
      - tcp
      - http
dependencies:
  lnd:
    version: ">=0.13.4 <0.19.0"
    description: Used to communicate with the Lightning Network.
    requirement:
      type: opt-in
      how: Can opt to use the internal Core Lightning (CLN) instance instead of LND
    config: ~
  c-lightning:
    version: ">=23.11.2.1 <25.0.0"
    description: Used to communicate with the Lightning Network.
    requirement:
      type: opt-in
      how: Can opt to use the internal LND instance instead of LND
    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"]