From 6fe3d913acce973e5b5c08673ba92fdb0b479436 Mon Sep 17 00:00:00 2001 From: Louise Crow Date: Thu, 26 Mar 2015 09:54:54 +0000 Subject: Add section for new config var AUTHORITY_MUST_RESPOND --- docs/customising/config.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) (limited to 'docs/customising') diff --git a/docs/customising/config.md b/docs/customising/config.md index 8778b2edd..8fd26b356 100644 --- a/docs/customising/config.md +++ b/docs/customising/config.md @@ -106,6 +106,7 @@ indentation correct. If in doubt, look at the examples already in the file, and ### Behaviour settings and switches: NEW_RESPONSE_REMINDER_AFTER_DAYS +
AUTHORITY_MUST_RESPOND
MAX_REQUESTS_PER_USER_PER_DAY
OVERRIDE_ALL_PUBLIC_BODY_REQUEST_EMAILS
ALLOW_BATCH_REQUESTS @@ -829,6 +830,25 @@ EXCEPTION_NOTIFICATIONS_TO: + +
+ AUTHORITY_MUST_RESPOND +
+
+
+ Introduced in Alaveteli version 0.21 +
+ Set this to true if authorities must respond by law. Set to false otherwise. It defaults to true. At the moment this just controls the display of some UI text telling users that the authority must respond to them by law. +
+

Example:

+
    +
  • + AUTHORITY_MUST_RESPOND: true +
    • +
+
+
+
MAX_REQUESTS_PER_USER_PER_DAY
-- cgit v1.2.3 From 09b7a5a1b66e8c228b99c26616a0d58a19098874 Mon Sep 17 00:00:00 2001 From: Louise Crow Date: Thu, 26 Mar 2015 11:10:23 +0000 Subject: Reorder sections in index order --- docs/customising/config.md | 750 ++++++++++++++++++++++----------------------- 1 file changed, 370 insertions(+), 380 deletions(-) (limited to 'docs/customising') diff --git a/docs/customising/config.md b/docs/customising/config.md index 8fd26b356..c03e0fc9e 100644 --- a/docs/customising/config.md +++ b/docs/customising/config.md @@ -111,7 +111,6 @@ indentation correct. If in doubt, look at the examples already in the file, and
OVERRIDE_ALL_PUBLIC_BODY_REQUEST_EMAILS
ALLOW_BATCH_REQUESTS
PUBLIC_BODY_LIST_FALLBACK_TO_DEFAULT_LOCALE -
CACHE_FRAGMENTS ### External public services: @@ -127,6 +126,7 @@ indentation correct. If in doubt, look at the examples already in the file, and
USE_MAILCATCHER_IN_DEVELOPMENT
USE_GHOSTSCRIPT_COMPRESSION
HTML_TO_PDF_COMMAND +
CACHE_FRAGMENTS --- @@ -190,67 +190,222 @@ indentation correct. If in doubt, look at the examples already in the file, and
- ISO_COUNTRY_CODE + FORCE_REGISTRATION_ON_NEW_REQUEST
- The ISO country code - of the country in which your Alaveteli site is deployed. + Does a user needs to sign in to start the New Request process?

Example:

  • - ISO_COUNTRY_CODE: GB + FORCE_REGISTRATION_ON_NEW_REQUEST: false
- TIME_ZONE + THEME_URLS
- This is the timezone - that Alaveteli usese to display times and dates. - If not set, defaults to UTC. + URLs of themes to download and use + (when running the rails-post-deploy script). The earlier in the list means + the templates have a higher priority.

Example:

  • - TIME_ZONE: Australia/Sydney + 
    +THEME_URLS:
+ - 'git://github.com/mysociety/alavetelitheme.git'
+
- BLOG_FEED + THEME_BRANCH
- These feeds are displayed accordingly on the Alaveteli "blog" page: + When rails-post-deploy installs the themes, + it will try the theme branch first, but only if you've set THEME_BRANCH + to be true. If the branch doesn't exist it will fall back to using a tagged version + specific to your installed alaveteli version, and if that doesn't exist it will + back to master. +

+ The default theme is the "Alaveteli" theme. This gets installed automatically when + rails-post-deploy runs. +

Example:

  • - BLOG_FEED: 'https://www.mysociety.org/category/projects/whatdotheyknow/feed/' + THEME_BRANCH: false
- TWITTER_USERNAME - TWITTER_WIDGET_ID + FRONTPAGE_PUBLICBODY_EXAMPLES
- If you want a twitter feed displayed on the "blog" page, provide the widget ID and username. + Specify which public bodies you want to be listed as examples on the home page, + using their short_names. + If you want more than one, separate them with semicolons. + Comment this out if you want this to be auto-generated. +

+ Warning: this is slow — don't use in production! +

Examples:

  • - TWITTER_USERNAME: WhatDoTheyKnow + FRONTPAGE_PUBLICBODY_EXAMPLES: 'tgq'
  • - TWITTER_WIDGET_ID: '833549204689320031' + FRONTPAGE_PUBLICBODY_EXAMPLES: 'tgq;foo;bar' +
    • +
  • + # FRONTPAGE_PUBLICBODY_EXAMPLES: +
    • +
+
+
+ +
+ PUBLIC_BODY_STATISTICS_PAGE & + MINIMUM_REQUESTS_FOR_STATISTICS +
+
+ If PUBLIC_BODY_STATISTICS_PAGE is set to true, Alaveteli will make a + page of statistics on the performance of public bodies (which you can see at + /body_statistics). + The page will only consider public bodies that have had at least the number of requests + set by MINIMUM_REQUESTS_FOR_STATISTICS. + +
+

Example:

+
    +
  • + PUBLIC_BODY_STATISTICS_PAGE: false +
    • +
  • + MINIMUM_REQUESTS_FOR_STATISTICS: 50 +
    • +
+
+
+ +
+ RESPONSIVE_STYLING +
+
+ + Use the responsive base stylesheets and templates, rather than + those that only render the site at a fixed width. These + stylesheets are currently experimental but will become the default + in the future. They allow the site to render nicely on mobile + devices as well as larger screens. Currently the fixed width + stylesheets are used by default. + +
+

Example:

+
    +
  • + RESPONSIVE_STYLING: true +
    • +
+
+
+ +
+ READ_ONLY +
+
+ If present, READ_ONLY 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. +
+

Examples:

+
    +
  • + Typically, you do not want to run your site in + read-only mode — so set READ_ONLY to be + an empty string. +
    + + READ_ONLY: '' + +
    • +
  • + + READ_ONLY: 'The site is not currently accepting requests while we move the server.' + +
    • +
+
+
+ +
+ STAGING_SITE +
+
+ Is this a + staging or + development site? + If not, it's a live production + site. This setting controls whether or not the rails-post-deploy + script will create the file config/rails_env.rb file to force + Rails into production environment. +
+

Examples:

+
    +
  • + For staging or development: +

    + STAGING_SITE: 1 +

    +
    • +
  • + For production: +

    + STAGING_SITE: 0 +

    +
    • +
+
+
+ +
+ ISO_COUNTRY_CODE +
+
+ The ISO country code + of the country in which your Alaveteli site is deployed. +
+

Example:

+
    +
  • + ISO_COUNTRY_CODE: GB +
    • +
+
+
+ +
+ TIME_ZONE +
+
+ This is the timezone + that Alaveteli usese to display times and dates. + If not set, defaults to UTC. +
+

Example:

+
    +
  • + TIME_ZONE: Australia/Sydney
@@ -343,111 +498,81 @@ indentation correct. If in doubt, look at the examples already in the file, and
- FRONTPAGE_PUBLICBODY_EXAMPLES + ADMIN_USERNAME + & + ADMIN_PASSWORD +
+ DISABLE_EMERGENCY_USER
- Specify which public bodies you want to be listed as examples on the home page, - using their short_names. - If you want more than one, separate them with semicolons. - Comment this out if you want this to be auto-generated. -

- Warning: this is slow — don't use in production! -

+ Details for the + emergency user. +

+ This is useful for creating the initial admin users for your site: +

    +
  • Create a new user (using regular sign up on the site)
    • +
  • Log in as the emergency user
    • +
  • Promote the new account
    • +
  • Disable the emergency user
    • +
+

+

+ For details of this process, see + creating + a superuser account. +

Examples:

  • - FRONTPAGE_PUBLICBODY_EXAMPLES: 'tgq' + ADMIN_USERNAME: 'adminxxxx'
  • - FRONTPAGE_PUBLICBODY_EXAMPLES: 'tgq;foo;bar' + ADMIN_PASSWORD: 'passwordx'
  • - # FRONTPAGE_PUBLICBODY_EXAMPLES: + DISABLE_EMERGENCY_USER: false
- THEME_URLS + SKIP_ADMIN_AUTH
- URLs of themes to download and use - (when running the rails-post-deploy script). The earlier in the list means - the templates have a higher priority. + Set this to true, and the admin interface will be available to anonymous users. + Obviously, you should not set this to be true in production environments.

Example:

  • - 
    -THEME_URLS:
- - 'git://github.com/mysociety/alavetelitheme.git'
-
    + SKIP_ADMIN_AUTH: false
- THEME_BRANCH + INCOMING_EMAIL_DOMAIN
- When rails-post-deploy installs the themes, - it will try the theme branch first, but only if you've set THEME_BRANCH - to be true. If the branch doesn't exist it will fall back to using a tagged version - specific to your installed alaveteli version, and if that doesn't exist it will - back to master. -

- The default theme is the "Alaveteli" theme. This gets installed automatically when - rails-post-deploy runs. -

+ Your email domain for incoming mail. See also How Alaveteli handles email.

Example:

  • - THEME_BRANCH: false + INCOMING_EMAIL_DOMAIN: 'localhost' +
    • +
  • + INCOMING_EMAIL_DOMAIN: 'foifa.com'
- FORCE_REGISTRATION_ON_NEW_REQUEST -
-
- Does a user needs to sign in to start the New Request process? -
-

Example:

-
    -
  • - FORCE_REGISTRATION_ON_NEW_REQUEST: false -
    • -
-
-
- - -
- INCOMING_EMAIL_DOMAIN -
-
- Your email domain for incoming mail. See also How Alaveteli handles email. -
-

Example:

-
    -
  • - INCOMING_EMAIL_DOMAIN: 'localhost' -
    • -
  • - INCOMING_EMAIL_DOMAIN: 'foifa.com' -
    • -
-
-
- -
- INCOMING_EMAIL_PREFIX + INCOMING_EMAIL_PREFIX
An optional prefix to help you distinguish FOI requests. See also How Alaveteli handles email. @@ -464,7 +589,6 @@ THEME_URLS:
-
INCOMING_EMAIL_SECRET
@@ -495,62 +619,6 @@ THEME_URLS: -
- ADMIN_USERNAME - & - ADMIN_PASSWORD -
- DISABLE_EMERGENCY_USER -
-
- Details for the - emergency user. -

- This is useful for creating the initial admin users for your site: -

    -
  • Create a new user (using regular sign up on the site)
    • -
  • Log in as the emergency user
    • -
  • Promote the new account
    • -
  • Disable the emergency user
    • -
-

-

- For details of this process, see - creating - a superuser account. -

-
-

Examples:

-
    -
  • - ADMIN_USERNAME: 'adminxxxx' -
    • -
  • - ADMIN_PASSWORD: 'passwordx' -
    • -
  • - DISABLE_EMERGENCY_USER: false -
    • -
-
-
- -
- SKIP_ADMIN_AUTH -
-
- Set this to true, and the admin interface will be available to anonymous users. - Obviously, you should not set this to be true in production environments. -
-

Example:

-
    -
  • - SKIP_ADMIN_AUTH: false -
    • -
-
-
-
CONTACT_EMAIL & @@ -607,156 +675,110 @@ THEME_URLS:
- COOKIE_STORE_SESSION_SECRET + EXCEPTION_NOTIFICATIONS_FROM & + EXCEPTION_NOTIFICATIONS_TO
- Secret key for signing cookie_store sessions. Make it long and random. + Email address(es) used for sending exception notifications.
-

Example:

+

Examples:

  • - COOKIE_STORE_SESSION_SECRET: 'uIngVC238Jn9NsaQizMNf89pliYmDBFugPjHS2JJmzOp8' + 
    +EXCEPTION_NOTIFICATIONS_FROM: do-not-reply-to-this-address@example.com
+
+EXCEPTION_NOTIFICATIONS_TO:
+ - robin@example.com
+ - seb@example.com
+
- READ_ONLY + FORWARD_NONBOUNCE_RESPONSES_TO
- If present, READ_ONLY 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. + The email address to which non-bounce responses should be forwarded. See also How Alaveteli handles email.
-

Examples:

+

Example:

  • - Typically, you do not want to run your site in - read-only mode — so set READ_ONLY to be - an empty string. -
    - - READ_ONLY: '' - -
    • -
  • - - READ_ONLY: 'The site is not currently accepting requests while we move the server.' - + FORWARD_NONBOUNCE_RESPONSES_TO: user-support@example.com
- STAGING_SITE + MTA_LOG_PATH
- Is this a - staging or - development site? - If not, it's a live production - site. This setting controls whether or not the rails-post-deploy - script will create the file config/rails_env.rb file to force - Rails into production environment. + Path to your exim or postfix log files that will get sucked up + by script/load-mail-server-logs.
-

Examples:

+

Example:

  • - For staging or development: -

    - STAGING_SITE: 1 -

    -
    • -
  • - For production: -

    - STAGING_SITE: 0 -

    + MTA_LOG_PATH: '/var/log/exim4/exim-mainlog-*'
- RECAPTCHA_PUBLIC_KEY & - RECAPTCHA_PRIVATE_KEY + MTA_LOG_TYPE
- Recaptcha, for detecting humans. Get keys here: - http://recaptcha.net/whyrecaptcha.html + Are you using "exim" or "postfix" for your Mail Transfer Agnt (MTA)?
-

Examples:

+

Example:

  • - RECAPTCHA_PUBLIC_KEY: '7HoPjGBBBBBBBBBkmj78HF9PjjaisQ893' -
    • -
  • - RECAPTCHA_PRIVATE_KEY: '7HjPjGBBBBBCBBBpuTy8a33sgnGG7A' + MTA_LOG_TYPE: "exim"
- NEW_RESPONSE_REMINDER_AFTER_DAYS + COOKIE_STORE_SESSION_SECRET
- Number of days after which to send a 'new response reminder'. + Secret key for signing cookie_store sessions. Make it long and random.

Example:

  • - NEW_RESPONSE_REMINDER_AFTER_DAYS: [3, 10, 24] + COOKIE_STORE_SESSION_SECRET: 'uIngVC238Jn9NsaQizMNf89pliYmDBFugPjHS2JJmzOp8'
- DEBUG_RECORD_MEMORY + RECAPTCHA_PUBLIC_KEY & + RECAPTCHA_PRIVATE_KEY
- For debugging memory problems. If true, Alaveteli logs - the memory use increase of the Ruby process due to the - request (Linux only). Since Ruby never returns memory to the OS, if the - existing process previously served a larger request, this won't - show any consumption for the later request. + Recaptcha, for detecting humans. Get keys here: + http://recaptcha.net/whyrecaptcha.html
-

Example:

+

Examples:

  • - DEBUG_RECORD_MEMORY: false + RECAPTCHA_PUBLIC_KEY: '7HoPjGBBBBBBBBBkmj78HF9PjjaisQ893'
    • -
-
-
- - -
- USE_GHOSTSCRIPT_COMPRESSION -
-
- Currently we default to using pdftk to compress PDFs. You can - optionally try Ghostscript, which should do a better job of - compression. Some versions of pdftk are buggy with respect to - compression, in which case Alaveteli doesn't recompress the PDFs at - all and logs a warning message "Unable to compress PDF" — which would - be another reason to try this setting. -
-

Example:

-
  • - USE_GHOSTSCRIPT_COMPRESSION: true + RECAPTCHA_PRIVATE_KEY: '7HjPjGBBBBBCBBBpuTy8a33sgnGG7A'
-
GAZE_URL
@@ -775,134 +797,145 @@ THEME_URLS:
- FORWARD_NONBOUNCE_RESPONSES_TO + GA_CODE (GA=Google Analytics)
- The email address to which non-bounce responses should be forwarded. See also How Alaveteli handles email. + Adding a value here will enable Google Analytics on all non-admin pages for non-admin users.
-

Example:

+

Examples:

  • - FORWARD_NONBOUNCE_RESPONSES_TO: user-support@example.com + GA_CODE: '' +
    • +
  • + GA_CODE: 'AB-8222142-14'
- HTML_TO_PDF_COMMAND + UTILITY_SEARCH_PATH
- Path to a program that converts an HTML page in a file to PDF. It - should take two arguments: the URL, and a path to an output file. - A static binary of wkhtmltopdf is recommended. - If the command is not present, a text-only version will be rendered - instead. + Search path for external command-line utilities (such as pdftohtml, pdftk, unrtf).

Example:

  • - HTML_TO_PDF_COMMAND: /usr/local/bin/wkhtmltopdf-amd64 + UTILITY_SEARCH_PATH: ["/usr/bin", "/usr/local/bin"]
- EXCEPTION_NOTIFICATIONS_FROM & - EXCEPTION_NOTIFICATIONS_TO + SHARED_FILES_PATH
- Email address(es) used for sending exception notifications. + In some deployments of Alaveteli you may wish to install each newly + deployed version alongside the previous ones, in which case certain + files and resources should be shared between these installations. + For example, the files directory, the cache directory and the + generated graphs such as public/foi-live-creation.png. If you're + installing Alaveteli in such a setup then set SHARED_FILES_PATH to + the directory you're keeping these files under. Otherwise, leave it blank.
-

Examples:

+

Example:

  • - 
    -EXCEPTION_NOTIFICATIONS_FROM: do-not-reply-to-this-address@example.com
-
-EXCEPTION_NOTIFICATIONS_TO:
- - robin@example.com
- - seb@example.com
-
    + SHARED_FILES_PATH: ''
-
- AUTHORITY_MUST_RESPOND + SHARED_FILES & + SHARED_DIRECTORIES
-
- Introduced in Alaveteli version 0.21 -
- Set this to true if authorities must respond by law. Set to false otherwise. It defaults to true. At the moment this just controls the display of some UI text telling users that the authority must respond to them by law. + If you have SHARED_FILES_PATH set, then these options list the files + and directories that are shared; i.e. those to which the deploy scripts + should create symlinks from the repository.
-

Example:

+

Examples:

  • - AUTHORITY_MUST_RESPOND: true + 
    +SHARED_FILES:
+ - config/database.yml
+ - config/general.yml
+ - config/rails_env.rb
+ - config/newrelic.yml
+ - config/httpd.conf
+ - public/foi-live-creation.png
+ - public/foi-user-use.png
+ - config/aliases
+
    +
    • +
  • + 
    +SHARED_DIRECTORIES:
+ - files/
+ - cache/
+ - lib/acts_as_xapian/xapiandbs/
+ - vendor/bundle
+ - public/assets
+
- MAX_REQUESTS_PER_USER_PER_DAY + NEW_RESPONSE_REMINDER_AFTER_DAYS
- This rate limiting can be turned off per-user via the admin interface. + Number of days after which to send a 'new response reminder'.

Example:

  • - MAX_REQUESTS_PER_USER_PER_DAY: 6 + NEW_RESPONSE_REMINDER_AFTER_DAYS: [3, 10, 24]
- VARNISH_HOST + AUTHORITY_MUST_RESPOND
- If you're running behind Varnish, it might help to set this to - work out where to send purge requests. - Otherwise, don't set it. +
+ Introduced in Alaveteli version 0.21 +
+ Set this to true if authorities must respond by law. Set to false otherwise. It defaults to true. At the moment this just controls the display of some UI text telling users that the authority must respond to them by law.
-

Examples:

+

Example:

  • - VARNISH_HOST: null -
    • -
  • - VARNISH_HOST: localhost + AUTHORITY_MUST_RESPOND: true
- GA_CODE (GA=Google Analytics) + MAX_REQUESTS_PER_USER_PER_DAY
- Adding a value here will enable Google Analytics on all non-admin pages for non-admin users. + This rate limiting can be turned off per-user via the admin interface.
-

Examples:

+

Example:

  • - GA_CODE: '' -
    • -
  • - GA_CODE: 'AB-8222142-14' + MAX_REQUESTS_PER_USER_PER_DAY: 6
-
OVERRIDE_ALL_PUBLIC_BODY_REQUEST_EMAILS
@@ -928,242 +961,199 @@ EXCEPTION_NOTIFICATIONS_TO:
- UTILITY_SEARCH_PATH -
-
- Search path for external command-line utilities (such as pdftohtml, pdftk, unrtf). -
-

Example:

-
    -
  • - UTILITY_SEARCH_PATH: ["/usr/bin", "/usr/local/bin"] -
    • -
-
-
- - -
- MTA_LOG_PATH + ALLOW_BATCH_REQUESTS
- Path to your exim or postfix log files that will get sucked up - by script/load-mail-server-logs. + Allow some users to make batch requests to multiple authorities. Once + this is set to true, you can enable batch requests for an individual + user via the user admin page.

Example:

  • - MTA_LOG_PATH: '/var/log/exim4/exim-mainlog-*' + ALLOW_BATCH_REQUESTS: false
- MTA_LOG_TYPE + PUBLIC_BODY_LIST_FALLBACK_TO_DEFAULT_LOCALE
- Are you using "exim" or "postfix" for your Mail Transfer Agnt (MTA)? - + If you would like the public body list page to include bodies that have no translation + in the current locale (but which do have a translation in the default locale), set this to true.

Example:

  • - MTA_LOG_TYPE: "exim" + PUBLIC_BODY_LIST_FALLBACK_TO_DEFAULT_LOCALE: false
- DONATION_URL + BLOG_FEED
- URL where people can donate to the organisation running the site. If set, - this will be included in the message people see when their request is - successful. + These feeds are displayed accordingly on the Alaveteli "blog" page:

Example:

  • - DONATION_URL: "https://www.mysociety.org/donate/" + BLOG_FEED: 'https://www.mysociety.org/category/projects/whatdotheyknow/feed/'
- PUBLIC_BODY_STATISTICS_PAGE & - MINIMUM_REQUESTS_FOR_STATISTICS + TWITTER_USERNAME + TWITTER_WIDGET_ID
- If PUBLIC_BODY_STATISTICS_PAGE is set to true, Alaveteli will make a - page of statistics on the performance of public bodies (which you can see at - /body_statistics). - The page will only consider public bodies that have had at least the number of requests - set by MINIMUM_REQUESTS_FOR_STATISTICS. - + If you want a twitter feed displayed on the "blog" page, provide the widget ID and username.
-

Example:

+

Examples:

  • - PUBLIC_BODY_STATISTICS_PAGE: false + TWITTER_USERNAME: WhatDoTheyKnow
  • - MINIMUM_REQUESTS_FOR_STATISTICS: 50 + TWITTER_WIDGET_ID: '833549204689320031'
- PUBLIC_BODY_LIST_FALLBACK_TO_DEFAULT_LOCALE + DONATION_URL
- If you would like the public body list page to include bodies that have no translation - in the current locale (but which do have a translation in the default locale), set this to true. + URL where people can donate to the organisation running the site. If set, + this will be included in the message people see when their request is + successful.

Example:

  • - PUBLIC_BODY_LIST_FALLBACK_TO_DEFAULT_LOCALE: false + DONATION_URL: "https://www.mysociety.org/donate/"
-
- USE_MAILCATCHER_IN_DEVELOPMENT + DEBUG_RECORD_MEMORY
- - If true, while in development mode, try to send mail by SMTP to port - 1025 (the port the mailcatcher listens on by default): + For debugging memory problems. If true, Alaveteli logs + the memory use increase of the Ruby process due to the + request (Linux only). Since Ruby never returns memory to the OS, if the + existing process previously served a larger request, this won't + show any consumption for the later request. +

Example:

  • - USE_MAILCATCHER_IN_DEVELOPMENT: true + DEBUG_RECORD_MEMORY: false
- CACHE_FRAGMENTS + VARNISH_HOST
- Use memcached to cache HTML fragments for better performance. - This will only have an effect in environments where - config.action_controller.perform_caching is set to true - + If you're running behind Varnish, it might help to set this to + work out where to send purge requests. + Otherwise, don't set it.
-

Example:

+

Examples:

  • - CACHE_FRAGMENTS: true + VARNISH_HOST: null +
    • +
  • + VARNISH_HOST: localhost
- -
- SHARED_FILES_PATH + USE_MAILCATCHER_IN_DEVELOPMENT
- In some deployments of Alaveteli you may wish to install each newly - deployed version alongside the previous ones, in which case certain - files and resources should be shared between these installations. - For example, the files directory, the cache directory and the - generated graphs such as public/foi-live-creation.png. If you're - installing Alaveteli in such a setup then set SHARED_FILES_PATH to - the directory you're keeping these files under. Otherwise, leave it blank. + + If true, while in development mode, try to send mail by SMTP to port + 1025 (the port the mailcatcher listens on by default):

Example:

  • - SHARED_FILES_PATH: '' + USE_MAILCATCHER_IN_DEVELOPMENT: true
-
- SHARED_FILES & - SHARED_DIRECTORIES + USE_GHOSTSCRIPT_COMPRESSION
- If you have SHARED_FILES_PATH set, then these options list the files - and directories that are shared; i.e. those to which the deploy scripts - should create symlinks from the repository. + Currently we default to using pdftk to compress PDFs. You can + optionally try Ghostscript, which should do a better job of + compression. Some versions of pdftk are buggy with respect to + compression, in which case Alaveteli doesn't recompress the PDFs at + all and logs a warning message "Unable to compress PDF" — which would + be another reason to try this setting.
-

Examples:

+

Example:

  • - 
    -SHARED_FILES:
- - config/database.yml
- - config/general.yml
- - config/rails_env.rb
- - config/newrelic.yml
- - config/httpd.conf
- - public/foi-live-creation.png
- - public/foi-user-use.png
- - config/aliases
-
    -
    • -
  • - 
    -SHARED_DIRECTORIES:
- - files/
- - cache/
- - lib/acts_as_xapian/xapiandbs/
- - vendor/bundle
- - public/assets
-
    + USE_GHOSTSCRIPT_COMPRESSION: true
- ALLOW_BATCH_REQUESTS + HTML_TO_PDF_COMMAND
- Allow some users to make batch requests to multiple authorities. Once - this is set to true, you can enable batch requests for an individual - user via the user admin page. + Path to a program that converts an HTML page in a file to PDF. It + should take two arguments: the URL, and a path to an output file. + A static binary of wkhtmltopdf is recommended. + If the command is not present, a text-only version will be rendered + instead.

Example:

  • - ALLOW_BATCH_REQUESTS: false + HTML_TO_PDF_COMMAND: /usr/local/bin/wkhtmltopdf-amd64
+
- RESPONSIVE_STYLING + CACHE_FRAGMENTS
- - Use the responsive base stylesheets and templates, rather than - those that only render the site at a fixed width. These - stylesheets are currently experimental but will become the default - in the future. They allow the site to render nicely on mobile - devices as well as larger screens. Currently the fixed width - stylesheets are used by default. + Use memcached to cache HTML fragments for better performance. + This will only have an effect in environments where + config.action_controller.perform_caching is set to true

Example:

  • - RESPONSIVE_STYLING: true + CACHE_FRAGMENTS: true
-- cgit v1.2.3