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 Debian Stretch (9),

57 Ubuntu Focal Fossa (20.04),

58 and Ubuntu Bionic Beaver (18.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.2.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.2.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-bullseye`,`debian-buster`,`debian-stretch`,`ubuntu-focal`,

74 or `ubuntu-bionic` 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 --prod

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

183 +

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

185 the necessary browsers are installed:

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

187 `/usr/bin/chromium`:

188 +

189 [source,sh]

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

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

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

193

194 [[install_opac_deps]]

195 === Install OPAC skin dependencies ===

196

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

198 +

199 [source,sh]

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

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

202 ------------------------------------------------------------------------------

203 +

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

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

206 +

207 [source,sh]

208 ------------------------------------------------------------------------------

209 npm install # fetch JS and CSS dependencies

210 ------------------------------------------------------------------------------

211 +

212 Note that there is no build step.

213

214 == Configuration and compilation instructions ==

215

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

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

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

219

220 [source, bash]

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

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

223 make

224 ------------------------------------------------------------------------------

225

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

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

228 can find `osrf_config`.

229

230 == Installation instructions ==

231

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

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

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

235 +

236 [source, bash]

237 ------------------------------------------------------------------------------

238 make install

239 ------------------------------------------------------------------------------

240

241 == Change ownership of the Evergreen files ==

242

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

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

245 change the ownership on the files:

246

247 [source, bash]

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

249 chown -R opensrf:opensrf /openils

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

251

252 == Run ldconfig ==

253

254 On Ubuntu 18.04 / 20.04 or Debian Stretch / Buster / Bullseye, run the

255 following command as the root user:

256

257 [source, bash]

258 ------------------------------------------------------------------------------

259 ldconfig

260 ------------------------------------------------------------------------------

261

262 == Additional Instructions for Developers ==

263

264 [NOTE]

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

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

267

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

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

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

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

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

273

274 [source, bash]

275 ------------------------------------------------------------------------------

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

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

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

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

280

281

282 == Configure the Apache Web server ==

283

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

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

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

287 +

288 [source,bash]

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

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

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

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

293 # Now set up SSL

294 mkdir /etc/apache2/ssl

295 cd /etc/apache2/ssl

296 ------------------------------------------------------------------------------------

297 +

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

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

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

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

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

303 +

304 [source,bash]

305 ------------------------------------------------------------------------------

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

307 ------------------------------------------------------------------------------

308 +

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

310 place.

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

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

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

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

315 . Change the user for the Apache server.

316 * As the *root* Linux account, edit

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

318 `export APACHE_RUN_USER=opensrf`.

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

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

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

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

323 processes and memory.

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

325 a. Change `KeepAliveTimeout` to `1`.

326 b. Change `MaxKeepAliveRequests` to `100`.

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

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

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

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

331 +

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

333 [source,bash]

334 ------------------------------------------------------------------------------

335 <IfModule mpm_prefork_module>

336 StartServers 15

337 MinSpareServers 5

338 MaxSpareServers 15

339 MaxRequestWorkers 75

340 MaxConnectionsPerChild 500

341 </IfModule>

342 ------------------------------------------------------------------------------

343 +

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

345 +

346 [source,bash]

347 ------------------------------------------------------------------------------

348 a2dismod mpm_event

349 a2enmod mpm_prefork

350 ------------------------------------------------------------------------------

351 +

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

353 +

354 [source,bash]

355 ------------------------------------------------------------------------------

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

357 a2ensite eg.conf

358 ------------------------------------------------------------------------------

359 +

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

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

362 is running as the `opensrf` user:

363 +

364 [source,bash]

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

366 chown opensrf /var/lock/apache2

367 ------------------------------------------------------------------------------

368

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

370

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

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

373

374 == Configure OpenSRF for the Evergreen application ==

375

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

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

378 following commands as the *opensrf* Linux account:

379

380 [source, bash]

381 ------------------------------------------------------------------------------

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

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

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

385

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

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

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

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

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

391

392 [NOTE]

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

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

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

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

397

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

399

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

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

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

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

404 if there is no checkin time.

405

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

407 *opensrf* Linux account:

408

409 [source, bash]

410 ------------------------------------------------------------------------------

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

412 ------------------------------------------------------------------------------

413

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

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

416

417 [[creating_the_evergreen_database]]

418 == Creating the Evergreen database ==

419

420 === Setting up the PostgreSQL server ===

421

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

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

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

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

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

427 *root* Linux account:

428

429 . Installing PostgreSQL server packages

430

431 Each OS build target provides the postgres server installation

432 packages required for each operating system. To install Postgres

433 server packages, use the make target

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

435 appropriate command below based on your operating system and desired

436 PostgreSQL Version.

437

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

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

440

441 [source, bash]

442 ------------------------------------------------------------------------------

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

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

445 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-stretch-10

446 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-bionic-10

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

448 ------------------------------------------------------------------------------

449

450 [WARNING]

451 =========

452 Evergreen support for PostgreSQL server versions greater than 10 is

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

454 production environments. The following are only recommended if you

455 are willing to test newer PostgreSQL versions for performance and

456 possible bugs.

457 =========

458

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

460 system:

461

462 [source, bash]

463 ------------------------------------------------------------------------------

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

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

466 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-stretch-11

467 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-bionic-11

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

469 ------------------------------------------------------------------------------

470

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

472 system:

473

474 [source, bash]

475 ------------------------------------------------------------------------------

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

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

478 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-stretch-12

479 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-bionic-12

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

481 ------------------------------------------------------------------------------

482

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

484 system:

485

486 [source, bash]

487 ------------------------------------------------------------------------------

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

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

490 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-stretch-13

491 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-bionic-13

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

493 ------------------------------------------------------------------------------

494

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

496 system:

497

498 [source, bash]

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

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

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

502 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-stretch-14

503 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-bionic-14

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

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

506

507 For a standalone PostgreSQL server, install the following Perl modules for your

508 distribution as the *root* Linux account:

509

510 .(Debian and Ubuntu)

511 No extra modules required for these distributions.

512

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

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

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

516 password:

517

518 [source, bash]

519 ------------------------------------------------------------------------------

520 createuser -s -P evergreen

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

522

523 .Enabling connections to the PostgreSQL database

524

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

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

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

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

529 A simple way to enable TCP/IP

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

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

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

533 entries:

534

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

536 host all all ::1/128 md5

537 host all all 127.0.0.1/32 md5

538 ------------------------------------------------------------------------------

539

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

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

542 to PostgreSQL, see

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

544

545 === Creating the Evergreen database and schema ===

546

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

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

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

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

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

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

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

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

555

556 [source, bash]

557 ------------------------------------------------------------------------------

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

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

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

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

562 ------------------------------------------------------------------------------

563

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

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

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

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

568 Evergreen administrator account to your requested values.

569

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

571 `--help` parameter.

572

573 === Loading sample data ===

574

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

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

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

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

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

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

581 own copy of the _concerto_ sample data.

582

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

584

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

586 installed on a dedicated server.

587

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

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

590

591 == Starting Evergreen ==

592

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

594 (if they aren't already running):

595 +

596 [source, bash]

597 ------------------------------------------------------------------------------

598 /etc/init.d/ejabberd start

599 /etc/init.d/memcached start

600 ------------------------------------------------------------------------------

601 +

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

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

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

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

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

607 +

608 [source, bash]

609 ------------------------------------------------------------------------------

610 osrf_control -l --start-all

611 ------------------------------------------------------------------------------

612 +

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

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

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

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

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

618 following line:

619 +

620 [source, bash]

621 ------------------------------------------------------------------------------

622 export PATH=$PATH:/openils/bin

623 ------------------------------------------------------------------------------

624 +

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

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

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

628 ):

629 +

630 [source, bash]

631 ------------------------------------------------------------------------------

632 autogen.sh

633 ------------------------------------------------------------------------------

634 +

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

636 +

637 [source, bash]

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

639 /etc/init.d/apache2 restart

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

641 +

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

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

644 Apache Web server is restarted.

645

646 == Testing connections to Evergreen ==

647

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

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

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

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

652 `eg_db_config` command:

653

654 [source, bash]

655 ------------------------------------------------------------------------------

656 /openils/bin/srfsh

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

658 ------------------------------------------------------------------------------

659

660 You should see a result like:

661

662 Received Data: "250bf1518c7527a03249858687714376"

663 ------------------------------------

664 Request Completed Successfully

665 Request Time in seconds: 0.045286

666 ------------------------------------

667

668 Received Data: {

669 "ilsevent":0,

670 "textcode":"SUCCESS",

671 "desc":" ",

672 "pid":21616,

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

674 "payload":{

675 "authtoken":"e5f9827cc0f93b503a1cc66bee6bdd1a",

676 "authtime":420

677 }

678

679 }

680

681 ------------------------------------

682 Request Completed Successfully

683 Request Time in seconds: 1.336568

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

685 [[install-troubleshooting-1]]

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

687

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

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

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

691 tree.

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

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

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

695 Gather your configuration files and log files and contact the

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

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

698 configuration.

699

700 == Getting help ==

701

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

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

704 IRC network on the #evergreen channel.

705

706 == License ==

707

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

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

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

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