Koha-community/Koha
13
7
Fork 0
Code Issues Releases Wiki Activity
Koha/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/admin.pref
Nicholas van Oudtshoorn 722a098eac Bug 10988 - Fixes for comments 57 and 58 
Test Plan (remains the same):
     0) Back up your database
     1) Apply all these patches
     2) In your mysql client use your Koha database and execute:
        > DELETE FROM systempreferences;
        > SOURCE ~/kohaclone/installer/data/mysql/sysprefs.sql;
        -- Should be no errors.
        > SELECT * FROM systempreferences LIKE 'GoogleO%';
        -- Should see 4 entries.
        > QUIT;
     3) Restore your database
     4) Run ./installer/data/mysql/updatedatabase.pl;
     5) In your mysql client use your Koha database and execute:
        > SELECT * FROM systempreferences LIKE 'GoogleO%';
        -- Should see the same 4 entries.
     6) Log into the staff client
     7) Home -> Koha administration -> Global system preferences
     8) -> OPAC
        -- make sure your OPACBaseURL is set (e.g. https://opac.koha.ca)
     9) -> Administration
        -- There should be a 'Google OAuth2' section with the ability
           to set those 4 system preferences.
    10) In a new tab, go to https://console.developers.google.com/project
    11) Click 'Create Project'
    12) Type in a project name that won't freak users out, like your
        library name (e.g. South Pole Library).
    13) Click the 'Create' button.
    14) Click the 'APIs & auth' in the left frame.
    15) Click 'Credentials'
    16) Click 'Create new Client ID'
    17) Select 'Web application' and click 'Configure consent screen'.
    18) Select the Email Address.
    19) Put it a meaningful string into the Product Name
        (e.g. South Pole Library Authentication)
    20) Fill in the other fields as desired (or not)
    21) Click 'Save'
    22) Change the 'AUTHORIZED JAVASCRIPT ORIGINS' to your OPACBaseURL.
        (http://library.yourDNS.org)
    23) Change the 'AUTHORIZED REDIRECT URIS' to point to the new
        googleoauth2 script
        (http://library.yourDNS.org/cgi-bin/koha/svc/auth/googleopenidconnect)
    24) Click 'Create Client ID'
    25) Copy and paste the 'CLIENT ID' into the GoogleOAuth2ClientID
        system preference.
    26) Copy and paste the 'CLIENT SECRET' into the GoogleOAuth2ClientSecret
        system preference.
    27) Change the GoogleOpenIDConnect preference to 'Use'.
    28) Click 'Save all Administration preferences'
    29) In the OPAC, click 'Log in to your account'.
        -- You should get a confirmation request, if you are
            already logged in, OR a login screen if you are not.
        -- You need to have the primary email address set to one
           authenticated by Google in order to log in.
    30) Run koha qa test tools

Signed-off-by: Mark Tompsett <mtompset@hotmail.com>
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>

Signed-off-by: Brendan A Gallagher <brendan@bywatersolutions.com>
2016-04-01 19:25:35 +00:00

213 lines
8.5 KiB
Text
Raw Blame History

Administration:
# Only used internally, omitted: FrameworksLoaded, Version
Interface options:
-
- Use
- pref: KohaAdminEmailAddress
class: email
- "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.)"
-
- Use
- pref: ReplytoDefault
class: email
- "as the email address that will be set as the replyto in emails"
-
- Use
- pref: ReturnpathDefault
class: email
- "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)."
-
- Show
- pref: DebugLevel
default: 0
choices:
0: "no"
1: some
2: lots of
- debugging information in the browser when an internal error occurs.
-
- pref: noItemTypeImages
default: 0
choices:
yes: "Don't show"
no: Show
- itemtype icons in the catalog.
-
- Separate columns in an exported CSV file with
- pref: delimiter
default: ","
choices:
';': semicolons
tabulation: tabs
',': commas
'/': slashes
'\': backslashes
'#': "#'s"
- by default.
-
- pref: virtualshelves
choices:
yes: Allow
no: "Don't allow"
- staff and patrons to create and view saved lists of books.
-
- When editing circulation rules show the
- pref: DefaultToLoggedInLibraryCircRules
choices:
yes: "logged in library's"
no: "all libraries"
- rules by default.
-
- When editing notices and slips show the
- pref: DefaultToLoggedInLibraryNoticesSlips
choices:
yes: "logged in library's"
no: "all libraries"
- notices and slips by default.
-
- When editing overdue notice/status triggers show the
- pref: DefaultToLoggedInLibraryOverdueTriggers
choices:
yes: "logged in library's"
no: "all libraries"
- rules by default.
Login options:
-
- Automatically log out users after
- pref: timeout
class: integer
- seconds of inactivity. Adding d will specify it in days, e.g. 1d is timeout of one day.
-
- pref: AutoLocation
default: 0
choices:
yes: Require
no: "Don't require"
- 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).
-
- pref: SessionRestrictionByIP
default: 1
choices:
yes: Enable
no: "Disable"
- check for change in remote IP address for session security. Disable only when remote IP address changes frequently.
# PostgreSQL is supported by CGI::Session but not by Koha.
-
- Store login session information
- pref: SessionStorage
default: mysql
choices:
mysql: in the MySQL database.
Pg: in the PostgreSQL database (not supported).
tmp: as temporary files.
memcached: in a memcached server.
-
- pref: IndependentBranches
default: 0
choices:
yes: Prevent
no: "Don't prevent"
- staff (but not superlibrarians) from modifying objects (holds, items, patrons, etc.) belonging to other libraries.
-
- pref: IndependentBranchesPatronModifications
default: 0
choices:
yes: Prevent
no: "Don't prevent"
- staff (but not superlibrarians) from viewing and approving/denying patron modification requests for patrons belonging to other libraries.
CAS authentication:
-
- pref: casAuthentication
default: 0
choices:
yes: Use
no: "Don't use"
- CAS for login authentication.
-
- pref: casLogout
default: 0
choices:
yes: Logout
no: "Don't Logout"
- of CAS when logging out of Koha.
-
- The CAS Authentication Server can be found at
- pref: casServerUrl
SSL client certificate authentication:
-
- Use
- pref: AllowPKIAuth
default: None
choices:
None: "no"
Common Name: the Common Name
emailAddress: the emailAddress
- field for SSL client certificate authentication
Google OpenID Connect:
-
- pref: GoogleOpenIDConnect
choices:
yes: Use
no: "Don't Use"
- Google OpenID Connect login.
- 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
Mozilla Persona:
-
- pref: Persona
default: 0
choices:
yes: Allow
no: "Don't Allow"
- Mozilla persona for login
Share anonymous usage statistics:
-
- pref: UsageStats
default: 0
choices:
yes: Share
no: "Don't share"
- 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.
-
- The library name
- pref: UsageStatsLibraryName
- will be shown on the <a href="http://hea.koha-community.org">Hea Koha community website</a>.
- 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:"
- pref: UsageStatsCountry
- 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
- pref: UsageStatsLibraryUrl
- 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 type
- pref: UsageStatsLibraryType
default: public
choices:
public: "public"
school: "school"
academic: "academic"
research: "research"
private: "private"
societyAssociation: "society or association"
corporate: "corporate"
government: "government"
religiousOrg: "religious organization"
subscription: "subscription"
- 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"
View git blame Copy permalink