Koha-community/Koha
13
7
Fork 0
Code Issues Releases Wiki Activity
Koha/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/admin.pref
Mark Tompsett ae45243fae Bug 16892: Add automatic patron registration via OAuth2 login 
10988 added the ability to log into the OPAC authenticating with
Google Open ID Connect. This extends it, by allowing an
unregistered patron to have an account automatically created
with default category code and branch.

This is accomplished by adding 3 system preferences.
- GoogleOpenIDConnectAutoRegister
      whether it will attempt to auto-register the patron.
- GoogleOpenIDConnectDefaultCategory
      This category code will be used to create Google OpenID Connect patrons.
- GoogleOpenIDConnectDefaultBranch'
      This branch code will be used to create Google OpenID Connect patrons.

Sponsored-by: Tulong Aklatan

Signed-off-by: Eugene Jose Espinoza <eugenegf@yahoo.com>

Signed-off-by: Nick Clemens <nick@bywatersolutions.com>

Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
2017-08-25 10:51:25 -03:00

427 lines
18 KiB
Text
Raw Blame History

Administration:
# Only used internally, omitted: FrameworksLoaded, Version
Interface options:
-
- "Email address for the administrator of Koha: "
- pref: KohaAdminEmailAddress
class: email
- "(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.)"
-
- "Email address to be set as the replyto in emails: "
- pref: ReplytoDefault
class: email
-
- "Return path or bounce address for undeliverable mail messages: "
- pref: ReturnpathDefault
class: email
- "If you leave this empty, the From address will be used (often defaulting to the admin address)."
-
- "How much debugging information to show in the browser when an internal error occurs: "
- pref: DebugLevel
default: 0
choices:
0: None
1: Some
2: All
-
- "Show itemtype icons in the catalog: "
- pref: noItemTypeImages
default: 0
choices:
yes: "No"
no: "Yes"
-
- "Default separator for columns in an exported CSV file: "
- pref: delimiter
default: ","
choices:
';': semicolons
tabulation: tabs
',': commas
'/': slashes
'\': backslashes
'#': "#'s"
-
- "Allow staff and patrons to create and view saved lists of books: "
- pref: virtualshelves
choices:
yes: "Yes"
no: "No"
-
- "Default view when editing circulation rules: "
- pref: DefaultToLoggedInLibraryCircRules
choices:
yes: "The logged-in library"
no: "All libraries"
-
- "Default view when editing notices and slips: "
- pref: DefaultToLoggedInLibraryNoticesSlips
choices:
yes: "The logged-in library"
no: "All libraries"
-
- "Default view when editing overdue notice/status triggers: "
- pref: DefaultToLoggedInLibraryOverdueTriggers
choices:
yes: "The logged-in library"
no: "All libraries"
Login options:
-
- "Inactivity timeout in seconds to automatically log out users: "
- pref: timeout
class: integer
- Adding d will specify it in days, e.g. 1d is timeout of one day.
-
- "Require staff to log in from a computer in the IP address range specified by their library (if any): "
- pref: AutoLocation
default: 0
choices:
yes: "Yes"
no: "No"
- <a href="/cgi-bin/koha/admin/branches.pl">Link to library administration</a>
-
- "Enable check for change in remote IP address for session security: "
- pref: SessionRestrictionByIP
default: 1
choices:
yes: "Yes"
no: "No"
- (Disable only when remote IP address changes frequently.)
# PostgreSQL is supported by CGI::Session but not by Koha.
-
- "Storage of login session information: "
- pref: SessionStorage
default: mysql
choices:
mysql: MySQL database
Pg: PostgreSQL database (not supported)
tmp: Temporary files
memcached: Memcached server
-
- "Prevent staff (but not superlibrarians) from modifying objects (holds, items, patrons, etc.) belonging to other libraries: "
- pref: IndependentBranches
default: 0
choices:
yes: "Yes"
no: "No"
-
- Prevent staff (but not superlibrarians) from viewing and approving/denying patron modification requests for patrons belonging to other libraries.
- pref: IndependentBranchesPatronModifications
default: 0
choices:
yes: "Yes"
no: "No"
CAS authentication:
-
- "Use CAS for login authentication: "
- pref: casAuthentication
default: 0
choices:
yes: "Yes"
no: "No"
-
- "Logout of CAS when logging out of Koha: "
- pref: casLogout
default: 0
choices:
yes: "Yes"
no: "No"
-
- "URL of the CAS Authentication Server: "
- pref: casServerUrl
SSL client certificate authentication:
-
- "Field to use for SSL client certificate authentication: "
- pref: AllowPKIAuth
default: None
choices:
None: "None"
Common Name: Common Name
emailAddress: emailAddress
Google OpenID Connect:
-
- "Use Google OpenID Connect login: "
- pref: GoogleOpenIDConnect
choices:
yes: "Yes"
no: "No"
- 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 .
-
- "Google OAuth2 Client ID: "
- pref: GoogleOAuth2ClientID
-
- "Google OAuth2 Client Secret: "
- pref: GoogleOAuth2ClientSecret
-
- "Google OpenID Connect Restrict to domain (or subdomain of this domain): "
- pref: GoogleOpenIDConnectDomain
- Leave blank for all google domains
-
- pref: GoogleOpenIDConnectAutoRegister
choices:
yes: Allow
no: "Don't Allow"
- users logging in with Google Open ID to automatically register.
-
- pref: GoogleOpenIDConnectDefaultCategory
- Use this category code when automatically registering a Google Open ID patron.
-
- pref: GoogleOpenIDConnectDefaultBranch
- Use this branch code when automatically registering a Google Open ID patron.
Share anonymous usage statistics:
-
- "Share anonymous Koha usage data with the Koha community: "
- pref: UsageStats
default: 0
choices:
yes: "Yes"
no: "No"
- "You have to run misc/cronjobs/share_usage_with_koha_community.pl in a cronjob. Note that the other \"UsageStats\" preferences have no effect if this preference is set to \"No\". Website where usage statistics are published: <a href=\"http://hea.koha-community.org\">Hea Koha community website</a>."
-
- "Use the following library name to be shown on the Hea Community website: "
- pref: UsageStatsLibraryName
- If this field is empty data will be sent anonymously.
- Note that this value has no effect if the UsageStats system preference is set to "Don't share"
-
- "The country where your library is located to be shown on the Hea Community website: "
- pref: UsageStatsCountry
default: ""
choices:
"" : ""
Afghanistan : "Afghanistan"
Albania : "Albania"
Algeria : "Algeria"
Andorra : "Andorra"
Angola : "Angola"
Antigua & Deps : "Antigua & Deps"
Argentina : "Argentina"
Armenia : "Armenia"
Australia : "Australia"
Austria : "Austria"
Azerbaijan : "Azerbaijan"
Bahamas : "Bahamas"
Bahrain : "Bahrain"
Bangladesh : "Bangladesh"
Barbados : "Barbados"
Belarus : "Belarus"
Belgium : "Belgium"
Belize : "Belize"
Benin : "Benin"
Bhutan : "Bhutan"
Bolivia : "Bolivia"
Bosnia Herz. : "Bosnia Herz."
Botswana : "Botswana"
Brazil : "Brazil"
Brunei : "Brunei"
Bulgaria : "Bulgaria"
Burkina : "Burkina"
Burundi : "Burundi"
Cambodia : "Cambodia"
Cameroon : "Cameroon"
Canada : "Canada"
Cape Verde : "Cape Verde"
Centr. Afr. Rep: "Centr. Afr. Rep"
Chad : "Chad"
Chile : "Chile"
China : "China"
Colombia : "Colombia"
Comoros : "Comoros"
Congo : "Congo"
Costa Rica : "Costa Rica"
Croatia : "Croatia"
Cuba : "Cuba"
Cyprus : "Cyprus"
Czech Republic : "Czech Republic"
Denmark : "Denmark"
Djibouti : "Djibouti"
Dominica : "Dominica"
Dominican Rep. : "Dominican Rep."
East Timor : "East Timor"
Ecuador : "Ecuador"
Egypt : "Egypt"
El Salvador : "El Salvador"
Equator. Guinea: "Equator. Guinea"
Eritrea : "Eritrea"
Estonia : "Estonia"
Ethiopia : "Ethiopia"
Fiji : "Fiji"
Finland : "Finland"
France : "France"
Gabon : "Gabon"
Gambia : "Gambia"
Georgia : "Georgia"
Germany : "Germany"
Ghana : "Ghana"
Greece : "Greece"
Grenada : "Grenada"
Guatemala : "Guatemala"
Guinea : "Guinea"
Guinea-Bissau : "Guinea-Bissau"
Guyana : "Guyana"
Haiti : "Haiti"
Honduras : "Honduras"
Hungary : "Hungary"
Iceland : "Iceland"
India : "India"
Indonesia : "Indonesia"
Iran : "Iran"
Iraq : "Iraq"
Ireland : "Ireland"
Israel : "Israel"
Italy : "Italy"
Ivory Coast : "Ivory Coast"
Jamaica : "Jamaica"
Japan : "Japan"
Jordan : "Jordan"
Kazakhstan : "Kazakhstan"
Kenya : "Kenya"
Kiribati : "Kiribati"
Korea North : "Korea North"
Korea South : "Korea South"
Kosovo : "Kosovo"
Kuwait : "Kuwait"
Kyrgyzstan : "Kyrgyzstan"
Laos : "Laos"
Latvia : "Latvia"
Lebanon : "Lebanon"
Lesotho : "Lesotho"
Liberia : "Liberia"
Libya : "Libya"
Liechtenstein : "Liechtenstein"
Lithuania : "Lithuania"
Luxembourg : "Luxembourg"
Macedonia : "Macedonia"
Madagascar : "Madagascar"
Malawi : "Malawi"
Malaysia : "Malaysia"
Maldives : "Maldives"
Mali : "Mali"
Malta : "Malta"
Marshall Isl. : "Marshall Isl."
Mauritania : "Mauritania"
Mauritius : "Mauritius"
Mexico : "Mexico"
Micronesia : "Micronesia"
Moldova : "Moldova"
Monaco : "Monaco"
Mongolia : "Mongolia"
Montenegro : "Montenegro"
Morocco : "Morocco"
Mozambique : "Mozambique"
Myanmar : "Myanmar"
Namibia : "Namibia"
Nauru : "Nauru"
Nepal : "Nepal"
Netherlands : "Netherlands"
New Zealand : "New Zealand"
Nicaragua : "Nicaragua"
Niger : "Niger"
Nigeria : "Nigeria"
Norway : "Norway"
Oman : "Oman"
Pakistan : "Pakistan"
Palau : "Palau"
Panama : "Panama"
Papua N. Guinea: "Papua N. Guinea"
Paraguay : "Paraguay"
Peru : "Peru"
Philippines : "Philippines"
Poland : "Poland"
Portugal : "Portugal"
Qatar : "Qatar"
Romania : "Romania"
Russian Fed. : "Russian Fed."
Rwanda : "Rwanda"
St Kitts & Nev.: "St Kitts & Nev."
St Lucia : "St Lucia"
St Vincent : "Saint Vincent"
Samoa : "Samoa"
San Marino : "San Marino"
Sao Tome : "Sao Tome"
Saudi Arabia : "Saudi Arabia"
Senegal : "Senegal"
Serbia : "Serbia"
Seychelles : "Seychelles"
Sierra Leone : "Sierra Leone"
Singapore : "Singapore"
Slovakia : "Slovakia"
Slovenia : "Slovenia"
Solomon Islands: "Solomon Islands"
Somalia : "Somalia"
South Africa : "South Africa"
Spain : "Spain"
Sri Lanka : "Sri Lanka"
Sudan : "Sudan"
Suriname : "Suriname"
Swaziland : "Swaziland"
Sweden : "Sweden"
Switzerland : "Switzerland"
Syria : "Syria"
Taiwan : "Taiwan"
Tajikistan : "Tajikistan"
Tanzania : "Tanzania"
Thailand : "Thailand"
Togo : "Togo"
Tonga : "Tonga"
Trinidad & Tob.: "Trinidad & Tob."
Tunisia : "Tunisia"
Turkey : "Turkey"
Turkmenistan : "Turkmenistan"
Tuvalu : "Tuvalu"
Uganda : "Uganda"
Ukraine : "Ukraine"
UAE : "UAE"
United Kingdom : "United Kingdom"
USA : "USA"
Uruguay : "Uruguay"
Uzbekistan : "Uzbekistan"
Vanuatu : "Vanuatu"
Vatican City : "Vatican City"
Venezuela : "Venezuela"
Vietnam : "Vietnam"
Yemen : "Yemen"
Zambia : "Zambia"
Zimbabwe : "Zimbabwe"
- This will be shown on the <a href="http://hea.koha-community.org">Hea Koha community website</a>.
- Note that this value has no effect if the UsageStats system preference is set to "Don't share"
-
- "The library URL to be shown on the Hea Community website: "
- pref: UsageStatsLibraryUrl
- Note that this value has no effect if the UsageStats system preference is set to "Don't share"
-
- "The library type to be shown on the Hea Community website: "
- pref: UsageStatsLibraryType
default: ""
choices:
"" : ""
public : "public"
school : "school"
academic : "academic"
research : "research"
private : "private"
societyAssociation: "society or association"
corporate : "corporate"
government : "government"
religiousOrg: "religious organization"
subscription: "subscription"
- Note that this value has no effect if the UsageStats system preference is set to "Don't share"
-
- pref: UsageStatsLibrariesInfo
choices:
yes: "Share"
no: "Do not Share"
- "libraries information (name, url, country)"
- Note that this value has no effect if the UsageStats system preference is set to "Don't share"
-
- "Geolocation of the main library: "
- pref: UsageStatsGeolocation
- Note that this value has no effect if the UsageStats system preference is set to "Don't share"
Search Engine:
-
- "Use following search engine: "
- pref: SearchEngine
default: Zebra
choices:
Zebra: Zebra
Elasticsearch: Elasticsearch
View git blame Copy permalink