Tomas Cohen Arazi
5394e8443f
Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com> Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org> Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
119 lines
5.1 KiB
Text
119 lines
5.1 KiB
Text
Web services:
|
|
General:
|
|
-
|
|
- "Set the Access-Control-Allow-Origin header to"
|
|
- pref: 'AccessControlAllowOrigin'
|
|
class: Text
|
|
- "."
|
|
REST API:
|
|
-
|
|
- pref: RESTBasicAuth
|
|
choices:
|
|
yes: Enable
|
|
no: "Disable"
|
|
- '<a href="https://www.w3.org/Protocols/HTTP/1.0/spec.html#BasicAA" target="_blank">Basic authentication</a> for the REST API.'
|
|
-
|
|
- "Set the default number of results returned by the REST API endpoints to"
|
|
- pref: "RESTdefaultPageSize"
|
|
class: integer
|
|
- "per page."
|
|
-
|
|
- pref: RESTOAuth2ClientCredentials
|
|
choices:
|
|
yes: Enable
|
|
no: "Disable"
|
|
- "the OAuth2 client credentials grant for the REST API. Requires Net::OAuth2::AuthorizationServer installed. [EXPERIMENTAL]"
|
|
-
|
|
- pref: RESTPublicAnonymousRequests
|
|
choices:
|
|
yes: "Enable"
|
|
no: "Disable"
|
|
- anonymous access to public routes (that don't require authenticated access)
|
|
-
|
|
- pref: RESTPublicAPI
|
|
choices:
|
|
yes: Enable
|
|
no: "Disable"
|
|
- "the /public namespace of the API."
|
|
OAI-PMH:
|
|
-
|
|
- pref: OAI-PMH
|
|
choices:
|
|
yes: Enable
|
|
no: Disable
|
|
- "Koha's"
|
|
- '<a href="http://www.openarchives.org/pmh/">OAI-PMH</a> server. (available at: /cgi-bin/koha/oai.pl?verb=Identify)'
|
|
-
|
|
- Identify records at this site with the prefix
|
|
- pref: "OAI-PMH:archiveID"
|
|
- '. Please, insert prefix without ending colon (":") char. The archiveID should respect OAI specification. See '
|
|
- '<a href="http://www.openarchives.org/OAI/2.0/guidelines-oai-identifier.htm">Implementation guidelines</a>. '
|
|
- 'Example: "oai:example-library.org"'
|
|
-
|
|
- Only return
|
|
- pref: "OAI-PMH:MaxCount"
|
|
class: integer
|
|
- records at a time in response to a ListRecords or ListIdentifiers query.
|
|
-
|
|
- "YAML OAI Koha server configuration file:"
|
|
- pref: "OAI-PMH:ConfFile"
|
|
class: file
|
|
- . If empty, Koha OAI Server operates in normal mode, otherwise it operates in extended mode. In extended mode, it's possible to parameter other formats than marcxml or Dublin Core. OAI-PMH:ConfFile specify a YAML configuration file which list available metadata formats and XSL file used to create them from marcxml records.
|
|
-
|
|
- pref: "OAI-PMH:AutoUpdateSets"
|
|
choices:
|
|
yes: Enable
|
|
no: Disable
|
|
- automatic update of OAI-PMH sets when a bibliographic record is created or updated
|
|
-
|
|
- Koha's deletedbiblio table
|
|
- pref: "OAI-PMH:DeletedRecord"
|
|
choices:
|
|
persistent: will never be emptied or truncated (persistent)
|
|
transient: might be emptied or truncated at some point (transient)
|
|
no: will never have any data in it (no)
|
|
- "."
|
|
ILS-DI:
|
|
-
|
|
- pref: ILS-DI
|
|
choices:
|
|
yes: Enable
|
|
no: Disable
|
|
- "ILS-DI services for OPAC users (available at: /cgi-bin/koha/ilsdi.pl)"
|
|
-
|
|
- Allow IP addresses
|
|
- pref: ILS-DI:AuthorizedIPs
|
|
class: Text
|
|
- to use the ILS-DI services (when enabled). Separate the IP addresses with commas and without spaces. Leave the field blank to allow any IP address.
|
|
Mana KB:
|
|
-
|
|
- pref: Mana
|
|
choices:
|
|
yes: Enable
|
|
no: Disable
|
|
2: No, let me think about
|
|
- submissions to Mana KB. Mana centralizes information between other Koha installations to facilitate the creation of new subscriptions, vendors, reports, etc. You can search, share, import, and comment on the content of Mana. The information shared with Mana KB is shared under the <a href="https://creativecommons.org/choose/zero/">CC-0 license</a>
|
|
-
|
|
- "Security token used to authenticate on Mana KB:"
|
|
- pref: ManaToken
|
|
class: Text
|
|
- Get a security token on the <a href="/cgi-bin/koha/admin/share_content.pl">Mana KB administration page</a>.
|
|
-
|
|
- 'Fields automatically shared with Mana KB'
|
|
- pref: AutoShareWithMana
|
|
multiple:
|
|
subscription: Subscriptions
|
|
Reporting:
|
|
-
|
|
- Only return
|
|
- pref: SvcMaxReportRows
|
|
class: integer
|
|
- rows of a report requested via the reports web service.
|
|
IdRef:
|
|
-
|
|
- pref: IdRef
|
|
choices:
|
|
yes: Enable
|
|
no: Disable
|
|
- the IdRef webservice from the opac detail page. IdRef allows to request authorities from the Sudoc database.
|
|
- Please note that this feature is available only for UNIMARC.
|