Unless otherwise specified, all configuration settings on this page are to be made in the
.env file of the application in question. Each application has a file named
.env in its root directory.
- 1 Console
- 1.1 Operational Settings
- 1.2 DNS Settings
- 1.3 FastTrack Settings
- 1.4 Storage and Path Settings
- 1.4.1 DFE_HOSTED_BASE_PATH
- 1.4.2 DFE_STORAGE_ZONE_TYPE
- 1.4.3 DFE_STATIC_ZONE_NAME
- 1.4.4 DFE_PUBLIC_PATH_BASE
- 1.4.5 DFE_PRIVATE_PATH_NAME
- 1.4.6 DFE_SNAPSHOT_PATH_NAME
- 1.4.7 DFE_PUBLIC_PATHS
- 1.4.8 DFE_PRIVATE_PATHS
- 1.4.9 DFE_OWNER_PRIVATE_PATHS
- 1.4.10 DFE_OWNER_BLUEPRINT_PATH
- 1.4.11 DFE_INSTANCE_INSTALL_PATH
- 1.4.12 DFE_CAPSULE_PATH
- 1.4.13 DFE_CAPSULE_LOG_PATH
- 1.5 Instance Settings
- 1.6 UI Settings
- 1.7 Metrics and Snapshot Settings
- 1.8 Miscellaneous Settings
- 2 Dashboard
These settings govern the operations of the DreamFactory Enterprise™ system.
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.
The cluster in which this system is included
The system user to use when running back-end shell scripts. Defaults to dfadmin.
Default prefix for email sent from console. Defaults to [DFE]
A string to prepend to non-admin created instance names.
The default cluster to use. Set at installation.
The default database to use. Set at installation.
The default provisioner to use. Defaults to 2, indicating DreamFactory
The hash algorithm to use system-wide. Defaults to sha256.
If admin credentials are required for blueprinting. Defaults to false.
These settings govern the way instance and back-end URLs are created.
The subdomain for instances (i.e.
dfe). Set at installation.
The top-level domain for instances (i.e.
example.com). Set at installation.
The fully qualifed 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.
The HTTP protocol to use, by default. This can be http (the default) or https.
The URL used in generated links to send users to the DFE Dashboard. This is generated at the time of installation.
The support email address to use in correspondence.
These settings govern the operations of the DreamFactory Enterprise™ FastTrack registration flow.
f=== DFE_ENABLE_FAST_TRACK === Enable the auto-registration "one-click" pipeline.
Sets the route to be used for FastTrack. Defaults to
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.
The root mount point of hosted-instance storage.
The type of storage zone. Can be static or dynamic. Defaults to static.
The storage zone name to use when zone type is static. Defaults to local.
The public base path for instances. Defaults to
The name of an instance's private path. This is relative to the instance owner's storage path, and their private path. Defaults to
The name of the directory under the owner's private path which will hold any instance snapshots. Defaults to
A pipe-delimited list of paths to be created during instance provisioning. Defaults to
A pipe-delimited list of private paths to be created during instance provisioning. Defaults to
A pipe-delimited list of owner private paths to be created during instance provisioning. Defaults to
The directory in which to store blueprints. Defaults to
The path in which this cluster's instance code base is located. Defaults to
The directory in which instance capsules are to be placed. Defaults to
The directory in which instance capsule log files are to be placed. Defaults to
If true, admin credentials are required to use of DFE Console command line utilities
An API key to use for communications instead of provisioning channel
The header to use when transmitting the API key. Defaults to X-DreamFactory-API-Key
By default, users are not able to self-register on the DFE Console. To change this behavior, set this variable to
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.
The URL for use when a Help button is clicked
The Bootswatch theme to use for all auth pages (i.e. login, password reset, etc.). Defaults to darkly.
The Bootswatch theme to use for non-auth pages. Defaults to yeti.
Metrics and Snapshot Settings
The system gathers metrics daily for reporting. This information is kept for 365 days by default. Changing this variable will set the number of days which metrics information is kept.
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.
true, once expired, snapshots are moved to the trash path. Otherwise they will be deleted. Defaults to
If soft deletion is enabled, snapshots will be moved to this path instead of being deleted. Defaults to
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
By default, users are able to self-register on the DFE Dashboard. To change this behavior, set this variable to
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