diff --git a/doc/configuration.rst b/doc/configuration.rst index 618b8a897a8..1aef8efeba7 100644 --- a/doc/configuration.rst +++ b/doc/configuration.rst @@ -1,6 +1,3 @@ -.. index:: - single: config file - ===================================== Reference: CKAN Configuration Options ===================================== @@ -16,9 +13,6 @@ The file is well-documented, but we recommend reading this section in full to le Database Settings ----------------- -.. index:: - single: sqlalchemy.url - sqlalchemy.url ^^^^^^^^^^^^^^ @@ -34,9 +28,6 @@ This defines the database that CKAN is to use. The format is:: Front-End Settings ------------------ -.. index:: - single: ckan.site_title - ckan.site_title ^^^^^^^^^^^^^^^ @@ -48,9 +39,6 @@ Default value: ``CKAN`` This sets the name of the site, as displayed in the CKAN web interface. -.. index:: - single: ckan.site_description - ckan.site_description ^^^^^^^^^^^^^^^^^^^^^ @@ -62,9 +50,6 @@ 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: ckan.site_logo - ckan.site_logo ^^^^^^^^^^^^^^ @@ -76,9 +61,6 @@ Default value: (none) This sets the logo used in the title bar. -.. index:: - single: ckan.site_about - ckan.site_about ^^^^^^^^^^^^^^^ @@ -117,9 +99,6 @@ Format tips: .. 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. For this reason, it's better to overload the snippet in ``home/snippets/about_text.html``. For more information, see :doc:`theming`. -.. index:: - single: ckan.main_css - ckan.main_css ^^^^^^^^^^^^^ @@ -131,9 +110,6 @@ Default value: ``/base/css/main.css`` With this option, instead of using the default `main.css`, you can use your own. -.. index:: - single: ckan.favicon - ckan.favicon ^^^^^^^^^^^^ @@ -145,9 +121,6 @@ Default value: ``/images/icons/ckan.ico`` This sets the site's `favicon`. This icon is usually displayed by the browser in the tab heading and bookmark. -.. index:: - single: ckan.datasets_per_page - ckan.datasets_per_page ^^^^^^^^^^^^^^^^^^^^^^ @@ -160,9 +133,6 @@ 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. -.. index:: - single: package_hide_extras - package_hide_extras ^^^^^^^^^^^^^^^^^^^ @@ -189,9 +159,6 @@ 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. -.. index:: - single: ckan.activity_list_limit - ckan.activity_list_limit ^^^^^^^^^^^^^^^^^^^^^^^^ @@ -204,9 +171,6 @@ Default value: ``infinite`` This controls the number of activities to show in the Activity Stream. By default, it shows everything. -.. index:: - single: ckan.preview.direct - ckan.preview.direct ^^^^^^^^^^^^^^^^^^^ @@ -218,9 +182,6 @@ Default value: ``png jpg gif`` Defines the resource formats which should be embedded directly in an `img` tag when previewing them. -.. index:: - single: ckan.preview.loadable - ckan.preview.loadable ^^^^^^^^^^^^^^^^^^^^^ @@ -247,9 +208,6 @@ Configure this if you have an RDF store of the same datasets as are in your CKAN 3. A visible RDF link on the page. e.g. `` -.. index:: - single: ckan.dumps_url, ckan.dumps_format - ckan.dumps_url & ckan.dumps_format ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -262,9 +220,6 @@ 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`. -.. index:: - single: ckan.recaptcha.publickey, ckan.recaptcha.privatekey - ckan.recaptcha.publickey & ckan.recaptcha.privatekey ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -281,9 +236,6 @@ And there is an option for the default expiry time if not specified:: ckan.cache.default_expires = 600 -.. index:: - single: ckan.feeds.author_name - ckan.feeds.author_name ^^^^^^^^^^^^^^^^^^^^^^ @@ -295,9 +247,6 @@ Default value: ``(none)`` This controls the feed author's name. If unspecified, it'll use ckan.site_id. -.. index:: - single: ckan.feeds.author_link - ckan.feeds.author_link ^^^^^^^^^^^^^^^^^^^^^^ @@ -309,9 +258,6 @@ Default value: ``(none)`` This controls the feed author's link. If unspecified, it'll use ckan.site_url. -.. index:: - single: ckan.feeds.authority_name - ckan.feeds.authority_name ^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -323,9 +269,6 @@ Default value: ``(none)`` The domain name or email address of the default publisher of the feeds and elements. If unspecified, it'll use ckan.site_url. -.. index:: - single: ckan.feeds.date - ckan.feeds.date ^^^^^^^^^^^^^^^ @@ -337,9 +280,6 @@ Default value: ``(none)`` A string representing the default date on which the authority_name is owned by the publisher of the feed. -.. index:: - ckan.gravatar_default - ckan.gravatar_default ^^^^^^^^^^^^^^^^^^^^^ @@ -351,9 +291,6 @@ Default value: ``identicon`` This controls the default gravatar avatar, in case the user has none. -.. index:: - single: ckan.legacy_templates - ckan.legacy_templates ^^^^^^^^^^^^^^^^^^^^^ @@ -401,9 +338,6 @@ Setting this option to False turns off OpenID for login. Activity Streams Settings ------------------------- -.. index:: - single: ckan.activity_streams_enabled - ckan.activity_streams_enabled ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -416,9 +350,6 @@ Default value: ``True`` Turns on and off the activity streams used to track changes on datasets, groups, users, etc -.. index:: - single: ckan.activity_streams_email_notifications - ckan.activity_streams_email_notifications ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -436,9 +367,6 @@ the emails. For more information, visit :ref:`email-notifications`. Internationalisation Settings ----------------------------- -.. index:: - single: ckan.locale_default - ckan.locale_default ^^^^^^^^^^^^^^^^^^^ @@ -452,9 +380,6 @@ Use this to specify the locale (language of the text) displayed in the CKAN Web .. note: In versions of CKAN before 1.5, the settings used for this was variously `lang` or `ckan.locale`, which have now been deprecated in favour of `ckan.locale_default`. -.. index:: - single: ckan.locales_offered - ckan.locales_offered ^^^^^^^^^^^^^^^^^^^^ @@ -466,9 +391,6 @@ Default value: (none) By default, all locales found in the ``ckan/i18n`` directory will be offered to the user. To only offer a subset of these, list them under this option. The ordering of the locales is preserved when offered to the user. -.. index:: - single: ckan.locales_filtered_out - ckan.locales_filtered_out ^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -480,9 +402,6 @@ Default value: (none) If you want to not offer particular locales to the user, then list them here to have them removed from the options. -.. index:: - single: ckan.locale_order - ckan.locale_order ^^^^^^^^^^^^^^^^^ @@ -494,9 +413,6 @@ Default value: (none) If you want to specify the ordering of all or some of the locales as they are offered to the user, then specify them here in the required order. Any locales that are available but not specified in this option, will still be offered at the end of the list. -.. index:: - single: ckan.i18n_directory - ckan.i18n_directory ^^^^^^^^^^^^^^^^^^^ @@ -512,9 +428,6 @@ By default, the locales are searched for in the ``ckan/i18n`` directory. Use thi Storage Settings ---------------- -.. index:: - single: ckan.storage.bucket - ckan.storage.bucket ^^^^^^^^^^^^^^^^^^^ @@ -526,9 +439,6 @@ Default value: ``None`` This setting will change the bucket name for the uploaded files. -.. index:: - single: ckan.storage.key_prefix - ckan.storage.key_prefix ^^^^^^^^^^^^^^^^^^^^^^^ @@ -540,9 +450,6 @@ Default value: ``file/`` This setting will change the prefix for the uploaded files. -.. index:: - single: ckan.storage.max_content_length - ckan.storage.max_content_length ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -554,9 +461,6 @@ Default value: ``50000000`` This defines the maximum content size, in bytes, for uploads. -.. index:: - single: ofs.storage_dir - ofs.storage_dir ^^^^^^^^^^^^^^^ @@ -568,9 +472,6 @@ Default value: ``None`` Use this to specify where uploaded files should be stored, and also to turn on the handling of file storage. The folder should exist, and will automatically be turned into a valid pairtree repository if it is not already. -.. index:: - single: ckan.cache_enabled - ckan.cache_enabled ^^^^^^^^^^^^^^^^^^ @@ -597,9 +498,6 @@ Controls CKAN static files' cache max age, if we're serving and caching them. Theming Settings ---------------- -.. index:: - single: ckan.template_head_end - ckan.template_head_end ^^^^^^^^^^^^^^^^^^^^^^ @@ -617,9 +515,6 @@ You can also have multiline strings. Just indent following lines. e.g.:: .. note:: This is only for legacy code, and shouldn't be used anymore. -.. index:: - single: ckan.template_footer_end - ckan.template_footer_end ^^^^^^^^^^^^^^^^^^^^^^^^ @@ -642,9 +537,6 @@ Example (showing insertion of Google Analytics code):: .. note:: This is only for legacy code, and shouldn't be used anymore. -.. index:: - single: extra_template_paths - extra_template_paths ^^^^^^^^^^^^^^^^^^^^ @@ -658,9 +550,6 @@ For more information on theming, see :doc:`theming`. .. note:: This is only for legacy code, and shouldn't be used anymore. -.. index:: - single: extra_public_paths - extra_public_paths ^^^^^^^^^^^^^^^^^^ @@ -678,9 +567,6 @@ For more information on theming, see :doc:`theming`. Form Settings ------------- -.. index:: - single: package_form - package_form ^^^^^^^^^^^^ @@ -698,9 +584,6 @@ The value for this setting can be a Formalchemy form defined in the core CKAN co For more information on forms, see :doc:`forms`. -.. index:: - single: package_new_return_url, package_edit_return_url - .. _config-package-urls: package_new_return_url & package_edit_return_url @@ -716,9 +599,6 @@ If integrating the Edit Dataset and New Dataset forms into a third-party interfa The ```` string is replaced with the name of the dataset edited. Full details of this process are given in :doc:`form-integration`. -.. index:: - single: licenses_group_url - licenses_group_url ^^^^^^^^^^^^^^^^^^ @@ -743,9 +623,6 @@ Examples:: Messaging Settings ------------------ -.. index:: - single: carrot_messaging_library - carrot_messaging_library ^^^^^^^^^^^^^^^^^^^^^^^^ @@ -765,9 +642,6 @@ This is the messaging library backend to use. Options:: See the `Carrot documentation `_ for details. -.. index:: - single: amqp_hostname, amqp_port, amqp_user_id, amqp_password - amqp_hostname, amqp_port, amqp_user_id, amqp_password ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -783,9 +657,6 @@ These are the setup parameters for AMQP messaging. These only apply if the messa Search Settings --------------- -.. index:: - single: ckan.simple_search - ckan.simple_search ^^^^^^^^^^^^^^^^^^ @@ -797,9 +668,6 @@ Default value: ``false`` Switching this on tells CKAN search functionality to just query the database, (rather than using Solr). In this setup, search is crude and limited, e.g. no full-text search, no faceting, etc. However, this might be very useful for getting up and running quickly with CKAN. -.. index:: - single: ckan.site-id - ckan.site_id ^^^^^^^^^^^^ @@ -830,9 +698,6 @@ Optionally, ``solr_user`` and ``solr_password`` can also be configured to specif Note, if you change this value, you need to rebuild the search index. -.. index:: - single: ckan.search.automatic_indexing - ckan.search.automatic_indexing ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -846,9 +711,6 @@ to occur asynchronously, set this option to 0. Note, this is equivalent to explicitly load the `synchronous_search` plugin. -.. index:: - single: ckan.search.solr_commit - ckan.search.solr_commit ^^^^^^^^^^^^^^^^^^^^^^^ @@ -860,9 +722,6 @@ Default value: ``true`` Make ckan commit changes solr after every dataset update change. Turn this to false if on solr 4.0 and you have automatic (soft)commits enabled to improve dataset update/create speed (however there may be a slight delay before dataset gets seen in results). -.. index:: - single: ckan.extra_resource_fields - ckan.extra_resource_fields ^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -875,9 +734,6 @@ Default value: ``None`` List of the extra resource fields that would be used when searching. -.. index:: - single: ckan.search.show_all_types - ckan.search.show_all_types ^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -895,9 +751,6 @@ standard datasets. Site Settings ------------- -.. index:: - single: ckan.site_url - ckan.site_url ^^^^^^^^^^^^^ @@ -909,9 +762,6 @@ Default value: (none) The primary URL used by this site. Used in the API to provide datasets with links to themselves in the web UI. -.. index:: - single: ckan.api_url - ckan.api_url ^^^^^^^^^^^^ @@ -925,9 +775,6 @@ The URL that resolves to the CKAN API part of the site. This is useful if the API is hosted on a different domain, for example when a third-party site uses the forms API. -.. index:: - single: apikey_header_name - apikey_header_name ^^^^^^^^^^^^^^^^^^ @@ -939,9 +786,6 @@ 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. -.. index:: - single: email_to - email_to ^^^^^^^^ @@ -953,9 +797,6 @@ Default value: ``None`` This controls where the error messages will be sent to. -.. index:: - single: ckan.cache_expires - ckan.cache_expires ^^^^^^^^^^^^^^^^^^ @@ -967,9 +808,6 @@ Default value: '' This sets ``Cache-Control`` header's max-age value. -.. index:: - single: ckan.page_cache_enable - ckan.page_cache_enable ^^^^^^^^^^^^^^^^^^^^^^ @@ -981,9 +819,6 @@ Default value: '' This enables the page caching. -.. index:: - single: moderated - moderated ^^^^^^^^^ @@ -999,9 +834,6 @@ This controls if new datasets will require moderation approval before going publ Authorization Settings ---------------------- -.. index:: - single: error_email_from - error_email_from ^^^^^^^^^^^^^^^^ @@ -1013,9 +845,6 @@ Default value: ``None`` This controls from which email the error messages will come from. -.. index:: - single: debug - debug ^^^^^ @@ -1032,9 +861,6 @@ files, and enables CKAN templates' debugging features. Debug mode will enable the interactive debugging tool, allowing ANYONE to execute malicious code after an exception is raised. -.. index:: - single: ckan.debug_supress_header - ckan.debug_supress_header ^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -1052,9 +878,6 @@ receiving the request being is shown in the header. Plugin Settings --------------- -.. index:: - single: ckan.plugins - ckan.plugins ^^^^^^^^^^^^ @@ -1068,9 +891,6 @@ Specify which CKAN extensions are to be enabled. Format as a space-separated list of the extension names. The extension name is the key in the [ckan.plugins] section of the extension's ``setup.py``. For more information on extensions, see :doc:`extensions`. -.. index:: - single: ckan.datastore.enabled - ckan.datastore.enabled ^^^^^^^^^^^^^^^^^^^^^^ @@ -1084,9 +904,6 @@ Controls if the Data API link will appear in Dataset's Resource page. .. note:: This setting only applies to the legacy templates. -.. index:: - single: ckanext.stats.cache_enabled - ckanext.stats.cache_enabled ^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -1102,9 +919,6 @@ This controls if we'll use the 1 day cache for stats. Directory Settings ------------------ -.. index:: - single: ckan.log_dir - ckan.log_dir ^^^^^^^^^^^^ @@ -1116,9 +930,6 @@ This is the directory to which CKAN cron scripts (if there are any installed) sh .. note:: This setting is nothing to do with the main CKAN log file, whose filepath is set in the ``[handler_file]`` args. -.. index:: - single: ckan.dump_dir - ckan.dump_dir ^^^^^^^^^^^^^ @@ -1130,9 +941,6 @@ This is the directory to which JSON or CSV dumps of the database are to be writt .. note:: It is usual to set up the Apache config to serve this directory. -.. index:: - single: ckan.backup_dir - ckan.backup_dir ^^^^^^^^^^^^^^^