[doc] Document api_key config option

This commit is contained in:
Adrià Mercader 2011-11-23 11:09:16 +00:00
parent da469ab08e
commit ac9a9100f8
1 changed files with 4 additions and 0 deletions

View File

@ -132,6 +132,9 @@ field. The currently supported configuration options are:
needs to have permission for creating packages, and if default groups were needs to have permission for creating packages, and if default groups were
defined, the user must have permission to assign packages to these groups. defined, the user must have permission to assign packages to these groups.
* api_key: If the remote CKAN instance has restricted access to the API you
can provide a CKAN API key, which will be sent in any request.
* read_only: Create harvested packages in read-only mode. Only the user who * read_only: Create harvested packages in read-only mode. Only the user who
performed the harvest (the one defined in the previous setting or the performed the harvest (the one defined in the previous setting or the
'harvest' sysadmin) will be able to edit and administer the packages 'harvest' sysadmin) will be able to edit and administer the packages
@ -146,6 +149,7 @@ the configuration field)::
"default_tags":["new-tag-1","new-tag-2"], "default_tags":["new-tag-1","new-tag-2"],
"default_groups":["my-own-group"], "default_groups":["my-own-group"],
"user":"harverster-user", "user":"harverster-user",
"api_key":"<REMOTE_API_KEY>",
"read_only": true "read_only": true
} }