Skip to content

Commit

Permalink
Improve CLI option documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
avinson committed Aug 2, 2017
1 parent 82dc4fd commit 92f7dcf
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,23 @@ Guide. Typically, running Registrator looks like this:
gliderlabs/registrator:latest \
consul:https://localhost:8500

## CLI Options
```
Usage of /bin/registrator:
/bin/registrator [options] <registry URI>
-cleanup=false: Remove dangling services
-deregister="always": Deregister exited services "always" or "on-success"
-internal=false: Use internal ports instead of published ones
-ip="": IP for ports mapped to the host
-resync=0: Frequency with which services are resynchronized
-retry-attempts=0: Max retry attempts to establish a connection with the backend. Use -1 for infinite retries
-retry-interval=2000: Interval (in millisecond) between retry-attempts.
-tags="": Append tags for all registered services
-ttl=0: TTL for services (default is no expiry)
-ttl-refresh=0: Frequency with which service TTLs are refreshed
```

## Contributing

Pull requests are welcome! We recommend getting feedback before starting by
Expand Down

0 comments on commit 92f7dcf

Please sign in to comment.