Krai Framework Homepage - Documentation

User Manual

Configuration Options

How to configure things to do what you want.

Table of Contents

Framework Configuration

This is a copy of the default configuration file, along with additional comments as to what everything does. For details on YAML syntax, see this site.

Lines with two or more # characters at the beginning are documentation lines. Lines with a single # at the beginning are lines that can be un-commented for use.


---
##### Things you most likely want to edit

## The base uri for the application. If the application is at 
## http://example.com/path/to/me/, the value would be path/to/me
## (no leading or training slash)
BASEURI: k
## The root url for the application. This is the url without any path 
## information. It should NOT be terminated by a /
ROOTURL: http://example.com
## This is the domain for the application. This is the ROOTURL 
## without the http://www. part
DOMAIN: example.com
## The email address of the system administrator
ADMIN_EMAIL: system@example.com
## The name of the system
SYSTEM_NAME: Example App

## Configuration for the database
CONFIG_DB:
  ## Whether or not to use PDO for the backend
  USE_PDO: false
  ## Connection information
  DATA:
    ## The first database, keyed by the name "db1"
    db1:
      ## The database type
      _type: mysql
      ## The database username
      _user: user
      ## The database password
      _pass:
      ## The database host
      _host: localhost
      ## The database name
      _name: dbase_name
      ## The database port, if not the default
      #_port:
    ## A second database, keyed by "db2" (not active -- commented out)
    #db2:
      #_type:
      #_user:
      #_pass:
      #_host:
      #_name:
      #_port:
  ## Whether or not to enable database debugging
  DEBUG: false

## Configuration of Krai_Mail
CONFIG_MAIL:
  ## Whether to actually send mail or not
  SEND_MAIL: true
  ## Address to send mail from
  FROM_ADDR: admin@example.com
  ## Name to send mail from
  FROM_NAME: Example App Mailer
  ## Backend configuration
  MAILER_CONFIG:
    type: internal  # internal, sendmail, or smtp
    charset: iso-8859-1
    #args: -
    #sendmail_path: /usr/bin/sendmail
    #smtp_host: localhost
    #smtp_port: 25
    #smtp_auth: false
    #smtp_username:
    #smtp_password:
    #smtp_localhost: localhost
    #smtp_timeout:
    #smtp_verp: false
    #smtp_debug: false
    #smtp_persist: false

##### Things you might want to edit

## Un-comment and change the value of this if the framework files are 
## not in the application directory
#APPDIR: /path/to/app #Path to your application in the filesystem
## You can disable Output Buffering if you want
#DISABLE_OB: false
## You can disable the Gzhandler use with output buffering, too.
#USE_OB_GZHANDLER: false
## You can disable the automatic use of php sessions
#DISABLE_SESSION: false
## You can change the default timezone
#DEFAULT_TIMEZONE: America/New_York
## You can change the path to pear files if you need to
#PEAR_PATH: /path/to/pear/lib/ #include trailing slash
## You can toggle using databases
USE_DB: true
## You can toggle using logging
USE_LOG: true
## You can toggle using the mailer
USE_MAIL: true
## You can toggle using the cache manager
USE_CACHE: false

## Configuration for modules
CONFIG_MODULE:
  ## You can toggle whether or not to use a layout
  USE_LAYOUT: true
  ## You can change the name of the layout to use
  DEFAULT_LAYOUT: default

##### Things you probably do not want to edit unless you 
#####  really know what you are doing

CONFIG_LOG:
  CONFS:
    n:requests:
      LocalSetLogfileName: requests.log
    n:sql:
      LocalSetLogfileName: sql.log
    n:maillog:
      LocalSetLogfileName: mail.log
    t:local:
      EnableQueueMode:
      SetThresh: 6 #For info mode
      #SetThresh: 7 #For debug mode
      SetErrorConditionTriggerThresh: 3
      SetErrorConditionThresh: 7
    t:email:
      EnableQueueMode:
      SetThresh: 3 #For info mode
      SetErrorConditionTriggerThresh: 2
      SetErrorConditionThresh: 7
  TYPES:
    requests: local
    sql: local
    maillog: local
    email: email
  DEFAULT: requests

CONFIG_CACHE:
  DIR: .
  TIMEOUT: 3600

Routes Configuration

(coming soon)

Page Updated: Wed, Jul. 23rd 10:58 AM
Content Updated: Wed, Jul. 23rd 10:58 AM by Greg McWhirter (gsmcwhirter)