Configuration

In many cases, Girder will work with default configuration whether installed via pip or from a source checkout or tarball. That said, the Girder config file can be set at the following locations (ordered by precedent):

The path specified by the environment variable GIRDER_CONFIG.
~/.girder/girder.cfg
/etc/girder.cfg

Settings

Girder settings are specific key-value pairs that control system behavior. There are two ways to change Girder settings.

Via the Web API / front-end web site

System settings can be set and retrieved using the web API endpoint at /api/v1/system/setting. Most of them are exposed via the web UI under Admin console -> System configuration. When setting the values through the web API endpoint, they will be interpreted as JSON.

Note

Modifying setting values via the web API is officially deprecated, as it violates the Twelve-Factor App principle of storing configuration in the environment. Setting values should instead be set via environment variables as documented below.

Via the environment

Any system setting can be controlled via environment variables as well. To do so, find the key of the setting and apply the following transformation:

transform all . characters in the key to _
convert it to uppercase
prefix it with GIRDER_SETTING_

Whatever value you set for that environment variable will be parsed as JSON and used at runtime. If the value cannot be parsed as JSON, its raw string value will be used instead. For example, to set the setting named "core.brand_name", you’d use GIRDER_SETTING_CORE_BRAND_NAME='My brand name'

Settings set through environment variables will override any setting value that is set in the database via the web API.

The full list of system settings available in Girder core can be seen in the file girder/girder/settings.py, under the SettingKey class. Plugins may add additional settings within their own packages.

Environment Variable List

This section is auto-generated from code inspection.

Girder Environment Variables

Database-Stored Settings via Environment Variables

Environment Variable	Setting Key	Component	Repo	Source File
`GIRDER_SETTING_AUTOJOIN`	`autojoin`	autojoin	v5.0.1	`plugins/autojoin/girder_autojoin/settings.py`
`GIRDER_SETTING_CORE_ADD_TO_GROUP_POLICY`	`core.add_to_group_policy`	v5.0.1	v5.0.1	`girder/settings.py`
`GIRDER_SETTING_CORE_API_KEYS`	`core.api_keys`	v5.0.1	v5.0.1	`girder/settings.py`
`GIRDER_SETTING_CORE_BANNER_COLOR`	`core.banner_color`	v5.0.1	v5.0.1	`girder/settings.py`
`GIRDER_SETTING_CORE_BRAND_NAME`	`core.brand_name`	v5.0.1	v5.0.1	`girder/settings.py`
`GIRDER_SETTING_CORE_CACHE_CONFIG`	`core.cache_config`	v5.0.1	v5.0.1	`girder/settings.py`
`GIRDER_SETTING_CORE_CACHE_ENABLED`	`core.cache.enabled`	v5.0.1	v5.0.1	`girder/settings.py`
`GIRDER_SETTING_CORE_COLLECTION_CREATE_POLICY`	`core.collection_create_policy`	v5.0.1	v5.0.1	`girder/settings.py`
`GIRDER_SETTING_CORE_CONTACT_EMAIL_ADDRESS`	`core.contact_email_address`	v5.0.1	v5.0.1	`girder/settings.py`
`GIRDER_SETTING_CORE_COOKIE_DOMAIN`	`core.cookie_domain`	v5.0.1	v5.0.1	`girder/settings.py`
`GIRDER_SETTING_CORE_COOKIE_LIFETIME`	`core.cookie_lifetime`	v5.0.1	v5.0.1	`girder/settings.py`
`GIRDER_SETTING_CORE_CORS_ALLOW_HEADERS`	`core.cors.allow_headers`	v5.0.1	v5.0.1	`girder/settings.py`
`GIRDER_SETTING_CORE_CORS_ALLOW_METHODS`	`core.cors.allow_methods`	v5.0.1	v5.0.1	`girder/settings.py`
`GIRDER_SETTING_CORE_CORS_ALLOW_ORIGIN`	`core.cors.allow_origin`	v5.0.1	v5.0.1	`girder/settings.py`
`GIRDER_SETTING_CORE_CORS_EXPOSE_HEADERS`	`core.cors.expose_headers`	v5.0.1	v5.0.1	`girder/settings.py`
`GIRDER_SETTING_CORE_EMAIL_FROM_ADDRESS`	`core.email_from_address`	v5.0.1	v5.0.1	`girder/settings.py`
`GIRDER_SETTING_CORE_EMAIL_HOST`	`core.email_host`	v5.0.1	v5.0.1	`girder/settings.py`
`GIRDER_SETTING_CORE_EMAIL_VERIFICATION`	`core.email_verification`	v5.0.1	v5.0.1	`girder/settings.py`
`GIRDER_SETTING_CORE_ENABLE_PASSWORD_LOGIN`	`core.enable_password_login`	v5.0.1	v5.0.1	`girder/settings.py`
`GIRDER_SETTING_CORE_FILEHANDLE_MAX_SIZE`	`core.filehandle_max_size`	v5.0.1	v5.0.1	`girder/settings.py`
`GIRDER_SETTING_CORE_GIRDER_MOUNT_INFORMATION`	`core.girder_mount_information`	v5.0.1	v5.0.1	`girder/settings.py`
`GIRDER_SETTING_CORE_PRIVACY_NOTICE`	`core.privacy_notice`	v5.0.1	v5.0.1	`girder/settings.py`
`GIRDER_SETTING_CORE_REGISTRATION_POLICY`	`core.registration_policy`	v5.0.1	v5.0.1	`girder/settings.py`
`GIRDER_SETTING_CORE_SERVER_ROOT`	`core.server_root`	v5.0.1	v5.0.1	`girder/settings.py`
`GIRDER_SETTING_CORE_SMTP_ENCRYPTION`	`core.smtp.encryption`	v5.0.1	v5.0.1	`girder/settings.py`
`GIRDER_SETTING_CORE_SMTP_HOST`	`core.smtp_host`	v5.0.1	v5.0.1	`girder/settings.py`
`GIRDER_SETTING_CORE_SMTP_PASSWORD`	`core.smtp.password`	v5.0.1	v5.0.1	`girder/settings.py`
`GIRDER_SETTING_CORE_SMTP_PORT`	`core.smtp.port`	v5.0.1	v5.0.1	`girder/settings.py`
`GIRDER_SETTING_CORE_SMTP_USERNAME`	`core.smtp.username`	v5.0.1	v5.0.1	`girder/settings.py`
`GIRDER_SETTING_CORE_UPLOAD_MINIMUM_CHUNK_SIZE`	`core.upload_minimum_chunk_size`	v5.0.1	v5.0.1	`girder/settings.py`
`GIRDER_SETTING_CORE_USER_DEFAULT_FOLDERS`	`core.user_default_folders`	v5.0.1	v5.0.1	`girder/settings.py`
`GIRDER_SETTING_GOOGLE_ANALYTICS_TRACKING_ID`	`google_analytics.tracking_id`	google_analytics	v5.0.1	`plugins/google_analytics/girder_google_analytics/settings.py`
`GIRDER_SETTING_GRAVATAR_DEFAULT_IMAGE`	`gravatar.default_image`	gravatar	v5.0.1	`plugins/gravatar/girder_gravatar/settings.py`
`GIRDER_SETTING_HASHSUM_DOWNLOAD_AUTO_COMPUTE`	`hashsum_download.auto_compute`	hashsum_download	v5.0.1	`plugins/hashsum_download/girder_hashsum_download/settings.py`
`GIRDER_SETTING_HOMEPAGE_HEADER`	`homepage.header`	homepage	v5.0.1	`plugins/homepage/girder_homepage/settings.py`
`GIRDER_SETTING_HOMEPAGE_LOGO`	`homepage.logo`	homepage	v5.0.1	`plugins/homepage/girder_homepage/settings.py`
`GIRDER_SETTING_HOMEPAGE_MARKDOWN`	`homepage.markdown`	homepage	v5.0.1	`plugins/homepage/girder_homepage/settings.py`
`GIRDER_SETTING_HOMEPAGE_SUBHEADER`	`homepage.subheader`	homepage	v5.0.1	`plugins/homepage/girder_homepage/settings.py`
`GIRDER_SETTING_HOMEPAGE_WELCOME_TEXT`	`homepage.welcome_text`	homepage	v5.0.1	`plugins/homepage/girder_homepage/settings.py`
`GIRDER_SETTING_ITEM_LICENSES_LICENSES`	`item_licenses.licenses`	item_licenses	v5.0.1	`plugins/item_licenses/girder_item_licenses/settings.py`
`GIRDER_SETTING_LDAP_SERVERS`	`ldap.servers`	ldap	v5.0.1	`plugins/ldap/girder_ldap/settings.py`
`GIRDER_SETTING_LDAP_SETTINGS`	`ldap.settings`	ldap	v5.0.1	`plugins/ldap/girder_ldap/settings.py`
`GIRDER_SETTING_OAUTH_BITBUCKET_CLIENT_ID`	`oauth.bitbucket_client_id`	oauth	v5.0.1	`plugins/oauth/girder_oauth/settings.py`
`GIRDER_SETTING_OAUTH_BITBUCKET_CLIENT_SECRET`	`oauth.bitbucket_client_secret`	oauth	v5.0.1	`plugins/oauth/girder_oauth/settings.py`
`GIRDER_SETTING_OAUTH_BOX_CLIENT_ID`	`oauth.box_client_id`	oauth	v5.0.1	`plugins/oauth/girder_oauth/settings.py`
`GIRDER_SETTING_OAUTH_BOX_CLIENT_SECRET`	`oauth.box_client_secret`	oauth	v5.0.1	`plugins/oauth/girder_oauth/settings.py`
`GIRDER_SETTING_OAUTH_CILOGON_CLIENT_ID`	`oauth.cilogon_client_id`	oauth	v5.0.1	`plugins/oauth/girder_oauth/settings.py`
`GIRDER_SETTING_OAUTH_CILOGON_CLIENT_SECRET`	`oauth.cilogon_client_secret`	oauth	v5.0.1	`plugins/oauth/girder_oauth/settings.py`
`GIRDER_SETTING_OAUTH_GITHUB_CLIENT_ID`	`oauth.github_client_id`	oauth	v5.0.1	`plugins/oauth/girder_oauth/settings.py`
`GIRDER_SETTING_OAUTH_GITHUB_CLIENT_SECRET`	`oauth.github_client_secret`	oauth	v5.0.1	`plugins/oauth/girder_oauth/settings.py`
`GIRDER_SETTING_OAUTH_GLOBUS_CLIENT_ID`	`oauth.globus_client_id`	oauth	v5.0.1	`plugins/oauth/girder_oauth/settings.py`
`GIRDER_SETTING_OAUTH_GLOBUS_CLIENT_SECRET`	`oauth.globus_client_secret`	oauth	v5.0.1	`plugins/oauth/girder_oauth/settings.py`
`GIRDER_SETTING_OAUTH_GOOGLE_CLIENT_ID`	`oauth.google_client_id`	oauth	v5.0.1	`plugins/oauth/girder_oauth/settings.py`
`GIRDER_SETTING_OAUTH_GOOGLE_CLIENT_SECRET`	`oauth.google_client_secret`	oauth	v5.0.1	`plugins/oauth/girder_oauth/settings.py`
`GIRDER_SETTING_OAUTH_IGNORE_REGISTRATION_POLICY`	`oauth.ignore_registration_policy`	oauth	v5.0.1	`plugins/oauth/girder_oauth/settings.py`
`GIRDER_SETTING_OAUTH_LINKEDIN_CLIENT_ID`	`oauth.linkedin_client_id`	oauth	v5.0.1	`plugins/oauth/girder_oauth/settings.py`
`GIRDER_SETTING_OAUTH_LINKEDIN_CLIENT_SECRET`	`oauth.linkedin_client_secret`	oauth	v5.0.1	`plugins/oauth/girder_oauth/settings.py`
`GIRDER_SETTING_OAUTH_MICROSOFT_CLIENT_ID`	`oauth.microsoft_client_id`	oauth	v5.0.1	`plugins/oauth/girder_oauth/settings.py`
`GIRDER_SETTING_OAUTH_MICROSOFT_CLIENT_SECRET`	`oauth.microsoft_client_secret`	oauth	v5.0.1	`plugins/oauth/girder_oauth/settings.py`
`GIRDER_SETTING_OAUTH_MICROSOFT_TENANT_ID`	`oauth.microsoft_tenant_id`	oauth	v5.0.1	`plugins/oauth/girder_oauth/settings.py`
`GIRDER_SETTING_OAUTH_PROVIDERS_ENABLED`	`oauth.providers_enabled`	oauth	v5.0.1	`plugins/oauth/girder_oauth/settings.py`
`GIRDER_SETTING_SENTRY_BACKEND_DSN`	`sentry.backend_dsn`	sentry	v5.0.1	`plugins/sentry/girder_sentry/settings.py`
`GIRDER_SETTING_SENTRY_FRONTEND_DSN`	`sentry.frontend_dsn`	sentry	v5.0.1	`plugins/sentry/girder_sentry/settings.py`
`GIRDER_SETTING_SLICER_CLI_WEB_TASK_FOLDER`	`slicer_cli_web.task_folder`	slicer_cli_web	v5.0.1	`plugins/slicer_cli_web/slicer_cli_web/config.py`
`GIRDER_SETTING_SLICER_CLI_WEB_WORKER_CONFIG_ITEM`	`slicer_cli_web.worker_config_item`	slicer_cli_web	v5.0.1	`plugins/slicer_cli_web/slicer_cli_web/config.py`
`GIRDER_SETTING_USER_QUOTA_DEFAULT_COLLECTION_QUOTA`	`user_quota.default_collection_quota`	user_quota	v5.0.1	`plugins/user_quota/girder_user_quota/settings.py`
`GIRDER_SETTING_USER_QUOTA_DEFAULT_USER_QUOTA`	`user_quota.default_user_quota`	user_quota	v5.0.1	`plugins/user_quota/girder_user_quota/settings.py`
`GIRDER_SETTING_WORKER_API_URL`	`worker.api_url`	worker	v5.0.1	`plugins/worker/girder_plugin_worker/event_handlers.py`
`GIRDER_SETTING_WORKER_DIRECT_PATH`	`worker.direct_path`	worker	v5.0.1	`plugins/worker/girder_plugin_worker/event_handlers.py`

Direct Environment Variables

Environment Variable	Component	Repo	Source File
`DOCKER_CLIENT_TIMEOUT`	v5.0.1	v5.0.1	`worker/girder_worker/docker/tasks/__init__.py`
`GIRDER_API_KEY`	slicer_cli_web	v5.0.1	`plugins/slicer_cli_web/slicer_cli_web/upload_slicer_cli_task.py`
`GIRDER_EMAIL_TO_CONSOLE`	v5.0.1	v5.0.1	`girder/utility/mail_utils.py`
`GIRDER_HOST`	v5.0.1	v5.0.1	`girder/utility/config.py`
`GIRDER_MAX_CURSOR_TIMEOUT_MS`	v5.0.1	v5.0.1	`girder/models/model_base.py`
`GIRDER_MONGO_REPLICA_SET`	v5.0.1	v5.0.1	`girder/utility/config.py`
`GIRDER_MONGO_URI`	v5.0.1	v5.0.1	`girder/cli/serve.py`
`GIRDER_NOTIFICATION_REDIS_URL`	v5.0.1	v5.0.1	`girder/notification.py`
`GIRDER_PASSWORD_REGEX`	v5.0.1	v5.0.1	`girder/models/user.py`
`GIRDER_PORT`	v5.0.1	v5.0.1	`girder/utility/config.py`
`GIRDER_S3_DOWNLOAD_RETRIES`	v5.0.1	v5.0.1	`girder/utility/s3_assetstore_adapter.py`
`GIRDER_SERVER_MODE`	v5.0.1	v5.0.1	`girder/cli/mount.py`
`GIRDER_SPHINX_BUILD`	v5.0.1	v5.0.1	`girder/__init__.py`
`GIRDER_STATIC_ROOT_DIR`	v5.0.1	v5.0.1	`girder/utility/server.py`
`GIRDER_TEST_DB`	v5.0.1	v5.0.1	`girder/utility/config.py`
`GIRDER_THREAD_POOL`	v5.0.1	v5.0.1	`girder/utility/config.py`
`GIRDER_URL_ROOT`	v5.0.1	v5.0.1	`girder/api/describe.py`
`GIRDER_VALID_PASSWORD_DESCRIPTION`	v5.0.1	v5.0.1	`girder/models/user.py`
`GIRDER_WORKER_BACKEND`	v5.0.1	v5.0.1	`worker/girder_worker/celeryconfig.py`
`GIRDER_WORKER_BROKER`	v5.0.1	v5.0.1	`worker/girder_worker/celeryconfig.py`
`GIRDER_WORKER_CELERY_APP_MAIN`	v5.0.1	v5.0.1	`worker/girder_worker/app.py`
`GIRDER_WORKER_JOB_GC_SCOPE`	v5.0.1	v5.0.1	`worker/girder_worker/utils/transforms/girder_io.py`
`GIRDER_WORKER_LOGGING_FORMAT`	v5.0.1	v5.0.1	`worker/girder_worker/log_utils.py`
`GIRDER_WORKER_LOGGING_LEVEL`	v5.0.1	v5.0.1	`worker/girder_worker/log_utils.py`
`GIRDER_WORKER_TASK_ALWAYS_EAGER`	v5.0.1	v5.0.1	`worker/girder_worker/celeryconfig.py`
`GW_DIRECT_PATHS`	v5.0.1	v5.0.1	`worker/girder_worker/utils/transforms/contrib/girder_io.py`
`LOGLEVEL`	v5.0.1	v5.0.1	`girder/utility/server.py`