Configuration

From DreamFactory
Jump to: navigation, search
DFEConfiguration
m
m
Line 1: Line 1:
Unless otherwise specified, all configuration settings on this page are to be made in the <code>.env</code> file of the application in question. Each application has a file named <code>.env</code> in its root directory.
+
Unless otherwise specified, all configuration settings on this page are to be made in the <code>.env</code> file of the application in question. Each application has a file named <code>.env</code> in its root directory.  
  
 
= Console =
 
= Console =
  
== Instance API Settings ==
+
== Operational Settings ==
 +
These settings govern the operations of the DreamFactory Enterprise&trade; 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.
 +
 
 +
=== 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_ENABLE_FAST_TRACK ===
 +
Enable the auto-registration "one-click" pipeline.
 +
 
 +
=== DFE_LOGIN_REQUIRED_FOR_BLUEPRINT ===
 +
If admin credentials are required for blueprinting. Defaults to '''false'''.
 +
 
 +
== Instance Settings ==
  
 
=== DFE_INSTANCE_API_LOGIN_REQUIRED ===
 
=== DFE_INSTANCE_API_LOGIN_REQUIRED ===
Line 21: Line 56:
 
=== DFE_CLOSED_ROUTE ===
 
=== 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 (<code>auth/login</code>). Changing this variable selects the route to which users are redirected.
 
When self-registration is disabled (the default), users are directed to specific route. The default is to send them back to the login page (<code>auth/login</code>). 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 [[https://bootswatch.com bootswatch]] theme to use for all ''auth'' pages (i.e. login, password reset, etc.). Defaults to '''darkly'''.
 +
 +
=== DFE_PAGE_THEME ===
 +
The [[https://bootswatch.com bootswatch]] theme to use for ''non-auth'' pages. Defaults to '''yeti'''.
  
 
== Data Storage Settings ==
 
== Data Storage Settings ==

Revision as of 16:45, 23 February 2016

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.

Console

Operational Settings

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.

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_ENABLE_FAST_TRACK

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

DFE_LOGIN_REQUIRED_FOR_BLUEPRINT

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

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.

Data Storage Settings

DFE_METRICS_KEEP_DAYS

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.

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.

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.