diff --git a/doc/configuration.rst b/doc/configuration.rst index 19619eaf385..69b1ce819bc 100644 --- a/doc/configuration.rst +++ b/doc/configuration.rst @@ -51,6 +51,17 @@ Default value: (none) This is for a description, or tag line for the site, as displayed in the header of the CKAN web interface. +ckan.site_intro_text +^^^^^^^^^^^^^^^^^^^^ + +Example:: + + 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 ^^^^^^^^^^^^^^ @@ -403,6 +414,22 @@ Default value: (none) By default, the locales are searched for in the ``ckan/i18n`` directory. Use this option if you want to use another folder. +.. _ckan_root_path: + +ckan.root_path +^^^^^^^^^^^^^^ + +Example:: + + ckan.root_path = /my/custom/path/{{LANG}}/foo + +Default value: (none) + +By default, the URLs are formatted as ``/some/url``, when using the default +locale, or ``/de/some/url`` when using the "de" locale, for example. This +lets you change this. You can use any path that you want, adding ``{{LANG}}`` +where you want the locale code to go. + Storage Settings ---------------- @@ -636,17 +663,6 @@ These are the setup parameters for AMQP messaging. These only apply if the messa Search Settings --------------- -ckan.simple_search -^^^^^^^^^^^^^^^^^^ - -Example:: - - ckan.simple_search = true - -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. - ckan.site_id ^^^^^^^^^^^^ @@ -660,6 +676,17 @@ a single CKAN instance then this can be ignored. Note, if you change this value, you need to rebuild the search index. +ckan.simple_search +^^^^^^^^^^^^^^^^^^ + +Example:: + + ckan.simple_search = true + +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. + .. _solr-url: solr_url @@ -701,29 +728,39 @@ 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). -ckan.extra_resource_fields +ckan.search.show_all_types ^^^^^^^^^^^^^^^^^^^^^^^^^^ Example:: - ckan.extra_resource_fields = alt_url + ckan.search.show_all_types = true -Default value: ``None`` +Default value: ``false`` -List of the extra resource fields that would be used when searching. +Controls whether the default search page (``/dataset``) should show only +standard datasets or also custom dataset types. -ckan.search.show_all_types +search.facet.limits +^^^^^^^^^^^^^^^^^^^ + +Example:: + + search.facet.limits = 100 + +Default value: ``50`` + +Sets the default number of searched facets returned in a query. + +ckan.extra_resource_fields ^^^^^^^^^^^^^^^^^^^^^^^^^^ Example:: - ckan.search.show_all_types = true + ckan.extra_resource_fields = alt_url -Default value: ``false`` +Default value: ``None`` -Controls whether the default search page (``/dataset``) should show only -standard datasets or also custom dataset types. Default is to show only -standard datasets. +List of the extra resource fields that would be used when searching. Site Settings @@ -808,6 +845,17 @@ Default value: (none) This controls if new datasets will require moderation approval before going public. +ckan.tracking_enabled +--------------------- + +Example:: + + ckan.tracking_enabled = True + +Default value: ``False`` + +This controls if CKAN will track the site usage. + Authorization Settings ---------------------- diff --git a/doc/i18n.rst b/doc/i18n.rst index 73615259ee7..48860880209 100644 --- a/doc/i18n.rst +++ b/doc/i18n.rst @@ -6,7 +6,7 @@ Internationalize CKAN CKAN is used in many countries, and adding a new language to the web interface is a simple process. -CKAN uses the url to determine which language is used. An example would be ``/fr/dataset`` would be shown in french. If CKAN is running under a directory then an example would be ``/root/fr/dataset``. For custom paths the ``ckan.root_path`` config option can be used and is of the form ``/path/from/root/with/{{LANG}}/substitution``. +CKAN uses the url to determine which language is used. An example would be ``/fr/dataset`` would be shown in french. If CKAN is running under a directory then an example would be ``/root/fr/dataset``. For custom paths check the :ref:`ckan_root_path` config option. .. Note: Storing metadata field values in more than one language is a separate topic. This is achieved by storing the translations in extra fields. A custom dataset form and dataset display template are recommended. Ask the CKAN team for more information.