From 9416cc5af2440eeea1878a1f96e1ae5f618b05de Mon Sep 17 00:00:00 2001 From: jahway603 Date: Mon, 9 Aug 2021 00:38:12 -0400 Subject: [PATCH] added CLI options to README --- README.md | 15 +++++++++++++++ start.sh | 7 +++++-- 2 files changed, 20 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a99ed79..5f18903 100644 --- a/README.md +++ b/README.md @@ -109,6 +109,21 @@ cargo build --release * If you have trouble compiling silentdragonlite-cli, then [please refer to it's separate documentation here](https://git.hush.is/hush/silentdragonlite-cli) on how to build it and what pre-requisites need to be installed. +## Lightwalletd Command-line Options + +These are the current different command line options for lightwalletd: + +| CLI option | Default | What it does | +|------------|:--------------:|------------------------------:| +| -bind-addr | 127.0.0.1:9069 | address and port to listen on | +| -tls-cert | | the path to a TLS certificate | +| -tls-key | | the path to a TLS key file | +| -no-tls | false | Disable TLS, serve un-encrypted traffic | +| -log-file | | log file to write to | +| -log-level | logrus.InfoLevel | log level 1 thru 7 (something from logrus)| +| -conf-file | | conf file to pull RPC creds from | +| -cache-size| 40000 | number of blocks to hold in the cache | + ## Support For support or other questions, join us on [Telegram](https://hush.is/telegram), or tweet at [@MyHushTeam](https://twitter.com/MyHushTeam), or toot at our [Mastodon](https://fosstodon.org/@myhushteam) or join [Telegram Support](https://hush.is/telegram_support). diff --git a/start.sh b/start.sh index 1b5b236..ef85a9d 100755 --- a/start.sh +++ b/start.sh @@ -2,8 +2,11 @@ # Copyright 2020-2021 The Hush Developers # Released under GPLv3 +# Description: This script would be used with a NGINX reverse proxy +# you can choose either IPv4 or IPv6 + # using ipv4 localhost -#./go/bin/go run cmd/server/main.go -bind-addr localhost:9067 -conf-file ~/.komodo/HUSH3/HUSH3.conf -no-tls +#./lightwalletd -bind-addr localhost:9067 -conf-file ~/.komodo/HUSH3/HUSH3.conf -no-tls # using ipv6 localhost -./go/bin/go run cmd/server/main.go -bind-addr ip6-localhost:9067 -conf-file ~/.komodo/HUSH3/HUSH3.conf -no-tls +./lightwalletd -bind-addr ip6-localhost:9067 -conf-file ~/.komodo/HUSH3/HUSH3.conf -no-tls