git.evergreen-ils.org Git - working/OpenSRF.git/blob

1 Installing OpenSRF

2 ==================

4 Preamble: referenced user accounts

5 ----------------------------------

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

8 follows:

10 * Linux user accounts:

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

12 Linux system as a regular user.

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

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

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

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

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

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

19 ** The *opensrf* Linux account is an account that you will create as part

20 of installing OpenSRF. You can switch to this account from the *root*

21 account by issuing the `su - opensrf` command.

23 Download and unpack the code

24 ----------------------------

26 Issue the following commands as the *user* Linux account.

28 1. Acquire a stable release tarball from https://evergreen-ils.org/opensrf-downloads/

29 +

30 [source, bash]

31 ------------------------------------------------------------------------------

32 wget https://evergreen-ils.org/downloads/opensrf-OSRFVERSION.tar.gz

33 ------------------------------------------------------------------------------

34 +

35 [NOTE]

36 Developers can find the full source code at the OpenSRF Git repository:

37 http://git.evergreen-ils.org/?p=OpenSRF.git

38 +

39 2. Unpack the tarball, and move into that directory:

40 +

41 [source, bash]

42 ------------------------------------------------------------------------------

43 tar -xvf opensrf-OSRFVERSION.tar.gz

44 cd opensrf-OSRFVERSION/

45 ------------------------------------------------------------------------------

47 Installing prerequisites

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

50 OpenSRF has a number of prerequisite packages that must be installed

51 before you can successfully configure, compile, and install OpenSRF.

52 On Debian and Ubuntu, the easiest way to install these prerequisites

53 is to use the Makefile.install prerequisite installer.

55 Issue the following commands as the *root* Linux account to install

56 prerequisites using the Makefile.install prerequisite installer, substituting

57 your operating system identifier for <osname> below:

59 [source, bash]

60 ---------------------------------------------------------------------------

61 apt-get install make

62 make -f src/extras/Makefile.install <osname>

63 ---------------------------------------------------------------------------

65 Well-tested values for <osname> include:

67 * `debian-buster` for Debian 10

68 * `debian-stretch` for Debian 9

69 * `debian-jessie` for Debian 8

70 * `ubuntu-xenial` for Ubuntu 16.04

71 * `ubuntu-bionic` for Ubuntu 18.04

73 Patches and suggestions for improvement from users of these distributions,

74 or others, are welcome!

76 When the prerequisite installer reaches the Perl module stage, you may

77 be prompted for configuration of Comprehensive Perl Archive Network (CPAN)

78 on your server. You can generally accept the defaults by pressing <return>

79 for all of the prompts, except for the country configuration.

81 Preamble: Developer instructions

82 --------------------------------

84 [NOTE]

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

86 from https://evergreen-ils.org/opensrf-downloads/

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

89 rather than an official release tarball, must install some extra packages

90 and perform one step before they can proceed with the `./configure` step.

92 As the *root* Linux account, install the following packages:

94 * autoconf

95 * automake

96 * libtool

98 As the *user* Linux account, issue the following command in the OpenSRF

99 source directory to generate the configure script and Makefiles:

100

101 [source, bash]

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

103 autoreconf -i

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

105

106 Configuration and compilation instructions

107 ------------------------------------------

108

109 Use the `configure` command to configure OpenSRF, and the `make` command to

110 build OpenSRF. The default installation prefix (PREFIX) for OpenSRF is

111 `/opensrf/`.

112

113 If you are building OpenSRF for Evergreen, issue the following commands as

114 the *user* Linux account to configure and build OpenSRF:

115

116 [source, bash]

117 ---------------------------------------------------------------------------

118 ./configure --prefix=/openils --sysconfdir=/openils/conf

119 make

120 ---------------------------------------------------------------------------

121

122 By default, OpenSRF includes C, Perl, and JavaScript support.

123 You can add the `--enable-python` option to the configure command

124 to build Python support and `--enable-java` for Java support.

125

126 If you are planning on proxying WebSockets traffic (see below), you

127 can add `--with-websockets-port=443` to specify that WebSockets traffic

128 will be going through port 443. Without that option, the default port

129 is 7682.

130

131 Installation instructions

132 -------------------------

133

134 1. Once you have configured and compiled OpenSRF, issue the following

135 command as the *root* Linux account to install OpenSRF:

136 +

137 [source, bash]

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

139 make install

140 ---------------------------------------------------------------------------

141

142 Create and set up the opensrf Unix user environment

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

144

145 This user is used to start and stop all OpenSRF processes, and must own all

146 files contained in the PREFIX directory hierarchy. Issue the following

147 commands as the *root* Linux account to create the `opensrf` user and set up

148 its environment, substituting <PREFIX> with the value you passed to `--prefix`

149 in your configure command:

150

151 .Creating the `opensrf` user

152 [source, bash]

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

154 useradd -m -s /bin/bash opensrf

155 echo "export PATH=\$PATH:/<PREFIX>/bin" >> /home/opensrf/.bashrc

156 passwd opensrf

157 chown -R opensrf:opensrf /<PREFIX>

158 ---------------------------------------------------------------------------

159

160 Define your public and private OpenSRF domains

161 ----------------------------------------------

162

163 For security purposes, OpenSRF uses Jabber domains to separate services

164 into public and private realms. Throughout these instructions, we will use

165 the example domains `public.localhost` and `private.localhost`.

166

167 On a single-server system, the easiest way to define public and private

168 domains is to define separate hostnames by adding entries to the `/etc/hosts`

169 file. Here are entries that you could add to a stock `/etc/hosts` file for our

170 example domains:

171

172 .Example added entries for `/etc/hosts`

173 [source, bash]

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

175 127.0.1.2 public.localhost public

176 127.0.1.3 private.localhost private

177 ---------------------------------------------------------------------------

178

179 Adjust the system dynamic library path

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

181

182 Add `<PREFIX>/lib/` to the system's dynamic library path, and then run

183 `ldconfig` as the *root* Linux account.

184

185 On Debian and Ubuntu systems, run the following commands as the *root*

186 Linux account:

187

188 .Adjusting the system dynamic library path

189 [source, bash]

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

191 echo <PREFIX>/lib > /etc/ld.so.conf.d/opensrf.conf

192 ldconfig

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

194

195 On most other systems, you can add these entries to `/etc/ld.so.conf`, or

196 create a file within the `/etc/ld.so.conf.d/` directory, and then run

197 `ldconfig` as the *root* Linux account.

198

199 Configure the ejabberd server

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

201

202 OpenSRF requires an XMPP (Jabber) server. For performance reasons, ejabberd is

203 the Jabber server of choice for the OpenSRF project. In most cases, you only

204 have to make a few changes to the default configuration file to make ejabberd

205 work for OpenSRF.

206

207 1. Stop ejabberd before making any changes to its configuration by issuing the

208 following command as the *root* Linux account:

209 +

210 .(Debian / Ubuntu Xenial / Ubuntu Bionic) Stopping ejabberd

211 [source, bash]

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

213 systemctl stop ejabberd.service

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

215 +

216 2. Edit the ejabberd config file.

217 +

218 (Debian Jessie) Ejabberd 13.x and 14.x::

219 Open `/etc/ejabberd/ejabberd.yml` and make the following

220 changes:

221 a. Define your public and private domains in the `hosts` directive. For

222 example:

223 +

224 [source, bash]

225 ---------------------------------------------------------------------------

226 hosts:

227 - "localhost"

228 - "private.localhost"

229 - "public.localhost"

230 ---------------------------------------------------------------------------

231 +

232 b. Change `shaper:` `normal` and `fast` values to 500000

233 c. Increase the `max_user_sessions:` `all:` value to 10000

234 d. Comment out the `mod_offline` directive

235 +

236 -----------------------

237 ##mod_offline:

238 ##access_max_user_messages: max_user_offline_messages

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

240 +

241 (Debian Stretch / Ubuntu Xenial) Ejabberd 16.x::

242 Open `/etc/ejabberd/ejabberd.yml` and make the following

243 changes:

244 a. Define your public and private domains in the `hosts` directive. For

245 example:

246 +

247 [source, bash]

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

249 hosts:

250 - "localhost"

251 - "private.localhost"

252 - "public.localhost"

253 ---------------------------------------------------------------------------

254 +

255 b. Change `auth_password_format` to plain

256 c. Change `shaper:` `normal` and `fast` values to 500000

257 d. Increase the `max_user_sessions:` `all:` value to 10000

258 e. Comment out the `mod_offline` directive

259 +

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

261 ##mod_offline:

262 ##access_max_user_messages: max_user_offline_messages

263 -----------------------

264 +

265 (Debian Buster / Ubuntu Bionic) Ejabberd 18.x::

266 Open `/etc/ejabberd/ejabberd.yml` and make the following

267 changes:

268 a. Define your public and private domains in the `hosts` directive. For

269 example:

270 +

271 [source, bash]

272 ---------------------------------------------------------------------------

273 hosts:

274 - "localhost"

275 - "private.localhost"

276 - "public.localhost"

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

278 +

279 b. Change `starttls_required` to false

280 c. Change `auth_password_format` to plain

281 d. Change `shaper:` `normal` and `fast` values to 500000

282 e. Increase the `max_user_sessions:` `all:` value to 10000

283 f. Comment out the `mod_offline` directive

284 +

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

286 ##mod_offline:

287 ##access_max_user_messages: max_user_offline_messages

288 -----------------------

289 +

290 g. Uncomment or add the `mod_legacy_auth` directive

291 +

292 -----------------------

293 mod_legacy_auth: {}

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

295 +

296 3. Restart the ejabberd server to make the changes take effect:

297 +

298 .(Debian / Ubuntu Xenial / Ubuntu Bionic) Starting ejabberd

299 [source, bash]

300 ---------------------------------------------------------------------------

301 systemctl start ejabberd.service

302 ---------------------------------------------------------------------------

303

304 Create the OpenSRF Jabber users

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

306

307 On each domain, you need two Jabber users to manage the OpenSRF communications:

308

309 * a `router` user, to whom all requests to connect to an OpenSRF service

310 will be routed; this Jabber user must be named `router`

311 * an `opensrf` user, which clients use to connect to OpenSRF services; this

312 user can be named anything you like

313

314 Create the Jabber users by issuing the following commands as the *root* Linux

315 account. Substitute `<password>` for your chosen passwords for each user

316 respectively:

317

318 .Creating the OpenSRF Jabber users

319 [source, bash]

320 ---------------------------------------------------------------------------

321 ejabberdctl register router private.localhost <password>

322 ejabberdctl register opensrf private.localhost <password>

323 ejabberdctl register router public.localhost <password>

324 ejabberdctl register opensrf public.localhost <password>

325 ---------------------------------------------------------------------------

326

327 Update the OpenSRF configuration files

328 --------------------------------------

329

330 About the OpenSRF configuration files

331 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

332 There are several configuration files that you must update to make OpenSRF

333 work. SYSCONFDIR is `/opensrf/etc` by default, or the value that you passed to

334 `--sysconfdir` during the configuration phase.

335

336 * `SYSCONFDIR/opensrf.xml` - this file lists the services that this

337 OpenSRF installation supports; if you create a new OpenSRF service,

338 you need to add it to this file.

339 ** The `<hosts>` element at the bottom of the file lists the services

340 that should be started for each hostname. You can force the system

341 to use `localhost`, so in most cases you will leave this section

342 as-is.

343

344 * `SYSCONFDIR/opensrf_core.xml` - this file lists the Jabber connection

345 information that will be used for the system, as well as determining

346 logging verbosity and defining which services will be exposed on the

347 HTTP gateway.

348

349 * `~/.srfsh.xml` - this file gives a Linux account the ability to use

350 the `srfsh` interpreter to communicate with OpenSRF services.

351

352 Updating the OpenSRF configuration files

353 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

354 1. As the *opensrf* Linux account, copy the example configuration files

355 to create your locally customizable OpenSRF configuration files:

356 +

357 .Copying the example OpenSRF configuration files

358 [source, bash]

359 ---------------------------------------------------------------------------

360 cd SYSCONFDIR

361 cp opensrf_core.xml.example opensrf_core.xml

362 cp opensrf.xml.example opensrf.xml

363 ---------------------------------------------------------------------------

364 +

365 2. Edit the `SYSCONFDIR/opensrf_core.xml` file to update the four username

366 / password pairs to match the Jabber user accounts you just created:

367

368 a. `<config><opensrf>` = use the private Jabber `opensrf` user

369 b. `<config><gateway>` = use the public Jabber `opensrf` user

370 c. `<config><routers><router>` = use the public Jabber `router` user

371 d. `<config><routers><router>` = use the private Jabber `router` user

372 3. Create a `.srfsh.xml` file in the home directory of each user

373 that you want to use `srfsh` to communicate with OpenSRF services. For

374 example, to enable the *opensrf* Linux account to use `srfsh`:

375 a. `cp SYSCONFDIR/srfsh.xml.example ~/.srfsh.xml`

376 b. Open `~/.srfsh.xml` in your text editor of choice and update the

377 password to match the password you set for the Jabber `opensrf` user

378 at the `private.localhost` domain.

379

380 Starting and stopping OpenSRF services

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

382

383 To start all OpenSRF services with a hostname of `localhost`, issue the

384 following command as the *opensrf* Linux account:

385

386 [source, bash]

387 ---------------------------------------------------------------------------

388 osrf_control --localhost --start-all

389 ---------------------------------------------------------------------------

390

391 To stop all OpenSRF services with a hostname of `localhost`, issue the

392 following command as the *opensrf* Linux account:

393

394 [source, bash]

395 ---------------------------------------------------------------------------

396 osrf_control --localhost --stop-all

397 ---------------------------------------------------------------------------

398

399 Testing the default OpenSRF services

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

401

402 By default, OpenSRF ships with an `opensrf.math` service that performs basic

403 calculations involving two integers. Once you have started the OpenSRF

404 services, test the services as follows:

405

406 1. Start the `srfsh` interactive OpenSRF shell by issuing the following

407 command as the *opensrf* Linux account:

408 +

409 .Starting the `srfsh` interactive OpenSRF shell

410 [source, bash]

411 ---------------------------------------------------------------------------

412 srfsh

413 ---------------------------------------------------------------------------

414 +

415 2. Issue the following request to test the `opensrf.math` service:

416 +

417 [source, bash]

418 ---------------------------------------------------------------------------

419 srfsh# request opensrf.math add 2,2

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

421 +

422 You should receive the value `4`.

423

424 Websockets installation instructions: Option #1 Apache

425 -------------------------------------------------------

426 Websockets are new to OpenSRF 2.4+ and are required for operating the new web-based

427 staff client for Evergreen. Complete the following steps as the *root* Linux

428 account:

429

430 1. Install git if not already present:

431 +

432 [source, bash]

433 ---------------------------------------------------------------------------

434 apt-get install git-core

435 ---------------------------------------------------------------------------

436 +

437 2. Install the apache-websocket module:

438 +

439 [source, bash]

440 ---------------------------------------------------------------------------

441 # Use a temporary directory

442 cd /tmp

443 git clone https://github.com/disconnect/apache-websocket

444 cd apache-websocket

445 apxs2 -i -a -c mod_websocket.c

446 ---------------------------------------------------------------------------

447 +

448 3. Create the websocket Apache instance (more information about this in

449 `/usr/share/doc/apache2/README.multiple-instances`)

450 +

451 [source, bash]

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

453 sh /usr/share/doc/apache2/examples/setup-instance websockets

454 ---------------------------------------------------------------------------

455 +

456 4. Remove from the main apache instance

457 +

458 [source, bash]

459 ---------------------------------------------------------------------------

460 a2dismod websocket

461 ---------------------------------------------------------------------------

462 +

463 5. Change to the directory into which you unpacked OpenSRF, then copy into

464 place the config files

465 +

466 [source, bash]

467 ---------------------------------------------------------------------------

468 cd /path/to/opensrf-OSRFVERSION

469 cp examples/apache_24/websockets/apache2.conf /etc/apache2-websockets/

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

471 +

472 6. OPTIONAL: add these configuration variables to `/etc/apache2-websockets/envvars`

473 and adjust as needed.

474 +

475 [source, bash]

476 ---------------------------------------------------------------------------

477 export OSRF_WEBSOCKET_IDLE_TIMEOUT=120

478 export OSRF_WEBSOCKET_IDLE_CHECK_INTERVAL=5

479 export OSRF_WEBSOCKET_CONFIG_FILE=/openils/conf/opensrf_core.xml

480 export OSRF_WEBSOCKET_CONFIG_CTXT=gateway

481 export OSRF_WEBSOCKET_MAX_REQUEST_WAIT_TIME=600

482 ---------------------------------------------------------------------------

483 +

484 * `IDLE_TIMEOUT` specifies how long we will allow a client to stay connected

485 while idle. A longer timeout means less network traffic (from fewer

486 websocket CONNECT calls), but it also means more Apache processes are

487 tied up doing nothing.

488 * `IDLE_CHECK_INTERVAL` specifies how often we wake to check the idle status

489 of the connected client.

490 * `MAX_REQUEST_WAIT_TIME` is the maximum amount of time the gateway will

491 wait before declaring a client as idle when there is a long-running

492 outstanding request, yet no other activity is occurring. This is

493 primarily a fail-safe to allow idle timeouts when one or more requests

494 died on the server, and thus no response was ever delivered to the gateway.

495 * `CONFIG_FILE / CTXT` are the standard opensrf core config options.

496

497 7. Before you can start websockets, you must install a valid SSL certificate

498 in `/etc/apache2/ssl/`. It is possible, but not recommended, to generate a

499 self-signed SSL certificate. For example, if you need to test with a self-signed

500 certicate on Chrome or Chromimum browsers, one workaround is to start the browser

501 with `--ignore-certificate-errors`.

502

503 8. After OpenSRF is up and running (or after any re-install),

504 fire up the secondary Apache instance. Errors will appear in

505 `/var/log/apache2-websockets/error.log`. Start apache2-websockets with:

506 +

507 [source, bash]

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

509 /etc/init.d/apache2-websockets start

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

511

512 Websockets installation instructions: Option #2 Websocketd

513 ----------------------------------------------------------

514

515 1. Install websocketd (latest stable release from http://websocketd.com/)

516 +

517 .(Debian, Ubuntu)

518 [source,bash]

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

520 cd /tmp

521 wget 'https://github.com/joewalnes/websocketd/releases/download/v0.3.0/websocketd-0.3.0-linux_amd64.zip'

522 unzip websocketd-0.3.0-linux_amd64.zip

523 sudo cp websocketd /usr/local/bin/

524 ---------------------------------------------------------------------------

525 +

526 2. Run websocketd

527 +

528 Choose option a or b, below.

529 +

530 a. Run websocketd as 'opensrf'

531 +

532 [NOTE]

533 ===========================================================================

534 This choice requires one of the proxy configurations mentioned below.

535 ===========================================================================

536 +

537 .(Debian, Ubuntu)

538 [source,bash]

539 ---------------------------------------------------------------------------

540 /usr/local/bin/websocketd --port 7682 /openils/bin/osrf-websocket-stdio &

541

542 # Other useful command line parameters include:

544 # --maxforks <n>

545 # --sameorigin=true

546 # --origin=host[:port][,host[:port]...]

547

548 # See https://github.com/joewalnes/websocketd/blob/master/help.go

549 ---------------------------------------------------------------------------

550 +

551 b. Run websocketd without a proxy

552 +

553 .(Debian, Ubuntu)

554 [source,bash]

555 ---------------------------------------------------------------------------

556 sudo -b /usr/local/bin/websocketd --port 7682 --ssl --sslcert=/etc/apache2/ssl/server.crt \

557 --sslkey=/etc/apache2/ssl/server.key /openils/bin/osrf-websocket-stdio

558 ---------------------------------------------------------------------------

559

560 Optional: Using a web proxy (Apache 2.4 and above)

561 --------------------------------------------------

562 When the OpenSRF HTTP Translator runs behind a proxy, Apache must be

563 configured to read the IP address of the originating client instead

564 of the proxy IP address.

565

566 1. Enable mod_remoteip

567 +

568 [source,bash]

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

570 sudo a2enmod remoteip

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

572 +

573 2. Enable remote IP settings by uncommenting and modifying as needed the

574 Apache configuration variables starting with RemoteIP* in the sample Apache

575 configuration file opensrf.conf.

576

577 Optional: Using NGINX as a proxy

578 --------------------------------

579 NGINX can be used to proxy HTTP, HTTPS, and WebSockets traffic. Among other

580 reasons, this can be useful for Evergreen setups that want to have both

581 HTTPS and secure WebSockets traffic both go through port 443 while using

582 two Apache instances (one for the WebSockets gateway and one for the more

583 memory-intensive TPAC pages).

584

585 The following instructions are a guide for setting this up on Debian

586 and Ubuntu systems, but expect general familiarity with various system

587 administration and network tasks. The steps should be run as the *root*

588 Linux account, and assume that you already followed the instructions

589 for installing WebSockets support.

590

591 1. Configure the main Apache instance to listen on port 7080 for HTTP and

592 port 7443 for HTTPS and ensure that it is not listening on ports 80

593 and 443, then restart Apache.

594 +

595 2. Install NGINX if not already present:

596 +

597 [source, bash]

598 ---------------------------------------------------------------------------

599 apt-get install nginx

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

601 +

602 3. Copy the example NGINX configuration file into place and remove default.

603 +

604 [source, bash]

605 ---------------------------------------------------------------------------

606 cd /path/to/opensrf-OSRFVERSION

607 cp examples/nginx/osrf-ws-http-proxy /etc/nginx/sites-available/

608 ln -s /etc/nginx/sites-available/osrf-ws-http-proxy /etc/nginx/sites-enabled/osrf-ws-http-proxy

609 rm /etc/nginx/sites-enabled/default

610 ---------------------------------------------------------------------------

611 +

612 4. Edit `/etc/nginx/sites-available/osrf-ws-http-proxy` to set the location

613 of the SSL certificate and private key.

614 5. Generate a dhparam file in the directory specified in the nginx config.

615 +

616 [source, bash]

617 ---------------------------------------------------------------------------

618 # Default config stores dhparam.pem in the Apache2 ssl directory.

619 openssl dhparam -out /etc/apache2/ssl/dhparam.pem 2048

620 ---------------------------------------------------------------------------

621 +

622 6. Start NGINX

623 +

624 [source, bash]

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

626 /etc/init.d/nginx start

627 ---------------------------------------------------------------------------

628 +

629 7. If you didn't run `configure` with the `--with-websockets-port=443` option,

630 edit `<PREFIX>/javascript/opensrf_ws.js` and `<PREFIX>/javascript/opensrf_ws_shared.js`

631 and change

632 +

633 [source, javascript]

634 ---------------------------------------------------------------------------

635 var WEBSOCKET_PORT_SSL = 7682;

636 ---------------------------------------------------------------------------

637 +

638 to

639 +

640 [source, javascript]

641 ---------------------------------------------------------------------------

642 var WEBSOCKET_PORT_SSL = 443;

643 ---------------------------------------------------------------------------

644

645 Optional: Using HAProxy as a proxy

646 ----------------------------------

647 HAProxy can also be used to proxy HTTP, HTTPS, and WebSockets traffic

648 as an alternative to NGINX.

649

650 The following instructions are a guide for setting this up on Debian

651 and Ubuntu systems, but expect general familiarity with various system

652 administration and network tasks. The steps should be run as the *root*

653 Linux account, and assume that you already followed the instructions

654 for installing WebSockets support.

655

656 1. Install HAProxy if not already present:

657 +

658 [source, bash]

659 ---------------------------------------------------------------------------

660 apt-get install haproxy

661 ---------------------------------------------------------------------------

662 +

663 2. Configure the main Apache instance to listen on port 7080 for HTTP and

664 port 7443 for HTTPS and ensure that it is not listening on ports 80

665 and 443, then restart Apache.

666 3. Append the example HAProxy to `haproxy.cfg`.

667 +

668 [source, bash]

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

670 cd /path/to/opensrf-OSRFVERSION

671 cat examples/haproxy/osrf-ws-http-proxy >> /etc/haproxy/haproxy.cfg

672 ---------------------------------------------------------------------------

673 +

674 4. Edit `/etc/haproxy/haproxy.cfg` to set the location

675 of the PEM file containing the SSL certificate and private key.

676 5. Start HAProxy.

677 +

678 [source, bash]

679 ---------------------------------------------------------------------------

680 /etc/init.d/haproxy start

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

682 +

683 6. Edit `<PREFIX>/javascript/opensrf_ws.js` and `<PREFIX>/javascript/opensrf_ws_shared.js`

684 and change

685 +

686 [source, javascript]

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

688 var WEBSOCKET_PORT_SSL = 7682;

689 ---------------------------------------------------------------------------

690 +

691 to

692 +

693 [source, javascript]

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

695 var WEBSOCKET_PORT_SSL = 443;

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

697

698 Troubleshooting note for Python users

699 -------------------------------------

700

701 If you are running a Python client and trying to connect to OpenSRF running on

702 localhost rather than a hostname that can be resolved via DNS, you will

703 probably receive exceptions about `dns.resolver.NXDOMAIN`. If this happens,

704 you need to install the `dnsmasq` package, configure it to serve up a DNS

705 entry for localhost, and point your local DNS resolver to `dnsmasq`. For example,

706 on Ubuntu you can issue the following commands as the *root* Linux account:

707

708 .Installing and starting `dnsmasq`

709 [source, bash]

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

711 aptitude install dnsmasq

712 /etc/init.d/dnsmasq restart

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

714

715 Then edit `/etc/resolv.conf` and ensure that `nameserver 127.0.0.1` is the

716 first entry in the file.

717

718 Getting help

719 ------------

720

721 Need help installing or using OpenSRF? Join the mailing lists at

722 http://evergreen-ils.org/communicate/mailing-lists/ or contact us

723 on the Freenode IRC network on the #evergreen channel.