Configuration settings

Default settings are configured to provide a testing/development environment. For a production setup it is recommended to adjust them following your target environment.

When using docker-compose, the configuration is loaded from environment variables file placed in the folder docker/environment_variables.

When using Kubernetes, the configuration need to be placed in the squest.yml inventory file in the variable squest_django/env.

Database

DATABASE

Default: default

Setup mysql database usage Set to psql for postgres SQL usage

DB_DATABASE

Default: squest_db

Database name.

DB_USER

Default: squest_user

User used to connect to the DB_DATABASE name.

DB_PASSWORD

Default: squest_password

Password of the DB_USER username.

DB_HOST

Default: 127.0.0.1

Database host. The default value is localhost to match the development configuration. Switch to db in production when using the docker-compose based deployment.

DB_PORT

Default: 3306

Database port.

Authentication

LDAP

LDAP_ENABLED

Default: False

Set to True to enable LDAP based authentication.

AUTH_LDAP_SERVER_URI

Default: NONE

Set the URI of your LDAP server, using a protocol prefix (ldap:// or ldaps://) and the server's hostname, e.g. ldaps://ldap.example.com.

AUTH_LDAP_BIND_DN

Default: NONE

Set the LDAP DN to authenticate to the LDAP server, e.g. cn=service_account_name,ou=Applications,o=domain.com.

AUTH_LDAP_BIND_PASSWORD

Default: NONE

Associated to AUTH_LDAP_BIND_DN, this sets the password used to authenticate

AUTH_LDAP_USER_SEARCH

Default: NONE

Base DN for the user search, e.g. ou=People,o=domain.com

AUTH_LDAP_USER_SEARCH_FILTER

Default: (uid=%(user)s)

LDAP search filter for the user search. For connections to an Active Directory this is normally set to (sAMAccountName=%(user)s).

AUTH_LDAP_ATTR_FIRSTNAME

Default: givenName

set the LDAP "first_name" attribute

AUTH_LDAP_ATTR_LASTNAME

Default: sn

set the LDAP "last_name" attribute

AUTH_LDAP_ATTR_MAIL

Default: mail

set the LDAP "email" attribute

OpenID Connect

SOCIAL_AUTH_OIDC_ENABLED

Default: False

set to True to enable OpenID Connect based authentication

SOCIAL_AUTH_OIDC_BTN_TEXT

Default: OpenID Login

set the OpenID Connect login button text

SOCIAL_AUTH_OIDC_OIDC_ENDPOINT

Default: None

set the endpoint to the base url and the remaining configuration will be auto-completed like so: <SOCIAL_AUTH_OIDC_OIDC_ENDPOINT>/.well-known/openid-configuration

SOCIAL_AUTH_OIDC_KEY

Default: None

set to the OpenID client ID that Squest should be configured to use

SOCIAL_AUTH_OIDC_SECRET

Default: None

set to the OpenID client secret that Squest should be configured to use

Password & token

PASSWORD_ENABLED

Default: True

set to False to disable the password form on the login view

DEFAULT_ADMIN_PASSWORD

Default: None

Set a default password to the admin user when starting Squest.

LOGIN_HELPER_TEXT

Default: None

Add a custom note into the login page that helps user to know what are the expected credentials. HTML text is supported.

E.G: "Use your corporate email and password".

DEFAULT_ADMIN_TOKEN

Default: None

Set an API token that will be linked to the admin user when starting Squest.

Squest

MAINTENANCE_MODE_ENABLED

Default: False

When enabled, only administrators can access squest UI and API. This can be used for example to block new requests by end users from the service catalog. So an administrator can perform operations against the API like migrating instance specs.

Note

This can also be set on the fly from the admin panel (top right corner of the UI) in the object Squest settings.

SQUEST_HOST

Default: http://squest.domain.local

Address of the Squest portal instance. Used in email templates and in metadata sent to Red Hat Ansible Automation Platform/AWX job templates.

SQUEST_ADMINS

Default: ''

Comma separated list of email who get code error notifications. When DEBUG=False. Example:

elias.boulharts@mail.com,nicolas.marcq@mail.com

IS_DEV_SERVER

Default: False

Set to True to change the navbar and footer color to visually identify a testing instance of Squest.

GUNICORN_WORKERS

Default: 4

Number of workers used by Gunicorn process in charge of serving client connection. Increase the number of worker threads to serve more clients concurrently

DOC_IMAGES_CLEANUP_ENABLED

Default: False

Switch to True to enable automatic cleanup of ghost docs images from media folder.

DOC_IMAGES_CLEANUP_CRONTAB

Default: 30 1 * * *

Crontab line for ghost image cleanup. By default performed every day at 1:30 AM.

SMTP

SQUEST_EMAIL_NOTIFICATION_ENABLED

Default: Based on DEBUG value by default

Set to True to enable email notifications.

SQUEST_EMAIL_HOST

Default: squest@squest.domain.local

Domain name used as email sender. E.g: "squest@squest.domain.local".

EMAIL_HOST

Default: localhost

The SMTP host to use for sending email.

EMAIL_PORT

Default: 25

Port to use for the SMTP server defined in EMAIL_HOST.

EMAIL_HOST_USER

Default: None

User to use to authenticate with the SMTP server defined in EMAIL_HOST in combination with EMAIL_HOST_PASSWORD. Leave empty/unconfigured to send emails unauthenticated.

EMAIL_HOST_PASSWORD

Default: None

Password to use to authenticate with the SMTP server defined in EMAIL_HOST in combination with EMAIL_HOST_USER. Leave empty/unconfigured to send emails unauthenticated.

EMAIL_USE_SSL

Default: False

Whether to use an implicit TLS (secure) connection when talking to the SMTP server defined in EMAIL_HOST.

Backup

BACKUP_ENABLED

Default: False

Switch to True to enable backup. Refer to the dedicated documentation.

BACKUP_CRONTAB

Default: 0 1 * * *

Crontab line for backup. By default, the backup is performed every day at 1AM.

DBBACKUP_CLEANUP_KEEP

Default: 5

Number of db backup file to keep. Doc.

DBBACKUP_CLEANUP_KEEP_MEDIA

Default: 5

Number of media backup tar to keep. Doc.

Metrics

METRICS_ENABLED

Default: False

Switch to True to enable Prometheus metrics page.

METRICS_PASSWORD_PROTECTED

Default: True

Switch to False to disable the basic authentication on metrics page.

METRICS_AUTHORIZATION_USERNAME

Default: admin

Username for the basic authentication of the metrics page.

METRICS_AUTHORIZATION_PASSWORD

Default: admin

Password for the basic authentication of the metrics page.

Django

SECRET_KEY

Default: Default randomly-generated

Django secret key used for cryptographic signing. Doc.

DEBUG

Default: True

Django DEBUG mode. Switch to False for production.

SQL_DEBUG

Default: False

Enables SQL debug logs.

ALLOWED_HOSTS

Default: *

Comma separated list of allowed FQDN. Refer to the complete documentation.

CSRF_TRUSTED_ORIGINS

Default: http://127.0.0.1:8080,http://localhost:8080

Comma separated list of trusted origin. Refer to the complete documentation.

Note

If you deploy with http://1.2.3.4:8080, please add CSRF_TRUSTED_ORIGINS=http://127.0.0.1:8080,http://localhost:8080,http://1.2.3.4:8080 in your variables.

LANGUAGE_CODE

Default: en-us

Django language. Doc

TIME_ZONE

Default: Europe/Paris

Time zone of the server that host Squest service. Doc

DATE_FORMAT

Default: %d %b, %Y %H:%M

Change the format of all date in Squest UI. Based on Python strftime.

RabbitMQ

RabbitMQ is used as message broker for asynchronous tasks executed by Squest via the "Celery" python library.

RABBITMQ_USER

Default: rabbitmq

RabbitMQ message broker user.

RABBITMQ_PASSWORD

Default: rabbitmq

RabbitMQ message broker password.

RABBITMQ_HOST

Default: localhost

RabbitMQ message broker host. The default value is localhost to match the development configuration. Replace localhost by rabbitmq in production when using the docker-compose or kubernetes based deployment.

RABBITMQ_PORT

Default: 5672

RabbitMQ message broker port.

RABBITMQ_VHOST

Default: squest

RabbitMQ message broker vhost.

Redis

REDIS_CACHE_USER

Default: default

Username of Redis account.

REDIS_CACHE_PASSWORD

Default: redis_secret_password

Password of Redis account.

REDIS_CACHE_HOST

Default: 127.0.0.1

Redis hostname.

REDIS_CACHE_PORT

Default: 6379

Redis port.