git.evergreen-ils.org Git - 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 Bullseye (11),

55 Debian Buster (10),

56 Ubuntu Jammy Jellyfish (22.04),

57 and Ubuntu Focal Fossa (20.04).

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

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

60 distributions, visit the Debian or Ubuntu websites.

61 * **OpenSRF**: The minimum supported version of OpenSRF is 3.2.0.

62

63

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

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

66

67 1. Begin by installing the most recent version of OpenSRF (3.2.0 or later).

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

69 +

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

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

72 substituting `debian-bullseye`,`debian-buster`,`ubuntu-jammy`,

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

74 +

75 [source, bash]

76 ------------------------------------------------------------------------------

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

78 ------------------------------------------------------------------------------

79 +

80 [[optional_developer_additions]]

81 3. OPTIONAL: Developer additions

82 +

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

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

85 +

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

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

88 this is only needed for building and installing the web

89 staff client.

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

91 install Firefox and your choice of Chromium or Chrome.

92 +

93 [source, bash]

94 ------------------------------------------------------------------------------

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

96 ------------------------------------------------------------------------------

97 +

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

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

100 +

101 [source, bash]

102 ------------------------------------------------------------------------------

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

104 ------------------------------------------------------------------------------

105 +

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

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

108 +

109 [source, bash]

110 ------------------------------------------------------------------------------

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

112 ------------------------------------------------------------------------------

113

114 == Extra steps for web staff client ==

115

116 [NOTE]

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

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

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

120

121 [[install_files_for_web_staff_client]]

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

123

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

125 the staff JS web root:

126 +

127 [source,sh]

128 ------------------------------------------------------------------------------

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

130 ------------------------------------------------------------------------------

131 +

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

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

134 +

135 [source,sh]

136 ------------------------------------------------------------------------------

137 npm install # fetch JS dependencies

138 ------------------------------------------------------------------------------

139 +

140 3. Run the build script.

141 +

142 [source,sh]

143 ------------------------------------------------------------------------------

144 npm run build-prod

145 ------------------------------------------------------------------------------

146 +

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

148 the necessary browsers are installed.

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

150 `/usr/bin/chromium`:

151 +

152 [source,sh]

153 ------------------------------------------------------------------------------

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

155 ------------------------------------------------------------------------------

156

157 [[install_files_for_angular_web_staff_client]]

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

159

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

161 the Angular staff root:

162 +

163 [source,sh]

164 ------------------------------------------------------------------------------

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

166 ------------------------------------------------------------------------------

167 +

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

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

170 +

171 [source,sh]

172 ------------------------------------------------------------------------------

173 npm install # fetch JS dependencies

174 ------------------------------------------------------------------------------

175 +

176 3. Run the build script.

177 +

178 [source,sh]

179 ------------------------------------------------------------------------------

180 ng build --configuration=production

181 ------------------------------------------------------------------------------

182 +

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

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

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

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

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

188 +

189 [source,sh]

190 ------------------------------------------------------------------------------

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

192 ------------------------------------------------------------------------------

193 +

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

195 the necessary browsers are installed:

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

197 `/usr/bin/chromium`:

198 +

199 [source,sh]

200 ------------------------------------------------------------------------------

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

202 MOZ_HEADLESS=1 ng e2e

203 ------------------------------------------------------------------------------

204

205 [[install_opac_deps]]

206 === Install OPAC skin dependencies ===

207

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

209 +

210 [source,sh]

211 ------------------------------------------------------------------------------

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

213 ------------------------------------------------------------------------------

214 +

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

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

217 +

218 [source,sh]

219 ------------------------------------------------------------------------------

220 npm install # fetch JS and CSS dependencies

221 ------------------------------------------------------------------------------

222 +

223 Note that there is no build step.

224

225 == Configuration and compilation instructions ==

226

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

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

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

230

231 [source, bash]

232 ------------------------------------------------------------------------------

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

234 make

235 ------------------------------------------------------------------------------

236

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

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

239 can find `osrf_config`.

240

241 == Installation instructions ==

242

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

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

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

246 +

247 [source, bash]

248 ------------------------------------------------------------------------------

249 make install

250 ------------------------------------------------------------------------------

251

252 == Change ownership of the Evergreen files ==

253

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

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

256 change the ownership on the files:

257

258 [source, bash]

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

260 chown -R opensrf:opensrf /openils

261 ------------------------------------------------------------------------------

262

263 == Run ldconfig ==

264

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

266

267 [source, bash]

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

269 ldconfig

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

271

272 == Additional Instructions for Developers ==

273

274 [NOTE]

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

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

277

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

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

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

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

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

283

284 [source, bash]

285 ------------------------------------------------------------------------------

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

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

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

289 ------------------------------------------------------------------------------

290

291

292 == Configure the Apache Web server ==

293

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

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

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

297 +

298 [source,bash]

299 ------------------------------------------------------------------------------------

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

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

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

303 # Now set up SSL

304 mkdir /etc/apache2/ssl

305 cd /etc/apache2/ssl

306 ------------------------------------------------------------------------------------

307 +

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

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

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

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

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

313 +

314 [source,bash]

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

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

317 ------------------------------------------------------------------------------

318 +

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

320 place.

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

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

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

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

325 . Change the user for the Apache server.

326 * As the *root* Linux account, edit

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

328 `export APACHE_RUN_USER=opensrf`.

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

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

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

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

333 processes and memory.

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

335 a. Change `KeepAliveTimeout` to `1`.

336 b. Change `MaxKeepAliveRequests` to `100`.

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

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

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

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

341 +

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

343 [source,bash]

344 ------------------------------------------------------------------------------

345 <IfModule mpm_prefork_module>

346 StartServers 15

347 MinSpareServers 5

348 MaxSpareServers 15

349 MaxRequestWorkers 75

350 MaxConnectionsPerChild 500

351 </IfModule>

352 ------------------------------------------------------------------------------

353 +

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

355 +

356 [source,bash]

357 ------------------------------------------------------------------------------

358 a2dismod mpm_event

359 a2enmod mpm_prefork

360 ------------------------------------------------------------------------------

361 +

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

363 +

364 [source,bash]

365 ------------------------------------------------------------------------------

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

367 a2ensite eg.conf

368 ------------------------------------------------------------------------------

369 +

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

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

372 is running as the `opensrf` user:

373 +

374 [source,bash]

375 ------------------------------------------------------------------------------

376 chown opensrf /var/lock/apache2

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

378

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

380

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

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

383

384 == Configure OpenSRF for the Evergreen application ==

385

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

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

388 following commands as the *opensrf* Linux account:

389

390 [source, bash]

391 ------------------------------------------------------------------------------

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

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

394 ------------------------------------------------------------------------------

395

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

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

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

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

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

401

402 [NOTE]

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

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

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

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

407

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

409

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

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

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

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

414 if there is no checkin time.

415

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

417 *opensrf* Linux account:

418

419 [source, bash]

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

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

422 ------------------------------------------------------------------------------

423

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

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

426

427 [[creating_the_evergreen_database]]

428 == Creating the Evergreen database ==

429

430 === Setting up the PostgreSQL server ===

431

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

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

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

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

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

437 *root* Linux account:

438

439 .Installing PostgreSQL server packages

440

441 Each OS build target provides the postgres server installation

442 packages required for each operating system. To install Postgres

443 server packages, use the make target

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

445 appropriate command below based on your operating system and desired

446 PostgreSQL Version.

447

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

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

450

451 [source, bash]

452 ------------------------------------------------------------------------------

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

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

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

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

457 ------------------------------------------------------------------------------

458

459 [WARNING]

460 =========

461 Evergreen support for PostgreSQL server versions greater than 10 is

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

463 production environments. The following are only recommended if you

464 are willing to test newer PostgreSQL versions for performance and

465 possible bugs.

466 =========

467

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

469 system:

470

471 [source, bash]

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

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

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

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

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

477 ------------------------------------------------------------------------------

478

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

480 system:

481

482 [source, bash]

483 ------------------------------------------------------------------------------

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

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

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

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

488 ------------------------------------------------------------------------------

489

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

491 system:

492

493 [source, bash]

494 ------------------------------------------------------------------------------

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

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

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

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

499 ------------------------------------------------------------------------------

500

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

502 system:

503

504 [source, bash]

505 ------------------------------------------------------------------------------

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

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

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

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

510 ------------------------------------------------------------------------------

511

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

513 system:

514

515 [source, bash]

516 ------------------------------------------------------------------------------

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

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

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

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

521 ------------------------------------------------------------------------------

522

523 .Create the Evergreen PostgreSQL user

524

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

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

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

528 password:

529

530 [source, bash]

531 ------------------------------------------------------------------------------

532 createuser -s -P evergreen

533 ------------------------------------------------------------------------------

534

535 .Enabling connections to the PostgreSQL database

536

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

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

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

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

541 A simple way to enable TCP/IP

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

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

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

545 entries:

546

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

548 host all all ::1/128 md5

549 host all all 127.0.0.1/32 md5

550 ------------------------------------------------------------------------------

551

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

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

554 to PostgreSQL, see

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

556

557 === Creating the Evergreen database and schema ===

558

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

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

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

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

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

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

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

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

567

568 [source, bash]

569 ------------------------------------------------------------------------------

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

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

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

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

574 ------------------------------------------------------------------------------

575

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

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

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

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

580 Evergreen administrator account to your requested values.

581

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

583 `--help` parameter.

584

585 === Loading sample data ===

586

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

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

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

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

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

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

593 own copy of the _concerto_ sample data.

594

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

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

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

598

599 . The organization units have friendly names

600 . Acquisitions data

601 . More billing scenarios

602 . More shelving locations and shelving location settings

603 . Authority data

604 . Japanese, Spanish, French and Czech bib records

605 . Metarecord holds

606 . Item Stat Cats

607 . Bookings data

608 . Pre-created OPAC carousels

609 . Serials data

610

611

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

613

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

615 installed on a dedicated server.

616

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

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

619

620 == Starting Evergreen ==

621

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

623 (if they aren't already running):

624 +

625 [source, bash]

626 ------------------------------------------------------------------------------

627 /etc/init.d/ejabberd start

628 /etc/init.d/memcached start

629 ------------------------------------------------------------------------------

630 +

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

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

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

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

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

636 +

637 [source, bash]

638 ------------------------------------------------------------------------------

639 osrf_control -l --start-all

640 ------------------------------------------------------------------------------

641 +

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

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

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

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

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

647 following line:

648 +

649 [source, bash]

650 ------------------------------------------------------------------------------

651 export PATH=$PATH:/openils/bin

652 ------------------------------------------------------------------------------

653 +

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

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

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

657 ):

658 +

659 [source, bash]

660 ------------------------------------------------------------------------------

661 autogen.sh

662 ------------------------------------------------------------------------------

663 +

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

665 +

666 [source, bash]

667 ------------------------------------------------------------------------------

668 /etc/init.d/apache2 restart

669 ------------------------------------------------------------------------------

670 +

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

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

673 Apache Web server is restarted.

674

675 == Testing connections to Evergreen ==

676

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

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

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

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

681 `eg_db_config` command:

682

683 [source, bash]

684 ------------------------------------------------------------------------------

685 /openils/bin/srfsh

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

687 ------------------------------------------------------------------------------

688

689 You should see a result like:

690

691 Received Data: "250bf1518c7527a03249858687714376"

692 ------------------------------------

693 Request Completed Successfully

694 Request Time in seconds: 0.045286

695 ------------------------------------

696

697 Received Data: {

698 "ilsevent":0,

699 "textcode":"SUCCESS",

700 "desc":" ",

701 "pid":21616,

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

703 "payload":{

704 "authtoken":"e5f9827cc0f93b503a1cc66bee6bdd1a",

705 "authtime":420

706 }

707

708 }

709

710 ------------------------------------

711 Request Completed Successfully

712 Request Time in seconds: 1.336568

713 ------------------------------------

714 [[install-troubleshooting-1]]

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

716

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

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

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

720 tree.

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

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

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

724 Gather your configuration files and log files and contact the

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

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

727 configuration.

728

729 == Getting help ==

730

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

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

733 IRC network on the #evergreen channel.

734

735 == License ==

736

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

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

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

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