MethodBox:Installation:EnvironmentConstants

This is a list of all the constants which are actively used in the codebase. Only constants which are in use are listed. Any others in the config/environment_local.example.rb file are legacy or prototype and may be removed at any time.


 * SARS_SHARED_SECRET = "something"
 * the secret used when calculating shibboleth login hash
 * SHIB_LOGIN_URL = "http://some.url:port"
 * the root url where the shib login process should redirect to
 * CSV_OUTPUT_DIRECTORY = "directory path"
 * where should completed data extracts be stored
 * HTTPS_ON = true
 * Is the server running ssl routes or not, to get the dev server to use http set it to false
 * STATA_VERSION = '10.0'
 * which version to write into the stata do files when creating the data extracts
 * LOCAL_REQUEST_ERROR = true
 * Exception Notification - true to ignore errors if running on localhost
 * ADMIN_CAN_SEE_DORMANT = true
 * whether admin users can also see dormant users when using the web ui
 * ADMIN_EMAIL = "you@somewhere.com"
 * used by the doi publication stuff. You need to register an address at http://www.crossref.org/requestaccount/ to do the DOI checking
 * SANDBOX = false
 * switch on the sandbox ui warning messages
 * EMAIL_ENABLED = true
 * should emails be sent out when data extracts completed etc
 * METADATA_PATH='file path'
 * directory used by the datasets controller to write metadata files that users upload. Also used by the rake metadata import task if doing some manual loading of metadata files.
 * UKDA_EMAIL_ADDRESS='http://oai.esds.ac.uk:8080/NesstarLogin/login.do'
 * the address used to check the users email against the ukda's registered users list. This is only used if a survey is flagged as being from UKDA
 * CSV_FILE_PATH="file path"
 * Used to write any user uploaded datasets to, note that it needs a trailing '/' at the moment (issue reported here.
 * REGISTRATION_CLOSED = true
 * If you don't want users to be able to register themselves set to true. Users can request registration but admin users have to approve them.