[ckan-changes] commit/ckan: dread: [doc, config]: #1428 Tidy up of config option docs and template.

Fri Oct 28 12:02:45 UTC 2011

1 new commit in ckan:


https://bitbucket.org/okfn/ckan/changeset/a3b0080467d4/
changeset:   a3b0080467d4
branch:      release-v1.5
user:        dread
date:        2011-10-28 13:59:55
summary:     [doc,config]: #1428 Tidy up of config option docs and template.
affected #:  2 files

diff -r ec9a9efc2d4072c6e81d106f44af9e2a0f831731 -r a3b0080467d419c23542f63f52dd8f397a025247 ckan/config/deployment.ini_tmpl

--- a/ckan/config/deployment.ini_tmpl
+++ b/ckan/config/deployment.ini_tmpl
@@ -49,10 +49,6 @@
 who.log_level = warning
 who.log_file = %(cache_dir)s/who_log.ini
 
-# CKAN auth configuration (TODO: rename to ckan.auth or similar ...)
-# space separated list ...
-auth.admins = 
-
 # CKAN caching 
 ckan.cache_enabled = False
 ckan.cache_validation_enabled = True
@@ -71,9 +67,6 @@
 ckan.controllers.apiv2.package.list.expires = -1
 ckan.controllers.apiv2.package.show.expires = -1
 
-# CKAN QoS monitoring
-ckan.enable_call_timing = false
-
 # Location of RDF versions of datasets
 #rdf_packages = http://semantic.ckan.net/record/
 
@@ -89,13 +82,6 @@
 # API configuration
 #apikey_header_name = X-CKAN-API-Key
 
-# Changeset configuration
-#changeset.auto_commit = true
-#changeset.sources = http://www.ckan.net/,
-
-# Guide location
-#guide_url = http://wiki.okfn.org/ckan/doc/
-
 ## extra places to look for templates and public files (comma separated lists)
 ## any templates/files found will override correspondingly named ones in
 ## ckan/templates/ and ckan/public


diff -r ec9a9efc2d4072c6e81d106f44af9e2a0f831731 -r a3b0080467d419c23542f63f52dd8f397a025247 doc/configuration.rst
--- a/doc/configuration.rst
+++ b/doc/configuration.rst
@@ -116,6 +116,16 @@
 
 For more information on using dumpfiles, see :doc:`database_dumps`.
 
+recaptcha
+^^^^^^^^^
+
+Example::
+ ckan.recaptcha.publickey = 6Lc...-KLc
+ ckan.recaptcha.privatekey = 6Lc...-jP
+
+Setting both these options according to an established Recaptcha account adds captcha to the user registration form. This has been effective at preventing bots registering users and creating spam packages.
+
+To get a Recaptcha account, sign up at: http://www.google.com/recaptcha
 
 Cache Settings
 --------------
@@ -167,6 +177,10 @@
 
  ckan.static_max_age = 3600
 
+And there is an option for the default expiry time if not specified::
+
+ ckan.cache.default_expires = 600
+
 
 Authentication Settings
 -----------------------
@@ -473,6 +487,16 @@
 API is hosted on a different domain, for example when a third-party site uses
 the forms API.
 
+apikey_header_name
+^^^^^^^^^^^^^^^^^^
+
+Example::
+
+ apikey_header_name = API-KEY
+
+Default value: ``X-CKAN-API-Key`` & ``Authorization``
+
+This allows another http header to be used to provide the CKAN API key. This is useful if network infrastructure block the Authorization header and ``X-CKAN-API-Key`` is not suitable.
 
 Authorization Settings
 ----------------------

Repository URL: https://bitbucket.org/okfn/ckan/

--

This is a commit notification from bitbucket.org. You are receiving
this because you have the service enabled, addressing the recipient of
this email.


