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