diff options
| -rw-r--r-- | config/general.yml-example | 78 | ||||
| -rw-r--r-- | doc/INSTALL.md | 4 |
2 files changed, 50 insertions, 32 deletions
diff --git a/config/general.yml-example b/config/general.yml-example index 7d964360d..cb10ea40e 100644 --- a/config/general.yml-example +++ b/config/general.yml-example @@ -1,29 +1,43 @@ -# general-example: +# general.yml-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.... +# Configuration parameters, in YAML syntax. # -# Copy this file to one called "general" in the same directory. Or +# Copy this file to one called "general.yml" 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 +# Site name appears in various places throughout the site +SITE_NAME: 'Alaveteli' # Domain used in URLs generated by scripts (e.g. for going in some emails) DOMAIN: '127.0.0.1:3000' +# These feeds are displayed accordingly on the Alaveteli "blog" page: +BLOG_FEED: 'http://www.mysociety.org/category/projects/whatdotheyknow/feed/' +TWITTER_USERNAME: 'whatdotheyknow' + +# Locales we wish to support in this app, space-delimited +AVAILABLE_LOCALES: 'en es' +DEFAULT_LOCALE: 'en' + +# How many days should have passed before an answer to a request is officially late? +REPLY_LATE_AFTER_DAYS: 20 + +# 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 (when running rails-post-deploy script) +THEME_URL: 'git://github.com/mysociety/whatdotheyknow-theme.git' + + ## Incoming email -# e.g. 'foifa.com' +# Your email domain, e.g. 'foifa.com' INCOMING_EMAIL_DOMAIN: 'localhost' -# e.g. 'foi+' +# An optional prefix to help you distinguish FOI requests, e.g. 'foi+' INCOMING_EMAIL_PREFIX: '' # used for hash in request email address @@ -32,12 +46,24 @@ INCOMING_EMAIL_SECRET: 'xxxx xxxx xxxx xxxx xxxx xxxx xxxx xxxx' # used as envelope from at the incoming email domain for cases where we don't care about failure BLACKHOLE_PREFIX: 'do-not-reply-to-this-address' -# Administration -CONTACT_EMAIL: 'admin@localhost' +## Administration + +# Leave these two blank to skip admin authorisation +ADMIN_USERNAME: 'adminxxxx' +ADMIN_PASSWORD: 'passwordx' + +# Email "from" details +CONTACT_EMAIL: 'postmaster@localhost' +CONTACT_NAME: 'Alaveteli Webmaster' + +# The base URL for admin pages. You probably don't want to change this. 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: '' + +# 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 /). Again, unlikely to want to change +# this. +ADMIN_PUBLIC_URL: '' # Secret key for signing cookie_store sessions COOKIE_STORE_SESSION_SECRET: 'your secret key here, make it long and random' @@ -47,18 +73,10 @@ COOKIE_STORE_SESSION_SECRET: 'your secret key here, make it long and random' # checks in a few obvious places. READ_ONLY: '' +# Doesn't do anything right now. +STAGING_SITE: 1 + # 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' diff --git a/doc/INSTALL.md b/doc/INSTALL.md index f6f8ff483..c729a0737 100644 --- a/doc/INSTALL.md +++ b/doc/INSTALL.md @@ -75,8 +75,8 @@ The following command will set up a user 'foi' with password 'foi': # Set up configs -For overall application settings, copy `config/general-example` to -`config/general` and edit to your taste. +For overall application settings, copy `config/general.yml-example` to +`config/general.yml` and edit to your taste. Note that the default settings for frontpage examples are designed to work with the dummy data shipped with Alaveteli; once you have real |