diff --git a/doc/configuration.rst b/doc/configuration.rst index a4df7d79238..2499b2d8511 100644 --- a/doc/configuration.rst +++ b/doc/configuration.rst @@ -429,19 +429,6 @@ Default value: ``false`` Controls whether the default search page (``/dataset``) should show only standard datasets or also custom dataset types. -.. _search.facets.limits: - -search.facets.limits -^^^^^^^^^^^^^^^^^^^ - -Example:: - - search.facets.limits = 100 - -Default value: ``50`` - -Sets the default number of searched facets returned in a query. - .. _search.facets.default: search.facets.default @@ -572,36 +559,6 @@ This is for an introductory text used in the default template's index page. ckan.site_logo ^^^^^^^^^^^^^^ -ckan.featured_groups -^^^^^^^^^^^^^^^^^^^^ - -Example:: - ckan.featured_groups = group_one group_two - -Default Value: (empty) - -Defines a list of group names or group ids. This setting is used to display -groups and datasets from each group on the home page in the default templates -(2 groups and 2 datasets for each group are displayed). - -Authentication Settings ------------------------ - -.. index:: - single: openid_enabled - -openid_enabled -^^^^^^^^^^^^^^ - -Example:: - - openid_enabled = False - -Default value: ``True`` - -CKAN operates a delegated authentication model based on `OpenID `_. - -Setting this option to False turns off OpenID for login. Example:: ckan.site_logo = /images/ckan_logo_fullname_long.png @@ -1346,130 +1303,3 @@ Example:: Default value: ``None`` This controls from which email the error messages will come from. - - -Authorization Settings ----------------------- - -debug -^^^^^ - -Example:: - - debug = False - -Default value: ``False`` - -This enables Pylons' interactive debugging tool, makes Fanstatic serve unminified JS and CSS -files, and enables CKAN templates' debugging features. - -.. warning:: THIS SETTING MUST BE SET TO FALSE ON A PRODUCTION ENVIRONMENT. - Debug mode will enable the interactive debugging tool, allowing ANYONE to - execute malicious code after an exception is raised. - -ckan.debug_supress_header -^^^^^^^^^^^^^^^^^^^^^^^^^ - -Example:: - - ckan.debug_supress_header = False - -Default value: ``False`` - -This configs if the debug information showing the controller and action -receiving the request being is shown in the header. - -.. note:: This info only shows if debug is set to True. - - -Plugin Settings ---------------- - -ckan.plugins -^^^^^^^^^^^^ - -Example:: - - ckan.plugins = disqus datapreview googleanalytics follower - -Specify which CKAN extensions are to be enabled. - -.. warning:: If you specify an extension but have not installed the code, CKAN will not start. - -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`. - -ckan.datastore.enabled -^^^^^^^^^^^^^^^^^^^^^^ - -Example:: - - ckan.datastore.enabled = True - -Default value: ``False`` - -Controls if the Data API link will appear in Dataset's Resource page. - -.. note:: This setting only applies to the legacy templates. - -ckanext.stats.cache_enabled -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Example:: - - ckanext.stats.cache_enabled = True - -Default value: ``True`` - -This controls if we'll use the 1 day cache for stats. - - -Directory Settings ------------------- - -ckan.log_dir -^^^^^^^^^^^^ - -Example:: - - ckan.log_dir = /var/log/ckan/ - -This is the directory to which CKAN cron scripts (if there are any installed) should write log files. - -.. note:: This setting is nothing to do with the main CKAN log file, whose filepath is set in the ``[handler_file]`` args. - -ckan.dump_dir -^^^^^^^^^^^^^ - -Example:: - - ckan.dump_dir = /var/lib/ckan/dump/ - -This is the directory to which JSON or CSV dumps of the database are to be written, assuming a script has been installed to do this. - -.. note:: It is usual to set up the Apache config to serve this directory. - -ckan.backup_dir -^^^^^^^^^^^^^^^ - -Example:: - - ckan.backup_dir = /var/backups/ckan/ - -This is a directory where SQL database backups are to be written, assuming a script has been installed to do this. -search.facets.default -^^^^^^^^^^^^^^^^^^^^^ - -Example:: - - search.facets.default = 10 - -Default number of facets shown in search results. Default 10. - -search.facets.limit -^^^^^^^^^^^^^^^^^^^ - -Example:: - - search.facets.limit = 50 - -Highest number of facets shown in search results. Default 50.