Configuration

Unless otherwise specified, all configuration settings on this page live in the .env file of the application (Console or Dashboard). Each application installation root has a file named .env in its root directory, defining its operating environment. Non-DFE related settings are _not_ documented here.

Console

Operational Settings

These settings govern the operations of the DreamFactory Enterprise™ Console.

Many of these settings are created at the time of installation. Changing them may cause your system to not function properly. Back up your original file and use caution when making any changes.

DFE_CLUSTER_ID

The cluster in which this system is included

DFE_SCRIPT_USER

The system user to use when running back-end shell scripts. Defaults to dfadmin.

DFE_EMAIL_SUBJECT_PREFIX

Default prefix for email sent from console. Defaults to [DFE]

DFE_DEFAULT_INSTANCE_PREFIX

A string to prepend to non-admin created instance names.

DFE_DEFAULT_CLUSTER

The default cluster to use. Set at installation.

DFE_DEFAULT_DATABASE

The default database to use. Set at installation.

DFE_DEFAULT_GUEST_LOCATION

The default provisioner to use. Defaults to 2, indicating DreamFactory

DFE_SIGNATURE_METHOD

The hash algorithm to use system-wide. Defaults to sha256.

DFE_LOGIN_REQUIRED_FOR_BLUEPRINT

If admin credentials are required for blueprinting. Defaults to false.

DNS Settings

These settings govern the way instance and back-end URLs are created.

DFE_DEFAULT_DNS_ZONE

The subdomain for instances (i.e. dfe). Set at installation.

DFE_DEFAULT_DNS_DOMAIN

The top-level domain for instances (i.e. example.com). Set at installation.

DFE_DEFAULT_DOMAIN

The fully qualified domain name to use for this system (i.e. dfe.example.com). This is merely the combination of the prior two settings, and is set at installation.

DFE_DEFAULT_DOMAIN_PROTOCOL

The HTTP protocol to use, by default. This can be http (the default) or https.

DFE_DASHBOARD_URL

The URL used in generated links to send users to the DFE Dashboard. This is generated at the time of installation.

DFE_SUPPORT_EMAIL_ADDRESS

The support email address to use in correspondence.

Auditing

Metadata from all API calls made by managed instances is stored in the DFE log processing system. These settings modify some of that behaviour.

DFE_AUDIT_HOST

The host name of the data collection server. Set by installation system.

DFE_AUDIT_PORT

The port number of the data collection server. Set by installation system.

DFE_AUDIT_MESSAGE_FORMAT

The message format of the audit data (0 = GELF, is only supported currently). Defaults to 0.

DFE_AUDIT_CLIENT_HOST

The host name for client requests (to the reporting server) if different from DFE_AUDIT_HOST. Defaults to null

DFE_AUDIT_CLIENT_PORT

The port for client requests (to the reporting server). Defaults to 5601

FastTrack Settings

These settings govern the operations of the DreamFactory Enterprise™ FastTrack registration flow.

DFE_ENABLE_FAST_TRACK

Enable the auto-registration "one-click" pipeline.

DFE_FAST_TRACK_ROUTE

Sets the route to be used for FastTrack. Defaults to /fast-track.

DFE_FAST_TRACK_HUBSPOT_ONLY

If true, only clients referred by HubSpot are allowed. Defaults to false.

Storage and Path Settings

All of these settings are determined at the time of installation unless otherwise noted.

DFE_HOSTED_BASE_PATH

The root mount point of hosted-instance storage.

DFE_STORAGE_ZONE_TYPE

The type of storage zone. Can be static or dynamic. Defaults to static.

DFE_STATIC_ZONE_NAME

The storage zone name to use when zone type is static. Defaults to local.

DFE_PUBLIC_PATH_BASE

The public base path for instances. Defaults to /

DFE_PRIVATE_PATH_NAME

The name of an instance's private path. This is relative to the instance owner's storage path, and their private path. Defaults to .private

DFE_SNAPSHOT_PATH_NAME

The name of the directory under the owner's private path which will hold any instance snapshots. Defaults to snapshots.

DFE_PUBLIC_PATHS

A pipe-delimited list of paths to be created during instance provisioning. Defaults to applications|.private.

DFE_PRIVATE_PATHS

A pipe-delimited list of private paths to be created during instance provisioning. Defaults to .cache|config|scripts|scripts.user.

DFE_OWNER_PRIVATE_PATHS

A pipe-delimited list of owner private paths to be created during instance provisioning. Defaults to snapshots.

DFE_OWNER_BLUEPRINT_PATH

The directory in which to store blueprints. Defaults to /data/blueprints.

DFE_INSTANCE_INSTALL_PATH

The path in which this cluster's instance code base is located. Defaults to /var/www/launchpad.

DFE_CAPSULE_PATH

The directory in which instance capsules are to be placed. Defaults to /data/capsules

DFE_CAPSULE_LOG_PATH

The directory in which instance capsule log files are to be placed. Defaults to /data/logs/capsules

Instance Settings

DFE_INSTANCE_API_LOGIN_REQUIRED

If true, admin credentials are required to use of DFE Console command line utilities

DFE_INSTANCE_API_KEY

An API key to use for communications instead of provisioning channel

DFE_INSTANCE_API_HEADER

The header to use when transmitting the API key. Defaults to X-DreamFactory-API-Key

UI Settings

DFE_OPEN_REGISTRATION

By default, users are not able to self-register on the DFE Console. To change this behavior, set this variable to true.

DFE_CLOSED_ROUTE

When self-registration is disabled (the default), users are directed to specific route. The default is to send them back to the login page (auth/login). Changing this variable selects the route to which users are redirected.

DFE_HELP_BUTTON_URL

The URL for use when a Help button is clicked

DFE_AUTH_THEME

The Bootswatch theme to use for all auth pages (i.e. login, password reset, etc.). Defaults to darkly.

DFE_PAGE_THEME

The Bootswatch theme to use for non-auth pages. Defaults to yeti.

Branding

These settings are used to customize the look and feel of the application.

DFE_NAVBAR_IMAGE

The image/logo to use on the navigation bar of the application. This image must be 194x42px in size. Defaults to /theme/standard/img/logo.png

DFE_LOGIN_SPLASH_IMAGE

The image/logo to use on the authentication pages (login, password reset, etc.). For best results, this image should be 256x256px, or at the least, square. Defaults to /vendor/dfe-common/img/dfe-logo.png.

DFE_CUSTOM_CSS_FILE

The name of a file containing additional CSS to augment the default theme of the application. This value should reflect the relative path of the file as it will be loaded from the application's HTML. Defaults to null.

DFE_PARTNER_ID

If the DFE Partner integration system is in use, this value represents the partner site for the application. Defaults to null.

Metrics, Snapshot and Task Settings

DFE_METRICS_KEEP_DAYS

The system gathers metrics daily for reporting. This information is kept for 180 days by default. Changing this variable will set the number of days which metrics information is kept.

DFE_METRICS_DETAILS_KEEP_DAYS

During the daily metrics process, individual instance metadata is gathered prior to aggregation. This setting governs how long to keep such data. The default is to keep them for 7 days.

DFE_SNAPSHOT_DAYS_TO_KEEP

By default, all user-created exports have a shelf life of 30 days. The daily maintenance task removes expired snapshots. If you wish to lengthen or shorten this time frame, simply change the value of this variable.

DFE_SNAPSHOT_SOFT_DELETE

If true, once expired, snapshots are moved to the trash path. Otherwise they will be deleted. Defaults to false.

DFE_SNAPSHOT_TRASH_PATH

If soft deletion is enabled, snapshots will be moved to this path instead of being deleted. Defaults to /data/trash

DFE_ACTIVATE_DAYS_BY

The number of days an instance may remain inactive. Used by the auto deactivation system. Defaults to 7

DFE_ACTIVATE_ALLOWED_EXTENDS

The number of allowable extensions past the activate by date allowed. Defaults to 0. This is for future use.

DFE_RESETS_DAYS_TO_KEEP

One of the default daily tasks is to remove expired password reset requests. By default, any unused requests are purged after one day. This settings allows you to extend that value, although it is not recommended. Defaults to 1.

Miscellaneous Settings

DFE_DEFAULT_DOMAIN_PROTOCOL

By default, a basic DFE installation does not have SSL configured. There are outside dependencies that are beyond the scope of the installation utility. However, once you're in possession of an SSL certificate and want DFE to produce https SSL URLs, change this variable to https from http.

Dashboard

UI Settings

DFE_OPEN_REGISTRATION

By default, users are able to self-register on the DFE Dashboard. To change this behavior, set this variable to false.

DFE_ALLOW_IMPORT_UPLOADS

By default, dashboard users are not allowed to upload their own personal export files. The system manages a list of exports it has created, and by default, users may choose only from that list.

If you wish to allow your users to upload their own export files, set the value of this variable true.

Branding

DFE_NAVBAR_IMAGE

The image/logo to use on the navigation bar of the application. This image must be 194x42px in size. Defaults to /theme/standard/img/logo.png

DFE_LOGIN_SPLASH_IMAGE

The image/logo to use on the authentication pages (login, password reset, etc.). For best results, this image should be 256x256px, or at the least, square. Defaults to /vendor/dfe-common/img/dfe-logo.png.

DFE_CUSTOM_CSS_FILE

The name of a file containing additional CSS to augment the default theme of the application. This value should reflect the relative path of the file as it will be loaded from the application's HTML. Defaults to null.

DFE_PARTNER_ID

If the DFE Partner integration system is in use, this value represents the partner site for the application. Defaults to null.