-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathinstall_instructions_english.html
executable file
·408 lines (388 loc) · 21.1 KB
/
install_instructions_english.html
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
<html>
<head>
<meta name="description" content="OpenBiblio Library Automation System">
<title>OpenBiblio Install Instructions</title>
<style type="text/css">
.notice {
margin-left: 50px;
margin-right: 50px;
border: solid black 1px;
background: #ffaaaa;
padding: 4px;
}
.new {
margin-left: 50px;
margin-right: 50px;
border: solid black 1px;
background: #ffffaa;
padding: 4px;
}
h1 {
border-bottom: solid black 1px
}
th {
text-align: right
}
</style>
</head>
<body bgcolor="#ffffff" topmargin="0" bottommargin="0" leftmargin="0" rightmargin="0" marginheight="0" marginwidth="0">
<div style="background: #bebdbe"><img src="images/obiblio_logo.gif" width="170" height="35" border="0"></div>
<div style="padding: 8px">
<h1>Contents:</h1>
<ul>
<li><a href="#releaseNotes">Release Notes</a></li>
<li><a href="#sysReq">System requirements</a></li>
<li><a href="#install">Install Instructions</a></li>
<li><a href="#userlogin">Setup of Userlogin</a></li>
<li><a href="#update">Updating from a previous version of OpenBiblio</a></li>
</ul>
<a name="releaseNotes">
<h1>Release Notes:</h1>
</a>
<p>Version 0.7.2.2(g) is recommended for new installs. Updating older versions of OpenBiblio is highly
recommended because the most important changes are for hardening security.</p>
<p>See the <a href="ChangeLog">ChangeLog</a> for more details.</p>
Known limitations:
<ul>
<li>MARC is not stored perfectly in the database tables (issue 1, fixed in obiblio-10-wip).</li>
<li>UTF-8 multibyte characters: very limited support in reports and possibly issues with search (issue 19).</li>
<li>If you have not updated to 64 bit PHP before some day in the year 2038: days late and late fee not
calculated, incorrect timestamp calculations for holds (issue 51).
</li>
</ul>
<p>OpenBiblio test suite ran successfully on the following configurations:</p>
<blockquote>
<table>
<tr>
<th>Operating System:</th>
<td>Microsoft Windows 7</td>
<td>Ubuntu 9.04 (GNU/Linux)</td>
<td>Ubuntu 9.04 (GNU/Linux)</td>
</tr>
<tr>
<th>PHP Version:</th>
<td>5.6.0alpha3 VC11 <sup>EasyPHP</sup></td>
<td>5.3.1 <sup>XAMPP for Linux 173a</sup></td>
<td>4.3.9 <sup>XAMPP for Linux 149a</sup></td>
</tr>
<tr>
<th>Web Server:</th>
<td>Apache 2.2.21 VC9</td>
<td>Apache 2.2.14</td>
<td>Apache 2.0.52</td>
</tr>
<tr>
<th>MySql Version:</th>
<td>5.6.15 (lower versions of 5.6 count results incorrectly)</td>
<td>5.1.41</td>
<td>4.0.21</td>
</tr>
<tr>
<th>Browser:</th>
<td>Firefox 28.0<br>Internet Explorer 11.0.4</td>
<td>Firefox 3.6.27</td>
<td>Firefox 3.6.27</td>
</tr>
</table>
</blockquote>
</li>
</ul>
<a name="sysReq">
<h1>System requirements:</h1>
</a>
<ul>
<li>PHP version 4.2.0 or higher and a web server which supports it</li>
<li>MySQL version 4.0.12 or higher</li>
<li>A relatively modern web browser. Versions of Internet Explorer before 6.0 may have problems with PDF files
generated by OpenBiblio. Users of Netscape 4.x and earlier may suffer from appearance problems.
</li>
</ul>
<div class="notice">
This release is still compatible with ancient versions of PHP and MySQL. Make sure to use versions that are
updated for security.
</div>
<br>
<div class="new">
<strong>Commonly used scenarios for making a system meet the requirements:</strong>
<ul>
<li>Linux: add the required software using a "package manager".</li>
<li>Windows: for standalone use or testing purposes use a "WAMP" package like <a
href="http://www.easyphp.org">EasyPHP</a> or <a href="http://www.apachefriends.org/de/xampp.html">XAMPP</a>.
</li>
<li>Handpick the required software: full procedure below.</li>
</ul>
Find more reading, tutorials, etc. in the documentation section of <a href="http://obiblio.sourceforge.net/">OpenBiblio's
home</a>.
</div>
<a name="install">
<h1>Install Instructions:</h1>
</a>
<div class="new">
For systems that meet the requirements: jump to <a href="#step9">step 9 and finish the procedure.</a>
</div>
<br>
<div class="new">
When using <i>phpMyAdmin</i> for setting up the database:
<ul>
<li>Open the SQL query window.</li>
<li>Run the SQL commands from <a href="#step9">step 9</a> and step 10 in the procedure below.
The command is the part in <tt><b>bold</b></tt> directly after <tt>mysql></tt></li>
<li>Jump to <a href="#step12">step 12</a> and finish the procedure.</li>
</ul>
</div>
<h3>Procedure</h3>
<div class="notice">Steps 1-8: detail is out of date, but the basics are still valid.</div>
<ol>
<li>To use your system for OpenBiblio you have to install a webserver, PHP and MySQL. If you didn't done it
already, i recommend to use <a href="http://www.apachefriends.org/en/xampp.html">XAMPP</a> for this
installation, because this includes all the needed programs in one installation (of course except
Openbiblio). XAMPP is ditributed for <a
href="http://www.apachefriends.org/en/xampp-windows.html">Windows</a>, <a
href="http://www.apachefriends.org/en/xampp-linux.html">Linux</a>, <a
href="http://www.apachefriends.org/en/xampp-macosx.html">MacOS X</a> and <a
href="http://www.apachefriends.org/en/xampp-solaris.html">Solaris</a>. The Windows-Version doesn't
run with Windows ME, because there are problems with Apache2 (there are TCP/IP-Problems under Win ME). If
you use Win ME or a other not mentioned system, please use the manual installation (since point 4),
otherwise continue with point 2. (i want to thank Christopher Dagleish for the hint to XAMPP :-))
</li>
<li>Download <a href="http://www.apachefriends.org/en/xampp.html">XAMPP</a> in the version, which your system
needs, the Lite-version is sufficient but i recommend the full version nevertheless (this version offers
regulary updates...). Following install the downloaded XAMPP (the installation is described on the site of
the corresponding XAMPP-version in english, so i didn't explain it here, but please read everything there
:-)). Now you should start XAMPP (it's explained there how) and you have a running Apache, PHP and MySQL.
Continue now with the installation of OpenBiblio at point 7.!
</li>
<li>The following points 4-6 you only have to do, if you didn't installed XAMPP (or XAMPP doesn't run):</li>
<li>Install a web server such as <a href="http://httpd.apache.org/">Apache</a> that is compatible with PHP. If
you install Apache, get familiar with starting and stopping your Apache Web Server. If you are running
Windows 95 or Windows 98 there will be "Start Apache" and "Stop Apache" icons that will help you start and
stop your web server. You may want to consider adding the "Start Apache" icon to your startup folder. If you
are running NT or Windows 2000 you can add Apache as a service which will be running, even if you are logged
off. If you are running Linux your Apache server should be packaged with your Linux installation and will
start when you start Linux. <b>Attention: Under Windows ME there are much reports about problems with Apache
2.0.x (in my practice it doesn't run, as long as i had installed networkcards, the tcp/ip-driver of ME
seems buggy), take Apache 1.3.33 in this case.</b>
</li>
<li>Add PHP to your web server as a CGI or a module. If you are using Apache 2.0, I would highly recommend that
you install PHP as a module instead of a cgi application. In my experience the Apache PHP module performed
over 4 times faster than the cgi PHP. See <a href="http://www.php.net/manual/en/install.apache2.php">Example
3-9. PHP and Apache 2.0 as Module</a> in the <a href="http://www.php.net/manual/en/">PHP Manual</a> for
more info on how to install PHP as a module.
<p>OpenBiblio uses session data. Therefore, you will need to make sure PHP sessions are turned on. Be sure
to create a directory for your session data on your server and specify the session.save_path in your
php.ini file. The default php.ini sets session.save_path to "/tmp". Therefore, you have to create a
directory called c:/tmp (for Windows) users. However, I usually create a more descriptive name inside my
PHP directory and then change my php.ini file to match it.
<p>Example php.ini directive:
<pre>session.save_path = d:\PHP\sessiondata</pre>
<p>See section <a href="http://www.php.net/manual/en/ref.session.php">XCIII. Session handling functions</a>
in the PHP manual for more details on PHP sessions.
</li>
<li>Install the MySQL database from <a href="http://www.mysql.com/">http://www.mysql.com/</a>. Get familiar with
starting and stopping your MySQL Server. See <a href="http://www.mysql.com/doc/W/i/Win95_start.html">Starting
MySQL on Windows 95 or Windows 98</a> for more information.<br><br>If you are running NT or Windows
2000, setup MySQL as a service so it starts whenever the machine powers up. See <a
href="http://www.mysql.com/doc/N/T/NT_start.html">Starting MySQL on Windows NT or Windows 2000</a>
for more information on starting MySQL as a service.<br><br>
If you are running Linux, MySQL should be packaged with your Linux installation and will start when you
start Linux.
</li>
<li>The following points are describing the installation of OpenBiblio and have to be done from everything, who
install OpenBiblio at the first time (never mind if you use XAMPP or installed apache, PHP and MySQL on a
other way):
</li>
<li>Get familiar with logging into MySQL with your admin account within a DOS prompt window. You can use the
following command sequence as a test.
<blockquote><pre>
C:\><b>c:\mysql\bin\mysql -uroot mysql</b>
Enter password: <b>*********</b>
Welcome to the MySQL monitor. Commands end with ; or \g.
Your MySQL connection id is 8 to server version: 3.23.26-beta
Type 'help;' or '\h' for help. Type '\c' to clear the buffer
mysql> <b>show databases;</b>
+--------------+
| Database |
+--------------+
| mysql |
+--------------+
6 rows in set (0.00 sec)
mysql> <b>exit</b>
Bye
C:\>
</pre>
</blockquote>
</li>
<a name="step9">
<li>Create an OpenBiblio database. To do this, log into MySQL with your admin account
and run the following SQL command.
<blockquote><pre>
mysql> <b>create database OpenBiblio /*!40100 default character set latin1 */;</b>
</pre>
<div class="new">
<strong>New:</strong> The conditional comment <b><tt>/* ... */ </tt></b>is executed on MySQL
4.1.0 or higher and specifies <tt>latin1</tt> as the default database character set for the
database created.
</div>
<br>
<div class="notice">
You might discover issues when the database character set is not <tt>latin1</tt>.
<table border="1">
<th>database character set</th>
<th>tab Admin: Library Settings, field <i>HTML Charset</i></th>
<th>comment</th>
<tr>
<td>latin1<br><i>(recommended)</i></td>
<td>iso-8859-1<br><i>(initial value, set by install)</i></td>
<td>No issues.</i></td>
</tr>
<tr>
<td>utf8</td>
<td>UTF-8</td>
<td>Issues for multibyte characters
<ul>
<li>Search?</li>
<li>PDF layouts</li>
</ul>
</td>
</tr>
</table>
</div>
<br>
<div class="new">
<strong>New:</strong> When OpenBiblio HTML Charset setting is UTF-8, PDF layouts can display
some multibyte characters correctly by converting to single byte.
</div>
<br>
To check to make sure the OpenBiblio database was created properly, run the following command.
<pre>
mysql> <b>show databases;</b>
+--------------+
| Database |
+--------------+
| mysql |
| OpenBiblio |
+--------------+
</pre>
</blockquote>
</li>
</a>
<a name="step10">
<li>Create an OpenBiblio database user. To do this, login to MySQL under the admin userid
and run the following SQL command, substituting <i>obiblio_user</i> and <i>obiblio_password</i> with the
userid and password of your choice.
<blockquote>
<table>
<tr>
<td><pre>mysql>
-> </pre>
</td>
<td><pre><b>grant all privileges on OpenBiblio.* to <i>obiblio_user</i>@localhost</b></b>
<b>identified by '<i>obiblio_password</i>';</pre>
</td>
</tr>
</table>
</blockquote>
</li>
</a>
<li>Verify your OpenBiblio database and user by logging into the new MySQL database under the new user.
<blockquote><pre>
<b>C:\mysql\bin\mysql -u<i>obiblio_user</i> -p<i>obiblio_password</i> OpenBiblio</b>
</pre>
</blockquote>
</li>
<a name="step11">
<li>Copy the openbiblio directory and all of its contents into your web server's htdocs
root or any subdirectory within the htdocs root.
</li>
</a>
<a name="step12">
<li>Edit the database_constants.php file (located in the main openbiblio directory)
with the text editor of your choice.
Change the username and password to match the new MySQL user and password that you
created in the previous steps.
</li>
</a>
<li>Create the OpenBiblio database tables. To do this run the install php script
located at <a href="http://localhost/openbiblio/install/index.php">http://localhost/openbiblio/install/index.php</a>,
assuming you placed the openbiblio directory in the root htdocs directory.
</li>
<li><strong>For security:</strong> Remove the openbiblio/install directory completely
to prevent unauthorized use of install or upgrade tools.
</li>
<li><strong>For security:</strong> Verify that the <tt>display_errors</tt> setting in php.ini is 'Off' to
prevent unintended information disclosure.
</li>
<li>Access your new library automation system at <a href="http://localhost/openbiblio/index.php">http://localhost/openbiblio/index.php</a>,
assuming you placed the openbiblio directory in the root htdocs directory. Enter "admin" for both the userid
and password whenever you are prompted to signon. You can change the admin password from the "Admin" tab ->
staff list, where you can also add more library staff members.
</li>
</ol>
<br>
<a name="userlogin">
<h1>Setup of Userlogin:</h1>
<p>At the userlogin I've tried to develop a version that doesn't touch or enhance the existing database
structure, to make it possible to update from my german to the english sourceforge-version of openbiblio. So
I've used some functions for this new functionality, which are already in openbiblio. For this reason, it
wasn't possible to use a real password function. I'm only using a secret word, which is stored in plain text
and is readable in plain text by the librarian.</p>
<p>The following explains how to set up the user login (version 0.7.2g), since it does not work without this
additional setup.</p>
<ol>
<li>Log in to Openbiblio at <a href="http://localhost/openbiblio/index.html">http://localhost/openbiblio/index.html</a>
and change to the admin area.
</li>
<li>Change to Member Fields and add a new custom field.
</li>
<li>The new field must necessarily have the code "secret". In the description you can choose the name
itself, I'm using here "Secret Word". Press Submit.
</li>
<li>From now you can use user login at <a href="http://localhost/openbiblio/opac/index.html">http://localhost/openbiblio/opac/index.html</a>.
</li>
<li>At the memberinfo you can now define the secret word. Once this is filed, this member can login at <a
href="http://localhost/openbiblio/opac/loginform.php">http://localhost/openbiblio/opac/loginform.php</a>
with his card number an his secret word to renew his items or to place a hold. If a member has no secret
word, an info appears, that he has to give a secret word to the librarian.
</li>
</ol>
</a>
<br>
<a name="update">
<h1>Updating from a previous version of OpenBiblio:</h1>
<ol>
<li>Rename your old openbiblio installation directory so that you don't lose its contents. We'll call the
old directory openbiblio-old.
</li>
<li>Copy the new openbiblio directory and all of its contents into the directory where the old openbiblio
installation was.
</li>
<li>Copy the database_constants.php file from the openbiblio-old directory into the new openbiblio
directory, replacing the database_constants.php file there.
</li>
<li>Backup your database. See your MySQL documentation for instructions. (use mysqldump)
</li>
<li>Update your OpenBiblio database tables by using the conversion tool located at <a
href="http://localhost/openbiblio/install/index.php">http://localhost/openbiblio/install/index.php</a>,
assuming you placed the openbiblio directory in the root htdocs directory. When installed on a remote
host, the first part of the address will be different. If the tables are already OK, the tool will say
so.
</li>
<li><strong>For security:</strong> Remove the openbiblio/install directory completely
to prevent unauthorized use of install or upgrade tools. If present, also remove the openbiblio/tests
directory.
</li>
<li><strong>For security:</strong> Verify that the <tt>display_errors</tt> setting in php.ini is 'Off' to
prevent unintended information disclosure.
</li>
</ol>
<div class="notice">
<strong>Updates from 0.7.0:</strong> 0.7.2.2g is a bugfix release to 0.7.x: it can run without upgrading the
database. However, step 5 is recommended. This cleans unused entries from the database and lifts some
restrictions.<br>
<strong>Updates from 0.7.1:</strong> 0.7.2.2g is a bugfix release to 0.7.x: it can run without upgrading the
database.
</div>
</a>
</div>
</body>
</html>