Browse Source

update README for TLS config

Justin Tracey 2 years ago
parent
commit
cef381c978
1 changed files with 6 additions and 3 deletions
  1. 6 3
      README.md

+ 6 - 3
README.md

@@ -28,10 +28,13 @@ Alternatively, you can run the executables directly from the respective target d
 ### Invocation
 
 #### Server
-`mgen-server [addr:port]`
+`mgen-server server.crt server.key [addr:port]`
 
-The server will listen for connections on the given interface.
-If none is given, it will listen on `127.0.0.1:6397`.
+The first two arguments are the paths to the server's TLS certificate and private key files.
+The client is configured to skip validation, so any valid certificate with typical parameters is fine.
+If you don't want to generate your own, you can find pre-generated ones in the [test server template directory](/shadow/client/shadow.data.template/hosts/server/)
+The server will listen for connections on the given interface in the optional third argument.
+If no such argument is given, it will listen on `127.0.0.1:6397`.
 
 #### Client/Peer
 `mgen-client [config.yaml]...`