forked from vufind-org/vufind
/
config.ini.sample
1801 lines (1584 loc) · 78.7 KB
/
config.ini.sample
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
;
; VuFind Configuration
;
; This section controls global system behavior and can usually be left unmodified.
[System]
; Change to false to take the system offline and show an unavailability message;
; note that you can use the NoILS driver (in [Catalog] section below) to keep VuFind
; up during ILS maintenance.
available = true
; Change to true to see messages about the behavior of the system as part of the
; output -- only for use when troubleshooting problems:
debug = false
; This setting should be set to false after auto-configuration is complete
autoConfigure = "0"
; This setting specifies a health check file location. If a health check file exists,
; the getServerStatus AJAX call will return an error regardless of actual status
; allowing the server to be disabled from a load-balancer.
;healthCheckFile = /tmp/disable_vufind
; This setting allows a redirection message to production system to be displayed in
; a pre-production view. The regexp contains the rule to change the URL for
; production. First rule to match will take effect.
;preProductionRedirect[] = "/(https:.*?)\.finna-pre\.fi(.*)/i###$1.finna.fi$2"
; This section will need to be customized for your installation
[Site]
; Base URL is normally auto-detected, but this setting is used when autodetection is
; not possible (i.e. during sitemap generation at the command line).
;url = "http://localhost:8081/vufind2"
email = finna-posti@helsinki.fi
; The title of your site, used in some messages and (by default) page <title> tags.
; Including site title in page titles is recommended to improve browser tab
; navigation for users with screen readers. However, if you wish to remove this from
; titles or change the order/layout, you can customize the title_wrapper translation
; in your language files to remove or relocate the %%siteTitle%% token.
title = "Finna"
; The separator used between page name and site name in the <title> tag of pages.
titleSeparator = "|"
; This is the default theme for non-mobile devices (or all devices if mobile_theme
; is disabled below)
theme = finna2
; Automatic asset minification and concatenation setting. When active, HeadScript
; and HeadLink will concatenate and minify all viable files to reduce requests and
; load times. This setting is off by default.
;
; This configuration takes the form of a semi-colon separated list of
; environment:configuration pairs where "environment" is a possible APPLICATION_ENV
; value (e.g. 'production' or 'development') or '*'/no prefix for all contexts.
; Possible values for 'configuration' within each environment are 'js', 'css',
; 'off'/false, 'on'/true/'*'. This allows global enabling/disabling of the pipeline
; or separate configurations for different types of resources. Multiple configuration
; values may be comma-separated -- e.g. 'js,css'.
;
; Example: "development:off; production:js,css"
asset_pipeline = "production:js"
; Uncomment the following line to use a different default theme for mobile devices
;mobile_theme = jquerymobile
; This is a comma-separated list of themes that may be accessed via the ?ui GET
; parameter. Each entry has two parts: the value used on the URL followed by the
; actual theme name. For example, http://library.myuniversity.edu/vufind?ui=theme1
; would load the myTheme1 theme with the setting shown below. Note that the values
; of "standard" and "mobile" are reserved for the default and mobile themes defined
; above.
;alternate_themes = theme1:myTheme1,theme2:myTheme2
; This is a comma-separated list of theme options that will be displayed to the user
; as a drop-down. Each entry has two parts: a value for the "ui" GET parameter and
; an on-screen description. "standard" refers to the "theme" setting above, "mobile"
; refers to the "mobile_theme" setting, and all other values must be defined in
; alternate_themes above. When commented out, no drop-down theme list will display.
;selectable_themes = "standard:Standard Theme,mobile:Mobile Theme"
; Use the browser language setting to set the VuFind language.
browserDetectLanguage = false
language = fi ; default -- more options available in [Languages] below.
locale = fi_FI
; Find valid timezone values here:
; http://www.php.net/manual/en/timezones.php
timezone = "Europe/Helsinki"
; A string used to format user interface date strings using the PHP date() function
; default is m-d-Y (MM-DD-YYYY 01-01-2010)
displayDateFormat = "j.n.Y"
; A string used to format user interface time strings using the PHP date() function
; default is H:i (HH:MM 23:01)
displayTimeFormat = "H:i"
; The base VuFind URL will load the "Home" action of this module unless the user
; is logged in:
defaultModule = Search
; The base VuFind URL will load the "Home" action of this module when the user
; is logged in:
defaultLoggedInModule = Search
; The route VuFind will send users to following a log out operation. Set to false
; or omit to attempt to retain the user's current context after log out.
logOutRoute = home
; This tab will show by default when a record is viewed:
defaultRecordTab= Holdings
; Hide the holdings tab if no holdings are available from the ILS
hideHoldingsTabWhenEmpty = true
; Whether to load the default tab through AJAX (which brings some performance
; gain but breaks compatibility with non-Javascript-enabled browsers; off by default)
loadInitialTabWithAjax = true
; This page will show by default when a user accesses the MyResearch module:
defaultAccountPage = Favorites
; Allow access to the Admin module? (See [AdminAuth] below for more granular ways
; to restrict Admin access).
admin_enabled = false
; Show sidebar on the left side instead of right. This only affects on facet sidebar in search result view
sidebarOnLeft = true
; Show (true) / Hide (false) Book Bag - Default is Hide.
showBookBag = false
; Set the maximum amount of items allowed in the Book Bag - Default is 100
bookBagMaxSize = 100
; Show individual add/remove bookbag buttons in search results? (Supersedes cart
; checkboxes and bulk action buttons unless showBulkOptions is true).
bookbagTogglesInSearch = true
; Display bulk items (export, save, etc.) and checkboxes on search result screens?
showBulkOptions = false
; Should users be allowed to save searches in their accounts?
allowSavedSearches = true
; Generator value to display in an HTML header <meta> tag:
generator = "Finna"
; Whether to add records to favorites without displaying the intermediate dialog
quickAddToFavorites = true
; Force https
;useHttps = true
; Https port if not 443.
;httpsPort = 8443
; Whether this is a development site (defaults to false)
;development = true
; Institution code (a unique identifier of the institution the view belongs to)
institution =
; Whether index is used for new items search instead of backend driver
indexBasedNewItems = true
; Any system messages that need to be displayed on the top of every page. May contain html markup.
; systemMessages[fi] = "Huom! Tämä on kehitysympäristö. Sisältö ja toiminnallisuus voivat muuttua milloin tahansa."
; systemMessages[sv] = "Obs! Systemet är under utveckling. Innehåll och funktioner kan förändras när som helst."
; systemMessages[en-gb] = ""
; Whether to hide due date reminder settings. Default is false
;hideDueDateReminder = true
; Whether to hide email address in patron profile. Default is false
;hideProfileEmailAddress = true
; Scale for advanced search year slider. Current year + 1 is always added to the end.
; Default scale is "0,900,1800,1910"
;advSearchYearScale = "1600,1800,2000,2010"
; This section allows you to configure the mechanism used for storing user
; sessions. Available types: File, Memcache, Database.
; Some of the settings below only apply to specific session handlers;
; such settings are named with an obvious prefix. Non-prefixed settings
; are global to all handlers.
[Session]
type = Database
lifetime = 600 ; Session lasts for 10 minutes (without keepalive)
; Keep-alive interval in seconds. When set to a positive value, the session is kept
; alive with a JavaScript call as long as a VuFind page is open in the browser.
; Default is 0 (disabled). When keep-alive is enabled, session lifetime above can be
; reduced to e.g. 600.
keepAlive = 300
;file_save_path = /tmp/vufind_sessions
;memcache_host = localhost
;memcache_port = 11211
;memcache_connection_timeout = 1
; This section controls how VuFind creates cookies (to store session IDs, bookbag
; contents, theme/language settings, etc.)
[Cookies]
; In case there are multiple VuFind instances on the same server and they should not
; share cookies/sessions, this option can be enabled to limit the session to the
; current path. Default is false, which will place cookies at the root directory.
limit_by_path = true
; If VuFind is only accessed via HTTPS, this setting can be enabled to disallow
; the browser from ever sending cookies over an unencrypted connection (i.e.
; before being redirected to HTTPS). Default is false.
;only_secure = true
; Set the domain used for cookies (sometimes useful for sharing the cookies across
; subdomains); by default, cookies will be restricted to the current hostname.
;domain = ".example.edu"
; Please set the ILS that VuFind will interact with.
;
; Available drivers: Aleph, Amicus, ClaviusSQL, Evergreen, Horizon (basic database
; access only), HorizonXMLAPI (more features via API), Innovative, Koha,
; MultiBackend (to chain together multiple drivers in a consortial setting),
; NewGenLib, NoILS (for users without an ILS, or to disable ILS functionality
; during maintenance), Polaris, Unicorn (which also applies to SirsiDynix
; Symphony), Virtua, Voyager (for Voyager 6+), VoyagerRestful (for Voyager 7+
; w/ RESTful web services), XCNCIP (for XC NCIP Toolkit v1.x), XCNCIP2 (for
; XC NCIP Tookit v2.x)
; Note: Unicorn users should visit the vufind-unicorn project for more details:
; http://code.google.com/p/vufind-unicorn/
;
; If you haven't set up your ILS yet, two fake drivers are available for testing
; purposes. "Sample" is fast but does very little; "Demo" simulates more
; functionality of a real ILS but may slow down your system by performing extra
; searches. If you don't plan to use an ILS, the NoILS driver is your best option.
;
; Note: Enabling most of the features in this section will only work if you use an
; ILS driver that supports them; not all drivers support holds/renewals.
[Catalog]
driver = "MultiBackend"
;loadNoILSOnFailure - Whether or not to load the NoILS driver if the main driver fails
loadNoILSOnFailure = true
; This setting determines how and when hold / recall links are displayed.
; Legal values:
; - all (Show links for all items - Place Hold for Available Items and Place Recall
; for unavailable items)
; - availability (Only show recall links if ALL items on bib are currently
; unavailable)
; - disabled (Never show hold/recall links)
; - driver (Use ILS driver to determine which items may be held/recalled; best option
; if available, but not supported by all drivers)
; - holds (Only show links for available items)
; - recalls (Only show links for unavailable items)
; default is "all"
holds_mode = "driver"
; List of content types for which holds, title holds,
; call slips and UB requests are disallowed.
; This setting is only used when holds_mode and/or title_level_holds_mode is "driver".
disable_driver_hold_actions[] = "1/Book/eBook/"
; Set this to true if you want to allow your ILS driver to override your holds_mode
; setting on a record-by-record basis; this may be useful for local customizations,
; but in most cases you should leave this setting unchanged. Overrides are ignored
; for mode settings of "driver" or "disabled."
allow_holds_override = true
; Determines if holds can be cancelled or not. Options are true or false.
; default is false
cancel_holds_enabled = true
; Determines if storage retrieval requests can be cancelled or not.
; Options are true or false.
; default is false
cancel_storage_retrieval_requests_enabled = true
; Determines if ILL requests can be cancelled or not.
; Options are true or false.
; default is false
cancel_ill_requests_enabled = true
; Determines if item can be renewed or not. Options are true or false.
; default is false
renewals_enabled = true
; Determines if title level holds are displayed or not.
; Legal values:
; - disabled (Never show title Holds - Default)
; - always (Always show title Holds)
; - availability (Only show title holds if ALL items on bib are currently
; unavailable)
; - driver (Use ILS driver to determine which items may be held/recalled; best option
; if available, but not supported by all drivers)
title_level_holds_mode = "driver"
; Determines how holdings are grouped in the record display, using fields from
; the item information provided by the ILS driver.
;
; Most commonly-used values:
; - holdings_id (Use holdings record id if available, location name otherwise - Default)
; - location (Use location name)
;
; See https://vufind.org/wiki/development:plugins:ils_drivers#getholding for
; more options (though not every ILS driver supports every possible value).
;
; Note that there may also be driver-specific values outside of the specification,
; such as:
; - item_agency_id (XCNCIP2 driver's Agency ID, which may be useful in consortial
; environments)
;
; You may use multiple group keys (delimited by comma), e.g.,
; - item_agency_id,location
holdings_grouping = holdings_id,location
; Text fields such as holdings_notes gathered from items to be displayed in each
; holdings group in the display order.
; The default list is 'holdings_notes', 'summary', 'supplements' and 'indexes'. The
; deprecated field 'notes' is used as an alias for 'holdings_notes'.
; Note that displayed information depends on what the ILS driver returns.
holdings_text_fields[] = 'holdings_notes'
holdings_text_fields[] = 'summary'
holdings_text_fields[] = 'supplements'
holdings_text_fields[] = 'indexes'
holdings_text_fields[] = 'links'
; Whether support for multiple library cards is enabled. Default is false.
library_cards = true
; The number of checked out items to display per page; 0 for no limit (may cause
; memory problems for users with huge numbers of items). Default = 50.
;checked_out_page_size = 50
; The number of historic loans to display per page; 0 for no limit (may cause
; memory problems for users with a large number of historic loans). Default = 50
;historic_loan_page_size = 50
; Whether to display the item barcode for each loan. Default is false.
display_checked_out_item_barcode = true
; This section controls features related to user accounts
[Account]
; Allow the user to set a home library through the Profile screen, which will
; override ILS-provided default pickup locations throughout the system.
set_home_library = true
; Allow the user to "subscribe" to search history entries in order to receive
; email notifications of new search results.
schedule_searches = true
; This section allows you to determine how the users will authenticate.
; You can use an LDAP directory, the local ILS, the VuFind database (Database),
; Shibboleth, SIP2, CAS or some combination of these (via the MultiAuth option).
[Authentication]
;method = LDAP
;method = ILS
;method = Database
;method = Shibboleth
;method = Shibboleth_suomifi
;method = SIP2
;method = CAS
method = ChoiceAuth
; This setting only applies when method is set to ILS. It determines which
; field of the ILS driver's patronLogin() return array is used as the username
; in VuFind's user database. If commented out, it defaults to cat_username
; (the recommended setting in most situations).
;ILS_username_field = cat_username
; Whether or not to hide the Login Options
hideLogin = false
; Set this to false if you would like to store local passwords in plain text
; (only applies when method = Database above).
hash_passwords = true
; Allow users to recover passwords via email (if supported by Auth method)
; You can set the subject of recovery emails in your
; language files under the term "recovery_email_subject"
recover_password = true
; Time (seconds) before another recovery attempt can be made
recover_interval = 60
; Length of time before a recovery hash can no longer be used (expires)
; Default: Two weeks
recover_hash_lifetime = 1209600
; Allow users to set change their passwords (if supported by Auth method)
change_password = true
; Set this to false if you would like to store catalog passwords in plain text
encrypt_ils_password = true
; This is the key used to encrypt and decrypt catalog passwords. This must be
; filled in with a random string value when encrypt_ils_passwords is set to true.
ils_encryption_key = ""
; This is the algorithm used to encrypt and decrypt catalog passwords.
; For ILS, a symmetrical encryption algorithm must be used.
; You can use mcrypt_list_algorithms to see the full list of choices for your system.
ils_encryption_algo = "aes"
; Specify default minimum and maximum password length (Auth method may override
; this).
minimum_password_length = 8
maximum_password_length = 32
; Specify default limit of accepted characters in the password. Allowed values
; are "numeric", "alphanumeric" or a regular expression
;password_pattern = "(?=.*\d)(?=.*[a-z])(?=.*[A-Z])"
; Specify default hint about what the password may contain when using a regexp
; pattern. May be text or a translation key. The "numeric" and "alphanumeric"
; patterns have translated default hints.
;password_hint = "local_login_password_hint"
; Include only the listed ILS drivers in the authentication API
;include_api_targets = ils1,ils2
; Exclude the listed ILS drivers from the authentication API
;exclude_api_targets = ils3,ils4
; Allow a user to delete their account. Default is false.
account_deletion = true
; Whether comments added by a user are deleted when they remove their account.
; Default is true.
delete_comments_with_user = false
[ChoiceAuth]
choice_order = Database,Shibboleth,MultiILS
; See the comments in library/VF/Auth/MultiAuth.php for full details
; on using multiple authentication methods. Note that MultiAuth assumes login
; with username and password, so some methods (i.e. Shibboleth) may not be
; compatible.
;[MultiAuth]
;method_order = ILS,LDAP
;filters = "username:trim,password:trim"
; This section will allow you to control whether VuFind should record usage
; statistics.
[Statistics]
; Currently only supported statistics driver is Database. Uncomment to enable
; recording of statistics:
;driver = Database
; This section requires no changes for most installations
[Index]
engine = Solr
url = http://localhost:8983/solr
local = /data/vufind-solr
default_core = biblio
; This setting needs to match the <maxBooleanClauses> setting in your solrconfig.xml
; file; when VuFind has to look up large numbers of records using ID values, it may
; have to restrict the size of its result set based on this limitation.
maxBooleanClauses = 1024
; This is the timeout in seconds when communicating with the Solr server.
timeout = 30
; Whether to shuffle Solr URLs when an array of them is defined. Default is false.
;shuffle = true
; List of regexp filters that block invalid searches
;search_filters[] = "(.[,\s]){30,}"
;search_filters[] = "[^\s,.\-]{100,}"
; Enable/Disable searching reserves using the "reserves" Solr core. When enabling
; this feature, you also need to uncomment the relevant line in solr/solr.xml and
; restart Solr to enable the reserves core, and you need to run the
; util/index_reserves.php script to populate the new index.
[Reserves]
search_enabled = false
; This section requires no changes for most installations; if your SMTP server
; requires authentication, you can fill in a username and password below.
[Mail]
host = localhost
port = 25
;username = user
;password = pass
; If set to false, users can send anonymous emails; otherwise, they must log in first
require_login = false
; Should we put the logged-in user's address in the "from" field by default?
user_email_in_from = true
; Should we put the logged-in user's address in the "to" field by default?
user_email_in_to = false
; Populate the "from" field with this value if user_email_in_from is false and/or no
; user is logged in:
;default_from = "no-reply@myuniversity.edu"
; Should we hide the "from" field in email forms? If no from field is visible, emails
; will be sent based on user_email_in_from and default_from above, with the email
; setting from the [Site] section used as a last resort.
disable_from = false
; From field override. Setting this allows keeping the "from" field in email forms
; but will only use it as a reply-to address. The address defined here is used as the
; actual "from" address.
;override_from = "no-reply@myuniversity.edu"
; This section needs to be changed to match your database connection information
[Database]
database = mysql://vufind:vufind@localhost/vufind2
; If your database (e.g. PostgreSQL) uses a schema, you can set it here:
;schema = schema_name
; The character set of the database -- may be latin1 or utf8; utf8 is STRONGLY
; RECOMMENDED and is the default if no value is set here. You may need latin1
; for compatibility with existing VuFind 1.x installations.
;charset = utf8
; LDAP is optional. This section only needs to exist if the
; Authentication Method is set to LDAP. When LDAP is active,
; host, port, basedn and username are required. The remaining
; settings are optional, mapping fields in your LDAP schema
; to fields in VuFind's database -- the more you fill in, the more
; data will be imported from LDAP into VuFind.
;[LDAP]
; Prefix the host with ldaps:// to use LDAPS; omit the prefix for standard
; LDAP with TLS.
;host = ldap.myuniversity.edu
;port = 389 ; LDAPS usually uses port 636 instead
;basedn = "o=myuniversity.edu"
;username = uid
;firstname = givenname
;lastname = sn
;email = mail
;cat_username =
;cat_password =
;college = studentcollege
;major = studentmajor
; If you need to bind to LDAP with a particular account before
; it can be searched, you can enter the necessary credentials
; here. If this extra security measure is not needed, leave
; these settings commented out.
;bind_username = "uid=username o=myuniversity.edu"
;bind_password = password
; SIP2 is optional. This section only needs to exist if the
; Authentication Method is set to SIP2.
;[SIP2]
;host = ils.myuniversity.edu
;port = 6002
; Shibboleth is optional. This section only needs to exist if the
; Authentication Method is set to Shibboleth.
[Shibboleth]
; Attribute required to be set for Shibboleth login to be attempted
required_attribute = Shib-Application-ID
; Optional: you may set attribute names and values to be used as a filter;
; users will only be logged into VuFind if they match these filters.
;userattribute_1 = entitlement
;userattribute_value_1 = urn:mace:dir:entitlement:common-lib-terms
;userattribute_2 = unscoped-affiliation
;userattribute_value_2 = member
; Required: the attribute Shibboleth uses to uniquely identify users.
username = SHIB_eppn
; Required: Shibboleth login URL.
login = "https://www.finna.fi/Shibboleth.sso/Login"
; Optional: Shibboleth logout URL.
logout = "https://www.finna.fi/Shibboleth.sso/Logout"
; Optional: Dynamic Shibboleth logout url attribute id (alternative to the static url above)
logout_attribute = SHIB_logouturl
; Optional: URL to forward to after Shibboleth login (if omitted,
; defaultLoggedInModule from [Site] section will be used).
;target = http://shib.myuniversity.edu/vufind/MyResearch/Home
; Optional: provider_id parameter to pass along to Shibboleth login.
;provider_id = https://idp.example.edu/shibboleth-idp
; Some or all of the following entries may be uncommented to map Shibboleth
; attributes to user database columns:
;cat_username = HTTP_ALEPH_ID
;cat_password = HTTP_CAT_PASSWORD
email = SHIB_mail
;firstname = HTTP_FIRST_NAME
;lastname = SHIB_cn
;college = HTTP_COLLEGE
;major = HTTP_MAJOR
;home_library = HTTP_HOME_LIBRARY
; IdP-specific mappings from an attribute to ILS account identifier. The key is the
; IdP identifier and value contains the user attribute and ILS driver separated by a
; colon. Multiple mappings may be entered by separating them with a pipe
; (e.g. "SHIB_eppn:almasandbox|SHIB_mail:almasandbox)").
;idp_to_ils_map[https://testidp.funet.fi/idp/shibboleth] = "SHIB_mail:almasandbox"
; Shibboleth Suomi.fi is optional.
; This section is only needed if Suomi.fi is to be used as an authentication method.
[Shibboleth_suomifi]
; Provider_id parameter to pass along to Shibboleth login.
; Production
; provider_ id = ""
; Development
; provider_id = "https://testi.apro.tunnistus.fi/idp1"
userattribute_1 = "Shib-Identity-Provider"
userattribute_value_1 = "https:\\/\\/testi.apro.tunnistus.fi\\/idp1"
userattribute_2 = "SHIB_vtjverified"
userattribute_value_2 = "true"
; Attribute required to be set for Shibboleth login to be attempted
required_attribute = Shib-Application-ID
; Required: the attribute Shibboleth uses to uniquely identify users.
username = SHIB_eppn
; Secret key for hashing usernames before saving to user profile (required)
hash_secret = ""
; Should the encrypted user identity number be stored in session? Required when using REMS.
;store_identity_number_to_session = true
; Public key path. Required if store_identity_number_to_session is true
;public_key = ""
; Required: Shibboleth login URL.
login = "https://www.finna.fi/Shibboleth.sso/Login"
; Optional: Shibboleth logout URL.
logout = "https://www.finna.fi/Shibboleth.sso/Logout"
; Optional: Dynamic Shibboleth logout url attribute id (alternative to the static url above)
logout_attribute = SHIB_logouturl
; Optional: URL to forward to after Shibboleth login (if omitted,
; defaultLoggedInModule from [Site] section will be used).
;target = http://shib.myuniversity.edu/vufind/MyResearch/Home
; Some or all of the following entries may be uncommented to map Shibboleth
; attributes to user database columns:
;cat_username = HTTP_ALEPH_ID
;cat_password = HTTP_CAT_PASSWORD
email = SHIB_mail
firstname = SHIB_givenName
lastname = SHIB_sn
;college = HTTP_COLLEGE
;major = HTTP_MAJOR
;home_library = HTTP_HOME_LIBRARY
;
; CAS is optional. This section only needs to exist if the
; Authentication Method is set to CAS.
;[CAS]
; Required: the attribute CAS uses to uniquely identify users.
;username = uid
; Required: CAS Hostname.
;server = cas.myuniversity.edu
; Required: CAS port.
;port = 443
; Required: CAS context.
;context = /cas
; Required: CAS Certificate Path.
;CACert = /etc/pki/cert/cert.crt
; Required: CAS login URL.
;login = https://cas.myuniversity.edu/cas/login
; Required: CAS logout URL.
;logout = https://cas.myuniversity.edu/cas/logout
; Optional: CAS logging.
;debug = false
;log = /tmp/casdebug
; Optional: URL to forward to after CAS login (if omitted,
; defaultLoggedInModule from [Site] section will be used).
;target = http://lib.myuniversity.edu/vufind/MyResearch/Home
; Some or all of the following entries may be uncommented to map CAS
; attributes to user database columns:
;cat_username = acctSyncUserID
;cat_password = catPassword
;email = mail
;firstname = givenName
;lastname = sn
;college = college
;major = major1
;home_library = library
; External Content is Optional.
; To use multiple, separate with a comma. Priority will be given by the order listed
; Account id is separated with a colon, if no id is used then no colon is necessary
; For Amazon, use your 20-character access key in the coverimages and reviews values;
; you must also provide your 40-character secret key in the amazonsecret value and
; your associate ID in the amazonassociate value.
;
; IMPORTANT: Review content providers' terms of service before turning them on.
; Terms may change, and not all content sources are appropriate for all
; applications. The existence of functionality in VuFind does not imply
; suitability for any particular situation.
[Content]
; You can select Syndetics, LibraryThing, Summon, Amazon, Booksite, OpenLibrary,
; Contentcafe and/or Google Books.
; Note: Summon service takes a Serials Solutions client key, NOT Summon API key!
;coverimages = Syndetics:MySyndeticsId,Amazon:MyAccessKeyId,Booksite,LibraryThing:MyLibraryThingId,Google,OpenLibrary,Summon:MySerialsSolutionsClientKey,Contentcafe:MyContentCafeID,NatLibFi,BookyFi,BTJ:customerId
coverimages = NatLibFi,OpenLibrary
; List of undisplayable file formats
; undisplayable_file_formats = 'tif:tiff:3d-pdf:3d model:glb:obj:gltf'
; This setting controls the image to display when no book cover is available.
; The path is relative to the base of your theme directory.
noCoverAvailableImage = images/noCover2.gif
; URL of a service that is used to convert PDF files to jpg.
; The service receives the URL of the pdf file as a GET parameter and outputs a jpg file.
; convertPdfToCoverImageService = "http://127.0.0.1:9999"
; Comma separated list of record formats whose PDF converted record images may be downloaded.
pdfCoverImageDownload = "0/Map/"
; Threshold of consecutive failures after which a server is blocked. Default is 10.
coverServerFailureBlockThreshold = 10
; Duration of failed server block in seconds. Default is 3600.
coverServerFailureBlockDuration = 3600
; How long book summaries are cached locally in minutes. Default is one day
summarycachetime = 1440
; How long feed content is cached locally in minutes.
; Set this to 0 to disable caching.
feedcachetime = 10
; You can select from Syndetics, SyndeticsPlus, Amazon Editorial, Amazon, Booksite
; and/or the Guardian
; Note: Guardian reviews contain embedded advertisements. If the API key is not
; supplied, e.g. "Guardian:", only the review title, byline, Guardian logo
; and a link to the full Guardian page will be displayed
;reviews = Syndetics:MySyndeticsId,SyndeticsPlus:MySyndeticsID,AmazonEditorial:MyAccessKeyId,Amazon:MyAccessKeyId,Booksite,Guardian:MyGuardianKeyId
; You can select from Syndetics or SyndeticsPlus
;excerpts = Syndetics:MySyndeticsId,SyndeticsPlus:MySyndeticsId
; You can select from Syndetics or SyndeticsPlus
;authorNotes = Syndetics:MySyndeticsId,SyndeticsPlus:MySyndeticsId
; You can select from Syndetics or SyndeticsPlus
;videoClips = Syndetics:MySyndeticsId,SyndeticsPlus:MySyndeticsId
; You can select from Wikipedia
; Note for Windows users: If using Wikipedia, you may need to increase your Apache
; heap size settings. For details, see: http://vufind.org/jira/browse/VUFIND-630
;authors = Wikipedia
; You can look up your secret key by logging into http://aws.amazon.com and clicking
; "Access Identifiers" under "Your Account".
;amazonsecret = MyAmazonSecretKey
; You can sign up for an associate ID by logging into
; https://affiliate-program.amazon.com . Please make sure your instance of VuFind
; complies with Amazon's agreements before enabling this feature.
;amazonassociate = MyAmazonAssociateID
; You can select from Google, OpenLibrary, HathiTrust. You should consult
; https://developers.google.com/books/branding before using Google Book Search.
; previews = Google,OpenLibrary,HathiTrust
; Possible HathiRights options = pd,ic,op,orph,und,umall,ic-world,nobody,pdus,cc-by,cc-by-nd,
; cc-by-nc-nd,cc-by-nc,cc-by-nc-sa,cc-by-sa,orphcand,cc-zero,und-world,icus
; Default is "pd,ic-world" if unset here.
; See www.hathitrust.org/rights_database#Attributes for full details
;HathiRights = pd,ic-world,cc-by,cc-by-nd,cc-by-nc-nd,cc-by-nc,cc-by-nc-sa,cc-by-sa,cc-zero,und-world
; Possible GoogleBooks options full,partial,noview
; Default is "full,partial" if unset here.
; see code.google.com/apis/books/docs/dynamic-links.html#JSONformat
;GoogleOptions = full,partial
; OpenLibrary currently offers the same options/default as GoogleBooks (above):
;OpenLibraryOptions = full,partial
; An API key is needed to interact with the Europeana API (see the EuropeanaResults
; recommendation module in searches.ini for more information)
;europeanaAPI = INSERTKEY
; Geographic Display
; recordMap can be set to 'openlayers';
; 'openlayers' will display point and rectangle features. Default setting
; (see import/marc_local.properties for more information).
; Map Tab Options:
; mapLabels: leave empty, file:filename, or driver
; Leave it empty – no map labels will be displayed (default)
; file:filename - specify a file name after the colon for the
; coordinate/label lookup file. Coordinates in file must
; be specified as WENS.
; driver - Use the getCoordinateLabels method of the record driver to fetch labels;
; by default this relies on the long_lat_label field in Solr,
; but you can override the behavior with custom record driver code.
; The field must be the same length as the number of coordinate sets.
; Coordinates will be matched to labels on an ordered basis such that
; label[0] will be assigned for coordinate[0] and so forth.
; displayCoords: true or false. Default is false. (Only for recordMap = openlayers)
; If displayCoords is true, then the coordinate values from
; coordinate field will be displayed before the map label in the label popup.
recordMap = openlayers
;mapLabels = file:geosearch_test_lookup.txt
;displayCoords = true
; Enables zoom for images in the image popup, only applies to
; record formats specified in zoomFormats key. Disabled by default.
;enableImagePopupZoom = true
; A colon-separated list of formats that are enabled for image zoom function
zoomFormats = qdc:forward:ead3:ead:lido
[QRCode]
; This setting controls the image to display when no qrcode is available.
; The path is relative to the base of your theme directory.
;noQRCodeAvailableImage = images/noQRCode.gif
; Should we show QR codes in search results?
;showInResults = true
; Should we show QR codes on record pages?
showInCore = true
; If you are using Syndetics Plus for *any* content, set plus = true
; and set plus_id to your syndetics ID. This loads the javascript file.
; Syndetics vs. SyndeticsPlus: SyndeticsPlus has nice formatting, but loads slower
; and requires javascript to be enabled in users' browsers.
; You can change the base Syndetics URL used by the content services here.
; Most users will not need to change this setting. It does not affect
; Syndetics Plus at all. (FYI: Syndetics Plus is currently not available
; through SSL.)
[Syndetics]
plus = false
;plus_id = "MySyndeticsId"
;url = "https://secure.syndetics.com"
url = "http://syndetics.com"
; Booksite CATS Enhanced Content - cover images, reviews, description, etc.
[Booksite]
url = "https://api.booksite.com"
;key = "XXXXXXXXXXXXXXXXX"
; You can change the base Content Cafe URL used by the content services here. Most
; users will not need to change this setting. You also need to set your password,
; "pw". Note that Content Cafe is a subscription service from Baker & Taylor.
[Contentcafe]
url = "http://contentcafe2.btol.com"
pw = "xxxxxx"
; Summon is optional; this section is used for your API credentials. apiId is the
; short, human-readable identifier for your Summon account; apiKey is the longer,
; non-human-readable secret key. See also the separate Summon.ini file.
;[Summon]
;apiId = myAccessId
;apiKey = mySecretKey
; WorldCat is Optional. Worldcat offers extra features such as "Other Editions"
; and the WorldCat searching.
;[WorldCat]
;id = myAccount
;apiKey = YBaFHvqtTHbx7zzgtgAQDr4Rij9OSXBMmfsO1VRXxarmH1JU6neu2w3Lu6Y8OAjN2z5Pkz0M7GQwkwAF
;OCLCCode = MYCODE
;LimitCodes = Comma separated list of OCLC Codes
; These settings affect OpenURL generation and presentation; OpenURLs are used to
; help users find resources through your link resolver and to manage citations in
; Zotero.
[OpenURL]
; If a resolver base URL is enabled, it will be used to link ISSNs to your link
; resolver and to access articles in Summon if that module is enabled. Earlier
; versions of VuFind included some parameters as part of the URL; at this point,
; any extra parameters will be ignored -- please provide only the base URL.
;url = "http://openurl.myuniversity.edu/sfx_local"
; This string will be included as part of your OpenURL referer ID (the full string
; will be "info:sid/[your rfr_id setting]:generator"). You may be able to configure
; special behavior in your link resolver based on this ID -- for example, you may
; wish to prevent the resolver from linking to VuFind when links came from VuFind
; (to avoid putting a user in an infinite loop).
rfr_id = finna.fi
; By specifying your link resolver type, you can allow VuFind to optimize its
; OpenURLs for a particular platform. Current legal values: "sfx", "360link",
; "EZB" or "other" (default is "other" if commented out).
resolver = sfx
; If you want OpenURL links to open in a new window, set this setting to the
; desired Javascript window.open parameters. If you do not want a new window
; to open, set this to false or comment it out.
window_settings = "toolbar=no,location=no,directories=no,buttons=no,status=no,menubar=no,scrollbars=yes,resizable=yes,width=550,height=600"
; If you want to display a graphical link to your link resolver, uncomment the
; settings below. graphic should be a URL; graphic_width and graphic_height
; should be sizes in pixels.
; graphic = "http://myuniversity.edu/images/findIt.gif"
; graphic_width = 50
; graphic_height = 20
; The following settings control where OpenURL links are displayed:
show_in_results = true ; include in search results
show_in_record = true ; include in core record metadata
show_in_holdings = false ; include in holdings tab of record view
; If set to true, this setting will attempt to embed results from the link
; resolver directly in search results instead of opening a new window or page.
; This will override the window_settings option if set! Embedding is currently
; supported only when the resolver setting above is set to "sfx" or "360link".
embed = true
; When embed is true, you can set this to an absolute path on your system in order
; to cache link resolver results to disk. Be sure that the chosen directory has
; appropriate permissions set! Leave the setting commented out to skip caching.
; Note that the contents of this cache will not be expired by VuFind; you should
; set up an external process like a cron job to clear out the directory from time
; to time.
;resolver_cache = /usr/local/vufind/resolver_cache
; This setting controls whether we should display an OpenURL link INSTEAD OF other
; URLs associated with a record (true) or IN ADDITION TO other URLs (false).
replace_other_urls = false
; Whether to use SFX's Rapid Service Indication to provide information on whether
; full text is available.
use_rsi = true
; Whether to automatically check openurl resolver for full text services to be embedded
; when the record is scrolled to view. Only useful if embed = true.
autocheck = true
; Language mappings from VuFind to resolver (for embedded full menu)
language[fi] = fin
language[sv] = swe
language[en-gb] = eng
; EZproxy is optional. This section only needs to exist if you
; are using EZProxy to provide off-site access to online materials.
;[EZproxy]
;host = http://proxy.myuniversity.edu
; These settings affect RefWorks record exports. They rarely need to be changed.
[RefWorks]
vendor = Finna
url = http://www.refworks.com
; These settings affect EndNote Web record exports. They rarely need to be changed.
[EndNoteWeb]
vendor = Finna
url = https://www.myendnoteweb.com/EndNoteWeb.html
; These settings affect your OAI server if you choose to use it.
;
; If identifier is set, its value will be used as part of the standard OAI
; identifier prefix. It should only ever be set to a domain name that you
; control! If it is not set, your ID values will not be prefixed.
;
; If admin_email is not set, the main email under [Site] will be used instead.
;
; If set_field is set, the named Solr field will be used to generate sets on
; your OAI-PMH server. If it is not set, sets will not be supported.
;
; If set_query is set (as an array mapping set names to Solr queries -- see
; examples below), the specified queries will be exposed as OAI sets. If
; you use both set_field and set_query, be careful about the names you choose
; for your set queries. set_query names will trump set_field values when
; there are collisions.
;
; If vufind_api_format_fields is set, the listed fields (as defined in
; SearchApiRecordFields.yaml) are returned when metadata prefix
; "oai_vufind_json" is used.
;
;[OAI]
;identifier = myuniversity.edu
;repository_name = "MyUniversity Catalog"
;admin_email = oai@myuniversity.edu
;set_field = "format"
;set_query['eod_books'] = "institution:kfu AND publishDate:[1911 TO 1911]"
;set_query['eod_ebooks'] = "format:eBook"
;vufind_api_format_fields = "id,authors,cleanIsbn,cleanIssn,formats,title"
; Proxy Server is Optional.
[Proxy]
;host = your.proxy.server
;port = 8000
; Default HTTP settings can be loaded here. These values will be passed to
; the \Laminas\Http\Client's setOptions method.
[Http]
;sslcapath = "/etc/ssl/certs"
sslcafile = "/etc/ssl/certs/ca-bundle.crt"
; This is required on RHEL6 with PHP 5.6 for unknown reasons. Otherwise SSL
; connections may fail.
ssltransport = tls
; Spelling Suggestions
;
; Note: These settings affect the VuFind side of spelling suggestions; you
; may also wish to adjust some Solr settings in solr/biblio/conf/schema.xml
; and solr/biblio/conf/solrconfig.xml.
[Spelling]
enabled = true
; Number of suggestions to display on screen. This list is filtered from
; the number set in solr/biblio/conf/solrconfig.xml so they can differ.
limit = 3
; Show the full modified search phrase on screen
; rather then just the suggested word
phrase = false
; Offer expansions on terms as well as basic replacements
expand = true
; Turning on 'simple' spell checking will improve performance,
; by ignoring the more complicated 'shingle' (mini phrases)
; based dictionary.
simple = true
; This setting skips spell checking for purely numeric searches; spelling
; suggestions on searches for ISBNs and OCLC numbers are not generally very
; useful.
skip_numeric = true
; These settings control what events are logged and where the information is
; stored.
;
; VuFind currently supports four logging levels: alert (severe fatal error),
; error (fatal error), notice (non-fatal warning) and debug (informational).
;
; Each logging level can be further broken down into five levels of verbosity.
; You can specify the desired level by adding a dash and a number after the
; level in the configuration string -- for example, alert-2 or error-5.
; The higher the number, the more detailed the logging messages. If verbosity
; is not specified, it defaults to 1 (least detailed).
;
; Several logging methods are available, and each may be configured to log any
; combination of levels.
;
; You may enable multiple logging mechanisms if you want -- in fact, it is
; recommended, since the failure of one logging mechanism (i.e. database down,
; file system full) may then be reported to another.