config.inc.php.example

<?php
/**
 * Configuration file for Archon
 *
 * IMPORTANT:
 *
 * The following variables MUST be defined or Archon
 * will NOT work properly:
 *
 *      $_ARCHON->db->ServerType
 *      $_ARCHON->db->ServerAddress
 *      $_ARCHON->db->Login
 *      $_ARCHON->db->Password
 *      $_ARCHON->db->Database
 *
 * @package Archon
 * @author Chris Rishel
 */

// ***********************************************
// * Database Configuration                      *
// ***********************************************

   // ### REQUIRED ###
   // ********************************************
   // * $_ARCHON->db->ServerType                    *
   // ********************************************
   //
   //   - Explanation:
   //       Contains a string which indicates
   //       what type of Database server Archon
   //       will run on.
   //
   //   - Allowed Values:
   //       Any compatable database module installed in
   //       /(Archon Installation Directory)/db/
   //
   //       Archon's Database Module is installed with support
   //       for the following values for ServerType:
   //
   //     $_ARCHON->db->ServerType = 'MSSQL'      (Microsoft SQL Server)
   //     $_ARCHON->db->ServerType = 'MySQL'      (MySQL)
   //
   //       Unless you have added an additional module, please
   //       use one of the above options.
   //
   //         (NOTE: A custom database module MUST be named as
   //           (ServerType)Database.php
   //         For example, the module for 'MSSQL' is named:
   //           MSSQLDatabase.php
   //
   //        IMPORTANT: This variable IS case sensitive.
   //
   //   - Example:
   //       $_ARCHON->db->ServerType = 'MySQL';

   $_ARCHON->db->ServerType = 'MySQL';

   // ### REQUIRED ###
   // ********************************************
   // * $_ARCHON->db->ServerAddress                 *
   // ********************************************
   //
   //   - Explanation:
   //       Contains a string with either
   //       a numerical IP Address or a DNS
   //       Hostname that represents the location of
   //       the database server.
   //
   //   - Allowed Values:
   //       Any valid TCP/IP address
   //
   //   - Example:
   //       $_ARCHON->db->ServerAddress = 'localhost';
   //     OR
   //       $_ARCHON->db->ServerAddrses = '127.0.0.1';
   //

   $_ARCHON->db->ServerAddress = getenv("DB_HOST");

   // ### REQUIRED ###
   // ********************************************
   // * $_ARCHON->db->Login                         *
   // ********************************************
   //
   //   - Explanation:
   //       This variable contains a string with
   //       a login for Archon to use to connect to the
   //       database server.
   //
   //   - Allowed Values:
   //       Any string
   //
   //   - Example:
   //       $_ARCHON->db->ServerAddress = 'ArchonWebUser';
   //

   $_ARCHON->db->Login = getenv("DB_USER");

   // ### REQUIRED ###
   // ********************************************
   // * $_ARCHON->db->Password                      *
   // ********************************************
   //
   //   - Explanation:
   //       This variable contains a string with
   //       the password for the user above for
   //       Archon to use to connect to the database server.
   //
   //   - Allowed Values:
   //       Any string
   //
   //   - Example:
   //       $_ARCHON->db->Password = 'Archon';
   //

   $_ARCHON->db->Password = getenv("DB_PASS");

   // ### REQUIRED ###
   // ********************************************
   // * $_ARCHON->db->DatabaseName                  *
   // ********************************************
   //
   //   - Explanation:
   //       This variable contains a string with
   //       the name of the database for Archon to use
   //       on the database server specified above.
   //
   //       IMPORTANT: The login specified above MUST
   //                  be granted the following permissions
   //                  on this database:
   //
   //         SELECT, INSERT, UPDATE, DELETE, CREATE, ALTER, DROP
   //
   //
   //   - Allowed Values:
   //       Any string
   //
   //   - Example:
   //       $_ARCHON->db->DatabaseName = 'Archon';
   //

   $_ARCHON->db->DatabaseName = getenv("DB_NAME");

// ***********************************************
// * Google Analytics Configuration              *
// ***********************************************

//   $_ARCHON->config->GACode = "UA-0000000-0";
//   $_ARCHON->config->GACollectionsURL = "/downloads/pdfsfa";
//   $_ARCHON->config->GADigContentPrefix = "/digcontent";

// ***********************************************
// * Security Configuration                      *
// ***********************************************

//   $_ARCHON->config->ForceHTTPS = true;

// ***********************************************
// * File Cache Configuration                    *
// ***********************************************

//   $_ARCHON->config->CacheFiles = true;
//   $_ARCHON->config->CachePermissions = 0755;

// Set default timezone to prevent PHP warnings
if( ! ini_get('date.timezone') ) {
  date_default_timezone_set('GMT');
}

?>