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             - This will be shown on the <a href="http://hea.koha-community.org">Hea Koha community website</a>.
 190             - Note that this value has no effect if the UsageStats system preference is set to "Don't share"
 191         -
 192             - The library URL
 193             - pref: UsageStatsLibraryUrl
 194             - will be shown on the <a href="http://hea.koha-community.org">Hea Koha community website</a>.
 195             - Note that this value has no effect if the UsageStats system preference is set to "Don't share"
 196
 197         -
 198             - The library type
 199             - pref: UsageStatsLibraryType
 200               default: public
 201               choices:
 202                   public: "public"
 203                   school: "school"
 204                   academic: "academic"
 205                   research: "research"
 206                   private: "private"
 207                   societyAssociation: "society or association"
 208                   corporate: "corporate"
 209                   government: "government"
 210                   religiousOrg: "religious organization"
 211                   subscription: "subscription"
 212             - will be shown on the <a href="http://hea.koha-community.org">Hea Koha community website</a>.
 213             - Note that this value has no effect if the UsageStats system preference is set to "Don't share"