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