Updated documentation for clarity.
[arvados.git] / docker / config.yml.example
1 # Configuration for the Rails databases (database names,
2 # usernames and passwords).
3
4 # Path to a public ssh key you would like to have installed in the
5 # root account of the generated images. This is useful for debugging.
6 # To enable the SSH server, set the ENABLE_SSH environment variable to
7 # true when starting the container.
8 PUBLIC_KEY_PATH:
9
10 # ARVADOS_DOMAIN: the Internet domain of this installation.
11 # ARVADOS_DNS_SERVER: the authoritative nameserver for ARVADOS_DOMAIN.
12 ARVADOS_DOMAIN:         # e.g. arvados.internal
13 ARVADOS_DNS_SERVER:     # e.g. 192.168.0.1
14
15 # ==============================
16 # API server settings
17 # ==============================
18
19 # The API server hostname. Must be a 5-character
20 # string unique within this installation. This string
21 # will also be used as config.uuid_prefix.
22 API_HOSTNAME:           # e.g. qr1hi
23
24 # The e-mail address of the user you would like to become marked as an admin
25 # user on their first login.
26 # In the default configuration, authentication happens through the Arvados SSO
27 # server, which uses openid against Google's servers, so in that case this
28 # should be an address associated with a Google account.
29 API_AUTO_ADMIN_USER:
30
31 # If a _PW variable is set to an empty string, a password
32 # will be chosen randomly at build time. This is the
33 # recommended setting.
34 ARVADOS_DEV_DB: arvados_development
35 ARVADOS_DEV_USER: arvados_dev
36 ARVADOS_DEV_PW:
37 ARVADOS_TEST_DB: arvados_test
38 ARVADOS_TEST_USER: arvados_test
39 ARVADOS_TEST_PW:
40 ARVADOS_PROD_DB: arvados_production
41 ARVADOS_PROD_USER: arvados_prod
42 ARVADOS_PROD_PW:
43
44 # If a _SECRET variable is set to an empty string, a password
45 # will be chosen randomly at build time. This is the
46 # recommended setting.
47
48 # The value for the Rails config.secret_token setting.
49 API_SECRET:
50
51 # A "superuser" token with which servers can authenticate to
52 # the API server, before an administrative user has been created.
53 # Leave this blank to generate a secret randomly at build time (recommended).
54 API_SUPERUSER_SECRET:
55
56 # More than anything this should be auto-generated, but
57 # we don't presently have a good place to store it. So just
58 # change it and don't be dumb.
59 POSTGRES_ROOT_PW: dummy_pw
60
61 # The URL for this installation's Omniauth server.
62 OMNIAUTH_URL: https://@@SSO_HOSTNAME@@.@@ARVADOS_DOMAIN@@
63
64 # ==============================
65 # Workbench settings
66 # ==============================
67 WORKBENCH_RAILS_MODE: production
68 WORKBENCH_DATA_IMPORT_DIR: /data/arvados-workbench-upload/data
69 WORKBENCH_DATA_EXPORT_DIR: /data/arvados-workbench-download/data
70 WORKBENCH_VCF_PIPELINE_UUID:
71 WORKBENCH_SITE_NAME: Arvados Workbench
72 WORKBENCH_INSECURE_HTTPS: true
73 WORKBENCH_ACTIVATION_CONTACT_LINK: mailto:arvados@clinicalfuture.com
74 WORKBENCH_ARVADOS_LOGIN_BASE: https://@@API_HOSTNAME@@.@@ARVADOS_DOMAIN@@/login
75 WORKBENCH_ARVADOS_V1_BASE: https://@@API_HOSTNAME@@.@@ARVADOS_DOMAIN@@/arvados/v1
76 WORKBENCH_SECRET:
77
78 # ==============================
79 # SSO settings
80 # ==============================
81 SSO_HOSTNAME: sso
82 SSO_SECRET:
83 SSO_CLIENT_NAME: devsandbox
84 SSO_CLIENT_APP_ID: devsandbox
85 SSO_CLIENT_SECRET: