diff options
author | Dave Whiteland <dave@mysociety.org> | 2014-04-24 16:19:55 +0100 |
---|---|---|
committer | Dave Whiteland <dave@mysociety.org> | 2014-04-24 16:19:55 +0100 |
commit | abd6b1a1bf63718eb7bcc4236f706e5d9f8f60ce (patch) | |
tree | 4d7ab1eb7fbc9728e14b2197d36df27dc248e8c5 | |
parent | 9b973a1e726eccc9998765a895f883c9b4578f65 (diff) |
add 'examples' classes to config settings
-rw-r--r-- | customising/config.md | 102 |
1 files changed, 51 insertions, 51 deletions
diff --git a/customising/config.md b/customising/config.md index 56a2f8c3b..259ba7f00 100644 --- a/customising/config.md +++ b/customising/config.md @@ -142,7 +142,7 @@ indentation correct. If in doubt, look at the examples already in the file, and <strong>SITE_NAME</strong> appears in various places throughout the site. <div class="more-info"> <p>Examples:</p> - <ul> + <ul class="examples"> <li> <code>SITE_NAME: 'Alaveteli'</code> </li> @@ -160,7 +160,7 @@ indentation correct. If in doubt, look at the examples already in the file, and Domain used in URLs generated by scripts (e.g. for going in some emails) <div class="more-info"> <p>Examples:</p> - <ul> + <ul class="examples"> <li> <code>DOMAIN: '127.0.0.1:3000'</code> </li> @@ -180,7 +180,7 @@ indentation correct. If in doubt, look at the examples already in the file, and recommended</strong> so that logins can't be intercepted by naughty people. <div class="more-info"> <p>Example:</p> - <ul> + <ul class="examples"> <li> <code>FORCE_SSL: true</code> </li> @@ -196,7 +196,7 @@ indentation correct. If in doubt, look at the examples already in the file, and of the country in which your Alaveteli site is deployed. <div class="more-info"> <p>Example:</p> - <ul> + <ul class="examples"> <li> <code>ISO_COUNTRY_CODE: GB</code> </li> @@ -213,7 +213,7 @@ indentation correct. If in doubt, look at the examples already in the file, and If not set, defaults to UTC. <div class="more-info"> <p>Example:</p> - <ul> + <ul class="examples"> <li> <code>TIME_ZONE: Australia/Sydney</code> </li> @@ -228,7 +228,7 @@ indentation correct. If in doubt, look at the examples already in the file, and These feeds are displayed accordingly on the Alaveteli "blog" page: <!-- TODO --> <div class="more-info"> <p>Example:</p> - <ul> + <ul class="examples"> <li> <code>BLOG_FEED: 'http://www.mysociety.org/category/projects/whatdotheyknow/feed/'</code> </li> @@ -244,7 +244,7 @@ indentation correct. If in doubt, look at the examples already in the file, and If you want a twitter feed displayed on the "blog" page, provide the widget ID and username. <div class="more-info"> <p>Examples:</p> - <ul> + <ul class="examples"> <li> <code>TWITTER_USERNAME: WhatDoTheyKnow</code> </li> @@ -265,7 +265,7 @@ indentation correct. If in doubt, look at the examples already in the file, and Nominate one of these locales as the default with <strong>DEFAULT_LOCALE</strong>. <div class="more-info"> <p>Examples:</p> - <ul> + <ul class="examples"> <li> <code>AVAILABLE_LOCALES: 'en es'</code> </li> @@ -283,7 +283,7 @@ indentation correct. If in doubt, look at the examples already in the file, and Should Alaveteli try to use the default language of the user's browser? <div class="more-info"> <p>Example:</p> - <ul> + <ul class="examples"> <li> <code>USE_DEFAULT_BROWSER_LANGUAGE: true</code> </li> @@ -301,7 +301,7 @@ indentation correct. If in doubt, look at the examples already in the file, and <strong>INCLUDE_DEFAULT_LOCALE_IN_URLS</strong> to false. <div class="more-info"> <p>Example:</p> - <ul> + <ul class="examples"> <li> <code>INCLUDE_DEFAULT_LOCALE_IN_URLS: true</code> </li> @@ -324,7 +324,7 @@ indentation correct. If in doubt, look at the examples already in the file, and or "calendar", and determines which days are counted. <div class="more-info"> <p>Examples:</p> - <ul> + <ul class="examples"> <li> <code>REPLY_LATE_AFTER_DAYS: 20</code> </li> @@ -354,7 +354,7 @@ indentation correct. If in doubt, look at the examples already in the file, and </p> <div class="more-info"> <p>Examples:</p> - <ul> + <ul class="examples"> <li> <code>FRONTPAGE_PUBLICBODY_EXAMPLES: 'tgq'</code> </li> @@ -377,7 +377,7 @@ indentation correct. If in doubt, look at the examples already in the file, and the templates have a higher priority. <div class="more-info"> <p>Example:</p> - <ul> + <ul class="examples"> <li> <pre> THEME_URLS: @@ -403,7 +403,7 @@ THEME_URLS: </p> <div class="more-info"> <p>Example:</p> - <ul> + <ul class="examples"> <li> <code>THEME_BRANCH: false</code> </li> @@ -418,7 +418,7 @@ THEME_URLS: Does a user needs to sign in to start the New Request process? <div class="more-info"> <p>Example:</p> - <ul> + <ul class="examples"> <li> <code>FORCE_REGISTRATION_ON_NEW_REQUEST: false</code> </li> @@ -434,7 +434,7 @@ THEME_URLS: Your email domain for incoming mail. <div class="more-info"> <p>Example:</p> - <ul> + <ul class="examples"> <li> <code>INCOMING_EMAIL_DOMAIN: 'localhost'</code> </li> @@ -452,7 +452,7 @@ THEME_URLS: An optional prefix to help you distinguish FOI requests. <div class="more-info"> <p>Example:</p> - <ul> + <ul class="examples"> <li> <code>INCOMING_EMAIL_PREFIX: ''</code> </li> @@ -471,7 +471,7 @@ THEME_URLS: Used for hash in request email address. <div class="more-info"> <p>Example:</p> - <ul> + <ul class="examples"> <li> <code>INCOMING_EMAIL_SECRET: '11ae 4e3b 70ff c001 3682 4a51 e86d ef5f'</code> </li> @@ -486,7 +486,7 @@ THEME_URLS: Used as envelope from at the incoming email domain for cases where you don't care about failure. <div class="more-info"> <p>Example:</p> - <ul> + <ul class="examples"> <li> <code>BLACKHOLE_PREFIX: 'do-not-reply-to-this-address'</code> </li> @@ -505,7 +505,7 @@ THEME_URLS: The emergency user. <div class="more-info"> <p>Examples:</p> - <ul> + <ul class="examples"> <li> <code>ADMIN_USERNAME: 'adminxxxx'</code> </li> @@ -527,7 +527,7 @@ THEME_URLS: Obviously, you should not set this to be true in production environments. <div class="more-info"> <p>Example:</p> - <ul> + <ul class="examples"> <li> <code>SKIP_ADMIN_AUTH: false</code> </li> @@ -544,7 +544,7 @@ THEME_URLS: Email "from" details. <div class="more-info"> <p>Examples:</p> - <ul> + <ul class="examples"> <li> <code>CONTACT_EMAIL: 'team@example.com'</code> </li> @@ -563,7 +563,7 @@ THEME_URLS: Email "from" details for track messages. <div class="more-info"> <p>Examples:</p> - <ul> + <ul class="examples"> <li> <code>TRACK_SENDER_EMAIL: 'alaveteli@example.com'</code> </li> @@ -582,7 +582,7 @@ THEME_URLS: <strong>Make sure you back this up!</strong> <div class="more-info"> <p>Example:</p> - <ul> + <ul class="examples"> <li> <code>RAW_EMAILS_LOCATION: 'files/raw_emails'</code> </li> @@ -597,7 +597,7 @@ THEME_URLS: Secret key for signing cookie_store sessions. Make it long and random. <div class="more-info"> <p>Example:</p> - <ul> + <ul class="examples"> <li> <code>COOKIE_STORE_SESSION_SECRET: 'uIngVC238Jn9NsaQizMNf89pliYmDBFugPjHS2JJmzOp8'</code> </li> @@ -614,7 +614,7 @@ THEME_URLS: user as well, as it only checks in a few obvious places. <div class="more-info"> <p>Examples:</p> - <ul> + <ul class="examples"> <li> Typically, you do <strong>not</strong> want to run your site in read-only mode — so set <strong>READ_ONLY</strong> to be @@ -643,7 +643,7 @@ THEME_URLS: Rails into production environment. <div class="more-info"> <p>Example:</p> - <ul> + <ul class="examples"> <li> <code>STAGING_SITE: 1</code> </li> @@ -661,7 +661,7 @@ THEME_URLS: <div class="more-info"> <p>Examples:</p> - <ul> + <ul class="examples"> <li> <code>RECAPTCHA_PUBLIC_KEY: '7HoPjGBBBBBBBBBkmj78HF9PjjaisQ893'</code> </li> @@ -679,7 +679,7 @@ THEME_URLS: Number of days after which to send a 'new response reminder'. <div class="more-info"> <p>Example:</p> - <ul> + <ul class="examples"> <li> <code>NEW_RESPONSE_REMINDER_AFTER_DAYS: [3, 10, 24]</code> </li> @@ -699,7 +699,7 @@ THEME_URLS: <div class="more-info"> <p>Example:</p> - <ul> + <ul class="examples"> <li> <code>DEBUG_RECORD_MEMORY: false</code> </li> @@ -720,7 +720,7 @@ THEME_URLS: be another reason to try this setting. <div class="more-info"> <p>Example:</p> - <ul> + <ul class="examples"> <li> <code>USE_GHOSTSCRIPT_COMPRESSION: true</code> </li> @@ -738,7 +738,7 @@ THEME_URLS: You shouldn't normally need to change this. <div class="more-info"> <p>Example:</p> - <ul> + <ul class="examples"> <li> <code>GAZE_URL: http://gaze.mysociety.org</code> </li> @@ -753,7 +753,7 @@ THEME_URLS: The email address to which non-bounce responses should be forwarded <div class="more-info"> <p>Example:</p> - <ul> + <ul class="examples"> <li> <code>FORWARD_NONBOUNCE_RESPONSES_TO: user-support@example.com</code> </li> @@ -772,7 +772,7 @@ THEME_URLS: instead. <div class="more-info"> <p>Example:</p> - <ul> + <ul class="examples"> <li> <code>HTML_TO_PDF_COMMAND: /usr/local/bin/wkhtmltopdf-amd64</code> </li> @@ -788,7 +788,7 @@ THEME_URLS: Email address(es) used for sending exception notifications. <div class="more-info"> <p>Examples:</p> - <ul> + <ul class="examples"> <li> <pre> EXCEPTION_NOTIFICATIONS_FROM: do-not-reply-to-this-address@example.com @@ -809,7 +809,7 @@ EXCEPTION_NOTIFICATIONS_TO: This rate limiting can be turned off per-user via the admin interface. <div class="more-info"> <p>Example:</p> - <ul> + <ul class="examples"> <li> <code>MAX_REQUESTS_PER_USER_PER_DAY: 6</code> </li> @@ -826,7 +826,7 @@ EXCEPTION_NOTIFICATIONS_TO: Otherwise, don't set it. <div class="more-info"> <p>Examples:</p> - <ul> + <ul class="examples"> <li> <code>VARNISH_HOST: null</code> </li> @@ -844,7 +844,7 @@ EXCEPTION_NOTIFICATIONS_TO: Adding a value here will enable Google Analytics on all non-admin pages for non-admin users. <div class="more-info"> <p>Examples:</p> - <ul> + <ul class="examples"> <li> <code>GA_CODE: ''</code> </li> @@ -867,7 +867,7 @@ EXCEPTION_NOTIFICATIONS_TO: without inadvertently sending an email to a real authority. <div class="more-info"> <p>Examples:</p> - <ul> + <ul class="examples"> <li> <code>OVERRIDE_ALL_PUBLIC_BODY_REQUEST_EMAILS: test-email@foo.com</code> </li> @@ -887,7 +887,7 @@ EXCEPTION_NOTIFICATIONS_TO: Search path for external command-line utilities (such as pdftohtml, pdftk, unrtf). <div class="more-info"> <p>Example:</p> - <ul> + <ul class="examples"> <li> <code>UTILITY_SEARCH_PATH: ["/usr/bin", "/usr/local/bin"]</code> </li> @@ -904,7 +904,7 @@ EXCEPTION_NOTIFICATIONS_TO: by <code>script/load-mail-server-logs</code>. <div class="more-info"> <p>Example:</p> - <ul> + <ul class="examples"> <li> <code>MTA_LOG_PATH: '/var/log/exim4/exim-mainlog-*'</code> </li> @@ -920,7 +920,7 @@ EXCEPTION_NOTIFICATIONS_TO: <div class="more-info"> <p>Example:</p> - <ul> + <ul class="examples"> <li> <code>MTA_LOG_TYPE: "exim"</code> </li> @@ -937,7 +937,7 @@ EXCEPTION_NOTIFICATIONS_TO: successful. <div class="more-info"> <p>Example:</p> - <ul> + <ul class="examples"> <li> <code>DONATION_URL: "http://www.mysociety.org/donate/"</code> </li> @@ -958,7 +958,7 @@ EXCEPTION_NOTIFICATIONS_TO: <div class="more-info"> <p>Example:</p> - <ul> + <ul class="examples"> <li> <code>PUBLIC_BODY_STATISTICS_PAGE: false</code> </li> @@ -977,7 +977,7 @@ EXCEPTION_NOTIFICATIONS_TO: in the current locale (but which do have a translation in the default locale), set this to true. <div class="more-info"> <p>Example:</p> - <ul> + <ul class="examples"> <li> <code>PUBLIC_BODY_LIST_FALLBACK_TO_DEFAULT_LOCALE: false</code> </li> @@ -995,7 +995,7 @@ EXCEPTION_NOTIFICATIONS_TO: 1025 (the port the <a href="http://mailcatcher.me">mailcatcher</a> listens on by default): <div class="more-info"> <p>Example:</p> - <ul> + <ul class="examples"> <li> <code>USE_MAILCATCHER_IN_DEVELOPMENT: true</code> </li> @@ -1013,7 +1013,7 @@ EXCEPTION_NOTIFICATIONS_TO: <div class="more-info"> <p>Example:</p> - <ul> + <ul class="examples"> <li> <code>CACHE_FRAGMENTS: true</code> </li> @@ -1036,7 +1036,7 @@ EXCEPTION_NOTIFICATIONS_TO: the directory you're keeping these files under. Otherwise, leave it blank. <div class="more-info"> <p>Example:</p> - <ul> + <ul class="examples"> <li> <code>SHARED_FILES_PATH: ''</code> <!-- TODO specific example --> </li> @@ -1055,7 +1055,7 @@ EXCEPTION_NOTIFICATIONS_TO: should create symlinks from the repository. <div class="more-info"> <p>Examples:</p> - <ul> + <ul class="examples"> <li> <pre> SHARED_FILES: @@ -1092,7 +1092,7 @@ SHARED_DIRECTORIES: user via the user admin page. <div class="more-info"> <p>Example:</p> - <ul> + <ul class="examples"> <li> <code>ALLOW_BATCH_REQUESTS: false</code> </li> @@ -1114,7 +1114,7 @@ SHARED_DIRECTORIES: <div class="more-info"> <p>Example:</p> - <ul> + <ul class="examples"> <li> <code>RESPONSIVE_STYLING: true</code> </li> |