Administration:
# Only used internally, omitted: FrameworksLoaded, Version
Interface options:
-
- Use
- pref: KohaAdminEmailAddress
class: email
- "as the email address for the administrator of Koha. (This is the default From: address for emails unless there is one for the particular library, and is referred to when an internal error occurs.)"
-
- Use
- pref: ReplytoDefault
class: email
- "as the email address that will be set as the replyto in emails"
-
- Use
- pref: ReturnpathDefault
class: email
- "as the return path or bounce address for undeliverable mail messages. If you leave this empty, the From address will be used (often defaulting to the admin address)."
-
- Show
- pref: DebugLevel
default: 0
choices:
0: "no"
1: some
2: lots of
- debugging information in the browser when an internal error occurs.
-
- pref: noItemTypeImages
default: 0
choices:
yes: "Don't show"
no: Show
- itemtype icons in the catalog.
-
- Separate columns in an exported CSV file with
- pref: delimiter
default: ","
choices:
';': semicolons
tabulation: tabs
',': commas
'/': slashes
'\': backslashes
'#': "#'s"
- by default.
-
- pref: virtualshelves
choices:
yes: Allow
no: "Don't allow"
- staff and patrons to create and view saved lists of books.
-
- When editing circulation rules show the
- pref: DefaultToLoggedInLibraryCircRules
choices:
yes: "logged in library's"
no: "all libraries"
- rules by default.
-
- When editing notices and slips show the
- pref: DefaultToLoggedInLibraryNoticesSlips
choices:
yes: "logged in library's"
no: "all libraries"
- notices and slips by default.
-
- When editing overdue notice/status triggers show the
- pref: DefaultToLoggedInLibraryOverdueTriggers
choices:
yes: "logged in library's"
no: "all libraries"
- rules by default.
Login options:
-
- Automatically log out users after
- pref: timeout
class: integer
- seconds of inactivity. Adding d will specify it in days, e.g. 1d is timeout of one day.
-
- pref: AutoLocation
default: 0
choices:
yes: Require
no: "Don't require"
- staff to log in from a computer in the IP address range specified by their library (if any).
-
- pref: SessionRestrictionByIP
default: 1
choices:
yes: Enable
no: "Disable"
- check for change in remote IP address for session security. Disable only when remote IP address changes frequently.
# PostgreSQL is supported by CGI::Session but not by Koha.
-
- Store login session information
- pref: SessionStorage
default: mysql
choices:
mysql: in the MySQL database.
Pg: in the PostgreSQL database (not supported).
tmp: as temporary files.
memcached: in a memcached server.
-
- pref: IndependentBranches
default: 0
choices:
yes: Prevent
no: "Don't prevent"
- staff (but not superlibrarians) from modifying objects (holds, items, patrons, etc.) belonging to other libraries.
-
- pref: IndependentBranchesPatronModifications
default: 0
choices:
yes: Prevent
no: "Don't prevent"
- staff (but not superlibrarians) from viewing and approving/denying patron modification requests for patrons belonging to other libraries.
CAS authentication:
-
- pref: casAuthentication
default: 0
choices:
yes: Use
no: "Don't use"
- CAS for login authentication.
-
- pref: casLogout
default: 0
choices:
yes: Logout
no: "Don't Logout"
- of CAS when logging out of Koha.
-
- The CAS Authentication Server can be found at
- pref: casServerUrl
SSL client certificate authentication:
-
- Use
- pref: AllowPKIAuth
default: None
choices:
None: "no"
Common Name: the Common Name
emailAddress: the emailAddress
- field for SSL client certificate authentication
Google OpenID Connect:
-
- pref: GoogleOpenIDConnect
choices:
yes: Use
no: "Don't Use"
- Google OpenID Connect login.
- You will need to select OAuth2 when creating an app in the google cloud console, and set the web origin to your_opac_url and the redirect url to your_opac_url/cgi-bin/koha/svc/auth/googleopenidconnect .
-
- Google OAuth2 Client ID
- pref: GoogleOAuth2ClientID
-
- Google OAuth2 Client Secret
- pref: GoogleOAuth2ClientSecret
-
- Google OpenID Connect Restrict to domain (or subdomain of this domain)
- pref: GoogleOpenIDConnectDomain
- . Leave blank for all google domains
Mozilla Persona:
-
- pref: Persona
default: 0
choices:
yes: Allow
no: "Don't Allow"
- Mozilla persona for login
Share anonymous usage statistics:
-
- pref: UsageStats
default: 0
choices:
yes: Share
no: "Don't share"
- anonymous Koha usage data with the Koha community. You can see the data on the Hea Koha community website. You have to run misc/cronjobs/share_usage_with_koha_community.pl in a cronjob.
-
- The library name
- pref: UsageStatsLibraryName
- will be shown on the Hea Koha community website.
- If this field is empty data will be sent anonymously.
- Note that this value has no effect if the UsageStats system preference is set to "Don't share"
-
- "The country where your library is located:"
- pref: UsageStatsCountry
- This will be shown on the Hea Koha community website.
- Note that this value has no effect if the UsageStats system preference is set to "Don't share"
-
- The library URL
- pref: UsageStatsLibraryUrl
- will be shown on the Hea Koha community website.
- Note that this value has no effect if the UsageStats system preference is set to "Don't share"
-
- The library type
- pref: UsageStatsLibraryType
default: public
choices:
public: "public"
school: "school"
academic: "academic"
research: "research"
private: "private"
societyAssociation: "society or association"
corporate: "corporate"
government: "government"
religiousOrg: "religious organization"
subscription: "subscription"
- will be shown on the Hea Koha community website.
- Note that this value has no effect if the UsageStats system preference is set to "Don't share"
Search Engine:
-
- pref: SearchEngine
default: Zebra
choices:
Zebra: Zebra
Elasticsearch: Elasticsearch
- is the search engine used.