forked from caltechlibrary/dibs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathsettings.ini-example
149 lines (124 loc) · 6.92 KB
/
settings.ini-example
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
# ========================================================== -*- mode: conf -*-
# @file settings.ini
# @brief Settings file for DIBS.
# @created 2021-02-02
# @license Please see the file named LICENSE in the project directory
# @website https://github.com/caltechlibrary/dibs
#
# ,------------------- Notice -- Notice -- Notice -------------------.
# | This file must be located in the same directory as adapter.wsgi. |
# `------------------------------------------------------------------'
#
# =============================================================================
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
# ~~~~~~~~~~~~~~~~~~~~~~~~~ General DIBS settings ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
[dibs]
# For production use, we highly recommend that DIBS be placed behind a single
# sign-on authentication system such as Shibboleth. For testing & development,
# or internal use behind a firewall, you could use Apache's Basic AuthType.
# If you do the latter, unset the following variables and match the location of
# the password file to wherever you configured it in your Apache config file.
#
#HTPASSWD = /usr/bin/htpasswd
#PASSWORD_FILE = /path/to/dibs/here/password.txt
# Set the next variable to either "folio" or "tind", depending on which LSP
# you are using, and then uncomment and set the relevant variables later in
# this file to configure your particular LSP.
LSP_TYPE = poolapi
# Path to the sqlite database, relative to here.
DATABASE_FILE = data/dibs.db
# Directory containing IIIF manifest files. Each file name should follow the
# pattern "NNNNNN-manifest.json", where NNNNNN is the item barcode. The repo
# for DIBS contains a subdirectory called "manifests" with a demo file in it,
# but the path can be changed if you put your manifests elsewhere.
MANIFEST_DIR = data/manifests
# Directory containing status files for items being processed. DIBS embodies
# a simple scheme to interact with an external workflow for automated
# processing of scans for IIIF. This scheme involves reading and writing
# files to a directory -- the PROCESS_DIR. When a new item is added to DIBS
# from the /list page, a button named "Process" is shown next to the new item;
# when library staff press that button, DIBS writes a file in the PROCESS_DIR
# location and watches for the presence of other files. The end point of the
# workflow is assumed to be the appearance of a IIIF manifest for the item in
# the MANIFEST_DIR. If you do not want to use the workflow scheme, leave this
# value empty; DIBS will skip the "Process" button, and will only monitor for
# the existence of the manifest file.
PROCESS_DIR = data/processing
# Directory containing thumbnail images of book covers/jackets. Images are
# assumed to be in JPEG format and the files named "NNNNNN.jpg", where
# "NNNNNN" is the barcode. (Note: .jpg and not .jpeg.) DIBS attempts to
# obtain cover images automatically and will store them in this directory,
# but you can also deliberately put images there to override what DIBS uses.
THUMBNAILS_DIR = data/thumbnails
# IIIF image service API base path. Include the protocol version at the end.
# This will almost certainly be "/iiif/2" as shown in the (fake) example on
# the next line.
IIIF_BASE_URL = https://unconfigured.edu/iiif/2
# DIBS caches pages it fetches from the IIIF server. This sets the size of
# the least-recently used cache to the given number of images. Bear in mind
# that in IIIF, each document page is tiled, which means a single document
# page equates to many (possibly hundreds) of (usually small) image tiles.
IIIF_CACHE_SIZE = 50000
# DIBS sends the patron email after they borrow an item. The destination
# address is the sign-on received from the authentication layer. The
# following variables set the mail server details. Note that for this to
# work, the account owning the web server process must be able to send email.
MAIL_HOST = localhost
MAIL_PORT = 25
MAIL_SENDER = helpdesk@unconfigured.edu
# Set the cooling off period: the time a user must wait between when they
# return a title and when they can loan it out again (in minutes).
RELOAN_WAIT_TIME = 30
# Feedback form URL. This is used on the thank-you page and in the hamburger
# menu in the upper right of every page (it's link for "Give feedback").
FEEDBACK_URL =
# Help page URL. This is used in the hamburger menu in the upper right of
# every page (it's link for "Help").
HELP_URL = https://caltechlibrary.github.io/dibs/usage.html
# The following run mode options are recognized:
# "normal": use adapter.wsgi without special options
# "verbose": use adapter.wsgi with verbose logging options
# When started using the program run-server included with DIBS, this value
# maybe overriden by command-line options given to run-server.
RUN_MODE = normal
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
# ~~~~~~~~~~~~~~~~~~~~~~~~ LSP interface settings ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
[tind]
# If you use TIND, set this to the base URL of your hosted TIND server. For
# example, when Caltech was using TIND, this was https://caltech.tind.io
TIND_SERVER_URL =
[solr]
# If you use SOLR, set this to the base URL of your hosted SOLR server, plus the port and core name
SOLR_SERVER_URL = http://v4-solr-production-replica-1-private.internal.lib.virginia.edu:8080/solr/test_core/select
[poolapi]
# If you use SOLR, set this to the base URL of your hosted SOLR server, plus the port and core name
AUTH_URL = https://search.lib.virginia.edu/authorize
POOL_URL = https://pool-solr-ws-uva-library.internal.lib.virginia.edu/api
[folio]
# If you use FOLIO, set the URL to the URL for your FOLIO API (which is known
# as "Okapi") server, the tenant id, and the API access token. (There is
# sample code in https://github.com/FOLIO-FSE/tech-partner-demo that may help
# you figure how to create a token for your FOLIO installation.)
#
# The accession prefix is the string that appears in front of accession
# numbers in your instance of FOLIO. As an example of a prefix for accession
# numbers, for Caltech the prefix is the `clc` part of an accession number
# such as `clc.025d49d5.735a.4d79.8889.c5895ac65fd2`.
#
# The EDS page template is a URL for permalinks to detailed record pages in
# EBSCO EDS, with the sequence of characters {accession_number} somewhere in
# the URL. DIBS will replace the sequence {accession_number} with actual
# record accession numbers when creating hyperlinks to the record pages.
FOLIO_OKAPI_URL =
FOLIO_OKAPI_TENANT_ID =
FOLIO_OKAPI_TOKEN =
FOLIO_ACCESSION_PREFIX =
EDS_PAGE_TEMPLATE =
[contentcafe]
# DIB's LSP layer attempts to get book jacket cover images from multiple
# sources. One source it can use is Baker & Taylor's Content Cafe 2. If you
# have an account for using the Content Cafe API, provide the account info.
CC_USER =
CC_PASSWORD =