git.evergreen-ils.org Git - working/Evergreen.git/blob - docs/modules/installation/pages/server

1 = Installing the Evergreen server =

2 :toc:

3

4 == Preamble: referenced user accounts ==

5

6 In subsequent sections, we will refer to a number of different accounts, as

7 follows:

8

9 * Linux user accounts:

10 ** The *user* Linux account is the account that you use to log onto the

11 Linux system as a regular user.

12 ** The *root* Linux account is an account that has system administrator

13 privileges. On Debian you can switch to this account from

14 your *user* account by issuing the `su -` command and entering the

15 password for the *root* account when prompted. On Ubuntu you can switch

16 to this account from your *user* account using the `sudo su -` command

17 and entering the password for your *user* account when prompted.

18 ** The *opensrf* Linux account is an account that you create when installing

19 OpenSRF. You can switch to this account from the *root* account by

20 issuing the `su - opensrf` command.

21 ** The *postgres* Linux account is created automatically when you install

22 the PostgreSQL database server. You can switch to this account from the

23 *root* account by issuing the `su - postgres` command.

24 * PostgreSQL user accounts:

25 ** The *evergreen* PostgreSQL account is a superuser account that you will

26 create to connect to the PostgreSQL database server.

27 * Evergreen administrator account:

28 ** The *egadmin* Evergreen account is an administrator account for

29 Evergreen that you will use to test connectivity and configure your

30 Evergreen instance.

31

32 == Preamble: developer instructions ==

33

34 [NOTE]

35 Skip this section if you are using an official release tarball downloaded

36 from http://evergreen-ils.org/egdownloads

37

38 Developers working directly with the source code from the Git repository,

39 rather than an official release tarball, must perform one step before they

40 can proceed with the `./configure` step.

41

42 As the *user* Linux account, issue the following command in the Evergreen

43 source directory to generate the configure script and Makefiles:

44

45 [source, bash]

46 ------------------------------------------------------------------------------

47 autoreconf -i

48 ------------------------------------------------------------------------------

49

50 == Installing prerequisites ==

51

52 * **PostgreSQL**: The minimum supported version is 10.

53 * **Linux**: Evergreen has been tested on

54 Debian Bookworm (12),

55 Debian Bullseye (11),

56 Debian Buster (10),

57 Ubuntu Jammy Jellyfish (22.04),

58 and Ubuntu Focal Fossa (20.04).

59 If you are running an older version of these distributions, you may want

60 to upgrade before upgrading Evergreen. For instructions on upgrading these

61 distributions, visit the Debian or Ubuntu websites.

62 * **OpenSRF**: The minimum supported version of OpenSRF is 3.3.0.

63

64

65 Evergreen has a number of prerequisite packages that must be installed

66 before you can successfully configure, compile, and install Evergreen.

67

68 1. Begin by installing the most recent version of OpenSRF (3.3.0 or later).

69 You can download OpenSRF releases from http://evergreen-ils.org/opensrf-downloads/

70 +

71 2. Issue the following commands as the *root* Linux account to install

72 prerequisites using the `Makefile.install` prerequisite installer,

73 substituting `debian-bookworm`,`debian-bullseye`,`debian-buster`,`ubuntu-jammy`,

74 or `ubuntu-focal` for <osname> below:

75 +

76 [source, bash]

77 ------------------------------------------------------------------------------

78 make -f Open-ILS/src/extras/Makefile.install <osname>

79 ------------------------------------------------------------------------------

80 +

81 [[optional_developer_additions]]

82 3. OPTIONAL: Developer additions

83 +

84 To perform certain developer tasks from a Git source code checkout,

85 additional packages are required. As the *root* Linux account:

86 +

87 * To install packages needed for retrieving and managing web dependencies,

88 use the <osname>-developer Makefile.install target. Currently,

89 this is only needed for building and installing the web

90 staff client.

91 * To optionally run Angular and AngularJS tests you will need to manually

92 install Firefox and your choice of Chromium or Chrome.

93 +

94 [source, bash]

95 ------------------------------------------------------------------------------

96 make -f Open-ILS/src/extras/Makefile.install <osname>-developer

97 ------------------------------------------------------------------------------

98 +

99 * To install packages required for building Evergreen translations, use

100 the <osname>-translator Makefile.install target.

101 +

102 [source, bash]

103 ------------------------------------------------------------------------------

104 make -f Open-ILS/src/extras/Makefile.install <osname>-translator

105 ------------------------------------------------------------------------------

106 +

107 * To install packages required for building Evergreen release bundles, use

108 the <osname>-packager Makefile.install target.

109 +

110 [source, bash]

111 ------------------------------------------------------------------------------

112 make -f Open-ILS/src/extras/Makefile.install <osname>-packager

113 ------------------------------------------------------------------------------

114

115 == Extra steps for web staff client ==

116

117 [NOTE]

118 Skip this entire section if you are using an official release tarball downloaded

119 from http://evergreen-ils.org/downloads. Otherwise, ensure you have installed the

120 xref:#optional_developer_additions[optional developer additions] before proceeding.

121

122 [[install_files_for_web_staff_client]]

123 === Install AngularJS files for web staff client ===

124

125 1. Building, Testing, Minification: The remaining steps all take place within

126 the staff JS web root:

127 +

128 [source,sh]

129 ------------------------------------------------------------------------------

130 cd $EVERGREEN_ROOT/Open-ILS/web/js/ui/default/staff/

131 ------------------------------------------------------------------------------

132 +

133 2. Install Project-local Dependencies. npm inspects the 'package.json' file

134 for dependencies and fetches them from the Node package network.

135 +

136 [source,sh]

137 ------------------------------------------------------------------------------

138 npm install # fetch JS dependencies

139 ------------------------------------------------------------------------------

140 +

141 3. Run the build script.

142 +

143 [source,sh]

144 ------------------------------------------------------------------------------

145 npm run build-prod

146 ------------------------------------------------------------------------------

147 +

148 4. OPTIONAL: Test web client code if the <osname>-developer packages and

149 the necessary browsers are installed.

150 CHROME_BIN should be set to the path to chrome or chromimum, e.g.,

151 `/usr/bin/chromium`:

152 +

153 [source,sh]

154 ------------------------------------------------------------------------------

155 CHROME_BIN=/path/to/chrome npm run test

156 ------------------------------------------------------------------------------

157

158 [[install_files_for_angular_web_staff_client]]

159 === Install Angular files for web staff client ===

160

161 1. Building, Testing, Minification: The remaining steps all take place within

162 the Angular staff root:

163 +

164 [source,sh]

165 ------------------------------------------------------------------------------

166 cd $EVERGREEN_ROOT/Open-ILS/src/eg2/

167 ------------------------------------------------------------------------------

168 +

169 2. Install Project-local Dependencies. npm inspects the 'package.json' file

170 for dependencies and fetches them from the Node package network.

171 +

172 [source,sh]

173 ------------------------------------------------------------------------------

174 npm install # fetch JS dependencies

175 ------------------------------------------------------------------------------

176 +

177 3. Run the build script.

178 +

179 [source,sh]

180 ------------------------------------------------------------------------------

181 ng build --configuration=production

182 ------------------------------------------------------------------------------

183 +

184 This can be a memory-intensive build. If the process does not finish, and you

185 get the message "Killed" in the console, try running it with

186 https://nodejs.org/api/cli.html#cli_max_old_space_size_size_in_megabytes[an explicit max-old-space-size option]

187 to encourage more garbage collection. For example, on a machine with 4GB of

188 memory, you can limit max-old-space-size to 3GB with:

189 +

190 [source,sh]

191 ------------------------------------------------------------------------------

192 NODE_OPTIONS=--max-old-space-size=3072 ng build --configuration=production

193 ------------------------------------------------------------------------------

194 +

195 4. OPTIONAL: Test eg2 web client code if the <osname>-developer packages and

196 the necessary browsers are installed:

197 CHROME_BIN should be set to the path to chrome or chromimum, e.g.,

198 `/usr/bin/chromium`:

199 +

200 [source,sh]

201 ------------------------------------------------------------------------------

202 CHROME_BIN=/path/to/chrome npm run test

203 MOZ_HEADLESS=1 ng e2e

204 ------------------------------------------------------------------------------

205

206 [[install_opac_deps]]

207 === Install OPAC skin dependencies ===

208

209 1. The following steps take place within the OPAC dependencies root:

210 +

211 [source,sh]

212 ------------------------------------------------------------------------------

213 cd $EVERGREEN_ROOT/Open-ILS/web/opac/deps

214 ------------------------------------------------------------------------------

215 +

216 2. Install Project-local Dependencies. npm inspects the 'package.json' file

217 for dependencies and fetches them from the Node package network.

218 +

219 [source,sh]

220 ------------------------------------------------------------------------------

221 npm install # fetch JS and CSS dependencies

222 ------------------------------------------------------------------------------

223 +

224 Note that there is no build step.

225

226 3. OPTIONAL: Test OPAC javascript code:

227 +

228 [source,sh]

229 ------------------------------------------------------------------------------

230 npm run test

231 ------------------------------------------------------------------------------

232

233

234 == Configuration and compilation instructions ==

235

236 For the time being, we are still installing everything in the `/openils/`

237 directory. From the Evergreen source directory, issue the following commands as

238 the *user* Linux account to configure and build Evergreen:

239

240 [source, bash]

241 ------------------------------------------------------------------------------

242 PATH=/openils/bin:$PATH ./configure --prefix=/openils --sysconfdir=/openils/conf

243 make

244 ------------------------------------------------------------------------------

245

246 These instructions assume that you have also installed OpenSRF under `/openils/`.

247 If not, please adjust PATH as needed so that the Evergreen `configure` script

248 can find `osrf_config`.

249

250 == Installation instructions ==

251

252 1. Once you have configured and compiled Evergreen, issue the following

253 command as the *root* Linux account to install Evergreen and copy

254 example configuration files to `/openils/conf`.

255 +

256 [source, bash]

257 ------------------------------------------------------------------------------

258 make install

259 ------------------------------------------------------------------------------

260

261 == Change ownership of the Evergreen files ==

262

263 All files in the `/openils/` directory and subdirectories must be owned by the

264 `opensrf` user. Issue the following command as the *root* Linux account to

265 change the ownership on the files:

266

267 [source, bash]

268 ------------------------------------------------------------------------------

269 chown -R opensrf:opensrf /openils

270 ------------------------------------------------------------------------------

271

272 == Run ldconfig ==

273

274 On Ubuntu or Debian, run the following command as the root user:

275

276 [source, bash]

277 ------------------------------------------------------------------------------

278 ldconfig

279 ------------------------------------------------------------------------------

280

281 == Additional Instructions for Developers ==

282

283 [NOTE]

284 Skip this section if you are using an official release tarball downloaded

285 from http://evergreen-ils.org/egdownloads

286

287 Developers working directly with the source code from the Git repository,

288 rather than an official release tarball, need to install the Dojo Toolkit

289 set of JavaScript libraries. The appropriate version of Dojo is included in

290 Evergreen release tarballs. Developers should install the Dojo 1.3.3 version

291 of Dojo by issuing the following commands as the *opensrf* Linux account:

292

293 [source, bash]

294 ------------------------------------------------------------------------------

295 wget http://download.dojotoolkit.org/release-1.3.3/dojo-release-1.3.3.tar.gz

296 tar -C /openils/var/web/js -xzf dojo-release-1.3.3.tar.gz

297 cp -r /openils/var/web/js/dojo-release-1.3.3/* /openils/var/web/js/dojo/.

298 ------------------------------------------------------------------------------

299

300

301 == Configure the Apache Web server ==

302

303 . Use the example configuration files to configure your Web server for

304 the Evergreen catalog, web staff client, Web services, and administration

305 interfaces. Issue the following commands as the *root* Linux account:

306 +

307 [source,bash]

308 ------------------------------------------------------------------------------------

309 cp Open-ILS/examples/apache_24/eg_24.conf /etc/apache2/sites-available/eg.conf

310 cp Open-ILS/examples/apache_24/eg_vhost_24.conf /etc/apache2/eg_vhost.conf

311 cp Open-ILS/examples/apache_24/eg_startup /etc/apache2/

312 # Now set up SSL

313 mkdir /etc/apache2/ssl

314 cd /etc/apache2/ssl

315 ------------------------------------------------------------------------------------

316 +

317 . The `openssl` command cuts a new SSL key for your Apache server. For a

318 production server, you should purchase a signed SSL certificate, but you can

319 just use a self-signed certificate and accept the warnings in the

320 and browser during testing and development. Create an SSL key for the Apache

321 server by issuing the following command as the *root* Linux account:

322 +

323 [source,bash]

324 ------------------------------------------------------------------------------

325 openssl req -new -x509 -days 365 -nodes -out server.crt -keyout server.key

326 ------------------------------------------------------------------------------

327 +

328 . As the *root* Linux account, edit the `eg.conf` file that you copied into

329 place.

330 a. To enable access to the offline upload / execute interface from any

331 workstation on any network, make the following change (and note that

332 you *must* secure this for a production instance):

333 * Replace `Require host 10.0.0.0/8` with `Require all granted`

334 . Change the user for the Apache server.

335 * As the *root* Linux account, edit

336 `/etc/apache2/envvars`. Change `export APACHE_RUN_USER=www-data` to

337 `export APACHE_RUN_USER=opensrf`.

338 . As the *root* Linux account, configure Apache with KeepAlive settings

339 appropriate for Evergreen. Higher values can improve the performance of a

340 single client by allowing multiple requests to be sent over the same TCP

341 connection, but increase the risk of using up all available Apache child

342 processes and memory.

343 * Edit `/etc/apache2/apache2.conf`.

344 a. Change `KeepAliveTimeout` to `1`.

345 b. Change `MaxKeepAliveRequests` to `100`.

346 . As the *root* Linux account, configure the prefork module to start and keep

347 enough Apache servers available to provide quick responses to clients without

348 running out of memory. The following settings are a good starting point for a

349 site that exposes the default Evergreen catalog to the web:

350 +

351 .`/etc/apache2/mods-available/mpm_prefork.conf`

352 [source,bash]

353 ------------------------------------------------------------------------------

354 <IfModule mpm_prefork_module>

355 StartServers 15

356 MinSpareServers 5

357 MaxSpareServers 15

358 MaxRequestWorkers 75

359 MaxConnectionsPerChild 500

360 </IfModule>

361 ------------------------------------------------------------------------------

362 +

363 . As the *root* user, enable the mpm_prefork module:

364 +

365 [source,bash]

366 ------------------------------------------------------------------------------

367 a2dismod mpm_event

368 a2enmod mpm_prefork

369 ------------------------------------------------------------------------------

370 +

371 . As the *root* Linux account, enable the Evergreen site:

372 +

373 [source,bash]

374 ------------------------------------------------------------------------------

375 a2dissite 000-default # OPTIONAL: disable the default site (the "It Works" page)

376 a2ensite eg.conf

377 ------------------------------------------------------------------------------

378 +

379 . As the *root* Linux account, enable Apache to write

380 to the lock directory; this is currently necessary because Apache

381 is running as the `opensrf` user:

382 +

383 [source,bash]

384 ------------------------------------------------------------------------------

385 chown opensrf /var/lock/apache2

386 ------------------------------------------------------------------------------

387

388 Learn more about additional Apache options in the following sections:

389

390 * xref:admin:apache_rewrite_tricks.adoc#apache_rewrite_tricks[Apache Rewrite Tricks]

391 * xref:admin:apache_access_handler.adoc#apache_access_handler_perl_module[Apache Access Handler Perl Module]

392

393 == Configure OpenSRF for the Evergreen application ==

394

395 There are a number of example OpenSRF configuration files in `/openils/conf/`

396 that you can use as a template for your Evergreen installation. Issue the

397 following commands as the *opensrf* Linux account:

398

399 [source, bash]

400 ------------------------------------------------------------------------------

401 cp -b /openils/conf/opensrf_core.xml.example /openils/conf/opensrf_core.xml

402 cp -b /openils/conf/opensrf.xml.example /openils/conf/opensrf.xml

403 ------------------------------------------------------------------------------

404

405 When you installed OpenSRF, you created four Jabber users on two

406 separate domains and edited the `opensrf_core.xml` file accordingly. Please

407 refer back to the OpenSRF README and, as the *opensrf* Linux account, edit the

408 Evergreen version of the `opensrf_core.xml` file using the same Jabber users

409 and domains as you used while installing and testing OpenSRF.

410

411 === OPTIONAL: Configure Evergreen for OpenSRF+Redis

412

413 If using the Redis variant of OpenSRF, modify /openils/conf/opensrf_core.xml

414 to use the Redis settings instead of the Ejabberd settings.

415

416 Several sections of the file have 2 configuration blocks, one for Ejabberd

417 and one for Redis. Example:

418

419 [source,xml]

420 ------------------------------------------------------------------------------

421

422 <passwd>password</passwd>

423 <port>5222</port>

424

425

426

427 <!--

428 <passwd>456fc340-beba-4489-9070-0d6b49e9952b</passwd>

429 <port>6379</port>

430 -->

431

432 ------------------------------------------------------------------------------

433

434 For each occurrence of such block, commente out the Ejabberd sections

435 and un-comment the Redis sections. Example:

436

437 [source,xml]

438 ------------------------------------------------------------------------------

439

440 <!--

441 <passwd>password</passwd>

442 <port>5222</port>

443 -->

444

445

446

447 <passwd>456fc340-beba-4489-9070-0d6b49e9952b</passwd>

448 <port>6379</port>

449

450 ------------------------------------------------------------------------------

451

452 [NOTE]

453 The `-b` flag tells the `cp` command to create a backup version of the

454 destination file. The backup version of the destination file has a tilde (`~`)

455 appended to the file name, so if you have forgotten the Jabber users and

456 domains, you can retrieve the settings from the backup version of the files.

457

458 `eg_db_config`, described in xref:#creating_the_evergreen_database[Creating the Evergreen database], sets the database connection information in `opensrf.xml` for you.

459

460 === Configure action triggers for the Evergreen application ===

461 _Action Triggers_ provide hooks for the system to perform actions when a given

462 event occurs; for example, to generate reminder or overdue notices, the

463 `checkout.due` hook is processed and events are triggered for potential actions

464 if there is no checkin time.

465

466 To enable the default set of hooks, issue the following command as the

467 *opensrf* Linux account:

468

469 [source, bash]

470 ------------------------------------------------------------------------------

471 cp -b /openils/conf/action_trigger_filters.json.example /openils/conf/action_trigger_filters.json

472 ------------------------------------------------------------------------------

473

474 For more information about configuring and running action triggers, see

475 xref:admin:actiontriggers_process.adoc#processing_action_triggers[Notifications / Action Triggers].

476

477 [[creating_the_evergreen_database]]

478 == Creating the Evergreen database ==

479

480 === Setting up the PostgreSQL server ===

481

482 For production use, most libraries install the PostgreSQL database server on a

483 dedicated machine. Therefore, by default, the `Makefile.install` prerequisite

484 installer does *not* install the PostgreSQL database server that is required

485 by every Evergreen system. You can install the packages required by Debian or

486 Ubuntu on the machine of your choice using the following commands as the

487 *root* Linux account:

488

489 .Installing PostgreSQL server packages

490

491 Each OS build target provides the postgres server installation

492 packages required for each operating system. To install Postgres

493 server packages, use the make target

494 'postgres-server-<OSTYPE>-<POSTGRESVERSION>'. Choose the most

495 appropriate command below based on your operating system and desired

496 PostgreSQL Version.

497

498 The first below will install PostgreSQL 10, the minimum supported

499 version and the version recommended for production use of Evergreen:

500

501 [source, bash]

502 ------------------------------------------------------------------------------

503 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-bookworm-10

504 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-bullseye-10

505 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-buster-10

506 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-focal-10

507 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-jammy-10

508 ------------------------------------------------------------------------------

509

510 [WARNING]

511 =========

512 Evergreen support for PostgreSQL server versions greater than 10 is

513 still exprimental. The use of the following is discouraged in

514 production environments. The following are only recommended if you

515 are willing to test newer PostgreSQL versions for performance and

516 possible bugs.

517 =========

518

519 To install PostgreSQL version 11, use the following command for your operating

520 system:

521

522 [source, bash]

523 ------------------------------------------------------------------------------

524 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-bookworm-11

525 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-bullseye-11

526 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-buster-11

527 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-focal-11

528 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-jammy-11

529 ------------------------------------------------------------------------------

530

531 To install PostgreSQL version 12, use the following command for your operating

532 system:

533

534 [source, bash]

535 ------------------------------------------------------------------------------

536 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-bookworm-12

537 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-bullseye-12

538 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-buster-12

539 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-focal-12

540 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-jammy-12

541 ------------------------------------------------------------------------------

542

543 To install PostgreSQL version 13, use the following command for your operating

544 system:

545

546 [source, bash]

547 ------------------------------------------------------------------------------

548 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-bookworm-13

549 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-bullseye-13

550 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-buster-13

551 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-focal-13

552 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-jammy-13

553 ------------------------------------------------------------------------------

554

555 To install PostgreSQL version 14, use the following command for your operating

556 system:

557

558 [source, bash]

559 ------------------------------------------------------------------------------

560 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-bookworm-14

561 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-bullseye-14

562 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-buster-14

563 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-focal-14

564 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-jammy-14

565 ------------------------------------------------------------------------------

566

567 To install PostgreSQL version 15, use the following command for your operating

568 system:

569

570 [source, bash]

571 ------------------------------------------------------------------------------

572 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-bookworm-15

573 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-bullseye-15

574 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-buster-15

575 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-focal-15

576 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-jammy-15

577 ------------------------------------------------------------------------------

578

579 .Create the Evergreen PostgreSQL user

580

581 You need to create a PostgreSQL superuser to create and access the database.

582 Issue the following command as the *postgres* Linux account to create a new

583 PostgreSQL superuser named `evergreen`. When prompted, enter the new user's

584 password:

585

586 [source, bash]

587 ------------------------------------------------------------------------------

588 createuser -s -P evergreen

589 ------------------------------------------------------------------------------

590

591 .Enabling connections to the PostgreSQL database

592

593 Your PostgreSQL database may be configured by default to prevent connections,

594 for example, it might reject attempts to connect via TCP/IP or from other

595 servers. To enable TCP/IP connections from localhost, check your `pg_hba.conf`

596 file, found in the `/etc/postgresql/` directory on Debian and Ubuntu.

597 A simple way to enable TCP/IP

598 connections from localhost to all databases with password authentication, which

599 would be suitable for a test install of Evergreen on a single server, is to

600 ensure the file contains the following entries _before_ any "host ... ident"

601 entries:

602

603 ------------------------------------------------------------------------------

604 host all all ::1/128 md5

605 host all all 127.0.0.1/32 md5

606 ------------------------------------------------------------------------------

607

608 When you change the `pg_hba.conf` file, you will need to reload PostgreSQL to

609 make the changes take effect. For more information on configuring connectivity

610 to PostgreSQL, see

611 http://www.postgresql.org/docs/devel/static/auth-pg-hba-conf.html

612

613 === Creating the Evergreen database and schema ===

614

615 Once you have created the *evergreen* PostgreSQL account, you also need to

616 create the database and schema, and configure your configuration files to point

617 at the database server. Issue the following command as the *root* Linux account

618 from inside the Evergreen source directory, replacing <user>, <password>,

619 <hostname>, <port>, and <dbname> with the appropriate values for your

620 PostgreSQL database (where <user> and <password> are for the *evergreen*

621 PostgreSQL account you just created), and replace <admin-user> and <admin-pass>

622 with the values you want for the *egadmin* Evergreen administrator account:

623

624 [source, bash]

625 ------------------------------------------------------------------------------

626 perl Open-ILS/src/support-scripts/eg_db_config --update-config \

627 --service all --create-database --create-schema --create-offline \

628 --user <user> --password <password> --hostname <hostname> --port <port> \

629 --database <dbname> --admin-user <admin-user> --admin-pass <admin-pass>

630 ------------------------------------------------------------------------------

631

632 This creates the database and schema and configures all of the services in

633 your `/openils/conf/opensrf.xml` configuration file to point to that database.

634 It also creates the configuration files required by the Evergreen `cgi-bin`

635 administration scripts, and sets the user name and password for the *egadmin*

636 Evergreen administrator account to your requested values.

637

638 You can get a complete set of options for `eg_db_config` by passing the

639 `--help` parameter.

640

641 === Loading sample data ===

642

643 If you add the `--load-all-sample` parameter to the `eg_db_config` command,

644 a set of authority and bibliographic records, call numbers, copies, staff

645 and regular users, and transactions will be loaded into your target

646 database. This sample dataset is commonly referred to as the _concerto_

647 sample data, and can be useful for testing out Evergreen functionality and

648 for creating problem reports that developers can easily recreate with their

649 own copy of the _concerto_ sample data.

650

651 If you don't mind waiting a little longer, you can install the _enhanced_

652 concerto dataset. Use this flag: `--load-concerto-enhanced`. This includes

653 all of the data from _concerto_. Notable differences include:

654

655 . The organization units have friendly names

656 . Acquisitions data

657 . More billing scenarios

658 . More shelving locations and shelving location settings

659 . Authority data

660 . Japanese, Spanish, French and Czech bib records

661 . Metarecord holds

662 . Item Stat Cats

663 . Bookings data

664 . Pre-created OPAC carousels

665 . Serials data

666

667

668 === Creating the database on a remote server ===

669

670 In a production instance of Evergreen, your PostgreSQL server should be

671 installed on a dedicated server.

672

673 To create the database instance on a remote database server, simply

674 use the `--create-database` flag on `eg_db_config`.

675

676 == Starting Evergreen ==

677

678 1. As the *root* Linux account, start the `memcached` and `ejabberd` services

679 (if they aren't already running):

680 +

681 [source, bash]

682 ------------------------------------------------------------------------------

683 /etc/init.d/ejabberd start

684 /etc/init.d/memcached start

685 ------------------------------------------------------------------------------

686 +

687 2. As the *opensrf* Linux account, start Evergreen. The `-l` flag in the

688 following command is only necessary if you want to force Evergreen to treat the

689 hostname as `localhost`; if you configured `opensrf.xml` using the real

690 hostname of your machine as returned by `perl -ENet::Domain 'print

691 Net::Domain::hostfqdn() . "\n";'`, you should not use the `-l` flag.

692 +

693 [source, bash]

694 ------------------------------------------------------------------------------

695 osrf_control -l --start-all

696 ------------------------------------------------------------------------------

697 +

698 ** If you receive the error message `bash: osrf_control: command not found`,

699 then your environment variable `PATH` does not include the `/openils/bin`

700 directory; this should have been set in the *opensrf* Linux account's

701 `.bashrc` configuration file. To manually set the `PATH` variable, edit the

702 configuration file `~/.bashrc` as the *opensrf* Linux account and add the

703 following line:

704 +

705 [source, bash]

706 ------------------------------------------------------------------------------

707 export PATH=$PATH:/openils/bin

708 ------------------------------------------------------------------------------

709 +

710 3. As the *opensrf* Linux account, generate the Web files needed by the web staff

711 client and catalog and update the organization unit proximity (you need to do

712 this the first time you start Evergreen, and after that each time you change the library org unit configuration.

713 ):

714 +

715 [source, bash]

716 ------------------------------------------------------------------------------

717 autogen.sh

718 ------------------------------------------------------------------------------

719 +

720 4. As the *root* Linux account, restart the Apache Web server:

721 +

722 [source, bash]

723 ------------------------------------------------------------------------------

724 /etc/init.d/apache2 restart

725 ------------------------------------------------------------------------------

726 +

727 If the Apache Web server was running when you started the OpenSRF services, you

728 might not be able to successfully log in to the OPAC or web staff client until the

729 Apache Web server is restarted.

730

731 == Testing connections to Evergreen ==

732

733 Once you have installed and started Evergreen, test your connection to

734 Evergreen via `srfsh`. As the *opensrf* Linux account, issue the following

735 commands to start `srfsh` and try to log onto the Evergreen server using the

736 *egadmin* Evergreen administrator user name and password that you set using the

737 `eg_db_config` command:

738

739 [source, bash]

740 ------------------------------------------------------------------------------

741 /openils/bin/srfsh

742 srfsh% login <admin-user> <admin-pass>

743 ------------------------------------------------------------------------------

744

745 You should see a result like:

746

747 Received Data: "250bf1518c7527a03249858687714376"

748 ------------------------------------

749 Request Completed Successfully

750 Request Time in seconds: 0.045286

751 ------------------------------------

752

753 Received Data: {

754 "ilsevent":0,

755 "textcode":"SUCCESS",

756 "desc":" ",

757 "pid":21616,

758 "stacktrace":"oils_auth.c:304",

759 "payload":{

760 "authtoken":"e5f9827cc0f93b503a1cc66bee6bdd1a",

761 "authtime":420

762 }

763

764 }

765

766 ------------------------------------

767 Request Completed Successfully

768 Request Time in seconds: 1.336568

769 ------------------------------------

770 [[install-troubleshooting-1]]

771 If this does not work, it's time to do some troubleshooting.

772

773 * As the *opensrf* Linux account, run the `settings-tester.pl` script to see

774 if it finds any system configuration problems. The script is found at

775 `Open-ILS/src/support-scripts/settings-tester.pl` in the Evergreen source

776 tree.

777 * Follow the steps in the http://evergreen-ils.org/dokuwiki/doku.php?id=troubleshooting:checking_for_errors[troubleshooting guide].

778 * If you have faithfully followed the entire set of installation steps

779 listed here, you are probably extremely close to a working system.

780 Gather your configuration files and log files and contact the

781 http://evergreen-ils.org/communicate/mailing-lists/[Evergreen development

782 mailing list] for assistance before making any drastic changes to your system

783 configuration.

784

785 == Getting help ==

786

787 Need help installing or using Evergreen? Join the mailing lists at

788 http://evergreen-ils.org/communicate/mailing-lists/ or contact us on the Freenode

789 IRC network on the #evergreen channel.

790

791 == License ==

792

793 This work is licensed under the Creative Commons Attribution-ShareAlike 3.0

794 Unported License. To view a copy of this license, visit

795 http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to Creative

796 Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA.