aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
m---------commonlib0
-rw-r--r--config/.gitignore1
-rw-r--r--config/general-example69
-rw-r--r--config/general.yml-example57
4 files changed, 58 insertions, 69 deletions
diff --git a/commonlib b/commonlib
-Subproject 38e0a641eb63323f6a2f895bfbc1274b23e98a7
+Subproject a0d1c553951415439b09a6ca638a21d1b179a7a
diff --git a/config/.gitignore b/config/.gitignore
index b2ceae33c..b1cab35ec 100644
--- a/config/.gitignore
+++ b/config/.gitignore
@@ -1,5 +1,6 @@
/config.tmp
/general
+/general.yml
/general.deployed
/database.yml
/database.yml.deployed
diff --git a/config/general-example b/config/general-example
deleted file mode 100644
index a3d1aed2a..000000000
--- a/config/general-example
+++ /dev/null
@@ -1,69 +0,0 @@
-<?php
-/*
- * general-example:
- * Example values for the "general" config file.
- *
- * Configuration parameters, in PHP syntax. Configuration parameters are set
- * using the PHP define('OPTION_...', '...') function. Both perl and PHP code
- * parse this properly, so you can use comments and conditionals and whatnot,
- * but unless essential it's better to keep it simple....
- *
- * Copy this file to one called "general" in the same directory. Or
- * have multiple config files and use a symlink to change between them.
- *
- * NOTE ON USE IN RAILS: So that people don't have to have PHP installed just
- * to run this stuff, by convention we always provide a default config value
- * in the source code when reading the config option. The Rails application
- * should run fine without the general config file, it is a bug if it does not.
- *
- * Copyright (c) 2007 UK Citizens Online Democracy. All rights reserved.
- * Email: francis@mysociety.org; WWW: http://www.mysociety.org
- *
- * $Id: general-example,v 1.18 2009-02-09 10:37:13 francis Exp $
- *
- */
-
-// Doesn't do anything right now.
-define('OPTION_STAGING_SITE', 1);
-
-// Domain used in URLs generated by scripts (e.g. for going in some emails)
-define('OPTION_DOMAIN', '127.0.0.1:3000');
-
-// Incoming email
-define('OPTION_INCOMING_EMAIL_DOMAIN', 'localhost'); // e.g. 'foifa.com'
-define('OPTION_INCOMING_EMAIL_PREFIX', ''); // e.g. 'foi+'
-define('OPTION_INCOMING_EMAIL_SECRET', 'xxxx xxxx xxxx xxxx xxxx xxxx xxxx xxxx'); // used for hash in request email address
-define('OPTION_BLACKHOLE_PREFIX', 'do-not-reply-to-this-address'); // used as envelope from at the incoming email domain for cases where we don't care about failure
-
-// Administration
-define('OPTION_CONTACT_EMAIL', 'admin@localhost');
-define('OPTION_ADMIN_BASE_URL', '/admin/');
-// Where /stylesheets sits under for admin pages. See asset_host in
-// config/environment.rb. Can be full domain or relative path (not an absolute path beginning with /).
-define('OPTION_ADMIN_PUBLIC_URL', '');
-
-// Secret key for signing cookie_store sessions
-define('OPTION_COOKIE_STORE_SESSION_SECRET', 'your secret key here, make it long and random');
-
-// If present, puts the site in read only mode, and uses the text as reason
-// (whole paragraph). Please use a read-only database user as well, as it only
-// checks in a few obvious places.
-define('OPTION_READ_ONLY', '');
-
-// Recaptcha, for detecting humans. Get keys here: http://recaptcha.net/whyrecaptcha.html
-define('OPTION_RECAPTCHA_PUBLIC_KEY', 'x');
-define('OPTION_RECAPTCHA_PRIVATE_KEY', 'x');
-
-// Locales we wish to support in this app
-define('OPTION_AVAILABLE_LOCALES', 'en es');
-
-// example searches for the home page, semicolon delimited
-define('OPTION_FRONTPAGE_SEARCH_EXAMPLES', 'Geraldine Quango; Department for Humpadinking');
-
-// example public bodies for the home page, semicolon delimited - short_names
-define('OPTION_FRONTPAGE_PUBLICBODY_EXAMPLES', 'tgq');
-
-// URL of theme to install
-define('OPTION_THEME_URL', 'git://github.com/mysociety/whatdotheyknow-theme.git');
-
-?>
diff --git a/config/general.yml-example b/config/general.yml-example
new file mode 100644
index 000000000..9922437bd
--- /dev/null
+++ b/config/general.yml-example
@@ -0,0 +1,57 @@
+# general-example:
+# Example values for the "general" config file.
+#
+# Configuration parameters, in PHP syntax. Configuration parameters are set
+# using the PHP ...: '...') function. Both perl and PHP code
+# parse this properly, so you can use comments and conditionals and whatnot,
+# but unless essential it's better to keep it simple....
+#
+# Copy this file to one called "general" in the same directory. Or
+# have multiple config files and use a symlink to change between them.
+#
+# NOTE ON USE IN RAILS: By convention we always provide a default config value
+# in the source code when reading the config option. The Rails application
+# should run fine without the general config file: it is a bug if it does not.
+
+# Doesn't do anything right now.
+STAGING_SITE: 1
+
+# Domain used in URLs generated by scripts (e.g. for going in some emails)
+DOMAIN: '127.0.0.1:3000'
+
+# Incoming email
+INCOMING_EMAIL_DOMAIN: 'localhost' # e.g. 'foifa.com'
+INCOMING_EMAIL_PREFIX: '' # e.g. 'foi+'
+INCOMING_EMAIL_SECRET: 'xxxx xxxx xxxx xxxx xxxx xxxx xxxx xxxx' # used for hash in request email address
+BLACKHOLE_PREFIX: 'do-not-reply-to-this-address' # used as envelope from at the incoming email domain for cases where we don't care about failure
+
+# Administration
+CONTACT_EMAIL: 'admin@localhost'
+ADMIN_BASE_URL: '/admin/'
+# Where /stylesheets sits under for admin pages. See asset_host in
+# config/environment.rb. Can be full domain or relative path (not an absolute path beginning with /).
+ADMIN_PUBLIC_URL: ''
+
+# Secret key for signing cookie_store sessions
+COOKIE_STORE_SESSION_SECRET: 'your secret key here, make it long and random'
+
+# If present, puts the site in read only mode, and uses the text as reason
+# (whole paragraph). Please use a read-only database user as well, as it only
+# checks in a few obvious places.
+READ_ONLY: ''
+
+# Recaptcha, for detecting humans. Get keys here: http:#recaptcha.net/whyrecaptcha.html
+RECAPTCHA_PUBLIC_KEY: 'x'
+RECAPTCHA_PRIVATE_KEY: 'x'
+
+# Locales we wish to support in this app
+AVAILABLE_LOCALES: 'en es'
+
+# example searches for the home page, semicolon delimited
+FRONTPAGE_SEARCH_EXAMPLES: 'Geraldine Quango; Department for Humpadinking'
+
+# example public bodies for the home page, semicolon delimited - short_names
+FRONTPAGE_PUBLICBODY_EXAMPLES: 'tgq'
+
+# URL of theme to install
+THEME_URL: 'git:#github.com/mysociety/whatdotheyknow-theme.git'