mirror of
https://github.com/ElementsProject/lightning.git
synced 2025-02-22 06:41:44 +01:00
docs: document plugin options.
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
This commit is contained in:
parent
eb03b33655
commit
aa4284a35e
2 changed files with 71 additions and 10 deletions
|
@ -174,11 +174,6 @@ Sets configuration file (default:
|
||||||
\fIPATH\fR
|
\fIPATH\fR
|
||||||
must exist and be readable (we allow missing files in the default case)\&. Using this inside a configuration file is meaningless\&.
|
must exist and be readable (we allow missing files in the default case)\&. Using this inside a configuration file is meaningless\&.
|
||||||
.RE
|
.RE
|
||||||
.PP
|
|
||||||
\fBplugin\fR=\fIPATH\fR
|
|
||||||
.RS 4
|
|
||||||
Specify a plugin to run as part of c\-lightning\&. This can be specified multiple times and may enable additional configuration options and JSON\-RPC methods, depending on the plugin\&.
|
|
||||||
.RE
|
|
||||||
.SS "Lightning node customization options"
|
.SS "Lightning node customization options"
|
||||||
.PP
|
.PP
|
||||||
\fBrgb\fR=\fIRRGGBB\fR
|
\fBrgb\fR=\fIRRGGBB\fR
|
||||||
|
@ -442,6 +437,47 @@ Set a Tor control password, which may be needed for
|
||||||
\fIautotor:\fR
|
\fIautotor:\fR
|
||||||
to authenticate to the Tor control port\&.
|
to authenticate to the Tor control port\&.
|
||||||
.RE
|
.RE
|
||||||
|
.SS "Lightning Plugins"
|
||||||
|
.sp
|
||||||
|
lightningd(8) supports plugins, which offer additional configuration options and JSON\-RPC methods, depending on the plugin\&. Some are supplied by default (usually located in \fBlibexec/c\-lightning/plugins\fR), but you can add your own, too\&.
|
||||||
|
.PP
|
||||||
|
\fBplugin\fR=\fIPATH\fR
|
||||||
|
.RS 4
|
||||||
|
Specify a plugin to run as part of c\-lightning\&. This can be specified multiple times to add multiple plugins\&.
|
||||||
|
.RE
|
||||||
|
.PP
|
||||||
|
\fBplugin\-dir\fR=\fIDIRECTORY\fR
|
||||||
|
.RS 4
|
||||||
|
Specify a directory to look for plugins; all files beginning with
|
||||||
|
\fIlplugin_\fR
|
||||||
|
in
|
||||||
|
\fIDIRECTORY\fR
|
||||||
|
are loaded\&.
|
||||||
|
\fIDIRECTORY\fR
|
||||||
|
must exist; this can be specified multiple times to add multiple directories\&.
|
||||||
|
.RE
|
||||||
|
.PP
|
||||||
|
\fBclear\-plugins\fR
|
||||||
|
.RS 4
|
||||||
|
This option clears all
|
||||||
|
\fIplugin\fR
|
||||||
|
and
|
||||||
|
\fIplugin\-dir\fR
|
||||||
|
options preceeding it, including the default built\-in plugin directory\&. You can still add
|
||||||
|
\fIplugin\-dir\fR
|
||||||
|
and
|
||||||
|
\fIplugin\fR
|
||||||
|
options following this and they will have the normal effect\&.
|
||||||
|
.RE
|
||||||
|
.PP
|
||||||
|
\fBdisable\-plugin\fR=\fIPLUGIN\fR
|
||||||
|
.RS 4
|
||||||
|
If
|
||||||
|
\fIPLUGIN\fR
|
||||||
|
contains a /, plugins with the same path as
|
||||||
|
\fIPLUGIN\fR
|
||||||
|
are disabled\&. Otherwise, any plugin with that base name is disabled, whatever directory it is in\&.
|
||||||
|
.RE
|
||||||
.SH "BUGS"
|
.SH "BUGS"
|
||||||
.sp
|
.sp
|
||||||
You should report bugs on our github issues page, and maybe submit a fix to gain our eternal gratitude!
|
You should report bugs on our github issues page, and maybe submit a fix to gain our eternal gratitude!
|
||||||
|
|
|
@ -126,11 +126,6 @@ Lightning daemon options
|
||||||
(we allow missing files in the default case).
|
(we allow missing files in the default case).
|
||||||
Using this inside a configuration file is meaningless.
|
Using this inside a configuration file is meaningless.
|
||||||
|
|
||||||
*plugin*='PATH'::
|
|
||||||
Specify a plugin to run as part of c-lightning. This can be specified
|
|
||||||
multiple times and may enable additional configuration options and JSON-RPC
|
|
||||||
methods, depending on the plugin.
|
|
||||||
|
|
||||||
Lightning node customization options
|
Lightning node customization options
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
@ -308,6 +303,36 @@ or precisely control where to bind and what to announce with the
|
||||||
Set a Tor control password, which may be needed for 'autotor:' to
|
Set a Tor control password, which may be needed for 'autotor:' to
|
||||||
authenticate to the Tor control port.
|
authenticate to the Tor control port.
|
||||||
|
|
||||||
|
|
||||||
|
Lightning Plugins
|
||||||
|
~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
lightningd(8) supports plugins, which offer additional configuration
|
||||||
|
options and JSON-RPC methods, depending on the plugin. Some are
|
||||||
|
supplied by default (usually located in
|
||||||
|
*libexec/c-lightning/plugins/*), but you can add your own, too.
|
||||||
|
|
||||||
|
*plugin*='PATH'::
|
||||||
|
Specify a plugin to run as part of c-lightning. This can be specified
|
||||||
|
multiple times to add multiple plugins.
|
||||||
|
|
||||||
|
*plugin-dir*='DIRECTORY'::
|
||||||
|
Specify a directory to look for plugins; all executable files
|
||||||
|
not containing punctuation (other than '.', '-' or '_) in 'DIRECTORY'
|
||||||
|
are loaded. 'DIRECTORY' must exist;
|
||||||
|
this can be specified multiple times to add multiple directories.
|
||||||
|
|
||||||
|
*clear-plugins*::
|
||||||
|
This option clears all 'plugin' and 'plugin-dir' options
|
||||||
|
preceeding it, including the default built-in plugin directory.
|
||||||
|
You can still add 'plugin-dir' and 'plugin' options following
|
||||||
|
this and they will have the normal effect.
|
||||||
|
|
||||||
|
*disable-plugin*='PLUGIN'::
|
||||||
|
If 'PLUGIN' contains a /, plugins with the same path as 'PLUGIN'
|
||||||
|
are disabled. Otherwise, any plugin with that base name is
|
||||||
|
disabled, whatever directory it is in.
|
||||||
|
|
||||||
BUGS
|
BUGS
|
||||||
----
|
----
|
||||||
You should report bugs on our github issues page, and maybe submit a
|
You should report bugs on our github issues page, and maybe submit a
|
||||||
|
|
Loading…
Add table
Reference in a new issue