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 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
  72 Patches and suggestions for improvement from users of these distributions,
  73 or others, are welcome!
  74
  75 When the prerequisite installer reaches the Perl module stage, you may
  76 be prompted for configuration of Comprehensive Perl Archive Network (CPAN)
  77 on your server. You can generally accept the defaults by pressing <return>
  78 for all of the prompts, except for the country configuration.
  79
  80 Preamble: Developer instructions
  81 --------------------------------
  82
  83 [NOTE]
  84 Skip this section if you are using an official release tarball downloaded
  85 from https://evergreen-ils.org/opensrf-downloads/
  86
  87 Developers working directly with the source code from the Git repository,
  88 rather than an official release tarball, must install some extra packages
  89 and perform one step before they can proceed with the `./configure` step.
  90
  91 As the *root* Linux account, install the following packages:
  92
  93   * autoconf
  94   * automake
  95   * libtool
  96
  97 As the *user* Linux account, issue the following command in the OpenSRF
  98 source directory to generate the configure script and Makefiles:
  99
 100 [source, bash]
 101 ------------------------------------------------------------------------------
 102 autoreconf -i
 103 ------------------------------------------------------------------------------
 104
 105 Configuration and compilation instructions
 106 ------------------------------------------
 107
 108 Use the `configure` command to configure OpenSRF, and the `make` command to
 109 build OpenSRF. The default installation prefix (PREFIX) for OpenSRF is
 110 `/opensrf/`.
 111
 112 If you are building OpenSRF for Evergreen, issue the following commands as
 113 the *user* Linux account to configure and build OpenSRF:
 114
 115 [source, bash]
 116 ---------------------------------------------------------------------------
 117 ./configure --prefix=/openils --sysconfdir=/openils/conf
 118 make
 119 ---------------------------------------------------------------------------
 120
 121 By default, OpenSRF includes C, Perl, and JavaScript support.
 122 You can add the `--enable-python` option to the configure command
 123 to build Python support and `--enable-java` for Java support.
 124
 125 If you are planning on proxying WebSockets traffic (see below), you
 126 can add `--with-websockets-port=443` to specify that WebSockets traffic
 127 will be going through port 443. Without that option, the default port
 128 is 7682.
 129
 130 Installation instructions
 131 -------------------------
 132
 133 1. Once you have configured and compiled OpenSRF, issue the following
 134    command as the *root* Linux account to install OpenSRF:
 135 +
 136 [source, bash]
 137 ---------------------------------------------------------------------------
 138 make install
 139 ---------------------------------------------------------------------------
 140
 141 Create and set up the opensrf Unix user environment
 142 ---------------------------------------------------
 143
 144 This user is used to start and stop all OpenSRF processes, and must own all
 145 files contained in the PREFIX directory hierarchy. Issue the following
 146 commands as the *root* Linux account to create the `opensrf` user and set up
 147 its environment, substituting <PREFIX> with the value you passed to `--prefix`
 148 in your configure command:
 149
 150 .Creating the `opensrf` user
 151 [source, bash]
 152 ---------------------------------------------------------------------------
 153 useradd -m -s /bin/bash opensrf
 154 echo "export PATH=\$PATH:/<PREFIX>/bin" >> /home/opensrf/.bashrc
 155 passwd opensrf
 156 chown -R opensrf:opensrf /<PREFIX>
 157 ---------------------------------------------------------------------------
 158
 159 Define your public and private OpenSRF domains
 160 ----------------------------------------------
 161
 162 For security purposes, OpenSRF uses Jabber domains to separate services
 163 into public and private realms. Throughout these instructions, we will use
 164 the example domains `public.localhost` and `private.localhost`.
 165
 166 On a single-server system, the easiest way to define public and private
 167 domains is to define separate hostnames by adding entries to the `/etc/hosts`
 168 file. Here are entries that you could add to a stock `/etc/hosts` file for our
 169 example domains:
 170
 171 .Example added entries for `/etc/hosts`
 172 [source, bash]
 173 ---------------------------------------------------------------------------
 174 127.0.1.2       public.localhost        public
 175 127.0.1.3       private.localhost       private
 176 ---------------------------------------------------------------------------
 177
 178 Adjust the system dynamic library path
 179 --------------------------------------
 180
 181 Add `<PREFIX>/lib/` to the system's dynamic library path, and then run
 182 `ldconfig` as the *root* Linux account.
 183
 184 On Debian and Ubuntu systems, run the following commands as the *root*
 185 Linux account:
 186
 187 .Adjusting the system dynamic library path
 188 [source, bash]
 189 ---------------------------------------------------------------------------
 190 echo <PREFIX>/lib > /etc/ld.so.conf.d/opensrf.conf
 191 ldconfig
 192 ---------------------------------------------------------------------------
 193
 194 On most other systems, you can add these entries to `/etc/ld.so.conf`, or
 195 create a file within the `/etc/ld.so.conf.d/` directory, and then run
 196 `ldconfig` as the *root* Linux account.
 197
 198 Configure the ejabberd server
 199 -----------------------------
 200
 201 OpenSRF requires an XMPP (Jabber) server. For performance reasons, ejabberd is
 202 the Jabber server of choice for the OpenSRF project. In most cases, you only
 203 have to make a few changes to the default configuration file to make ejabberd
 204 work for OpenSRF.
 205
 206 1. Stop ejabberd before making any changes to its configuration by issuing the
 207    following command as the *root* Linux account:
 208 +
 209 .(Debian / Ubuntu Trusty) Stopping ejabberd
 210 [source, bash]
 211 ---------------------------------------------------------------------------
 212 /etc/init.d/ejabberd stop
 213 ---------------------------------------------------------------------------
 214 +
 215 .(Ubuntu Xenial) Stopping ejabberd
 216 [source, bash]
 217 ---------------------------------------------------------------------------
 218 systemctl stop ejabberd.service
 219 ---------------------------------------------------------------------------
 220 +
 221 2. Edit the ejabberd config file.
 222 +
 223 (Debian Wheezy / Ubuntu Trusty) Ejabberd 2.x.x::
 224 Open `/etc/ejabberd/ejabberd.cfg` and make the following
 225 changes:
 226   a. Define your public and private domains in the `hosts` directive. For
 227    example:
 228 +
 229 [source, bash]
 230 ---------------------------------------------------------------------------
 231 {hosts, ["localhost", "private.localhost", "public.localhost"]}.
 232 ---------------------------------------------------------------------------
 233 +
 234   b. Change all `maxrate` values to 500000
 235   c. Increase the `max_user_sessions` value to 10000
 236   d. Comment out the `mod_offline` directive
 237 +
 238 (Debian Jessie) Ejabberd 13.x and 14.x::
 239 Open `/etc/ejabberd/ejabberd.yml` and make the following
 240 changes:
 241   a. Define your public and private domains in the `hosts` directive. For
 242    example:
 243 +
 244 [source, bash]
 245 ---------------------------------------------------------------------------
 246 hosts:
 247   - "localhost"
 248   - "private.localhost"
 249   - "public.localhost"
 250 ---------------------------------------------------------------------------
 251 +
 252   b. Change `shaper:` `normal` and `fast` values to 500000
 253   c. Increase the `max_user_sessions:` `all:` value to 10000
 254   d. Comment out the `mod_offline` directive
 255 +
 256 -----------------------
 257 ##mod_offline:
 258     ##access_max_user_messages: max_user_offline_messages
 259 -----------------------
 260 +
 261 (Ubuntu Xenial) Ejabberd 16.x::
 262 Open `/etc/ejabberd/ejabberd.yml` and make the following
 263 changes:
 264   a. Define your public and private domains in the `hosts` directive. For
 265    example:
 266 +
 267 [source, bash]
 268 ---------------------------------------------------------------------------
 269 hosts:
 270   - "localhost"
 271   - "private.localhost"
 272   - "public.localhost"
 273 ---------------------------------------------------------------------------
 274 +
 275   b. Change `auth_password_format` to plain
 276   c. Change `shaper:` `normal` and `fast` values to 500000
 277   d. Increase the `max_user_sessions:` `all:` value to 10000
 278   e. Comment out the `mod_offline` directive
 279 +
 280 -----------------------
 281 ##mod_offline:
 282     ##access_max_user_messages: max_user_offline_messages
 283 -----------------------
 284 +
 285 3. Restart the ejabberd server to make the changes take effect:
 286 +
 287 .(Debian / Ubuntu Trusty) Starting ejabberd
 288 [source, bash]
 289 ---------------------------------------------------------------------------
 290 /etc/init.d/ejabberd start
 291 ---------------------------------------------------------------------------
 292 +
 293 .(Ubuntu Xenial) Starting ejabberd
 294 [source, bash]
 295 ---------------------------------------------------------------------------
 296 systemctl start ejabberd.service
 297 ---------------------------------------------------------------------------
 298
 299 Create the OpenSRF Jabber users
 300 -------------------------------
 301
 302 On each domain, you need two Jabber users to manage the OpenSRF communications:
 303
 304   * a `router` user, to whom all requests to connect to an OpenSRF service
 305     will be routed; this Jabber user must be named `router`
 306   * an `opensrf` user, which clients use to connect to OpenSRF services; this
 307     user can be named anything you like
 308
 309 Create the Jabber users by issuing the following commands as the *root* Linux
 310 account. Substitute `<password>` for your chosen passwords for each user
 311 respectively:
 312
 313 .Creating the OpenSRF Jabber users
 314 [source, bash]
 315 ---------------------------------------------------------------------------
 316 ejabberdctl register router private.localhost <password>
 317 ejabberdctl register opensrf private.localhost <password>
 318 ejabberdctl register router public.localhost <password>
 319 ejabberdctl register opensrf public.localhost <password>
 320 ---------------------------------------------------------------------------
 321
 322 Update the OpenSRF configuration files
 323 --------------------------------------
 324
 325 About the OpenSRF configuration files
 326 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 327 There are several configuration files that you must update to make OpenSRF
 328 work. SYSCONFDIR is `/opensrf/etc` by default, or the value that you passed to
 329 `--sysconfdir` during the configuration phase.
 330
 331   * `SYSCONFDIR/opensrf.xml` - this file lists the services that this
 332     OpenSRF installation supports; if you create a new OpenSRF service,
 333     you need to add it to this file.
 334       ** The `<hosts>` element at the bottom of the file lists the services
 335          that should be started for each hostname. You can force the system
 336          to use `localhost`, so in most cases you will leave this section
 337          as-is.
 338
 339   * `SYSCONFDIR/opensrf_core.xml` - this file lists the Jabber connection
 340     information that will be used for the system, as well as determining
 341     logging verbosity and defining which services will be exposed on the
 342     HTTP gateway.
 343
 344   * `~/.srfsh.xml` - this file gives a Linux account the ability to use
 345     the `srfsh` interpreter to communicate with OpenSRF services.
 346
 347 Updating the OpenSRF configuration files
 348 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 349   1. As the *opensrf* Linux account, copy the example configuration files
 350      to create your locally customizable OpenSRF configuration files:
 351 +
 352 .Copying the example OpenSRF configuration files
 353 [source, bash]
 354 ---------------------------------------------------------------------------
 355 cd SYSCONFDIR
 356 cp opensrf_core.xml.example opensrf_core.xml
 357 cp opensrf.xml.example opensrf.xml
 358 ---------------------------------------------------------------------------
 359 +
 360   2. Edit the `SYSCONFDIR/opensrf_core.xml` file to update the four username
 361      / password pairs to match the Jabber user accounts you just created:
 362
 363     a. `<config><opensrf>` = use the private Jabber `opensrf` user
 364     b. `<config><gateway>` = use the public Jabber `opensrf` user
 365     c. `<config><routers><router>` = use the public Jabber `router` user
 366     d. `<config><routers><router>` = use the private Jabber `router` user
 367   3. Create a `.srfsh.xml` file in the home directory of each user
 368      that you want to use `srfsh` to communicate with OpenSRF services. For
 369      example, to enable the *opensrf* Linux account to use `srfsh`:
 370     a. `cp SYSCONFDIR/srfsh.xml.example ~/.srfsh.xml`
 371     b. Open `~/.srfsh.xml` in your text editor of choice and update the
 372        password to match the password you set for the Jabber `opensrf` user
 373        at the `private.localhost` domain.
 374
 375 Starting and stopping OpenSRF services
 376 --------------------------------------
 377
 378 To start all OpenSRF services with a hostname of `localhost`, issue the
 379 following command as the *opensrf* Linux account:
 380
 381 [source, bash]
 382 ---------------------------------------------------------------------------
 383 osrf_control --localhost --start-all
 384 ---------------------------------------------------------------------------
 385
 386 To stop all OpenSRF services with a hostname of `localhost`, issue the
 387 following command as the *opensrf* Linux account:
 388
 389 [source, bash]
 390 ---------------------------------------------------------------------------
 391 osrf_control --localhost --stop-all
 392 ---------------------------------------------------------------------------
 393
 394 Testing the default OpenSRF services
 395 ------------------------------------
 396
 397 By default, OpenSRF ships with an `opensrf.math` service that performs basic
 398 calculations involving two integers. Once you have started the OpenSRF
 399 services, test the services as follows:
 400
 401 1. Start the `srfsh` interactive OpenSRF shell by issuing the following
 402    command as the *opensrf* Linux account:
 403 +
 404 .Starting the `srfsh` interactive OpenSRF shell
 405 [source, bash]
 406 ---------------------------------------------------------------------------
 407 srfsh
 408 ---------------------------------------------------------------------------
 409 +
 410 2. Issue the following request to test the `opensrf.math` service:
 411 +
 412 [source, bash]
 413 ---------------------------------------------------------------------------
 414 srfsh# request opensrf.math add 2,2
 415 ---------------------------------------------------------------------------
 416 +
 417 You should receive the value `4`.
 418
 419 Optional: Websockets installation instructions
 420 ----------------------------------------------
 421 Websockets are new to OpenSRF 2.4+ and are required for operating the new web-based
 422 staff client for Evergreen.  Complete the following steps as the *root* Linux
 423 account:
 424
 425 1. Install git if not already present:
 426 +
 427 [source, bash]
 428 ---------------------------------------------------------------------------
 429 apt-get install git-core
 430 ---------------------------------------------------------------------------
 431 +
 432 2. Install the apache-websocket module:
 433 +
 434 [source, bash]
 435 ---------------------------------------------------------------------------
 436 # Use a temporary directory
 437 cd /tmp
 438 git clone https://github.com/disconnect/apache-websocket
 439 cd apache-websocket
 440 apxs2 -i -a -c mod_websocket.c
 441 ---------------------------------------------------------------------------
 442 +
 443 3. Create the websocket Apache instance (more information about this in
 444    `/usr/share/doc/apache2/README.multiple-instances`)
 445 +
 446 .(Debian Wheezy)
 447 [source, bash]
 448 ---------------------------------------------------------------------------
 449 sh /usr/share/doc/apache2.2-common/examples/setup-instance websockets
 450 ---------------------------------------------------------------------------
 451 +
 452 .(Debian Jessie / Ubuntu Trusty / Xenial)
 453 [source, bash]
 454 ---------------------------------------------------------------------------
 455 sh /usr/share/doc/apache2/examples/setup-instance websockets
 456 ---------------------------------------------------------------------------
 457 +
 458 4. Remove from the main apache instance
 459 +
 460 [source, bash]
 461 ---------------------------------------------------------------------------
 462 a2dismod websocket
 463 ---------------------------------------------------------------------------
 464 +
 465 5. Change to the directory into which you unpacked OpenSRF, then copy into
 466    place the config files
 467 +
 468 .(Debian Wheezy)
 469 [source, bash]
 470 ---------------------------------------------------------------------------
 471 cd /path/to/opensrf-OSRFVERSION
 472 cp examples/apache2/websockets/apache2.conf /etc/apache2-websockets/
 473 ---------------------------------------------------------------------------
 474 +
 475 .(Debian Jessie / Ubuntu Trusty / Xenial)
 476 [source, bash]
 477 ---------------------------------------------------------------------------
 478 cd /path/to/opensrf-OSRFVERSION
 479 cp examples/apache_24/websockets/apache2.conf /etc/apache2-websockets/
 480 ---------------------------------------------------------------------------
 481 +
 482 6. OPTIONAL: add these configuration variables to `/etc/apache2-websockets/envvars`
 483    and adjust as needed.
 484 +
 485 [source, bash]
 486 ---------------------------------------------------------------------------
 487 export OSRF_WEBSOCKET_IDLE_TIMEOUT=120
 488 export OSRF_WEBSOCKET_IDLE_CHECK_INTERVAL=5
 489 export OSRF_WEBSOCKET_CONFIG_FILE=/openils/conf/opensrf_core.xml
 490 export OSRF_WEBSOCKET_CONFIG_CTXT=gateway
 491 export OSRF_WEBSOCKET_MAX_REQUEST_WAIT_TIME=600
 492 ---------------------------------------------------------------------------
 493 +
 494   * `IDLE_TIMEOUT` specifies how long we will allow a client to stay connected
 495     while idle.  A longer timeout means less network traffic (from fewer
 496     websocket CONNECT calls), but it also means more Apache processes are
 497     tied up doing nothing.
 498   * `IDLE_CHECK_INTERVAL` specifies how often we wake to check the idle status
 499     of the connected client.
 500   * `MAX_REQUEST_WAIT_TIME` is the maximum amount of time the gateway will
 501     wait before declaring a client as idle when there is a long-running
 502     outstanding request, yet no other activity is occurring.  This is
 503     primarily a fail-safe to allow idle timeouts when one or more requests
 504     died on the server, and thus no response was ever delivered to the gateway.
 505   * `CONFIG_FILE / CTXT` are the standard opensrf core config options.
 506
 507 7. Before you can start websockets, you must install a valid SSL certificate
 508    in `/etc/apache2/ssl/`.  It is possible, but not recommended, to generate a
 509    self-signed SSL certificate.  For example, if you need to test with a self-signed
 510    certicate on Chrome or Chromimum browsers, one workaround is to start the browser
 511    with `--ignore-certificate-errors`.
 512
 513 8. After OpenSRF is up and running (or after any re-install),
 514    fire up the secondary Apache instance. Errors will appear in
 515    `/var/log/apache2-websockets/error.log`. Start apache2-websockets with:
 516 +
 517 [source, bash]
 518 ---------------------------------------------------------------------------
 519 /etc/init.d/apache2-websockets start
 520 ---------------------------------------------------------------------------
 521
 522 Optional: Using NGINX as a proxy
 523 --------------------------------
 524 NGINX can be used to proxy HTTP, HTTPS, and WebSockets traffic. Among other
 525 reasons, this can be useful for Evergreen setups that want to have both
 526 HTTPS and secure WebSockets traffic both go through port 443 while using
 527 two Apache instances (one for the WebSockets gateway and one for the more
 528 memory-intensive TPAC pages).
 529
 530 The following instructions are a guide for setting this up on Debian
 531 and Ubuntu systems, but expect general familiarity with various system
 532 administration and network tasks.  The steps should be run as the *root*
 533 Linux account, and assume that you already followed the instructions
 534 for installing WebSockets support.
 535
 536 1. Configure the main Apache instance to listen on port 7080 for HTTP and
 537    port 7443 for HTTPS and ensure that it is not listening on ports 80
 538    and 443, then restart Apache.
 539 +
 540 2. Install NGINX if not already present:
 541 +
 542 [source, bash]
 543 ---------------------------------------------------------------------------
 544 apt-get install nginx
 545 ---------------------------------------------------------------------------
 546 +
 547 3. Copy the example NGINX configuration file into place and remove default.
 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 rm /etc/nginx/sites-enabled/default
 555 ---------------------------------------------------------------------------
 556 +
 557 4. Edit `/etc/nginx/sites-available/osrf-ws-http-proxy` to set the location
 558    of the SSL certificate and private key.
 559 5. Start NGINX
 560 +
 561 [source, bash]
 562 ---------------------------------------------------------------------------
 563 /etc/init.d/nginx start
 564 ---------------------------------------------------------------------------
 565 +
 566 6. If you didn't run `configure` with the `--with-websockets-port=443` option,
 567 edit `<PREFIX>/javascript/opensrf_ws.js` and `<PREFIX>/javascript/opensrf_ws_shared.js`
 568    and change
 569 +
 570 [source, javascript]
 571 ---------------------------------------------------------------------------
 572 var WEBSOCKET_PORT_SSL = 7682;
 573 ---------------------------------------------------------------------------
 574 +
 575 to
 576 +
 577 [source, javascript]
 578 ---------------------------------------------------------------------------
 579 var WEBSOCKET_PORT_SSL = 443;
 580 ---------------------------------------------------------------------------
 581
 582 Optional: Using HAProxy as a proxy
 583 ----------------------------------
 584 HAProxy can also be used to proxy HTTP, HTTPS, and WebSockets traffic
 585 as an alternative to NGINX.
 586
 587 The following instructions are a guide for setting this up on Debian
 588 and Ubuntu systems, but expect general familiarity with various system
 589 administration and network tasks.  The steps should be run as the *root*
 590 Linux account, and assume that you already followed the instructions
 591 for installing WebSockets support.
 592
 593 1. Install HAProxy if not already present:
 594 +
 595 [source, bash]
 596 ---------------------------------------------------------------------------
 597 apt-get install haproxy
 598 ---------------------------------------------------------------------------
 599 +
 600 2. Configure the main Apache instance to listen on port 7080 for HTTP and
 601    port 7443 for HTTPS and ensure that it is not listening on ports 80
 602    and 443, then restart Apache.
 603 3. Append the example HAProxy to `haproxy.cfg`.
 604 +
 605 [source, bash]
 606 ---------------------------------------------------------------------------
 607 cd /path/to/opensrf-OSRFVERSION
 608 cat examples/haproxy/osrf-ws-http-proxy >> /etc/haproxy/haproxy.cfg
 609 ---------------------------------------------------------------------------
 610 +
 611 4. Edit `/etc/haproxy/haproxy.cfg` to set the location
 612    of the PEM file containing the SSL certificate and private key.
 613 5. Start HAProxy.
 614 +
 615 [source, bash]
 616 ---------------------------------------------------------------------------
 617 /etc/init.d/haproxy start
 618 ---------------------------------------------------------------------------
 619 +
 620 6. Edit `<PREFIX>/javascript/opensrf_ws.js` and `<PREFIX>/javascript/opensrf_ws_shared.js`
 621    and change
 622 +
 623 [source, javascript]
 624 ---------------------------------------------------------------------------
 625 var WEBSOCKET_PORT_SSL = 7682;
 626 ---------------------------------------------------------------------------
 627 +
 628 to
 629 +
 630 [source, javascript]
 631 ---------------------------------------------------------------------------
 632 var WEBSOCKET_PORT_SSL = 443;
 633 ---------------------------------------------------------------------------
 634
 635 Troubleshooting note for Python users
 636 -------------------------------------
 637
 638 If you are running a Python client and trying to connect to OpenSRF running on
 639 localhost rather than a hostname that can be resolved via DNS, you will
 640 probably receive exceptions about `dns.resolver.NXDOMAIN`. If this happens,
 641 you need to install the `dnsmasq` package, configure it to serve up a DNS
 642 entry for localhost, and point your local DNS resolver to `dnsmasq`. For example,
 643 on Ubuntu you can issue the following commands as the *root* Linux account:
 644
 645 .(Debian / Ubuntu) Installing and starting `dnsmasq`
 646 [source, bash]
 647 ---------------------------------------------------------------------------
 648 aptitude install dnsmasq
 649 /etc/init.d/dnsmasq restart
 650 ---------------------------------------------------------------------------
 651
 652 Then edit `/etc/resolv.conf` and ensure that `nameserver 127.0.0.1` is the
 653 first entry in the file.
 654
 655 Getting help
 656 ------------
 657
 658 Need help installing or using OpenSRF? Join the mailing lists at
 659 http://evergreen-ils.org/communicate/mailing-lists/ or contact us
 660 on the Freenode IRC network on the #evergreen channel.