Settings

A Daiquiri application can be customised using various settings. Since Daiquiri is based on Django, we use its build-in settings system. Almost every setting has a default value, which is set in the Daiquiri library. The core settings are defined in the daiquiri.core.settings module:

Additional settings, which concern only a single Daiquiri module are defined in the settings module of the particular module:

All settings can be changed for your particular app in config/settings/base.py (app specific) or config/settings/local.py (machine specific, and ignored by git). In addition, selected settings can be configured as environment variables, in particular using the .env file app directory:

Setting Default
SECRET_KEY 🚫
SITE_URL http://localhost:8000
DEBUG False
ASYNC False
ALLOWED_HOSTS ['localhost']
TIME_ZONE 'UTC'
PROXY False
ADMINS []
DATABASE_APP 🚫
DATABASE_DATA 🚫
TAP_SCHEMA TAP_SCHEMA
TAP_UPLOAD TAP_UPLOAD
OAI_SCHEMA OAI_SCHEMA

In the .env file, lists are seperated by comma, e.g. ADMINS=Anna Admin <admin@example.com>, Manni Manager <manager@example.com>. Since SECRET_KEY, DATABASE_APP, and DATABASE_DATA have no default value, they need to be set in any case.

In the following all settings, which can be changed from their default values to customize you particular Daiquiri app are described in detail:

daiquiri.core.settings.django

SECRET_KEY

Secret key for Django.

See also SECRET_KEY in the Django documentation. Should be set in .env.

DEBUG

Default: False

Debug mode. See also DEBUG in the Django documentation. Should be set in .env.

BASE_URL

Default: /

Base URL for the Daiquiri app. Set if your Daiquiri app runs under a alias path on your web server, e.g. /daiquiri/.

ALLOWED_HOSTS

Default: ['localhost']

List of allowed hosts for this app.

See also ALLOWED_HOSTS in the Django documentation. Should be set in .env.

INSTALLED_APPS

The list of Django apps for this Daiquiri site. Usually it is set to

INSTALLED_APPS = DJANGO_APPS + [
    # the list of Daiquiri modules for this site
    ...
] + ADDITIONAL_APPS

See also INSTALLED_APPS in the Django documentation.

USER_TABLESPACE

Default: 'pg_default'

The tablespace where to store the user queryjob tables. Only supported for Postgres DB.

TIME_ZONE

Default: 'UTC'

The time zone for this Daiquiri app (e.g. Europe/Berlin).

ACCOUNT_LOGOUT_ON_GET

Default: False

Designates if a GET request is sufficient to logout. The seeting needs to be set to TRUE if the WordPress integration is used.

ACCOUNT_USERNAME_MIN_LENGTH

Default: 4

The minimal length of usernames.

ACCOUNT_PASSWORD_MIN_LENGTH

Default: 4

The minimal length of passwords.

ACCOUNT_EMAIL_VERIFICATION

Default: 'mandatory'

Designates if new users need to verify their email addresses before logging in. Options are

  • 'mandatory'
  • 'optional'
  • 'none'

See also ACCOUNT_EMAIL_VERIFICATION in the django-allauth documentation.

ACCOUNT_LOGIN_ON_EMAIL_CONFIRMATION

Default: True

Designates if new users are automatically logged in after validating their email address.

REST_FRAMEWORK

Default:

{
    'DEFAULT_THROTTLE_CLASSES': (
        'rest_framework.throttling.ScopedRateThrottle',
    ),
    'DEFAULT_THROTTLE_RATES': {
        'query.create': '10/second'
    }
}

Configuration object for the Django REST framework. Used to adjust the maximum rate in which queries are allowed to be submitted (by anyone). See also Throttling in the Django REST framework documentation.

CELERY_BROKER_URL

Default: amqp://

URL of the RabbitMQ server to be used. For a more sophisticated setup use:

CELERY_BROKER_URL=amqp://<user>:<password>@<host>:<port>/<vhost>

See also deployment. Should be set in .env.

EMAIL_BACKEND

Default: 'django.core.mail.backends.console.EmailBackend'

Sets the backend used for email delivery. On a production system, this will be django.core.mail.backends.smtp.EmailBackend. For testing/demonstration django.core.mail.backends.console.EmailBackend can be used. See also Sending email in the Django documentation. Can be set in .env.

EMAIL_HOST

Default: 'localhost'

Hostname of the SMTP server. Can be set in .env.

EMAIL_PORT

Default: '25'

Port of the SMTP server. Can be set in .env.

EMAIL_HOST_USER

Default: ''

User for the SMTP server. Can be set in .env.

EMAIL_HOST_PASSWORD

Default: ''

Password for the SMTP server. Can be set in .env.

EMAIL_USE_TLS

Default: False

Designates whether a STARTTLS is used (usually on port 587). Can be set in .env.

EMAIL_USE_SSL

Default: False

Designates whether a implicit TLS connection is used (usually on port 465). Can be set in .env.

DEFAULT_FROM_EMAIL

Default: ''

Sets the FROM field for the E-mails send. Can be set in .env.

SENDFILE_BACKEND

Default: 'sendfile.backends.simple'

Sets the backend used for the sendfile integration to deliver static files. On a production system (using Apache), this will be sendfile.backends.xsendfile. For testing/demonstration sendfile.backends.simple can be used.

See also Django Sendfile GitHub readme.

MEMCACHE_KEY_PREFIX

Default: None

Key prefix to use for caching with memcached. Enables caching with memcached. See also deployment. Should be set in .env.

daiquiri.core.settings.daiquiri

ASYNC

Default: False

Designates if celery workers are used for asyncronous tasks like query execution. If set to True, three workers need to run: default, query, and download.

IPV4_PRIVACY_MASK

Default: 16

Number of bits kept from IPv4 addresses (e.g. to produce query stats) for anonymity.

IPV6_PRIVACY_MASK

Default: 32

Number of bits kept from IPv6 addresses (e.g. to produce query stats) for anonymity.

SITE_URL

Default: http://localhost:8000

Public URL of the Daiquiri site. Used for VO and OAI metadata.

SITE_IDENTIFIER

Default: None

Identifier for the Daiquiri site. Usually the URL without the protocol. Used for VO and OAI metadata.

SITE_TITLE

Default: None

The title for the Daiquiri site. Used for VO and OAI metadata.

SITE_DESCRIPTION

Default: None

The description for the Daiquiri site. Used for VO and OAI metadata.

SITE_LICENSE

Default: None

A license for the Daiquiri site. See https://github.com/django-daiquiri/daiquiri/blob/master/daiquiri/core/constants.py for the available choices. Used in various metadata fields.

SITE_CREATOR

Default: None

Creator of the Daiquiri site. Used in the VO registry entry. Has to be of the following form:

{
    'name': 'Daiquiri project'
    'logo': None
}

SITE_CONTACT

Default: None

List of contacts for the Daiquiri site. Used in the VO registry entry. Has to be of the following form:

{
    'name': 'Anna Admin'
    'address': 'Beispielstr. 3, 12345 Berlin',
    'email': 'contact@example.com'
    'telephone': '+49 30 123467'
}

SITE_PUBLISHER

Default: None

Publisher of the Daiquiri site. Used for VO and OAI metadata.

SITE_CREATED

Default: None

Date of the creation of the Daiquiri site. Used for VO and OAI metadata. Has to be of the form YYYY-MM-DD.

SITE_UPDATED

Default: None

Date of the last update of the Daiquiri site. Used for VO and OAI metadata. Has to be of the form YYYY-MM-DD.

SITE_SUBJECTS

Default:

[
    {
        'subject': 'Astronomy',
        'schemeURI': 'http://id.loc.gov/authorities/subjects',
        'valueURI': 'http://id.loc.gov/authorities/subjects/sh85009003'
    }
]

Subjects for this Daiquiri app. Used for VO and OAI metadata.

SITE_TYPE

Default: 'service'

Type for this Daiquiri site. Used in the VO registry entry.

daiquiri.core.settings.logging

LOG_LEVEL

Default: INFO

Level of logging. Set to DEBUG to get more verbose logging. Should be set in .env.

LOG_DIR

Default: None

Directory for log files. In development log is suitable, in production /var/log/django/daiquiri/ might be a sensible choice. Note that this directory must exist for Daiquiri to work. Should be set in .env.

daiquiri.core.settings.vendor

VENDOR_CDN

Default: False

Use content delivery networks to host the static vendor assets (js and css files). Using the default of False implies that the assets need to be collected using python manage.py download_vendor_files.

daiquiri.archive.settings

ARCHIVE_BASE_PATH

Default: os.path.join(BASE_DIR, 'files')

Sets the absolute base path of the files served by the archive module in the local file system.

ARCHIVE_DOWNLOAD_DIR

Default: os.path.join(BASE_DIR, 'download')

Sets the absolute path where the zip files for downloads from the archive are located in the local file system.

ARCHIVE_ANONYMOUS

Default: False

Designates if the archive interface can be accessed by anonymus users.

ARCHIVE_SCHEMA

Default: 'daiquiri_archive'

Sets the schema for the archive in the data database.

ARCHIVE_TABLE

Default: 'files'

Sets the table for the archive in the schema set by ARCHIVE_SCHEMA the data database.

ARCHIVE_COLUMNS

Default:

[
    {
        'name': 'id',
        'hidden': True
    },
    {
        'name': 'timestamp',
        'label': 'Timestamp'
    },
    {
        'name': 'file',
        'label': 'Filename',
        'ucd': 'meta.file'
    },
    {
        'name': 'collection',
        'hidden': True
    },
    {
        'name': 'path',
        'hidden': True
    }
]

Sets the additional columns for the archive in the table set by ARCHIVE_TABLE the data database.

daiquiri.auth.settings

AUTH_SIGNUP

Default: False

Designates if users can register for an account. If set to false, all users need to be created through the Django admin system.

AUTH_WORKFLOW

Default: None

Sets the workflow for user registration. Options are

  • None: Newly registered users can log in after registartion.
  • 'activation': Newly registered users need to be activated by a manager or admin.
  • 'confirmation': Newly registered users need to be confirmed by a manager before they are activated by an admin.

AUTH_DETAIL_KEYS

Default: []

Sets additional details to be asked from the users when registering. An example would be:

AUTH_DETAIL_KEYS = [
    {
        'key': 'affiliation',
        'label': 'Affiliation',
        'data_type': 'text',
        'required': True,
        'options': []
    },

]

where:

  • key is the internal identifier,
  • label the text shown in the interface,
  • datatype the type of the detail which affects the widget to be used ('text', 'textarea', 'select', 'radio', 'multiselect', or 'checkbox'),
  • required whether this detail is required or not, and
  • options a list of options for select, radio or checkboxes widgets of the form [{'id': id, 'label': label}, ...].

AUTH_TERMS_OF_USE

Default: False

Designates whether terms of use are displayed on the signup page and need to be accepted to register. The text of to displayed needs to be configured in a template account/terms_of_use.html.

daiquiri.conesearch.settings

CONESEARCH_ADAPTER

Default: 'daiquiri.conesearch.adapter.SimpleConeSearchAdapter'

Sets the adapter class to be used by the cone search api. The adapter class encapsulated all operations creating a cone search votable output from the api request. Custom adapter need to enherit from daiquiri.conesearch.adapter.BaseConeSearchAdapter.

CONESEARCH_ANONYMOUS

Default: False

Designates if cone searches can be done by by anonymous users.

daiquiri.contact.settings

ANNOUNCEMENT_MESSAGE_FILTER

Default: daiquiri.contact.filters.DefaultMessageFilter

Sets the filter class to be used by the announcement messages. The filter class encapsulates all filter methods used to show announcements to a filtered set of users. Custom filter class must enherit from daiquiri.contact.filters.DefaultMessageFilter. All custom filter methods are required to have a single parameter request.

The announcement messages can be added in the Django admin site. In order to show the messages on a webpage, one has to load the announcement tags in the template {% load announcement_tags %} and then place {% show_announcements %} where the messages should be shown.

daiquiri.cutout.settings

CUTOUT_ADAPTER

Default: 'daiquiri.cutout.adapter.SimpleCutOutAdapter'

Sets the adapter class to be used by the cutout api. The adapter class encapsulated all operations creating a cut out from the api request. Custom adapter need to enherit from daiquiri.cutout.adapter.BaseCutOutAdapter.

CUTOUT_ANONYMOUS

Default: False

Designates if the cutout interface can be accessed by anonymus users.

daiquiri.files.settings

FILES_BASE_PATH

Default: os.path.join(BASE_DIR, 'files')

Sets the absolute base path of the files served by the files module in the local file system. Should be set in .env.

FILES_BASE_URL

Default: None

Sets the absolute URL for this Daiquiri app to be prepended to file references when downloading query results. This is done for columns with the meta.ref;meta.file, meta.ref;meta.image or meta.ref;meta.note UCD. Should be set in .env.

FILES_DOCS_REL_PATH

Default: None

Sets the relative file path to the documentation files on which the file search will be executed. The path is given relative to the FILES_BASE_PATH.

In order to use the search function for the files, one has to include the search field into the template.

{% include 'files/search-input.html' %}

The layout of the results page can be changed by overloading the template files/search-results.html in the daiquri app.

FILES_SEARCH_RESULTS_PER_PAGE

Default: 5

Sets the number of search results per page.

daiquiri.meetings.settings

MEETINGS_CONTRIBUTION_TYPES

Default:

[
    ('talk', _('Talk')),
    ('poster', _('Poster'))
]

Sets the types of contributions to be selected by partcipants when registering.

MEETINGS_PAYMENT_CHOICES

Default:

[
    ('cash', _('cash')),
    ('wire', _('wire transfer')),
]

Sets the different payment choices to be selected by partcipants when registering.

MEETINGS_PARTICIPANT_DETAIL_KEYS

Default: []

Sets additional details to be asked from the participants when registering. An example would be:

MEETINGS_PARTICIPANT_DETAIL_KEYS = [
    {
        'key': 'affiliation',
        'label': 'Affiliation',
        'data_type': 'text',
        'required': True
    },
    {
        'key': 'dinner',
        'label': 'Conference dinner',
        'data_type': 'radio',
        'required': True,
        'options': [
            {'id': 'yes', 'label': 'yes'},
            {'id': 'no', 'label': 'no'}
        ]
    }
]

where:

  • key is the internal identifier,
  • label the text shown in the interface,
  • datatype the type of the detail which affects the widget to be used ('text', 'textarea', 'select', 'radio', 'multiselect', or 'checkbox'),
  • required whether this detail is required or not, and
  • options a list of options for select, radio or checkboxes widgets of the form [{'id': id, 'label': label}, ...].

MEETINGS_ABSTRACT_MAX_LENGTH

Default: 2000

Sets the maximum lenght of an abstract.

daiquiri.metadata.settings

METADATA_COLUMN_PERMISSIONS

Default: False

Designates if permissions can be assigned to individual columns (in addition to tables and schemas). This is an experimental feature.

METADATA_BASE_URL

Default: None

Sets the absolute URL of the metadata module, e.g. http://example.com/metadata/. The URL is used to create links to the landing pages for schemas and tables in VOTables if a DOI is not set.

daiquiri.oai.settings

OAI_SCHEMA

Default: OAI_SCHEMA

Sets the name of the schema for OAI records. If more than one Daiquiri application is using the same data database, they cannot use the same OAI_SCHEMA schema. This setting must be set in .env

OAI_ADAPTER

Default: 'daiquiri.metadata.adapter.RegistryDoiMetadataOaiAdapter'

Sets the adapter class to be used by the OAI-PMH api. The adapter class encapsulated all operations to set up and retrieve the OAI records. Custom adapter need to enherit from daiquiri.metadata.adapter.BaseOaiAdapter. Usually this will be done in the Daiquiri app, e.g.

OAI_ADAPTER = 'app.adapter.OaiAdapter'

OAI_PAGE_SIZE

Default: 500

Number of records returned in a OAI-PMH request.

daiquiri.query.settings

QUERY_ANONYMOUS

Default: False

Designates if the query interface can be accessed by anonymus users. The permissions on schemas and tables need to be configured using the metadata interface.

QUERY_USER_SCHEMA_PREFIX

Default: 'daiquiri_user_'

Sets the prefix for user schemas in the data database. Each user has a private schema where the result table of successful queries are stored.

QUERY_QUOTA

Default:

{
    'anonymous': '100Mb',
    'user': '10000Mb',
    'users': {},
    'groups': {}
}

Sets the maximum quota for tables in a user’s personal schema. The quota need to be set for the anonymous user as well as regular loggen in users (user). Additionally, users or groups can be asigned individual quotas, e.g.:

{
    'anonymous': '100Mb',
    'user': '10000Mb',
    'users': {
        'admin': '1000Gb'
    },
    'groups': {
        'collab': '100Gb'
    }
}

If more than one quota applies, the maximum is used.

QUERY_SYNC_TIMEOUT

Default: 5

Sets the timeout for syncronous (TAP) queries in seconds.

QUERY_MAX_ACTIVE_JOBS

Default:

{
    'anonymous': '1'
}

Sets the maximum of simultanous jobs for users. The setting work analog to ‘QUERY_QUOTA’. If more than one maximum applies, the maximum is used. If no maximum is given, like the default setting for logged users, no maximum is enforced.

QUERY_QUEUES

Default:

[
    {
        'key': 'default',
        'label': 'Default',
        'timeout': 10,
        'priority': 1,
        'access_level': 'PUBLIC',
        'groups': []
    }
]

Set the different queue, which can be selected by the users. Each queue is represented by a dictionary where:

  • key is the internal identifier,
  • label is the text shown in the interface,
  • timeout the maximum excecution time in seconds,
  • priority is a integer number indicationg the priority in which jobs are executed, and
  • access_level and groups the usual restiction on who can use this queue.

Jobs in a queue with higher priority are selected first when a query worker becomes available.

QUERY_LANGUAGES

Default:

[
    {
        'key': 'adql',
        'version': 2.0,
        'label': 'ADQL',
        'description': '',
        'quote_char': '"'
    }
]

Sets the different query languages, which can be selected by the users. Each query language is represented by a dictionary where:

  • key is the internal identifier,
  • label is the text shown in the interface,
  • description is additional information shown, e.g. in TopCat, and
  • quote_char the character used by the database system to quote identifiers.

Already implemented in Daiquiri are adql, postgresql, and mysql. Apart from ADQL, the query language must match the database system of the data database.

QUERY_FORMS

Default:

[
    {
        'key': 'sql',
        'label': 'SQL query',
        'service': 'query/js/forms/sql.js',
        'template': 'query/query_form_sql.html'
    }
]

Sets the form available for the users in the query interface. Each form is represented by a dictionary where:

  • key is the internal identifier,
  • label is the text shown in the interface,
  • service the path AngularJS service containing the client side logic, and
  • template the path to the Django template with the markup for the form.

Included in Daiquiri are sql and (simplyfied) cone and box services.

QUERY_PLOTS

Default:

[
    {
        'key': 'scatter_plot',
        'label': 'Scatter',
        'is_active': True,
    },
    {
        'key': 'scatter_cmap_plot',
        'label': 'Scatter (color coded)',
        'is_active': True,
    },
    {
        'key': 'histogram',
        'label': 'Histogram',
        'is_active': True,
    }
]

Sets the visibility of the available plot types in the web interface.

  • key is the internal identifier,
  • label is the type name shown in the interface, and
  • is_active controls whether the plot type is used in the interface.

QUERY_DROPDOWNS

Default:

[
    {
        'key': 'simbad',
        'service': 'query/js/dropdowns/simbad.js',
        'template': 'query/query_dropdown_simbad.html',
        'options': {
            'url': 'http://simbad.u-strasbg.fr/simbad/sim-id'
        }
    },
    {
        'key': 'vizier',
        'service': 'query/js/dropdowns/vizier.js',
        'template': 'query/query_dropdown_vizier.html',
        'options': {
            'url': 'http://vizier.u-strasbg.fr/viz-bin/votable',
            'catalogs': ['I/322A', 'I/259']
        }
    }
]

Sets the additional drop down menus above the SQL query interface available for the users. Each drop down is represented by a dictionary where:

  • key is the internal identifier,
  • service the path AngularJS service containing the client side logic,
  • template the path to the Django template with the markup, and
  • options additional options specific to the drop down.

Included in Daiquiri are simbad and vizier services.

QUERY_DOWNLOAD_DIR

Default: os.path.join(BASE_DIR, 'download')

Sets the absolute base path of the download files served by the query module in the local file system.

QUERY_DEFAULT_DOWNLOAD_FORMAT

Default: 'votable'

Sets the default download format.

QUERY_DOWNLOAD_FORMATS

Default:

[
    {
        'key': 'votable',
        'extension': 'xml',
        'content_type': 'application/xml',
        'label': 'IVOA VOTable XML file - TABLEDATA serialization',
        'help': 'A XML file using the IVOA VOTable format. Use this option if you intend to use VO compatible software to further process the data.'
    },
    {
        'key': 'csv',
        'extension': 'csv',
        'content_type': 'text/csv',
        'label': 'Comma separated Values',
        'help': 'A text file with a line for each row of the table. The fields are delimited by a comma and quoted by double quotes. Use this option for a later import into a spreadsheed application or a custom script. Use this option if you are unsure what to use.'
    },
    {
        'key': 'fits',
        'extension': 'fits',
        'content_type': 'application/fits',
        'label': 'FITS',
        'help': 'Flexible Image Transport System (FITS) file format.'
    }
]

Sets the available default download formats. Each format is represented by a dictionary where:

  • key is the internal identifier,
  • extension the file extension,
  • content_type the content type,
  • label the text shown in the interface, and
  • help a more verbose help text for the format.

QUERY_UPLOAD

Default: True

Enables the upload functionality in the query interface.

QUERY_UPLOAD_LIMIT

Default:

{
    'anonymous': '10Mb',
    'user': '100Mb',
    'users': {},
    'groups': {}
}

Sets the maximum quota for uploads by a user. The quota need to be set for the anonymous user as well as regular loggen in users (user). Additionally, users or groups can be asigned individual quotas, much like with QUERY_QUOTA.

daiquiri.serve.settings

SERVE_DOWNLOAD_DIR

Default: os.path.join(BASE_DIR, 'download')

Sets the absolute base path of the download files served by the serve module in the local file system.

SERVE_RESOLVER

Default: None

Sets the a resolver class to handle references in tables served by the serve module.

daiquiri.stats.settings

STATS_RESOURCE_TYPES

Default:

[
    {
        'key': 'ARCHIVE_DOWNLOAD',
        'label': 'Archive downloads'
    },
    {
        'key': 'CONESEARCH',
        'label': 'Performed cone searches'
    },
    {
        'key': 'CUTOUT',
        'label': 'Performed cutouts'
    },
    {
        'key': 'FILE',
        'label': 'File downloads'
    },
    {
        'key': 'QUERY',
        'label': 'Queries'
    }
]

Sets the aggegated stats shown in the stats management overview.

daiquiri.tap.settings

TAP_SCHEMA

Default: 'TAP_SCHEMA'

Sets the name of the TAP schema. If more than one Daiquiri application is using the same data database, they cannot use the same TAP schema. Therefore the schema name TAP_SCHEMA is replaced before queries are submitted. This setting must be set in .env

TAP_UPLOAD

Default: 'TAP_UPLOAD'

Sets the name of the schema for TAP uploads. If more than one Daiquiri application is using the same data database, they cannot use the same TAP_UPLOAD schema. Therefore the schema name TAP_UPLOAD is replaced before queries are submitted. This setting must be set in .env

daiquiri.uws.settings

UWS_RESOURCES

Default: []

Configures UWS services (in addition to the TAP module). E.g.:

{
    'prefix': r'query',
    'viewset': 'daiquiri.query.viewsets.UWSQueryJobViewSet',
    'base_name': 'uws_query'
}

where:

  • prefix is part of the base URL of the service (e.g. http://example.com/usw/query),
  • viewset is the ViewSet class handling the requests (neets to enherit from daiquiri.jobs.viewsets.AsyncJobViewSet), and
  • base_name a basename needed for the integration in the Django REST framework.

daiquiri.wordpress.settings

WORDPRESS_PATH

Default: '/opt/wordpress'

Sets the location of the WordPress installation on the local file system.

WORDPRESS_SSH

Default: None

Sets the destination for a SSH connection to use with wp-cli. Use this setting if WordPress is not installed on the same host as Daiquiri. The local wp-cli will then connect to the remote system using ssh. An example would be:

WORDPRESS_SSH=example.com:/opt/daiquiri

This option overided WORDPRESS_PATH.

WORDPRESS_CLI

Default: '/opt/wp-cli/wp'

Sets the location of the wp-cli script on the local file system.

WORDPRESS_URL

Default: '/cms/'

Sets the base url of the WordPress instance.