Config.ini

From Snapp CMS Developer Documentation

Jump to: navigation, search

The config.ini file is the master configuration file for your website.

The file is divided up into the following sections by convention, although there's nothing to stop you adding extra sections and key/value pairs to it

Contents

Site

IDs of specific pages within the site (useful for referencing in templates) and basic site info.

[Site]
online = 1
template =
checkout = 37
debug =
defaultPage = 1
title = My Site
fire_console = 1

Session

User session key information

[Session]
name = myhost

Paths

Locations of your site's files

[Paths]
root =
media = media/
cache = cache/
sites = templates/

Database

DB connectivity

[Database]
host = 127.0.0.1
user = user
password = password
port = 3306
database = mydb
profiling = 1

CruMail

Configuration for the CruMail mailing list subscription system

[CruMail]
username = username
password = password
database = db

SEO

Enable SEO-URLs and activate SEO metadata

[SEO]
use_seo_urls = 1
use_seo_urls_v2 = 1
meta_description = My great site
meta_keywords = cool, site, snapp

Shopping Cart

Configuration information for the eCommerce module

[Shopping Cart]
class = cmsShoppingCart2
certificateAsPayment = 0

Mcrypt

Encryption keys for secure storage

[Mcrypt]
key = secret key

Mail

Details for controlling how mail is dispatched

[Mail]
server = localhost
mailer = smtp

Google

Information for the Google Analytics widget

[Google]
email = test@example.com
password = password
account = username
profile = default
key = UA-12345

Google Maps

API information for the Google Maps widget

[GoogleMaps]
URL = Google Maps Key
*.example.com = ABQIAAwedwfefd4MzCF1HTBPMqUTnhTkS-map2tmUR8Jg6QeufNex1Xt6BQRh2AtKT_mzuHkHl0g9sgPB7Wmug

Branding

Parameters for the Branding widget

[Branding]
company = SnappCMS
website = http://www.snappcms.com.au
email = info@snappcms.com.au
logo = http://www.snappcms.com.au/images.logo.png

Errors

Error handling

[Errors]
emailErrors = 1
logErrors = 1
name = Website Errors
email = errors@example.com

Tidy

Control the HTML Tidy input filter, for generating W3C-compliant content

[Tidy]
useTidy = 1
cfg_clean = 1
cfg_output-xhtml = 1
cfg_drop-empty-paras = 1
cfg_drop-proprietary-attributes = 1
cfg_word-2000 = 1
cfg_show-body-only = 1
cfg_wrap = 0
Personal tools
Core Components
Standalone Installs