README

   1 Installing OpenSRF
   2 ==================
   3
   4 Preamble: referenced user accounts
   5 ----------------------------------
   6
   7 In subsequent sections, we will refer to a number of different accounts, as
   8 follows:
   9
  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 and Fedora 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.
  22
  23 Download and unpack the code
  24 ----------------------------
  25
  26 Issue the following commands as the *user* Linux account.
  27
  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 ------------------------------------------------------------------------------
  46
  47 Installing prerequisites
  48 ------------------------
  49
  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.
  54
  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:
  58
  59 [source, bash]
  60 ---------------------------------------------------------------------------
  61 apt-get install make
  62 make -f src/extras/Makefile.install <osname>
  63 ---------------------------------------------------------------------------
  64
  65 Well-tested values for <osname> include:
  66
  67   * `debian-jessie` for Debian 8.0
  68   * `debian-wheezy` for Debian 7.0
  69   * `ubuntu-trusty` for Ubuntu 14.04
  70   * `ubuntu-xenial` for Ubuntu 16.04
  71   * `fedora` for Fedora 17 and later
  72
  73 Patches and suggestions for improvement from users of these distributions,
  74 or others, are welcome!
  75
  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.
  80
  81 Preamble: Developer instructions
  82 --------------------------------
  83
  84 [NOTE]
  85 Skip this section if you are using an official release tarball downloaded
  86 from https://evergreen-ils.org/opensrf-downloads/
  87
  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.
  91
  92 As the *root* Linux account, install the following packages:
  93
  94   * autoconf
  95   * automake
  96   * libtool
  97
  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, Ubuntu, and Fedora 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 Trusty) Stopping ejabberd
 211 [source, bash]
 212 ---------------------------------------------------------------------------
 213 /etc/init.d/ejabberd stop
 214 ---------------------------------------------------------------------------
 215 +
 216 .(Fedora / Ubuntu Xenial) Stopping ejabberd
 217 [source, bash]
 218 ---------------------------------------------------------------------------
 219 systemctl stop ejabberd.service
 220 ---------------------------------------------------------------------------
 221 +
 222 2. Edit the ejabberd config file.
 223 +
 224 (Debian Wheezy / Ubuntu Trusty) Ejabberd 2.x.x::
 225 Open `/etc/ejabberd/ejabberd.cfg` and make the following
 226 changes:
 227   a. Define your public and private domains in the `hosts` directive. For
 228    example:
 229 +
 230 [source, bash]
 231 ---------------------------------------------------------------------------
 232 {hosts, ["localhost", "private.localhost", "public.localhost"]}.
 233 ---------------------------------------------------------------------------
 234 +
 235   b. Change all `maxrate` values to 500000
 236   c. Increase the `max_user_sessions` value to 10000
 237   d. Comment out the `mod_offline` directive
 238 +
 239 (Debian Jessie) Ejabberd 13.x and 14.x::
 240 Open `/etc/ejabberd/ejabberd.yml` and make the following
 241 changes:
 242   a. Define your public and private domains in the `hosts` directive. For
 243    example:
 244 +
 245 [source, bash]
 246 ---------------------------------------------------------------------------
 247 hosts:
 248   - "localhost"
 249   - "private.localhost"
 250   - "public.localhost"
 251 ---------------------------------------------------------------------------
 252 +
 253   b. Change `shaper:` `normal` and `fast` values to 500000
 254   c. Increase the `max_user_sessions:` `all:` value to 10000
 255   d. Comment out the `mod_offline` directive
 256 +
 257 -----------------------
 258 ##mod_offline:
 259     ##access_max_user_messages: max_user_offline_messages
 260 -----------------------
 261 +
 262 (Ubuntu Xenial) Ejabberd 16.x::
 263 Open `/etc/ejabberd/ejabberd.yml` and make the following
 264 changes:
 265   a. Define your public and private domains in the `hosts` directive. For
 266    example:
 267 +
 268 [source, bash]
 269 ---------------------------------------------------------------------------
 270 hosts:
 271   - "localhost"
 272   - "private.localhost"
 273   - "public.localhost"
 274 ---------------------------------------------------------------------------
 275 +
 276   b. Change `auth_password_format` to plain
 277   c. Change `shaper:` `normal` and `fast` values to 500000
 278   d. Increase the `max_user_sessions:` `all:` value to 10000
 279   e. Comment out the `mod_offline` directive
 280 +
 281 -----------------------
 282 ##mod_offline:
 283     ##access_max_user_messages: max_user_offline_messages
 284 -----------------------
 285 +
 286 3. Restart the ejabberd server to make the changes take effect:
 287 +
 288 .(Debian / Ubuntu Trusty) Starting ejabberd
 289 [source, bash]
 290 ---------------------------------------------------------------------------
 291 /etc/init.d/ejabberd start
 292 ---------------------------------------------------------------------------
 293 +
 294 .(Fedora / Ubuntu Xenial) Starting ejabberd
 295 [source, bash]
 296 ---------------------------------------------------------------------------
 297 systemctl start ejabberd.service
 298 ---------------------------------------------------------------------------
 299
 300 Create the OpenSRF Jabber users
 301 -------------------------------
 302
 303 On each domain, you need two Jabber users to manage the OpenSRF communications:
 304
 305   * a `router` user, to whom all requests to connect to an OpenSRF service
 306     will be routed; this Jabber user must be named `router`
 307   * an `opensrf` user, which clients use to connect to OpenSRF services; this
 308     user can be named anything you like
 309
 310 Create the Jabber users by issuing the following commands as the *root* Linux
 311 account. Substitute `<password>` for your chosen passwords for each user
 312 respectively:
 313
 314 .Creating the OpenSRF Jabber users
 315 [source, bash]
 316 ---------------------------------------------------------------------------
 317 ejabberdctl register router private.localhost <password>
 318 ejabberdctl register opensrf private.localhost <password>
 319 ejabberdctl register router public.localhost <password>
 320 ejabberdctl register opensrf public.localhost <password>
 321 ---------------------------------------------------------------------------
 322
 323 Update the OpenSRF configuration files
 324 --------------------------------------
 325
 326 About the OpenSRF configuration files
 327 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 328 There are several configuration files that you must update to make OpenSRF
 329 work. SYSCONFDIR is `/opensrf/etc` by default, or the value that you passed to
 330 `--sysconfdir` during the configuration phase.
 331
 332   * `SYSCONFDIR/opensrf.xml` - this file lists the services that this
 333     OpenSRF installation supports; if you create a new OpenSRF service,
 334     you need to add it to this file.
 335       ** The `<hosts>` element at the bottom of the file lists the services
 336          that should be started for each hostname. You can force the system
 337          to use `localhost`, so in most cases you will leave this section
 338          as-is.
 339
 340   * `SYSCONFDIR/opensrf_core.xml` - this file lists the Jabber connection
 341     information that will be used for the system, as well as determining
 342     logging verbosity and defining which services will be exposed on the
 343     HTTP gateway.
 344
 345   * `~/.srfsh.xml` - this file gives a Linux account the ability to use
 346     the `srfsh` interpreter to communicate with OpenSRF services.
 347
 348 Updating the OpenSRF configuration files
 349 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 350   1. As the *opensrf* Linux account, copy the example configuration files
 351      to create your locally customizable OpenSRF configuration files:
 352 +
 353 .Copying the example OpenSRF configuration files
 354 [source, bash]
 355 ---------------------------------------------------------------------------
 356 cd SYSCONFDIR
 357 cp opensrf_core.xml.example opensrf_core.xml
 358 cp opensrf.xml.example opensrf.xml
 359 ---------------------------------------------------------------------------
 360 +
 361   2. Edit the `SYSCONFDIR/opensrf_core.xml` file to update the four username
 362      / password pairs to match the Jabber user accounts you just created:
 363
 364     a. `<config><opensrf>` = use the private Jabber `opensrf` user
 365     b. `<config><gateway>` = use the public Jabber `opensrf` user
 366     c. `<config><routers><router>` = use the public Jabber `router` user
 367     d. `<config><routers><router>` = use the private Jabber `router` user
 368   3. Create a `.srfsh.xml` file in the home directory of each user
 369      that you want to use `srfsh` to communicate with OpenSRF services. For
 370      example, to enable the *opensrf* Linux account to use `srfsh`:
 371     a. `cp SYSCONFDIR/srfsh.xml.example ~/.srfsh.xml`
 372     b. Open `~/.srfsh.xml` in your text editor of choice and update the
 373        password to match the password you set for the Jabber `opensrf` user
 374        at the `private.localhost` domain.
 375
 376 Starting and stopping OpenSRF services
 377 --------------------------------------
 378
 379 To start all OpenSRF services with a hostname of `localhost`, issue the
 380 following command as the *opensrf* Linux account:
 381
 382 [source, bash]
 383 ---------------------------------------------------------------------------
 384 osrf_control --localhost --start-all
 385 ---------------------------------------------------------------------------
 386
 387 To stop all OpenSRF services with a hostname of `localhost`, issue the
 388 following command as the *opensrf* Linux account:
 389
 390 [source, bash]
 391 ---------------------------------------------------------------------------
 392 osrf_control --localhost --stop-all
 393 ---------------------------------------------------------------------------
 394
 395 Testing the default OpenSRF services
 396 ------------------------------------
 397
 398 By default, OpenSRF ships with an `opensrf.math` service that performs basic
 399 calculations involving two integers. Once you have started the OpenSRF
 400 services, test the services as follows:
 401
 402 1. Start the `srfsh` interactive OpenSRF shell by issuing the following
 403    command as the *opensrf* Linux account:
 404 +
 405 .Starting the `srfsh` interactive OpenSRF shell
 406 [source, bash]
 407 ---------------------------------------------------------------------------
 408 srfsh
 409 ---------------------------------------------------------------------------
 410 +
 411 2. Issue the following request to test the `opensrf.math` service:
 412 +
 413 [source, bash]
 414 ---------------------------------------------------------------------------
 415 srfsh# request opensrf.math add 2,2
 416 ---------------------------------------------------------------------------
 417 +
 418 You should receive the value `4`.
 419
 420 Optional: Websockets installation instructions
 421 ----------------------------------------------
 422 Websockets are new to OpenSRF 2.4+ and are required for operating the new web-based
 423 staff client for Evergreen.  Complete the following steps as the *root* Linux
 424 account:
 425
 426 1. Install git if not already present:
 427 +
 428 [source, bash]
 429 ---------------------------------------------------------------------------
 430 apt-get install git-core
 431 ---------------------------------------------------------------------------
 432 +
 433 2. Install the apache-websocket module:
 434 +
 435 [source, bash]
 436 ---------------------------------------------------------------------------
 437 # Use a temporary directory
 438 cd /tmp
 439 git clone https://github.com/disconnect/apache-websocket
 440 cd apache-websocket
 441 apxs2 -i -a -c mod_websocket.c
 442 ---------------------------------------------------------------------------
 443 +
 444 3. Create the websocket Apache instance (more information about this in
 445    `/usr/share/doc/apache2/README.multiple-instances`)
 446 +
 447 .(Debian)
 448 [source, bash]
 449 ---------------------------------------------------------------------------
 450 sh /usr/share/doc/apache2.2-common/examples/setup-instance websockets
 451 ---------------------------------------------------------------------------
 452 +
 453 .(Ubuntu Trusty / Xenial)
 454 [source, bash]
 455 ---------------------------------------------------------------------------
 456 sh /usr/share/doc/apache2/examples/setup-instance websockets
 457 ---------------------------------------------------------------------------
 458 +
 459 4. Remove from the main apache instance
 460 +
 461 [source, bash]
 462 ---------------------------------------------------------------------------
 463 a2dismod websocket
 464 ---------------------------------------------------------------------------
 465 +
 466 5. Change to the directory into which you unpacked OpenSRF, then copy into
 467    place the config files
 468 +
 469 .(Debian)
 470 [source, bash]
 471 ---------------------------------------------------------------------------
 472 cd /path/to/opensrf-OSRFVERSION
 473 cp examples/apache2/websockets/apache2.conf /etc/apache2-websockets/
 474 ---------------------------------------------------------------------------
 475 +
 476 .(Ubuntu Trusty / Xenial)
 477 [source, bash]
 478 ---------------------------------------------------------------------------
 479 cd /path/to/opensrf-OSRFVERSION
 480 cp examples/apache_24/websockets/apache2.conf /etc/apache2-websockets/
 481 ---------------------------------------------------------------------------
 482 +
 483 6. OPTIONAL: add these configuration variables to `/etc/apache2-websockets/envvars`
 484    and adjust as needed.
 485 +
 486 [source, bash]
 487 ---------------------------------------------------------------------------
 488 export OSRF_WEBSOCKET_IDLE_TIMEOUT=120
 489 export OSRF_WEBSOCKET_IDLE_CHECK_INTERVAL=5
 490 export OSRF_WEBSOCKET_CONFIG_FILE=/openils/conf/opensrf_core.xml
 491 export OSRF_WEBSOCKET_CONFIG_CTXT=gateway
 492 export OSRF_WEBSOCKET_MAX_REQUEST_WAIT_TIME=600
 493 ---------------------------------------------------------------------------
 494 +
 495   * `IDLE_TIMEOUT` specifies how long we will allow a client to stay connected
 496     while idle.  A longer timeout means less network traffic (from fewer
 497     websocket CONNECT calls), but it also means more Apache processes are
 498     tied up doing nothing.
 499   * `IDLE_CHECK_INTERVAL` specifies how often we wake to check the idle status
 500     of the connected client.
 501   * `MAX_REQUEST_WAIT_TIME` is the maximum amount of time the gateway will
 502     wait before declaring a client as idle when there is a long-running
 503     outstanding request, yet no other activity is occurring.  This is
 504     primarily a fail-safe to allow idle timeouts when one or more requests
 505     died on the server, and thus no response was ever delivered to the gateway.
 506   * `CONFIG_FILE / CTXT` are the standard opensrf core config options.
 507
 508 7. Before you can start websockets, you must install a valid SSL certificate
 509    in `/etc/apache2/ssl/`.  It is possible, but not recommended, to generate a
 510    self-signed SSL certificate.  For example, if you need to test with a self-signed
 511    certicate on Chrome or Chromimum browsers, one workaround is to start the browser
 512    with `--ignore-certificate-errors`.
 513
 514 8. After OpenSRF is up and running (or after any re-install),
 515    fire up the secondary Apache instance. Errors will appear in
 516    `/var/log/apache2-websockets/error.log`. Start apache2-websockets with:
 517 +
 518 [source, bash]
 519 ---------------------------------------------------------------------------
 520 /etc/init.d/apache2-websockets start
 521 ---------------------------------------------------------------------------
 522
 523 Optional: Using NGINX as a proxy
 524 --------------------------------
 525 NGINX can be used to proxy HTTP, HTTPS, and WebSockets traffic. Among other
 526 reasons, this can be useful for Evergreen setups that want to have both
 527 HTTPS and secure WebSockets traffic both go through port 443 while using
 528 two Apache instances (one for the WebSockets gateway and one for the more
 529 memory-intensive TPAC pages).
 530
 531 The following instructions are a guide for setting this up on Debian
 532 and Ubuntu systems, but expect general familiarity with various system
 533 administration and network tasks.  The steps should be run as the *root*
 534 Linux account, and assume that you already followed the instructions
 535 for installing WebSockets support.
 536
 537 1. Install NGINX if not already present:
 538 +
 539 [source, bash]
 540 ---------------------------------------------------------------------------
 541 apt-get install nginx
 542 ---------------------------------------------------------------------------
 543 +
 544 2. Configure the main Apache instance to listen on port 7080 for HTTP and
 545    port 7443 for HTTPS and ensure that it is not listening on ports 80
 546    and 443, then restart Apache.
 547 3. Copy the example NGINX configuration file into place.
 548 +
 549 [source, bash]
 550 ---------------------------------------------------------------------------
 551 cd /path/to/opensrf-OSRFVERSION
 552 cp examples/nginx/osrf-ws-http-proxy /etc/nginx/sites-available/
 553 ln -s /etc/nginx/sites-available/osrf-ws-http-proxy /etc/nginx/sites-enabled/osrf-ws-http-proxy
 554 ---------------------------------------------------------------------------
 555 +
 556 4. Edit `/etc/nginx/sites-available/osrf-ws-http-proxy` to set the location
 557    of the SSL certificate and private key.
 558 5. Start NGINX
 559 +
 560 [source, bash]
 561 ---------------------------------------------------------------------------
 562 /etc/init.d/nginx start
 563 ---------------------------------------------------------------------------
 564 +
 565 6. If you didn't run `configure` with the `--with-websockets-port=443` option,
 566 edit `<PREFIX>/javascript/opensrf_ws.js` and `<PREFIX>/javascript/opensrf_ws_shared.js`
 567    and change
 568 +
 569 [source, javascript]
 570 ---------------------------------------------------------------------------
 571 var WEBSOCKET_PORT_SSL = 7682;
 572 ---------------------------------------------------------------------------
 573 +
 574 to
 575 +
 576 [source, javascript]
 577 ---------------------------------------------------------------------------
 578 var WEBSOCKET_PORT_SSL = 443;
 579 ---------------------------------------------------------------------------
 580
 581 Optional: Using HAProxy as a proxy
 582 ----------------------------------
 583 HAProxy can also be used to proxy HTTP, HTTPS, and WebSockets traffic
 584 as an alternative to NGINX.
 585
 586 The following instructions are a guide for setting this up on Debian
 587 and Ubuntu systems, but expect general familiarity with various system
 588 administration and network tasks.  The steps should be run as the *root*
 589 Linux account, and assume that you already followed the instructions
 590 for installing WebSockets support.
 591
 592 1. Install HAProxy if not already present:
 593 +
 594 [source, bash]
 595 ---------------------------------------------------------------------------
 596 apt-get install haproxy
 597 ---------------------------------------------------------------------------
 598 +
 599 2. Configure the main Apache instance to listen on port 7080 for HTTP and
 600    port 7443 for HTTPS and ensure that it is not listening on ports 80
 601    and 443, then restart Apache.
 602 3. Append the example HAProxy to `haproxy.cfg`.
 603 +
 604 [source, bash]
 605 ---------------------------------------------------------------------------
 606 cd /path/to/opensrf-OSRFVERSION
 607 cat examples/haproxy/osrf-ws-http-proxy >> /etc/haproxy/haproxy.cfg
 608 ---------------------------------------------------------------------------
 609 +
 610 4. Edit `/etc/haproxy/haproxy.cfg` to set the location
 611    of the PEM file containing the SSL certificate and private key.
 612 5. Start HAProxy.
 613 +
 614 [source, bash]
 615 ---------------------------------------------------------------------------
 616 /etc/init.d/haproxy start
 617 ---------------------------------------------------------------------------
 618 +
 619 6. Edit `<PREFIX>/javascript/opensrf_ws.js` and `<PREFIX>/javascript/opensrf_ws_shared.js`
 620    and change
 621 +
 622 [source, javascript]
 623 ---------------------------------------------------------------------------
 624 var WEBSOCKET_PORT_SSL = 7682;
 625 ---------------------------------------------------------------------------
 626 +
 627 to
 628 +
 629 [source, javascript]
 630 ---------------------------------------------------------------------------
 631 var WEBSOCKET_PORT_SSL = 443;
 632 ---------------------------------------------------------------------------
 633
 634 Troubleshooting note for Python users
 635 -------------------------------------
 636
 637 If you are running a Python client and trying to connect to OpenSRF running on
 638 localhost rather than a hostname that can be resolved via DNS, you will
 639 probably receive exceptions about `dns.resolver.NXDOMAIN`. If this happens,
 640 you need to install the `dnsmasq` package, configure it to serve up a DNS
 641 entry for localhost, and point your local DNS resolver to `dnsmasq`. For example,
 642 on Ubuntu you can issue the following commands as the *root* Linux account:
 643
 644 .(Debian / Ubuntu) Installing and starting `dnsmasq`
 645 [source, bash]
 646 ---------------------------------------------------------------------------
 647 aptitude install dnsmasq
 648 /etc/init.d/dnsmasq restart
 649 ---------------------------------------------------------------------------
 650
 651 Then edit `/etc/resolv.conf` and ensure that `nameserver 127.0.0.1` is the
 652 first entry in the file.
 653
 654 Getting help
 655 ------------
 656
 657 Need help installing or using OpenSRF? Join the mailing lists at
 658 http://evergreen-ils.org/communicate/mailing-lists/ or contact us
 659 on the Freenode IRC network on the #evergreen channel.