Mercurial > p > roundup > code
changeset 7306:1aad478fc03f
Add section on Securing Secrets
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Mon, 08 May 2023 21:54:42 -0400 |
| parents | 96a2bcb1bf1d |
| children | aa024cdf9ffb |
| files | doc/admin_guide.txt |
| diffstat | 1 files changed, 33 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/admin_guide.txt Sun May 07 22:21:19 2023 -0400 +++ b/doc/admin_guide.txt Mon May 08 21:54:42 2023 -0400 @@ -792,6 +792,39 @@ you should notify the roundup maintainers using the roundup-users mailing list. + +Securing Secrets +================ + +Roundup can read secrets from a file that is referenced from any +of the config.ini files. If you use Docker, you can bind mount +the files from a secure location, or store them in a subdirectory +of the tracker home. + +You can also use a secrets management tool like Docker Swarm's +secrets management. This example config.ini configuration gets +the database password from a file populated by Swarm secrets:: + + [rdbms] + # Database user password. + # A string that starts with 'file://' is interpreted as a file + # path relative to the tracker home. Using 'file:///' defines + # an absolute path. The first line of the file will be used as + # the value. Any string that does not start with 'file://' is + # used as is. It removes any whitespace at the end of the + # line, so a newline can be put in the file. + # + # Default: roundup + password = file:///run/secrets/db_password + +assuming that Docker Swarm secrets has the key ``db_password`` +and the ``--secret db_password`` option is used when starting the +Roundup service. + +Because environment variables can be inadvertently exposed in +logs or process listings, Roundup does not currently support +loading secrets from environment variables. + Tasks =====
