LP1834208 Rearrange proxy instructions to reduce repetition
[OpenSRF.git] / 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-stretch` for Debian 9
68   * `debian-jessie` for Debian 8
69   * `ubuntu-xenial` for Ubuntu 16.04
70   * `ubuntu-bionic` for Ubuntu 18.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 Xenial / Ubuntu Bionic) Stopping ejabberd
210 [source, bash]
211 ---------------------------------------------------------------------------
212 systemctl stop ejabberd.service
213 ---------------------------------------------------------------------------
214 +
215 2. Edit the ejabberd config file.
216 +
217 (Debian Jessie) Ejabberd 13.x and 14.x::
218 Open `/etc/ejabberd/ejabberd.yml` and make the following
219 changes:
220   a. Define your public and private domains in the `hosts` directive. For
221    example:
222 +
223 [source, bash]
224 ---------------------------------------------------------------------------
225 hosts:
226   - "localhost"
227   - "private.localhost"
228   - "public.localhost"
229 ---------------------------------------------------------------------------
230 +
231   b. Change `shaper:` `normal` and `fast` values to 500000
232   c. Increase the `max_user_sessions:` `all:` value to 10000
233   d. Comment out the `mod_offline` directive
234 +
235 -----------------------
236 ##mod_offline:
237     ##access_max_user_messages: max_user_offline_messages
238 -----------------------
239 +
240 (Debian Stretch / Ubuntu Xenial) Ejabberd 16.x::
241 Open `/etc/ejabberd/ejabberd.yml` and make the following
242 changes:
243   a. Define your public and private domains in the `hosts` directive. For
244    example:
245 +
246 [source, bash]
247 ---------------------------------------------------------------------------
248 hosts:
249   - "localhost"
250   - "private.localhost"
251   - "public.localhost"
252 ---------------------------------------------------------------------------
253 +
254   b. Change `auth_password_format` to plain
255   c. Change `shaper:` `normal` and `fast` values to 500000
256   d. Increase the `max_user_sessions:` `all:` value to 10000
257   e. Comment out the `mod_offline` directive
258 +
259 -----------------------
260 ##mod_offline:
261     ##access_max_user_messages: max_user_offline_messages
262 -----------------------
263 +
264 (Ubuntu Bionic) Ejabberd 18.x::
265 Open `/etc/ejabberd/ejabberd.yml` and make the following
266 changes:
267   a. Define your public and private domains in the `hosts` directive. For
268    example:
269 +
270 [source, bash]
271 ---------------------------------------------------------------------------
272 hosts:
273   - "localhost"
274   - "private.localhost"
275   - "public.localhost"
276 ---------------------------------------------------------------------------
277 +
278   b. Change `starttls_required` to false
279   c. Change `auth_password_format` to plain
280   d. Change `shaper:` `normal` and `fast` values to 500000
281   e. Increase the `max_user_sessions:` `all:` value to 10000
282   f. Comment out the `mod_offline` directive
283 +
284 -----------------------
285 ##mod_offline:
286     ##access_max_user_messages: max_user_offline_messages
287 -----------------------
288 +
289   g. Uncomment the `mod_legacy_auth` directive
290 3. Restart the ejabberd server to make the changes take effect:
291 +
292 .(Debian / Ubuntu Xenial / Ubuntu Bionic) Starting ejabberd
293 [source, bash]
294 ---------------------------------------------------------------------------
295 systemctl start ejabberd.service
296 ---------------------------------------------------------------------------
297
298 Create the OpenSRF Jabber users
299 -------------------------------
300
301 On each domain, you need two Jabber users to manage the OpenSRF communications:
302
303   * a `router` user, to whom all requests to connect to an OpenSRF service
304     will be routed; this Jabber user must be named `router`
305   * an `opensrf` user, which clients use to connect to OpenSRF services; this
306     user can be named anything you like
307
308 Create the Jabber users by issuing the following commands as the *root* Linux
309 account. Substitute `<password>` for your chosen passwords for each user
310 respectively:
311
312 .Creating the OpenSRF Jabber users
313 [source, bash]
314 ---------------------------------------------------------------------------
315 ejabberdctl register router private.localhost <password>
316 ejabberdctl register opensrf private.localhost <password>
317 ejabberdctl register router public.localhost <password>
318 ejabberdctl register opensrf public.localhost <password>
319 ---------------------------------------------------------------------------
320
321 Update the OpenSRF configuration files
322 --------------------------------------
323
324 About the OpenSRF configuration files
325 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
326 There are several configuration files that you must update to make OpenSRF
327 work. SYSCONFDIR is `/opensrf/etc` by default, or the value that you passed to
328 `--sysconfdir` during the configuration phase.
329
330   * `SYSCONFDIR/opensrf.xml` - this file lists the services that this
331     OpenSRF installation supports; if you create a new OpenSRF service,
332     you need to add it to this file.
333       ** The `<hosts>` element at the bottom of the file lists the services
334          that should be started for each hostname. You can force the system
335          to use `localhost`, so in most cases you will leave this section
336          as-is.
337     
338   * `SYSCONFDIR/opensrf_core.xml` - this file lists the Jabber connection
339     information that will be used for the system, as well as determining
340     logging verbosity and defining which services will be exposed on the
341     HTTP gateway.
342
343   * `~/.srfsh.xml` - this file gives a Linux account the ability to use
344     the `srfsh` interpreter to communicate with OpenSRF services.
345
346 Updating the OpenSRF configuration files
347 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
348   1. As the *opensrf* Linux account, copy the example configuration files
349      to create your locally customizable OpenSRF configuration files:
350 +
351 .Copying the example OpenSRF configuration files
352 [source, bash]
353 ---------------------------------------------------------------------------
354 cd SYSCONFDIR
355 cp opensrf_core.xml.example opensrf_core.xml
356 cp opensrf.xml.example opensrf.xml
357 ---------------------------------------------------------------------------
358 +
359   2. Edit the `SYSCONFDIR/opensrf_core.xml` file to update the four username
360      / password pairs to match the Jabber user accounts you just created:
361
362     a. `<config><opensrf>` = use the private Jabber `opensrf` user
363     b. `<config><gateway>` = use the public Jabber `opensrf` user
364     c. `<config><routers><router>` = use the public Jabber `router` user
365     d. `<config><routers><router>` = use the private Jabber `router` user
366   3. Create a `.srfsh.xml` file in the home directory of each user
367      that you want to use `srfsh` to communicate with OpenSRF services. For
368      example, to enable the *opensrf* Linux account to use `srfsh`:
369     a. `cp SYSCONFDIR/srfsh.xml.example ~/.srfsh.xml`
370     b. Open `~/.srfsh.xml` in your text editor of choice and update the
371        password to match the password you set for the Jabber `opensrf` user
372        at the `private.localhost` domain.
373
374 Starting and stopping OpenSRF services
375 --------------------------------------
376
377 To start all OpenSRF services with a hostname of `localhost`, issue the
378 following command as the *opensrf* Linux account:
379
380 [source, bash]
381 ---------------------------------------------------------------------------
382 osrf_control --localhost --start-all
383 ---------------------------------------------------------------------------
384
385 To stop all OpenSRF services with a hostname of `localhost`, issue the
386 following command as the *opensrf* Linux account:
387
388 [source, bash]
389 ---------------------------------------------------------------------------
390 osrf_control --localhost --stop-all
391 ---------------------------------------------------------------------------
392
393 Testing the default OpenSRF services
394 ------------------------------------
395
396 By default, OpenSRF ships with an `opensrf.math` service that performs basic
397 calculations involving two integers. Once you have started the OpenSRF
398 services, test the services as follows:
399
400 1. Start the `srfsh` interactive OpenSRF shell by issuing the following
401    command as the *opensrf* Linux account:
402 +
403 .Starting the `srfsh` interactive OpenSRF shell
404 [source, bash]
405 ---------------------------------------------------------------------------
406 srfsh
407 ---------------------------------------------------------------------------
408 +
409 2. Issue the following request to test the `opensrf.math` service:
410 +
411 [source, bash]
412 ---------------------------------------------------------------------------
413 srfsh# request opensrf.math add 2,2
414 ---------------------------------------------------------------------------
415 +
416 You should receive the value `4`.
417
418 Websockets installation instructions
419 ----------------------------------------------------------
420
421 1. Install websocketd (latest stable release from http://websocketd.com/)
422 +
423 .(Debian, Ubuntu)
424 [source,bash]
425 ---------------------------------------------------------------------------
426 cd /tmp
427 wget 'https://github.com/joewalnes/websocketd/releases/download/v0.3.0/websocketd-0.3.0-linux_amd64.zip'
428 unzip websocketd-0.3.0-linux_amd64.zip
429 sudo cp websocketd /usr/local/bin/
430 ---------------------------------------------------------------------------
431 +
432 2. Run websocketd
433 +
434 Choose option a or b, below.
435 +
436 [NOTE]
437 ===========================================================================
438 websocketd does not offer a configurable inactivity timeout, meaning
439 websocket client connections will persist until each client disconnects
440 or the service is restarted.  However, a timeout can be achieved with
441 the use of a proxy (option 'a' below).  A proxy also allows websocketd
442 to be exposed to web clients on port 443 instead of its internal port, 
443 which may simplify firewall configuration.
444 ===========================================================================
445 +
446 a. Run websocketd as 'opensrf'
447 +
448 [NOTE]
449 ===========================================================================
450 This choice requires one of the proxy configurations mentioned below.
451 ===========================================================================
452 +
453 .(Debian, Ubuntu)
454 [source,bash]
455 ---------------------------------------------------------------------------
456 /usr/local/bin/websocketd --port 7682 /openils/bin/osrf-websocket-stdio &
457
458 # Other useful command line parameters include:
459 # --loglevel debug|trace|access|info|error|fatal
460 # --maxforks <n>
461 # --sameorigin=true
462 # --origin=host[:port][,host[:port]...]
463
464 # See https://github.com/joewalnes/websocketd/blob/master/help.go
465 ---------------------------------------------------------------------------
466 +
467 b. Run websocketd without a proxy
468 +
469 .(Debian, Ubuntu)
470 [source,bash]
471 ---------------------------------------------------------------------------
472 sudo -b /usr/local/bin/websocketd --port 7682 --ssl --sslcert=/etc/apache2/ssl/server.crt \
473      --sslkey=/etc/apache2/ssl/server.key /openils/bin/osrf-websocket-stdio
474 ---------------------------------------------------------------------------
475
476 Optional: Using a web proxy (Apache 2.4 and above)
477 --------------------------------------------------
478 When the OpenSRF HTTP Translator runs behind a proxy, Apache must be 
479 configured to read the IP address of the originating client instead
480 of the proxy IP address.  
481
482 1. Enable mod_remoteip
483 +
484 [source,bash]
485 ---------------------------------------------------------------------------
486 sudo a2enmod remoteip
487 ---------------------------------------------------------------------------
488 +
489 2. Enable remote IP settings by uncommenting and modifying as needed the 
490    Apache configuration variables starting with RemoteIP* in the sample Apache
491    configuration file opensrf.conf.
492 +
493 3. Configure Apache to listen on port 7080 for HTTP and port 7443 for HTTPS
494    and ensure that it is not listening on ports 80 and 443, then restart Apache.
495 +
496 4. If you didn't run `configure` with the `--with-websockets-port=443` option,
497    edit `<PREFIX>/javascript/opensrf_ws.js` and `<PREFIX>/javascript/opensrf_ws_shared.js`
498    and change
499 +
500 [source, javascript]
501 ---------------------------------------------------------------------------
502 var WEBSOCKET_PORT_SSL = 7682;
503 ---------------------------------------------------------------------------
504 +
505 to
506 +
507 [source, javascript]
508 ---------------------------------------------------------------------------
509 var WEBSOCKET_PORT_SSL = 443;
510 ---------------------------------------------------------------------------
511
512
513 Optional: Using NGINX as a proxy
514 --------------------------------
515 NGINX can be used to proxy HTTP, HTTPS, and WebSockets traffic. Among other
516 reasons, this can be useful for Evergreen setups that want to have both
517 HTTPS and secure WebSockets traffic both go through port 443 while using
518 two Apache instances (one for the WebSockets gateway and one for the more
519 memory-intensive TPAC pages).
520
521 The following instructions are a guide for setting this up on Debian
522 and Ubuntu systems, but expect general familiarity with various system
523 administration and network tasks.  The steps should be run as the *root*
524 Linux account, and assume that you already followed the instructions
525 for installing WebSockets support.
526
527 1. Install NGINX if not already present:
528 +
529 [source, bash]
530 ---------------------------------------------------------------------------
531 apt-get install nginx
532 ---------------------------------------------------------------------------
533 +
534 2. Copy the example NGINX configuration file into place and remove default.
535 +
536 [source, bash]
537 ---------------------------------------------------------------------------
538 cd /path/to/opensrf-OSRFVERSION
539 cp examples/nginx/osrf-ws-http-proxy /etc/nginx/sites-available/
540 ln -s /etc/nginx/sites-available/osrf-ws-http-proxy /etc/nginx/sites-enabled/osrf-ws-http-proxy
541 rm /etc/nginx/sites-enabled/default
542 ---------------------------------------------------------------------------
543 +
544 3. Edit `/etc/nginx/sites-available/osrf-ws-http-proxy` to set the location
545    of the SSL certificate and private key.
546 4. Generate a dhparam file in the directory specified in the nginx config.
547 +
548 [source, bash]
549 ---------------------------------------------------------------------------
550 # Default config stores dhparam.pem in the Apache2 ssl directory.
551 openssl dhparam -out /etc/apache2/ssl/dhparam.pem 2048
552 ---------------------------------------------------------------------------
553 +
554 5. Start NGINX
555 +
556 [source, bash]
557 ---------------------------------------------------------------------------
558 /etc/init.d/nginx start
559 ---------------------------------------------------------------------------
560
561 Optional: Using HAProxy as a proxy
562 ----------------------------------
563 HAProxy can also be used to proxy HTTP, HTTPS, and WebSockets traffic
564 as an alternative to NGINX.
565
566 The following instructions are a guide for setting this up on Debian
567 and Ubuntu systems, but expect general familiarity with various system
568 administration and network tasks.  The steps should be run as the *root*
569 Linux account, and assume that you already followed the instructions
570 for installing WebSockets support.
571
572 1. Install HAProxy if not already present:
573 +
574 [source, bash]
575 ---------------------------------------------------------------------------
576 apt-get install haproxy
577 ---------------------------------------------------------------------------
578 +
579 2. Append the example HAProxy to `haproxy.cfg`.
580 +
581 [source, bash]
582 ---------------------------------------------------------------------------
583 cd /path/to/opensrf-OSRFVERSION
584 cat examples/haproxy/osrf-ws-http-proxy >> /etc/haproxy/haproxy.cfg
585 ---------------------------------------------------------------------------
586 +
587 3. Edit `/etc/haproxy/haproxy.cfg` to set the location
588    of the PEM file containing the SSL certificate and private key.
589 4. Start HAProxy.
590 +
591 [source, bash]
592 ---------------------------------------------------------------------------
593 /etc/init.d/haproxy start
594 ---------------------------------------------------------------------------
595
596 Troubleshooting note for Python users
597 -------------------------------------
598
599 If you are running a Python client and trying to connect to OpenSRF running on
600 localhost rather than a hostname that can be resolved via DNS, you will
601 probably receive exceptions about `dns.resolver.NXDOMAIN`. If this happens,
602 you need to install the `dnsmasq` package, configure it to serve up a DNS
603 entry for localhost, and point your local DNS resolver to `dnsmasq`. For example,
604 on Ubuntu you can issue the following commands as the *root* Linux account:
605
606 .Installing and starting `dnsmasq`
607 [source, bash]
608 ---------------------------------------------------------------------------
609 aptitude install dnsmasq
610 /etc/init.d/dnsmasq restart
611 ---------------------------------------------------------------------------
612
613 Then edit `/etc/resolv.conf` and ensure that `nameserver 127.0.0.1` is the
614 first entry in the file.
615
616 Getting help
617 ------------
618
619 Need help installing or using OpenSRF? Join the mailing lists at
620 http://evergreen-ils.org/communicate/mailing-lists/ or contact us 
621 on the Freenode IRC network on the #evergreen channel.