Mercurial > p > roundup > code
comparison share/man/man1/roundup-admin.1 @ 7098:fbc0ac8555ca
Mitigation for issue2551246 -u opton to roundup-admin
Missed change to man page.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Fri, 02 Dec 2022 23:09:51 -0500 |
| parents | f924af12ef50 |
| children | c1227f883177 |
comparison
equal
deleted
inserted
replaced
| 7097:d9b153732bb1 | 7098:fbc0ac8555ca |
|---|---|
| 7 .TP | 7 .TP |
| 8 \fB-i\fP \fIinstance home\fP | 8 \fB-i\fP \fIinstance home\fP |
| 9 Specify the issue tracker "home directory" to administer | 9 Specify the issue tracker "home directory" to administer |
| 10 .TP | 10 .TP |
| 11 \fB-u\fP \fIuser\fP[\fB:\fP\fIpassword\fP] | 11 \fB-u\fP \fIuser\fP[\fB:\fP\fIpassword\fP] |
| 12 The user and password to use for commands | 12 The user and password to use for commands (partial implemention, see |
| 13 Security Notes below). | |
| 14 .TP | |
| 13 \fB-h\fP | 15 \fB-h\fP |
| 14 Print help text. | 16 Print help text. |
| 15 .TP | 17 .TP |
| 16 \fB-d\fP | 18 \fB-d\fP |
| 17 Print full designators (e.g. issue1) not just id numbers (1). | 19 Print full designators (e.g. issue1) not just id numbers (1). |
| 251 merged/updated config file is written to \fI<filename>\fP. | 253 merged/updated config file is written to \fI<filename>\fP. |
| 252 .PP | 254 .PP |
| 253 Commands may be abbreviated as long as the abbreviation | 255 Commands may be abbreviated as long as the abbreviation |
| 254 matches only one command, e.g. l == li == lis == list. | 256 matches only one command, e.g. l == li == lis == list. |
| 255 | 257 |
| 258 .SH SECURITY NOTES | |
| 259 | |
| 260 The \fB-u user\fP setting does not currently operate like a | |
| 261 user logging in via the web. The user running roundup-admin | |
| 262 must have read access to the tracker home directory. As a | |
| 263 result the user has access to the files and the database | |
| 264 info contained in config.ini. | |
| 265 | |
| 266 Using \fB-u user\fP sets the actor/user parameter in the | |
| 267 journal. Changes that are made are attributed to that | |
| 268 user. The password is ignored if provided. Any existing | |
| 269 username has full access to the data just like the admin | |
| 270 user. This is an area for further development so that | |
| 271 roundup-admin could be used with sudo to provide secure | |
| 272 command line access to a tracker. | |
| 273 | |
| 274 .SH ENVIRONMENT VARIABLES | |
| 275 | |
| 276 .TP | |
| 277 \fBROUNDUP_LOGIN\fP | |
| 278 Provides an alternate way to set the user. | |
| 279 | |
| 256 .SH FURTHER HELP | 280 .SH FURTHER HELP |
| 257 roundup-admin -h | 281 roundup-admin -h |
| 258 roundup-admin help -- this help | 282 roundup-admin help -- this help |
| 259 roundup-admin help <command> -- command-specific help | 283 roundup-admin help <command> -- command-specific help |
| 260 roundup-admin help all -- all available help | 284 roundup-admin help all -- all available help |