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