From f99f1ce934c471ea4691815a4f7a3a388c684523 Mon Sep 17 00:00:00 2001 From: Jess Frazelle Date: Sun, 15 Jul 2018 18:31:29 -0400 Subject: [PATCH] update readme Signed-off-by: Jess Frazelle --- server/README.md | 50 +++++++++++++++++++++++------------------------- 1 file changed, 24 insertions(+), 26 deletions(-) diff --git a/server/README.md b/server/README.md index 9b17f7c1..4745815a 100644 --- a/server/README.md +++ b/server/README.md @@ -9,37 +9,35 @@ Demo at [r.j3ss.co](https://r.j3ss.co). ```console $ reg-server -h -NAME: - reg-server - Docker registry v2 static UI server. +reg-server - Docker registry v2 static UI server. -USAGE: - reg-server [global options] command [command options] [arguments...] +Usage: reg-server -VERSION: - v0.2.0 +Flags: -AUTHOR: - The Genuinetools Authors + -cert path to ssl cert (default: ) + -clair url to clair instance (default: ) + -d enable debug logging (default: false) + -f force allow use of non-ssl (default: false) + -force-non-ssl force allow use of non-ssl (default: false) + -insecure do not verify tls certificates (default: false) + -interval interval to generate new index.html's at (default: 1h0m0s) + -k do not verify tls certificates (default: false) + -key path to ssl key (default: ) + -once generate an output once and then exit (default: false) + -p password for the registry (default: ) + -password password for the registry (default: ) + -port port for server to run on (default: 8080) + -r URL to the private registry (ex. r.j3ss.co) (default: ) + -registry URL to the private registry (ex. r.j3ss.co) (default: ) + -skip-ping skip pinging the registry while establishing connection (default: false) + -timeout timeout for HTTP requests (default: 1m0s) + -u username for the registry (default: ) + -username username for the registry (default: ) -COMMANDS: - help, h Shows a list of commands or help for one command +Commands: -GLOBAL OPTIONS: - --debug, -d run in debug mode - --username value, -u value username for the registry - --password value, -p value password for the registry - --registry value, -r value URL to the private registry (ex. r.j3ss.co) - --insecure, -k do not verify tls certificates of registry - --once, -o generate an output once and then exit - --port value port for server to run on (default: "8080") - --cert value path to ssl cert - --key value path to ssl key - --interval value interval to generate new index.html's at (default: 1h0m0s) - --clair value url to clair instance - --skip-ping skip pinging the registry while establishing connection - --timeout value timeout for HTTP requests (default: "1m") - --help, -h show help - --version, -v print the version + version Show the version information. ``` ## Screenshots