Skip to content

Commit 3c99f1b

Browse files
committed
Add missing documentation for error_banner
1 parent da442cf commit 3c99f1b

File tree

2 files changed

+12
-1
lines changed

2 files changed

+12
-1
lines changed

cmd/sshproxyctl/sshproxyctl.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -486,7 +486,7 @@ The commands are:
486486
hosts show hosts stored in etcd
487487
users show users stored in etcd
488488
groups show groups stored in etcd
489-
error_banner show error banner stored in etcd and in configuration
489+
error_banner show error banners stored in etcd and in configuration
490490
491491
The options are:
492492
`, os.Args[0])

doc/sshproxyctl.txt

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,14 @@ COMMANDS
5454
Forget a host in etcd. The default port is 22. Remember that if this
5555
host is used, it will appear back in the list.
5656

57+
*error_banner [-expire] MESSAGE*::
58+
Set the error banner in etcd. Removes the error banner in etcd if
59+
'MESSAGE' is absent. 'MESSAGE' can be multiline. The error banner is
60+
displayed to the client when no backend can be reached (more
61+
precisely, when all backends are either down or disabled in etcd).
62+
'-expire' sets the expiration date of this error banner. Format:
63+
'YYYY-MM-DD[ HH:MM[:SS]]'
64+
5765
*show [-all] [-csv|-json] connections*::
5866
Show users connections in etcd. Without '-all' only one entry per user
5967
is displayed with the number of her/his connections. If '-all' is
@@ -71,6 +79,9 @@ COMMANDS
7179
group is displayed. If '-all' is specified, groups are splitted by
7280
services.
7381

82+
*show error_banner*::
83+
Show error banners stored in etcd and in configuration.
84+
7485

7586
FILES
7687
-----

0 commit comments

Comments
 (0)