koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/admin.pref

   1 Administration:
   2 # Only used internally, omitted: FrameworksLoaded, Version
   3     Interface options:
   4         -
   5             - "Email address for the administrator of Koha: "
   6             - pref: KohaAdminEmailAddress
   7               class: email
   8             - "(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.)"
   9         -
  10             - "Email address to be set as the replyto in emails: "
  11             - pref: ReplytoDefault
  12               class: email
  13         -
  14             - "Return path or bounce address for undeliverable mail messages: "
  15             - pref: ReturnpathDefault
  16               class: email
  17             - "If you leave this empty, the From address will be used (often defaulting to the admin address)."
  18         -
  19             - "Email to redirect all messages to: "
  20             - pref: SendAllEmailsTo
  21               class: email
  22             - "(Leave this field empty to send messages to their normal recipient.)"
  23         -
  24             - "Email address failed overdue notices are sent to: "
  25             - pref: AddressForFailedOverdueNotices
  26               class: email
  27             - 'If left empty then it will fallback to the first defined address in the following list: Library ReplyTo, Library Email, <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=ReplytoDefault">ReplytoDefault</a> and <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=KohaAdminEmailAddress">KohaAdminEmailAddress</a>'
  28         -
  29
  30             - "How much debugging information to show in the browser when an internal error occurs: "
  31             - pref: DebugLevel
  32               default: 0
  33               choices:
  34                   0: None
  35                   1: Some
  36                   2: All
  37         -
  38             - pref: noItemTypeImages
  39               default: 0
  40               choices:
  41                   1: "Don't show"
  42                   0: "Show"
  43             - "itemtype icons in the staff interface."
  44         -
  45             - "Default separator for columns in an exported CSV file: "
  46             - pref: CSVDelimiter
  47               default: ","
  48               choices:
  49                   ';': semicolons
  50                   tabulation: tabs
  51                   ',': commas
  52                   '/': slashes
  53                   '\': backslashes
  54                   '#': "#'s"
  55         -
  56             - "Allow staff and patrons to create and view saved lists of books: "
  57             - pref: virtualshelves
  58               choices:
  59                   1: "Yes"
  60                   0: "No"
  61         -
  62             - "Default view when editing circulation rules: "
  63             - pref: DefaultToLoggedInLibraryCircRules
  64               choices:
  65                   1: "The logged-in library"
  66                   0: "All libraries"
  67         -
  68             - "Default view when editing notices and slips: "
  69             - pref: DefaultToLoggedInLibraryNoticesSlips
  70               choices:
  71                   1: "The logged-in library"
  72                   0: "All libraries"
  73         -
  74             - "Default view when editing overdue notice/status triggers: "
  75             - pref: DefaultToLoggedInLibraryOverdueTriggers
  76               choices:
  77                   1: "The logged-in library"
  78                   0: "All libraries"
  79
  80         -
  81             - pref: EmailOverduesNoEmail
  82               choices:
  83                   1: "Send"
  84                   0: "Don't send"
  85             - "overdue notices for patrons without email address to staff."
  86
  87     Login options:
  88         -
  89             - "Inactivity timeout in seconds to automatically log out users: "
  90             - pref: timeout
  91               class: integer
  92             - Adding d will specify it in days, e.g. 1d is timeout of one day.
  93         -
  94             - "Require staff to log in from a computer in the IP address range specified by their library (if any): "
  95             - pref: AutoLocation
  96               default: 0
  97               choices:
  98                   1: "Yes"
  99                   0: "No"
 100             - <a href="/cgi-bin/koha/admin/branches.pl">Link to library administration</a>
 101         -
 102             - "Enable check for change in remote IP address for session security: "
 103             - pref: SessionRestrictionByIP
 104               default: 1
 105               choices:
 106                   1: "Yes"
 107                   0: "No"
 108             - (Disable only when remote IP address changes frequently.)
 109         # PostgreSQL is supported by CGI::Session but not by Koha.
 110         -
 111             - "Storage of login session information: "
 112             - pref: SessionStorage
 113               default: mysql
 114               choices:
 115                   mysql: MySQL database
 116                   Pg: PostgreSQL database (not supported)
 117                   tmp: Temporary files
 118                   memcached: Memcached server
 119         -
 120             - "Prevent staff (but not superlibrarians) from modifying objects (holds, items, patrons, etc.) belonging to other libraries: "
 121             - pref: IndependentBranches
 122               default: 0
 123               choices:
 124                   1: "Yes"
 125                   0: "No"
 126             - "<p class='text-danger'><strong>Warning:</strong> Changing this system preference will radically alter the behavior of Koha. Changing preference on a production system is highly discouraged.</p>"
 127         -
 128             - "Prevent staff (but not superlibrarians) from viewing and approving/denying patron modification requests for patrons belonging to other libraries: "
 129             - pref: IndependentBranchesPatronModifications
 130               default: 0
 131               choices:
 132                   1: "Yes"
 133                   0: "No"
 134         -
 135             - "Prevent staff (but not superlibrarians) from transfering items to other libraries: "
 136             - pref: IndependentBranchesTransfers
 137               default: 0
 138               choices:
 139                   1: "Yes"
 140                   0: "No"
 141     CAS authentication:
 142         -
 143             - "Use CAS for login authentication: "
 144             - pref: casAuthentication
 145               default: 0
 146               choices:
 147                   1: "Yes"
 148                   0: "No"
 149         -
 150             - "Logout of CAS when logging out of Koha: "
 151             - pref: casLogout
 152               default: 0
 153               choices:
 154                   1: "Yes"
 155                   0: "No"
 156         -
 157             - "URL of the Central Authentication Service (CAS) server: "
 158             - pref: casServerUrl
 159               class: url
 160         -
 161             - "Version of the CAS server Koha will connect to: "
 162             - pref: casServerVersion
 163               choices:
 164                 2: 'CAS 2 or earlier'
 165                 3: 'CAS 3 or later'
 166     SSL client certificate authentication:
 167         -
 168             - "Field to use for SSL client certificate authentication: "
 169             - pref: AllowPKIAuth
 170               default: None
 171               choices:
 172                   None: "None"
 173                   Common Name: Common Name
 174                   emailAddress: emailAddress
 175     Google OpenID Connect:
 176         -
 177             - "Use Google OpenID Connect login in the OPAC: "
 178             - pref: GoogleOpenIDConnect
 179               choices:
 180                 1: "Yes"
 181                 0: "No"
 182             - 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. Requires <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=GoogleOAuth2ClientID">GoogleOAuth2ClientID</a> and <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=GoogleOAuth2ClientSecret">GoogleOAuth2ClientSecret</a> to be set.
 183         -
 184             - "Google OAuth2 Client ID: "
 185             - pref: GoogleOAuth2ClientID
 186             -  Along with <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=GoogleOAuth2ClientSecret">GoogleOAuth2ClientSecret</a>, enables <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=GoogleOpenIDConnect">GoogleOpenIDConnect.</a>
 187         -
 188             - "Google OAuth2 Client Secret: "
 189             - pref: GoogleOAuth2ClientSecret
 190             -  Along with <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=GoogleOAuth2ClientID">GoogleOAuth2ClientID</a>, enables <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=GoogleOpenIDConnect">GoogleOpenIDConnect.</a>
 191         -
 192             - "Restrict Google OpenID Connect to this domain (or subdomain of this domain): "
 193             - pref: GoogleOpenIDConnectDomain
 194             - Leave blank for all Google domains. Requires <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=GoogleOpenIDConnect">GoogleOpenIDConnect</a>.
 195         -
 196             - pref: GoogleOpenIDConnectAutoRegister
 197               choices:
 198                 1: Allow
 199                 0: "Don't allow"
 200             - patrons logging in with Google Open ID to automatically register. Requires <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=GoogleOpenIDConnect">GoogleOpenIDConnect</a>.
 201         -
 202             - "Use this category code when automatically registering a Google Open ID patron: "
 203             - pref: GoogleOpenIDConnectDefaultCategory
 204               choices: patron-categories
 205             - Requires <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=GoogleOpenIDConnect">GoogleOpenIDConnect</a>.
 206         -
 207             - "Use this branch code when automatically registering a Google Open ID patron: "
 208             - pref: GoogleOpenIDConnectDefaultBranch
 209             - Requires <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=GoogleOpenIDConnect">GoogleOpenIDConnect</a>.
 210     Share anonymous usage statistics:
 211         -
 212             - "Share anonymous Koha usage data with the Koha community: "
 213             - pref: UsageStats
 214               default: 2
 215               choices:
 216                   1: "Yes"
 217                   0: "No"
 218                   2: "No, let me think about it"
 219             - "."
 220             - "<br>Website where usage statistics are published: <a href=\"https://hea.koha-community.org\">Hea Koha community website</a>."
 221             - <br><strong>NOTE:</strong> The other <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=UsageStats">UsageStats</a> system preferences have no effect if this system preference is set to "No" (don't share).
 222             - "<br><strong>NOTE:</strong> This system preference requires the <code>misc/cronjobs/share_usage_with_koha_community.pl</code> cronjob. Ask your system administrator to schedule it."
 223             - "<br><strong>NOTE:</strong> Use the <a href=\"/cgi-bin/koha/admin/usage_statistics.pl\">dedicated configuration page</a> to edit the statistics you share."
 224         -
 225             - "Use the following library name to be shown on the Hea Community website: "
 226             - pref: UsageStatsLibraryName
 227             - . If this field is empty the data will be sent anonymously.
 228             - <br><strong>NOTE:</strong> This value has no effect if the <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=UsageStats">UsageStats</a> system preference is set to "No" (don't share).
 229         -
 230             - "The country where your library is located to be shown on the Hea Community website: "
 231             - pref: UsageStatsCountry
 232               default: ""
 233               choices:
 234                 ""             : ""
 235                 Afghanistan    : "Afghanistan"
 236                 Albania        : "Albania"
 237                 Algeria        : "Algeria"
 238                 Andorra        : "Andorra"
 239                 Angola         : "Angola"
 240                 Antigua & Deps : "Antigua & Deps"
 241                 Argentina      : "Argentina"
 242                 Armenia        : "Armenia"
 243                 Australia      : "Australia"
 244                 Austria        : "Austria"
 245                 Azerbaijan     : "Azerbaijan"
 246                 Bahamas        : "Bahamas"
 247                 Bahrain        : "Bahrain"
 248                 Bangladesh     : "Bangladesh"
 249                 Barbados       : "Barbados"
 250                 Belarus        : "Belarus"
 251                 Belgium        : "Belgium"
 252                 Belize         : "Belize"
 253                 Benin          : "Benin"
 254                 Bhutan         : "Bhutan"
 255                 Bolivia        : "Bolivia"
 256                 Bosnia Herz.   : "Bosnia Herz."
 257                 Botswana       : "Botswana"
 258                 Brazil         : "Brazil"
 259                 Brunei         : "Brunei"
 260                 Bulgaria       : "Bulgaria"
 261                 Burkina        : "Burkina"
 262                 Burundi        : "Burundi"
 263                 Cambodia       : "Cambodia"
 264                 Cameroon       : "Cameroon"
 265                 Canada         : "Canada"
 266                 Cape Verde     : "Cape Verde"
 267                 Centr. Afr. Rep: "Centr. Afr. Rep"
 268                 Chad           : "Chad"
 269                 Chile          : "Chile"
 270                 China          : "China"
 271                 Colombia       : "Colombia"
 272                 Comoros        : "Comoros"
 273                 Congo          : "Congo"
 274                 Costa Rica     : "Costa Rica"
 275                 Croatia        : "Croatia"
 276                 Cuba           : "Cuba"
 277                 Cyprus         : "Cyprus"
 278                 Czech Republic : "Czech Republic"
 279                 Denmark        : "Denmark"
 280                 Djibouti       : "Djibouti"
 281                 Dominica       : "Dominica"
 282                 Dominican Rep. : "Dominican Rep."
 283                 East Timor     : "East Timor"
 284                 Ecuador        : "Ecuador"
 285                 Egypt          : "Egypt"
 286                 El Salvador    : "El Salvador"
 287                 Equator. Guinea: "Equator. Guinea"
 288                 Eritrea        : "Eritrea"
 289                 Estonia        : "Estonia"
 290                 Ethiopia       : "Ethiopia"
 291                 Fiji           : "Fiji"
 292                 Finland        : "Finland"
 293                 France         : "France"
 294                 Gabon          : "Gabon"
 295                 Gambia         : "Gambia"
 296                 Georgia        : "Georgia"
 297                 Germany        : "Germany"
 298                 Ghana          : "Ghana"
 299                 Greece         : "Greece"
 300                 Grenada        : "Grenada"
 301                 Guatemala      : "Guatemala"
 302                 Guinea         : "Guinea"
 303                 Guinea-Bissau  : "Guinea-Bissau"
 304                 Guyana         : "Guyana"
 305                 Haiti          : "Haiti"
 306                 Honduras       : "Honduras"
 307                 Hungary        : "Hungary"
 308                 Iceland        : "Iceland"
 309                 India          : "India"
 310                 Indonesia      : "Indonesia"
 311                 Iran           : "Iran"
 312                 Iraq           : "Iraq"
 313                 Ireland        : "Ireland"
 314                 Israel         : "Israel"
 315                 Italy          : "Italy"
 316                 Ivory Coast    : "Ivory Coast"
 317                 Jamaica        : "Jamaica"
 318                 Japan          : "Japan"
 319                 Jordan         : "Jordan"
 320                 Kazakhstan     : "Kazakhstan"
 321                 Kenya          : "Kenya"
 322                 Kiribati       : "Kiribati"
 323                 Korea North    : "Korea North"
 324                 Korea South    : "Korea South"
 325                 Kosovo         : "Kosovo"
 326                 Kuwait         : "Kuwait"
 327                 Kyrgyzstan     : "Kyrgyzstan"
 328                 Laos           : "Laos"
 329                 Latvia         : "Latvia"
 330                 Lebanon        : "Lebanon"
 331                 Lesotho        : "Lesotho"
 332                 Liberia        : "Liberia"
 333                 Libya          : "Libya"
 334                 Liechtenstein  : "Liechtenstein"
 335                 Lithuania      : "Lithuania"
 336                 Luxembourg     : "Luxembourg"
 337                 Macedonia      : "Macedonia"
 338                 Madagascar     : "Madagascar"
 339                 Malawi         : "Malawi"
 340                 Malaysia       : "Malaysia"
 341                 Maldives       : "Maldives"
 342                 Mali           : "Mali"
 343                 Malta          : "Malta"
 344                 Marshall Isl.  : "Marshall Isl."
 345                 Mauritania     : "Mauritania"
 346                 Mauritius      : "Mauritius"
 347                 Mexico         : "Mexico"
 348                 Micronesia     : "Micronesia"
 349                 Moldova        : "Moldova"
 350                 Monaco         : "Monaco"
 351                 Mongolia       : "Mongolia"
 352                 Montenegro     : "Montenegro"
 353                 Morocco        : "Morocco"
 354                 Mozambique     : "Mozambique"
 355                 Myanmar        : "Myanmar"
 356                 Namibia        : "Namibia"
 357                 Nauru          : "Nauru"
 358                 Nepal          : "Nepal"
 359                 Netherlands    : "Netherlands"
 360                 New Zealand    : "New Zealand"
 361                 Nicaragua      : "Nicaragua"
 362                 Niger          : "Niger"
 363                 Nigeria        : "Nigeria"
 364                 Norway         : "Norway"
 365                 Oman           : "Oman"
 366                 Pakistan       : "Pakistan"
 367                 Palau          : "Palau"
 368                 Panama         : "Panama"
 369                 Papua N. Guinea: "Papua N. Guinea"
 370                 Paraguay       : "Paraguay"
 371                 Peru           : "Peru"
 372                 Philippines    : "Philippines"
 373                 Poland         : "Poland"
 374                 Portugal       : "Portugal"
 375                 Qatar          : "Qatar"
 376                 Romania        : "Romania"
 377                 Russian Fed.   : "Russian Fed."
 378                 Rwanda         : "Rwanda"
 379                 St Kitts & Nev.: "St Kitts & Nev."
 380                 St Lucia       : "St Lucia"
 381                 St Vincent     : "Saint Vincent"
 382                 Samoa          : "Samoa"
 383                 San Marino     : "San Marino"
 384                 Sao Tome       : "Sao Tome"
 385                 Saudi Arabia   : "Saudi Arabia"
 386                 Senegal        : "Senegal"
 387                 Serbia         : "Serbia"
 388                 Seychelles     : "Seychelles"
 389                 Sierra Leone   : "Sierra Leone"
 390                 Singapore      : "Singapore"
 391                 Slovakia       : "Slovakia"
 392                 Slovenia       : "Slovenia"
 393                 Solomon Islands: "Solomon Islands"
 394                 Somalia        : "Somalia"
 395                 South Africa   : "South Africa"
 396                 Spain          : "Spain"
 397                 Sri Lanka      : "Sri Lanka"
 398                 Sudan          : "Sudan"
 399                 Suriname       : "Suriname"
 400                 Swaziland      : "Swaziland"
 401                 Sweden         : "Sweden"
 402                 Switzerland    : "Switzerland"
 403                 Syria          : "Syria"
 404                 Taiwan         : "Taiwan"
 405                 Tajikistan     : "Tajikistan"
 406                 Tanzania       : "Tanzania"
 407                 Thailand       : "Thailand"
 408                 Togo           : "Togo"
 409                 Tonga          : "Tonga"
 410                 Trinidad & Tob.: "Trinidad & Tob."
 411                 Tunisia        : "Tunisia"
 412                 Turkey         : "Turkey"
 413                 Turkmenistan   : "Turkmenistan"
 414                 Tuvalu         : "Tuvalu"
 415                 Uganda         : "Uganda"
 416                 Ukraine        : "Ukraine"
 417                 UAE            : "UAE"
 418                 United Kingdom : "United Kingdom"
 419                 USA            : "USA"
 420                 Uruguay        : "Uruguay"
 421                 Uzbekistan     : "Uzbekistan"
 422                 Vanuatu        : "Vanuatu"
 423                 Vatican City   : "Vatican City"
 424                 Venezuela      : "Venezuela"
 425                 Vietnam        : "Vietnam"
 426                 Yemen          : "Yemen"
 427                 Zambia         : "Zambia"
 428                 Zimbabwe       : "Zimbabwe"
 429
 430             - . This will be shown on the <a href="https://hea.koha-community.org">Hea Koha community website</a>.
 431             - <br><strong>NOTE:</strong> This value has no effect if the <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=UsageStats">UsageStats</a> system preference is set to "No" (don't share).
 432         -
 433             - "The library URL to be shown on the Hea Community website: "
 434             - pref: UsageStatsLibraryUrl
 435               class: url
 436             - <br><strong>NOTE:</strong> This value has no effect if the <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=UsageStats">UsageStats</a> system preference is set to "No" (don't share).
 437         -
 438             - "The library type to be shown on the Hea Community website: "
 439             - pref: UsageStatsLibraryType
 440               default: ""
 441               choices:
 442                   ""          : ""
 443                   public      : "public"
 444                   school      : "school"
 445                   academic    : "academic"
 446                   research    : "research"
 447                   private     : "private"
 448                   societyAssociation: "society or association"
 449                   corporate   : "corporate"
 450                   government  : "government"
 451                   religiousOrg: "religious organization"
 452                   subscription: "subscription"
 453             - <br><strong>NOTE:</strong> This value has no effect if the <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=UsageStats">UsageStats</a> system preference is set to "No" (don't share).
 454         -
 455             - pref: UsageStatsLibrariesInfo
 456               choices:
 457                   1: "Share"
 458                   0: "Don't share"
 459             - "libraries information (name, URL, country)."
 460             - <br><strong>NOTE:</strong> This value has no effect if the <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=UsageStats">UsageStats</a> system preference is set to "No" (don't share).
 461         -
 462             - "Geolocation of the main library: "
 463             - pref: UsageStatsGeolocation
 464             - <br><strong>NOTE:</strong> This value has no effect if the <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=UsageStats">UsageStats</a> system preference is set to "No" (don't share).
 465             - "<br><strong>NOTE:</strong> You must use the <a href=\"/cgi-bin/koha/admin/usage_statistics.pl\">dedicated configuration page</a> to set and edit this system preference."
 466     Search engine:
 467         -
 468             - "Use following search engine: "
 469             - pref: SearchEngine
 470               default: Zebra
 471               choices:
 472                 Zebra: Zebra
 473                 Elasticsearch: Elasticsearch
 474         -
 475             - "Elasticsearch MARC format: "
 476             - pref: ElasticsearchMARCFormat
 477               default: "ISO2709"
 478               choices:
 479                 "ISO2709": "ISO2709 (exchange format)"
 480                 "ARRAY": "Searchable array"
 481             - <br>ISO2709 format is recommended as it is faster and takes less space, whereas array format makes the full MARC record searchable.
 482             - <br><strong>NOTE:</strong> Making the full record searchable may have a negative effect on relevance ranking of search results.