Add documentation how to run the signer client

This commit is contained in:
Jan Dittberner 2022-12-03 12:58:28 +01:00
parent c65853d1f9
commit a688eb105b

View file

@ -18,10 +18,39 @@ Read the documentation of these tools, to find out how to use them.
## Building the binary
There is a `Makefile` to build the signerclient binary. Run
There is a `Makefile` to build the `signerclient` binary. Run
```shell
make
```
to run linting, tests and binary builds.
## Running the signer client
The signer client requires a YAML configuration file to know some information about its runtime environment. The
default configuration file name is `config.yaml` in the working directory.
### Generating a configuration file
Example configuration data is generated when the client is run with the `-generate-config` command line argument:
```shell
./signerclient -generate-config
```
### Start the client
With `config.yaml` in the current directory you can start the client:
```shell
./signerclient
```
### Supported command line arguments
To get a list of supported command line arguments run:
```shell
./signerclient -help
```