From 24bc983363aab940ac42b1954335d3d57a63a00c Mon Sep 17 00:00:00 2001 From: Jonas Nick Date: Mon, 8 Apr 2024 06:01:47 +0000 Subject: [PATCH] clightning-plugins: remove unmaintained plugins prometheus & helpme --- README.md | 2 -- docs/services.md | 6 +++--- examples/configuration.nix | 2 +- modules/clightning-plugins/default.nix | 3 --- modules/clightning-plugins/prometheus.nix | 21 --------------------- pkgs/clightning-plugins/default.nix | 10 ---------- test/tests.nix | 2 -- 7 files changed, 4 insertions(+), 42 deletions(-) delete mode 100644 modules/clightning-plugins/prometheus.nix diff --git a/README.md b/README.md index 24b6629..d26d182 100644 --- a/README.md +++ b/README.md @@ -74,9 +74,7 @@ NixOS modules ([src](modules/modules.nix)) Available plugins: * [clboss](https://github.com/ZmnSCPxj/clboss): automated C-Lightning Node Manager * [currencyrate](https://github.com/lightningd/plugins/tree/master/currencyrate): currency converter - * [helpme](https://github.com/lightningd/plugins/tree/master/helpme): walks you through setting up a fresh c-lightning node * [monitor](https://github.com/lightningd/plugins/tree/master/monitor): helps you analyze the health of your peers and channels - * [prometheus](https://github.com/lightningd/plugins/tree/master/prometheus): lightning node exporter for the prometheus timeseries server * [rebalance](https://github.com/lightningd/plugins/tree/master/rebalance): keeps your channels balanced * [summary](https://github.com/lightningd/plugins/tree/master/summary): print a nice summary of the node status * [trustedcoin](https://github.com/nbd-wtf/trustedcoin) ([experimental](docs/services.md#trustedcoin)): replaces bitcoind with trusted public explorers diff --git a/docs/services.md b/docs/services.md index a45884a..8037905 100644 --- a/docs/services.md +++ b/docs/services.md @@ -571,13 +571,13 @@ You can activate and configure these plugins like so: services.clightning = { enable = true; plugins = { - prometheus.enable = true; - prometheus.listen = "0.0.0.0:9900"; + clboss.enable = true; + clboss.min-onchain = 40000; }; }; ``` -Please have a look at the module for a plugin (e.g. [prometheus.nix](../modules/clightning-plugins/prometheus.nix)) to learn its configuration options. +Please have a look at the module for a plugin (e.g. [clboss.nix](../modules/clightning-plugins/clboss.nix)) to learn its configuration options. ### Trustedcoin When `services.clightning.tor.proxy` is enabled, [trustedcoin](https://github.com/nbd-wtf/trustedcoin) diff --git a/examples/configuration.nix b/examples/configuration.nix index 3cdabf4..0013bb8 100644 --- a/examples/configuration.nix +++ b/examples/configuration.nix @@ -52,7 +52,7 @@ # # == Plugins # See ../README.md (Features → clightning) for the list of available plugins. - # services.clightning.plugins.prometheus.enable = true; + # services.clightning.plugins.clboss.enable = true; # # == REST server # Set this to create a clightning REST onion service. diff --git a/modules/clightning-plugins/default.nix b/modules/clightning-plugins/default.nix index 6dd61c7..64ddcbe 100644 --- a/modules/clightning-plugins/default.nix +++ b/modules/clightning-plugins/default.nix @@ -4,7 +4,6 @@ with lib; let options.services.clightning.plugins = { currencyrate.enable = mkEnableOption "Currencyrate (clightning plugin)"; - helpme.enable = mkEnableOption "Help me (clightning plugin)"; monitor.enable = mkEnableOption "Monitor (clightning plugin)"; rebalance.enable = mkEnableOption "Rebalance (clightning plugin)"; }; @@ -15,7 +14,6 @@ in { imports = [ ./clboss.nix ./feeadjuster.nix - ./prometheus.nix ./summary.nix ./trustedcoin.nix ./zmq.nix @@ -26,7 +24,6 @@ in { config = { services.clightning.extraConfig = mkMerge [ (mkIf cfg.currencyrate.enable "plugin=${pluginPkgs.currencyrate.path}") - (mkIf cfg.helpme.enable "plugin=${pluginPkgs.helpme.path}") (mkIf cfg.monitor.enable "plugin=${pluginPkgs.monitor.path}") (mkIf cfg.rebalance.enable "plugin=${pluginPkgs.rebalance.path}") ]; diff --git a/modules/clightning-plugins/prometheus.nix b/modules/clightning-plugins/prometheus.nix deleted file mode 100644 index 94cf4c4..0000000 --- a/modules/clightning-plugins/prometheus.nix +++ /dev/null @@ -1,21 +0,0 @@ -{ config, lib, ... }: - -with lib; -let cfg = config.services.clightning.plugins.prometheus; in -{ - options.services.clightning.plugins.prometheus = { - enable = mkEnableOption "Prometheus (clightning plugin)"; - listen = mkOption { - type = types.str; - default = "0.0.0.0:9750"; - description = "Address and port to bind to."; - }; - }; - - config = mkIf cfg.enable { - services.clightning.extraConfig = '' - plugin=${config.nix-bitcoin.pkgs.clightning-plugins.prometheus.path} - prometheus-listen=${cfg.listen} - ''; - }; -} diff --git a/pkgs/clightning-plugins/default.nix b/pkgs/clightning-plugins/default.nix index 613e201..bbdb0be 100644 --- a/pkgs/clightning-plugins/default.nix +++ b/pkgs/clightning-plugins/default.nix @@ -20,20 +20,10 @@ let feeadjuster = { description = "Dynamically changes channel fees to keep your channels more balanced"; }; - helpme = { - description = "Walks you through setting up a c-lightning node, offering advice for common problems"; - }; monitor = { description = "Helps you analyze the health of your peers and channels"; extraPkgs = [ packaging ]; }; - prometheus = { - description = "Lightning node exporter for the prometheus timeseries server"; - extraPkgs = [ prometheus_client ]; - patchRequirements = - "--replace prometheus-client==0.6.0 prometheus-client==0.17.1" - + " --replace pyln-client~=0.9.3 pyln-client~=24.02"; - }; rebalance = { description = "Keeps your channels balanced"; }; diff --git a/test/tests.nix b/test/tests.nix index f490d49..5793b14 100644 --- a/test/tests.nix +++ b/test/tests.nix @@ -152,9 +152,7 @@ let services.clightning.plugins = { clboss.enable = true; feeadjuster.enable = true; - helpme.enable = true; monitor.enable = true; - prometheus.enable = true; rebalance.enable = true; summary.enable = true; zmq = let tcpEndpoint = "tcp://127.0.0.1:5501"; in {