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