diff --git a/ckan/config/deployment.ini_tmpl b/ckan/config/deployment.ini_tmpl index 61e598e99e9..775f5c447f3 100644 --- a/ckan/config/deployment.ini_tmpl +++ b/ckan/config/deployment.ini_tmpl @@ -79,9 +79,6 @@ who.config_file = %(here)s/who.ini who.log_level = warning who.log_file = %(cache_dir)s/who_log.ini -# Location of RDF versions of datasets -#rdf_packages = http://semantic.ckan.net/record/ - # Location of licenses group (defaults to cached local version of ckan group) #licenses_group_url = http://licenses.opendefinition.org/licenses/groups/ckan.json diff --git a/doc/configuration.rst b/doc/configuration.rst index eefbec4be74..4cc8253f6f1 100644 --- a/doc/configuration.rst +++ b/doc/configuration.rst @@ -1,6 +1,3 @@ -.. index:: - single: config file - ===================================== Reference: CKAN Configuration Options ===================================== @@ -13,12 +10,10 @@ The file is well-documented, but we recommend reading this section in full to le .. note:: The CKAN config file also includes general Pylons options. All CKAN-specific settings are in the `[app:main]` section. + Database Settings ----------------- -.. index:: - single: sqlalchemy.url - sqlalchemy.url ^^^^^^^^^^^^^^ @@ -34,26 +29,43 @@ This defines the database that CKAN is to use. The format is:: Front-End Settings ------------------ +.. _ckan-site-title: -.. index:: - single: site_description +ckan.site_title +^^^^^^^^^^^^^^^ -site_description -^^^^^^^^^^^^^^^^ +Example:: + + ckan.site_title = Open Data Scotland + +Default value: ``CKAN`` + +This sets the name of the site, as displayed in the CKAN web interface. + +ckan.site_description +^^^^^^^^^^^^^^^^^^^^^ Example:: - ckan.site_description= + ckan.site_description = The easy way to get, use and share data Default value: (none) This is for a description, or tag line for the site, as displayed in the header of the CKAN web interface. -.. index:: - single: site_logo +ckan.site_intro_text +^^^^^^^^^^^^^^^^^^^^ + +Example:: -site_logo -^^^^^^^^^ + ckan.site_intro_text = Nice introductory paragraph about CKAN or the site in general. + +Default value: (none) + +This is for an introductory text used in the default template's index page. + +ckan.site_logo +^^^^^^^^^^^^^^ Example:: @@ -63,48 +75,76 @@ Default value: (none) This sets the logo used in the title bar. -.. index:: - single: site_url +ckan.site_about +^^^^^^^^^^^^^^^ +Example:: -.. index:: - single: package_hide_extras + ckan.site_about = A _community-driven_ catalogue of _open data_ for the Greenfield area. -favicon -^^^^^^^ +Default value:: -Example:: +
CKAN is the world’s leading open-source data portal platform.
- ckan.favicon = http://okfn.org/wp-content/themes/okfn-master-wordpress-theme/images/favicon.ico +CKAN is a complete out-of-the-box software solution that makes data + accessible and usable – by providing tools to streamline publishing, sharing, + finding and using data (including storage of data and provision of robust data + APIs). CKAN is aimed at data publishers (national and regional governments, + companies and organizations) wanting to make their data open and available.
-Default value: ``/images/icons/ckan.ico`` +CKAN is used by governments and user groups worldwide and powers a variety + of official and community data portals including portals for local, national + and international government, such as the UK’s data.gov.uk + and the European Union’s publicdata.eu, + the Brazilian dados.gov.br, Dutch and + Netherland government portals, as well as city and municipal sites in the US, + UK, Argentina, Finland and elsewhere.
-This sets the site's `favicon`. This icon is usually displayed by the browser in the tab heading and bookmark. +CKAN: http://ckan.org/
+ CKAN Tour: http://ckan.org/tour/
+ Features overview: http://ckan.org/features/
${g.site_title} is a community-run catalogue of useful sets of data on the Internet. You can collect links here to data from around the web for yourself and others to use, or search for data that others have collected. Depending on the type of data (and its conditions of use), ${g.site_title} may also be able to store a copy of the data or host it in a database, and provide some basic visualisation tools.
+ckan.favicon
+^^^^^^^^^^^^
-This changes the text about the site on the 'About' page. i.e. replaces the text in the "About
``
+ckan.datasets_per_page
+^^^^^^^^^^^^^^^^^^^^^^
-.. note:: Whilst the default text is translated into many languages (switchable in the page footer), the text in this configuration option will not be translatable.
+Example::
+
+ ckan.datasets_per_page = 10
+
+Default value: ``20``
+
+This controls the pagination of the dataset search results page. This is the maximum number of datasets viewed per page of results.
package_hide_extras
^^^^^^^^^^^^^^^^^^^
@@ -119,9 +159,6 @@ This sets a space-separated list of extra field key values which will not be sho
.. warning:: While this is useful to e.g. create internal notes, it is not a security measure. The keys will still be available via the API and in revision diffs.
-.. index::
- single: rdf_packages
-
.. _config-apps-ideas:
ckan.dataset.show_apps_ideas
@@ -135,26 +172,41 @@ Default value: true
When set to false, or no, this setting will hide the 'Apps, Ideas, etc' tab on the package read page. If the value is not set, or is set to true or yes, then the tab will shown.
-rdf_packages
-^^^^^^^^^^^^
+ckan.activity_list_limit
+^^^^^^^^^^^^^^^^^^^^^^^^
Example::
- rdf_packages = http://semantic.ckan.net/record/
+ ckan.activity_list_limit = 31
-Configure this if you have an RDF store of the same datasets as are in your CKAN instance. It will provide three sorts of links from each dataset page to the equivalent RDF URL given in `rdf_packages`:
+Default value: ``infinite``
-1. 303 redirects for clients that content-negotiate rdf-xml or turtle. e.g. client GETs `http://ckan.net/dataset/pollution-2008` with accept header `application/rdf+xml` ``curl -H "Accept: application/rdf+xml" http://ckan.net/dataset/pollution-2008``. CKAN's response is a 303 redirect to `http://semantic.ckan.net/dataset/pollution-2008` which can be obtained with: ``curl -L -H "Accept: application/rdf+xml" http://ckan.net/dataset/pollution-2008``
+This controls the number of activities to show in the Activity Stream. By default, it shows everything.
-2. Embedded links for browsers that are aware. e.g. ``
+ckan.preview.direct
+^^^^^^^^^^^^^^^^^^^
-3. A visible RDF link on the page. e.g. ``
+Example::
+ ckan.preview.direct = png jpg gif
-.. index::
- single: dumps_url, dumps_format
+Default value: ``png jpg gif``
-dumps_url & dumps_format
-^^^^^^^^^^^^^^^^^^^^^^^^
+Defines the resource formats which should be embedded directly in an `img` tag
+when previewing them.
+
+ckan.preview.loadable
+^^^^^^^^^^^^^^^^^^^^^
+
+Example::
+ ckan.preview.loadable = html htm rdf+xml owl+xml xml n3 n-triples turtle plain atom rss txt
+
+Default value: ``html htm rdf+xml owl+xml xml n3 n-triples turtle plain atom rss txt``
+
+Defines the resource formats which should be loaded directly in an `iframe`
+tag when previewing them.
+
+ckan.dumps_url & ckan.dumps_format
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Example::
@@ -165,8 +217,8 @@ If there is a page which allows you to download a dump of the entire catalogue t
For more information on using dumpfiles, see :doc:`database-dumps`.
-recaptcha
-^^^^^^^^^
+ckan.recaptcha.publickey & ckan.recaptcha.privatekey
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Example::
ckan.recaptcha.publickey = 6Lc...-KLc
@@ -176,43 +228,49 @@ Setting both these options according to an established Recaptcha account adds ca
To get a Recaptcha account, sign up at: http://www.google.com/recaptcha
-And there is an option for the default expiry time if not specified::
+ckan.feeds.author_name
+^^^^^^^^^^^^^^^^^^^^^^
- ckan.cache.default_expires = 600
+Example::
+ ckan.feeds.author_name = Michael Jackson
-datasets_per_page
-^^^^^^^^^^^^^^^^^
+Default value: ``(none)``
+
+This controls the feed author's name. If unspecified, it'll use :ref:`ckan-site-id`.
+
+ckan.feeds.author_link
+^^^^^^^^^^^^^^^^^^^^^^
Example::
- ckan.datasets_per_page = 10
+ ckan.feeds.author_link = http://okfn.org
-Default value: ``20``
+Default value: ``(none)``
-This controls the pagination of the dataset search results page. This is the maximum number of datasets viewed per page of results.
+This controls the feed author's link. If unspecified, it'll use :ref:`ckan-site-url`.
-ckan.preview.direct
-^^^^^^^^^^^^^^^^^^^
+ckan.feeds.authority_name
+^^^^^^^^^^^^^^^^^^^^^^^^^
Example::
- ckan.preview.direct = png jpg gif
-Default value: ``png jpg gif``
+ ckan.feeds.authority_name = http://okfn.org
-Defines the resource formats which should be embedded directly in an `img` tag
-when previewing them.
+Default value: ``(none)``
-ckan.preview.loadable
-^^^^^^^^^^^^^^^^^^^^^
+The domain name or email address of the default publisher of the feeds and elements. If unspecified, it'll use :ref:`ckan-site-url`.
+
+ckan.feeds.date
+^^^^^^^^^^^^^^^
Example::
- ckan.preview.loadable = html htm rdf+xml owl+xml xml n3 n-triples turtle plain atom rss txt
-Default value: ``html htm rdf+xml owl+xml xml n3 n-triples turtle plain atom rss txt``
+ ckan.feeds.date = 2012-03-22
-Defines the resource formats which should be loaded directly in an `iframe`
-tag when previewing them.
+Default value: ``(none)``
+
+A string representing the default date on which the authority_name is owned by the publisher of the feed.
ckan.featured_groups
^^^^^^^^^^^^^^^^^^^^
@@ -229,27 +287,33 @@ groups and datasets from each group on the home page in the default templates
Authentication Settings
-----------------------
-.. index::
- single: openid_enabled
+ckan.gravatar_default
+^^^^^^^^^^^^^^^^^^^^^
-openid_enabled
-^^^^^^^^^^^^^^
+Example::
+
+ ckan.gravatar_default = monsterid
+
+Default value: ``identicon``
+
+This controls the default gravatar avatar, in case the user has none.
+
+ckan.legacy_templates
+^^^^^^^^^^^^^^^^^^^^^
Example::
- openid_enabled = False
+ ckan.legacy_templates = True
-Default value: ``True``
+Default value: ``False``
-CKAN operates a delegated authentication model based on `OpenID