Docs: Emphasize variables and paths consistently in README
[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 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 Installing prerequisites
24 ------------------------
25
26 OpenSRF has a number of prerequisite packages that must be installed
27 before you can successfully configure, compile, and install OpenSRF.
28 On Debian and Ubuntu, the easiest way to install these prerequisites
29 is to use the Makefile.install prerequisite installer.
30
31 Issue the following commands as the *root* Linux account to install 
32 prerequisites using the Makefile.install prerequisite installer, substituting 
33 your operating system identifier for <osname> below:
34
35 [source, bash]
36 ---------------------------------------------------------------------------
37 apt-get install make
38 make -f src/extras/Makefile.install <osname>
39 ---------------------------------------------------------------------------
40
41 Well-tested values for <osname> include:
42
43   * `debian-jessie` for Debian 8.0
44   * `debian-wheezy` for Debian 7.0
45   * `debian-squeeze` for Debian 6.0
46   * `ubuntu-precise` for Ubuntu 12.04
47   * `ubuntu-trusty` for Ubuntu 14.04
48   * `fedora` for Fedora 17 and later
49
50 Patches and suggestions for improvement from users of these distributions,
51 or others, are welcome!
52
53 When the prerequisite installer reaches the Perl module stage, you may 
54 be prompted for configuration of Comprehensive Perl Archive Network (CPAN)
55 on your server. You can generally accept the defaults by pressing <return>
56 for all of the prompts, except for the country configuration.
57
58 Preamble: Developer instructions
59 --------------------------------
60
61 [NOTE]
62 Skip this section if you are using an official release tarball downloaded
63 from http://evergreen-ils.org/downloads
64
65 Developers working directly with the source code from the Git repository,
66 rather than an official release tarball, must install some extra packages
67 and perform one step before they can proceed with the `./configure` step.
68
69 As the *root* Linux account, install the following packages:
70
71   * autoconf
72   * automake
73   * libtool
74
75 As the *user* Linux account, issue the following command in the OpenSRF
76 source directory to generate the configure script and Makefiles:
77
78 [source, bash]
79 ------------------------------------------------------------------------------
80 autoreconf -i
81 ------------------------------------------------------------------------------
82
83 Configuration and compilation instructions
84 ------------------------------------------
85
86 Use the `configure` command to configure OpenSRF, and the `make` command to
87 build OpenSRF. The default installation prefix (PREFIX) for OpenSRF is
88 `/opensrf/`.
89
90 If you are building OpenSRF for Evergreen, issue the following commands as
91 the *user* Linux account to configure and build OpenSRF:
92
93 [source, bash]
94 ---------------------------------------------------------------------------
95 ./configure --prefix=/openils --sysconfdir=/openils/conf
96 make
97 ---------------------------------------------------------------------------
98
99 By default, OpenSRF includes C, Perl, and JavaScript support.
100 You can add the `--enable-python` option to the configure command
101 to build Python support and `--enable-java` for Java support.
102
103 Installation instructions
104 -------------------------
105
106 1. Once you have configured and compiled OpenSRF, issue the following
107    command as the *root* Linux account to install OpenSRF:
108 +
109 [source, bash]
110 ---------------------------------------------------------------------------
111 make install
112 ---------------------------------------------------------------------------
113
114 Create and set up the opensrf Unix user environment
115 ---------------------------------------------------
116
117 This user is used to start and stop all OpenSRF processes, and must own all
118 files contained in the PREFIX directory hierarchy. Issue the following
119 commands as the *root* Linux account to create the `opensrf` user and set up
120 its environment, substituting <PREFIX> with the value you passed to `--prefix`
121 in your configure command:
122
123 .Creating the `opensrf` user
124 [source, bash]
125 ---------------------------------------------------------------------------
126 useradd -m -s /bin/bash opensrf
127 echo "export PATH=\$PATH:/<PREFIX>/bin" >> /home/opensrf/.bashrc
128 passwd opensrf
129 chown -R opensrf:opensrf /<PREFIX>
130 ---------------------------------------------------------------------------
131
132 Define your public and private OpenSRF domains
133 ----------------------------------------------
134
135 For security purposes, OpenSRF uses Jabber domains to separate services
136 into public and private realms. Throughout these instructions, we will use
137 the example domains `public.localhost` and `private.localhost`. 
138
139 On a single-server system, the easiest way to define public and private
140 domains is to define separate hostnames by adding entries to the `/etc/hosts`
141 file. Here are entries that you could add to a stock `/etc/hosts` file for our
142 example domains:
143
144 .Example added entries for `/etc/hosts`
145 [source, bash]
146 ---------------------------------------------------------------------------
147 127.0.1.2       public.localhost        public
148 127.0.1.3       private.localhost       private
149 ---------------------------------------------------------------------------
150
151 Adjust the system dynamic library path
152 --------------------------------------
153
154 Add `<PREFIX>/lib/` to the system's dynamic library path, and then run
155 `ldconfig` as the *root* Linux account.
156
157 On Debian, Ubuntu, and Fedora systems, run the following commands as the *root*
158 Linux account:
159
160 .Adjusting the system dynamic library path
161 [source, bash]
162 ---------------------------------------------------------------------------
163 echo <PREFIX>/lib > /etc/ld.so.conf.d/opensrf.conf
164 ldconfig
165 ---------------------------------------------------------------------------
166
167 On most other systems, you can add these entries to `/etc/ld.so.conf`, or
168 create a file within the `/etc/ld.so.conf.d/` directory, and then run
169 `ldconfig` as the *root* Linux account.
170
171 Configure the ejabberd server
172 -----------------------------
173
174 OpenSRF requires an XMPP (Jabber) server. For performance reasons, ejabberd is
175 the Jabber server of choice for the OpenSRF project. In most cases, you only
176 have to make a few changes to the default `ejabberd.cfg` file to make ejabberd
177 work for OpenSRF. 
178
179 1. Stop ejabberd before making any changes to its configuration by issuing the
180    following command as the *root* Linux account:
181 +
182 .(Debian / Ubuntu) Stopping ejabberd
183 [source, bash]
184 ---------------------------------------------------------------------------
185 /etc/init.d/ejabberd stop
186 ---------------------------------------------------------------------------
187 +
188 .(Fedora) Stopping ejabberd
189 [source, bash]
190 ---------------------------------------------------------------------------
191 systemctl stop ejabberd.service
192 ---------------------------------------------------------------------------
193 +
194 2. Open `/etc/ejabberd/ejabberd.cfg` and make the following
195 changes:
196   a. Define your public and private domains in the `hosts` directive. For
197    example:
198 +
199 [source, bash]
200 ---------------------------------------------------------------------------
201 {hosts, ["localhost", "private.localhost", "public.localhost"]}.
202 ---------------------------------------------------------------------------
203 +
204   b. Change all `max_stanza_size` values to 2000000
205   c. Change all `maxrate` values to 500000
206   d. Increase the `max_user_sessions` value to 10000
207   e. Comment out the `mod_offline` directive
208 +
209 3. Restart the ejabberd server to make the changes take effect:
210 +
211 .(Debian / Ubuntu) Starting ejabberd
212 [source, bash]
213 ---------------------------------------------------------------------------
214 /etc/init.d/ejabberd start
215 ---------------------------------------------------------------------------
216 +
217 .(Fedora) Starting ejabberd
218 [source, bash]
219 ---------------------------------------------------------------------------
220 systemctl start ejabberd.service
221 ---------------------------------------------------------------------------
222
223 Create the OpenSRF Jabber users
224 -------------------------------
225
226 On each domain, you need two Jabber users to manage the OpenSRF communications:
227
228   * a `router` user, to whom all requests to connect to an OpenSRF service
229     will be routed; this Jabber user must be named `router`
230   * an `opensrf` user, which clients use to connect to OpenSRF services; this
231     user can be named anything you like
232
233 Create the Jabber users by issuing the following commands as the *root* Linux
234 account. Substitute `<password>` for your chosen passwords for each user
235 respectively:
236
237 .Creating the OpenSRF Jabber users
238 [source, bash]
239 ---------------------------------------------------------------------------
240 ejabberdctl register router private.localhost <password>
241 ejabberdctl register opensrf private.localhost <password>
242 ejabberdctl register router public.localhost <password>
243 ejabberdctl register opensrf public.localhost <password>
244 ---------------------------------------------------------------------------
245
246 Update the OpenSRF configuration files
247 --------------------------------------
248
249 About the OpenSRF configuration files
250 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
251 There are several configuration files that you must update to make OpenSRF
252 work. SYSCONFDIR is `/opensrf/etc` by default, or the value that you passed to
253 `--sysconfdir` during the configuration phase.
254
255   * `SYSCONFDIR/opensrf.xml` - this file lists the services that this
256     OpenSRF installation supports; if you create a new OpenSRF service,
257     you need to add it to this file.
258       ** The `<hosts>` element at the bottom of the file lists the services
259          that should be started for each hostname. You can force the system
260          to use `localhost`, so in most cases you will leave this section
261          as-is.
262     
263   * `SYSCONFDIR/opensrf_core.xml` - this file lists the Jabber connection
264     information that will be used for the system, as well as determining
265     logging verbosity and defining which services will be exposed on the
266     HTTP gateway.
267
268   * `~/.srfsh.xml` - this file gives a Linux account the ability to use
269     the `srfsh` interpreter to communicate with OpenSRF services.
270
271 Updating the OpenSRF configuration files
272 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
273   1. As the *opensrf* Linux account, copy the example configuration files
274      to create your locally customizable OpenSRF configuration files:
275 +
276 .Copying the example OpenSRF configuration files
277 [source, bash]
278 ---------------------------------------------------------------------------
279 cd SYSCONFDIR
280 cp opensrf_core.xml.example opensrf_core.xml
281 cp opensrf.xml.example opensrf.xml
282 ---------------------------------------------------------------------------
283 +
284   2. Edit the `SYSCONFDIR/opensrf_core.xml` file to update the four username
285      / password pairs to match the Jabber user accounts you just created:
286
287     a. `<config><opensrf>` = use the private Jabber `opensrf` user
288     b. `<config><gateway>` = use the public Jabber `opensrf` user
289     c. `<config><routers><router>` = use the public Jabber `router` user
290     d. `<config><routers><router>` = use the private Jabber `router` user
291   3. Create a `.srfsh.xml` file in the home directory of each user
292      that you want to use `srfsh` to communicate with OpenSRF services. For
293      example, to enable the *opensrf* Linux account to use `srfsh`:
294     a. `cp SYSCONFDIR/srfsh.xml.example ~/.srfsh.xml`
295     b. Open `~/.srfsh.xml` in your text editor of choice and update the
296        password to match the password you set for the Jabber `opensrf` user
297        at the `private.localhost` domain.
298
299 Starting and stopping OpenSRF services
300 --------------------------------------
301
302 To start all OpenSRF services with a hostname of `localhost`, issue the
303 following command as the *opensrf* Linux account:
304
305 [source, bash]
306 ---------------------------------------------------------------------------
307 osrf_control --localhost --start-all
308 ---------------------------------------------------------------------------
309
310 To stop all OpenSRF services with a hostname of `localhost`, issue the
311 following command as the *opensrf* Linux account:
312
313 [source, bash]
314 ---------------------------------------------------------------------------
315 osrf_control --localhost --stop-all
316 ---------------------------------------------------------------------------
317
318 Testing the default OpenSRF services
319 ------------------------------------
320
321 By default, OpenSRF ships with an `opensrf.math` service that performs basic
322 calculations involving two integers. Once you have started the OpenSRF
323 services, test the services as follows:
324
325 1. Start the `srfsh` interactive OpenSRF shell by issuing the following
326    command as the *opensrf* Linux account:
327 +
328 .Starting the `srfsh` interactive OpenSRF shell
329 [source, bash]
330 ---------------------------------------------------------------------------
331 srfsh
332 ---------------------------------------------------------------------------
333 +
334 2. Issue the following request to test the `opensrf.math` service:
335 +
336 [source, bash]
337 ---------------------------------------------------------------------------
338 srfsh# request opensrf.math add 2,2
339 ---------------------------------------------------------------------------
340 +
341 You should receive the value `4`.
342
343 Optional: Websockets installation instructions
344 ----------------------------------------------
345 Websockets are new to OpenSRF 2.4+ and are required for operating the new web-based
346 staff client for Evergreen.  Complete the following steps as the *root* Linux 
347 account:
348
349 1. Install git if not already present:
350 +
351 [source, bash]
352 ---------------------------------------------------------------------------
353 apt-get install git-core
354 ---------------------------------------------------------------------------
355 +
356 2. Install the apache-websocket module:
357 +
358 [source, bash]
359 ---------------------------------------------------------------------------
360 # Use a temporary directory
361 cd /tmp
362 git clone https://github.com/disconnect/apache-websocket
363 cd apache-websocket
364 apxs2 -i -a -c mod_websocket.c
365 ---------------------------------------------------------------------------
366 +
367 3. Create the websocket Apache instance (more information about this in 
368    `/usr/share/doc/apache2/README.multiple-instances`)
369 +
370 .(Debian / Ubuntu Precise)
371 [source, bash]
372 ---------------------------------------------------------------------------
373 sh /usr/share/doc/apache2.2-common/examples/setup-instance websockets
374 ---------------------------------------------------------------------------
375 +
376 .(Ubuntu Trusty)
377 [source, bash]
378 ---------------------------------------------------------------------------
379 sh /usr/share/doc/apache2/examples/setup-instance websockets
380 ---------------------------------------------------------------------------
381 +
382 4. Remove from the main apache instance
383 +
384 [source, bash]
385 ---------------------------------------------------------------------------
386 a2dismod websocket
387 ---------------------------------------------------------------------------
388 +
389 5. Copy into place the config files
390 +
391 .(Debian / Ubuntu Precise)
392 [source, bash]
393 ---------------------------------------------------------------------------
394 cp examples/apache2/websockets/apache2.conf /etc/apache2-websockets/
395 ---------------------------------------------------------------------------
396 +
397 .(Ubuntu Trusty)
398 [source, bash]
399 ---------------------------------------------------------------------------
400 cp examples/apache_24/websockets/apache2.conf /etc/apache2-websockets/
401 ---------------------------------------------------------------------------
402 +
403 6. OPTIONAL: add these configuration variables to `/etc/apache2-websockets/envvars`
404    and adjust as needed.
405 +
406 [source, bash]
407 ---------------------------------------------------------------------------
408 export OSRF_WEBSOCKET_IDLE_TIMEOUT=120
409 export OSRF_WEBSOCKET_IDLE_CHECK_INTERVAL=5
410 export OSRF_WEBSOCKET_CONFIG_FILE=/openils/conf/opensrf_core.xml
411 export OSRF_WEBSOCKET_CONFIG_CTXT=gateway
412 export OSRF_WEBSOCKET_MAX_REQUEST_WAIT_TIME=600
413 ---------------------------------------------------------------------------
414 +
415   * `IDLE_TIMEOUT` specifies how long we will allow a client to stay connected
416     while idle.  A longer timeout means less network traffic (from fewer
417     websocket CONNECT calls), but it also means more Apache processes are
418     tied up doing nothing.
419   * `IDLE_CHECK_INTERVAL` specifies how often we wake to check the idle status
420     of the connected client.
421   * `MAX_REQUEST_WAIT_TIME` is the maximum amount of time the gateway will
422     wait before declaring a client as idle when there is a long-running
423     outstanding request, yet no other activity is occurring.  This is
424     primarily a fail-safe to allow idle timeouts when one or more requests
425     died on the server, and thus no response was ever delivered to the gateway.
426   * `CONFIG_FILE / CTXT` are the standard opensrf core config options.
427
428 7. Before you can start websockets, you must install a valid SSL certificate 
429    in `/etc/apache2/ssl/`.  It is possible, but not recommended, to generate a 
430    self-signed SSL certificate.  For example, if you need to test with a self-signed 
431    certicate on Chrome or Chromimum browsers, one workaround is to start the browser 
432    with `--ignore-certificate-errors`.
433
434 8. After OpenSRF is up and running (or after any re-install),
435    fire up the secondary Apache instance. Errors will appear in
436    `/var/log/apache2-websockets/error.log`. Start apache2-websockets with:
437 +
438 [source, bash]
439 ---------------------------------------------------------------------------
440 /etc/init.d/apache2-websockets start
441 ---------------------------------------------------------------------------
442
443 Troubleshooting note for Python users
444 -------------------------------------
445
446 If you are running a Python client and trying to connect to OpenSRF running on
447 localhost rather than a hostname that can be resolved via DNS, you will
448 probably receive exceptions about `dns.resolver.NXDOMAIN`. If this happens,
449 you need to install the `dnsmasq` package, configure it to serve up a DNS
450 entry for localhost, and point your local DNS resolver to `dnsmasq`. For example,
451 on Ubuntu you can issue the following commands as the *root* Linux account:
452
453 .(Debian / Ubuntu) Installing and starting `dnsmasq`
454 [source, bash]
455 ---------------------------------------------------------------------------
456 aptitude install dnsmasq
457 /etc/init.d/dnsmasq restart
458 ---------------------------------------------------------------------------
459
460 Then edit `/etc/resolv.conf` and ensure that `nameserver 127.0.0.1` is the
461 first entry in the file.
462
463 Getting help
464 ------------
465
466 Need help installing or using OpenSRF? Join the mailing lists at
467 http://evergreen-ils.org/listserv.php or contact us on the Freenode
468 IRC network on the #evergreen channel.