Skip to content

Commit 2c19601

Browse files
committed
Add section on Securing Secrets
1 parent e28ed19 commit 2c19601

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

doc/admin_guide.txt

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -792,6 +792,39 @@ At the time this is written, support is experimental. If you use it
792792
you should notify the roundup maintainers using the roundup-users
793793
mailing list.
794794

795+
796+
Securing Secrets
797+
================
798+
799+
Roundup can read secrets from a file that is referenced from any
800+
of the config.ini files. If you use Docker, you can bind mount
801+
the files from a secure location, or store them in a subdirectory
802+
of the tracker home.
803+
804+
You can also use a secrets management tool like Docker Swarm's
805+
secrets management. This example config.ini configuration gets
806+
the database password from a file populated by Swarm secrets::
807+
808+
[rdbms]
809+
# Database user password.
810+
# A string that starts with 'file://' is interpreted as a file
811+
# path relative to the tracker home. Using 'file:///' defines
812+
# an absolute path. The first line of the file will be used as
813+
# the value. Any string that does not start with 'file://' is
814+
# used as is. It removes any whitespace at the end of the
815+
# line, so a newline can be put in the file.
816+
#
817+
# Default: roundup
818+
password = file:///run/secrets/db_password
819+
820+
assuming that Docker Swarm secrets has the key ``db_password``
821+
and the ``--secret db_password`` option is used when starting the
822+
Roundup service.
823+
824+
Because environment variables can be inadvertently exposed in
825+
logs or process listings, Roundup does not currently support
826+
loading secrets from environment variables.
827+
795828
Tasks
796829
=====
797830

0 commit comments

Comments
 (0)