reg/server/README.md
Jess Frazelle 2b42e860f0
add readme for server
Signed-off-by: Jess Frazelle <acidburn@google.com>
2017-03-05 12:36:38 -08:00

46 lines
1.2 KiB
Markdown

# reg-server
A static UI for a docker registry. Comes with vulnerability scanning if you
have a [CoreOS Clair](https://github.com/coreos/clair) server set up.
Demo at [r.j3ss.co](https://r.j3ss.co).
## Usage
```console
$ reg-server -h
NAME:
reg-server - Docker registry v2 static UI server.
USAGE:
reg-server [global options] command [command options] [arguments...]
VERSION:
v0.1.0
AUTHOR:
@jessfraz <no-reply@butts.com>
COMMANDS:
help, h Shows a list of commands or help for one command
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 provate registry (ex. r.j3ss.co)
--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: "5m")
--clair value url to clair instance
--help, -h show help
--version, -v print the version
```
## Screenshots
![home.png](home.png)
![vuln.png](vuln.png)