Browse Source

updated manpage & added required directory info

deb-pkg-changes v0.1.2
jahway603 1 year ago
parent
commit
ca4520c8bf
  1. 2
      README.md
  2. 32
      doc/man/lightwalletd.1

2
README.md

@ -95,6 +95,7 @@ Then run the lightwalletd frontend with the following:
Note: we use the "--no-tls" option as we are using NGINX as a reverse proxy and letting it handle the TLS authentication for us instead. If you want to do TLS directly with lightwalletd with no reverse proxy, see the next section.
If you encounter an error about the lightwalletd "data directory", then set one on the command line with `--data-dir` (OR) create the `/var/lib/lightwalletd` and `/var/lib/lightwalletd/db` directories & chown that new db directory as the user account running lightwalletd and hushd.
##### Option B: "Let's Encrypt" certificate just using lightwalletd without NGINX
The other option is to configure lightwalletd to handle its own TLS authentication. Once you have a certificate that you want to use (from a certificate authority), pass the certificate to the frontend as follows:
@ -127,6 +128,7 @@ These are some of the most used command line options for lightwalletd:
| --tls-cert | blank | the path to a TLS certificate |
| --tls-key | blank | the path to a TLS key file |
| --no-tls | false | Disable TLS, serve un-encrypted traffic |
| --data-dir | /var/lib/lightwalletd | Sets the lightwalletd data directory |
| --log-file | blank | log file to write to |
| --log-level | logrus.InfoLevel | log level 1 thru 7 (something from logrus)|
| --hush-conf-path | blank | conf file to pull RPC creds from |

32
doc/man/lightwalletd.1

@ -1,6 +1,6 @@
.TH LIGHTWALLET "1" "October 2021" "lightwalletd v0.1.1" "User Commands"
.TH LIGHTWALLET "1" "December 2022" "lightwalletd v0.1.2" "User Commands"
.SH NAME
lightwalletd \- manual page for hush lightwalletd v0.1.1
lightwalletd \- manual page for hush lightwalletd v0.1.2
.SH DESCRIPTION
.B lightwalletd
runs a lightwallet daemon for a Hush Silent Dragon Lite node.
@ -23,35 +23,39 @@ Display version information
.IP
Display command line options
.HP
\fB\-conf-file\fR [conf_file location]
\fB\--hush-conf-path\fR [conf_file location]
.IP
Configures your HUSH3.conf file location [Required to run]. Typically ~/.hush/HUSH3/HUSH3.conf
Configures your HUSH3.conf file location to pull RPC creds from (default "./HUSH3.conf")
.HP
\fB\-bind-addr \fRhost.net:chosen_port
\fB\--data-dir\fR [location]
.IP
Set host.net to either a FQDN or 127.0.0.1 depending on your configuration [Required to run]. Most common port is 9067 unless changed.
Configures your lightwalletd data directory (such as db) (default "/var/lib/lightwalletd")
.HP
\fB\-no-tls
\fB\--grpc-bind-addr \fRlocalhost:chosen_port
.IP
Disable TLS, serve un-encrypted traffic. Toggle depending on your configuration.
The address to listen for grpc on (default "localhost:9067")
.HP
\fB\-cache-size \fRint
\fB\--no-tls
.IP
Run without TLS, only safe if a reverse proxy like nginx does TLS on localhost.
.HP
\fB\--cache-size \fRint
.IP
Set number of blocks to hold in the cache (default 40000)
.HP
\fB\-log-file \fRstring
\fB\--log-file \fRstring
.IP
Set log file to write to
.HP
\fB\-log-level \fRuint
\fB\--log-level \fRuint
.IP
log level (logrus 1-7) (default 4)
.HP
\fB\-tls-cert \fRstring
\fB\--tls-cert \fRstring
.IP
the path to a TLS certificate (optional)
.HP
\fB\-tls-key \fRstring
\fB\--tls-key \fRstring
.IP
the path to a TLS key file (optional)
@ -59,7 +63,7 @@ the path to a TLS key file (optional)
In order to ensure you are adequately protecting your privacy when using Hush,
please see <https://hush.is/security/>.
Copyright (C) 2021 Jahway603 and The Hush Developers
Copyright (C) 2021-2022 Jahway603 and The Hush Developers
This is experimental Free Software! Fuck Yeah!!!!!

Loading…
Cancel
Save