4 Preamble: referenced user accounts
5 ----------------------------------
7 In subsequent sections, we will refer to a number of different accounts, as
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.
23 Installing prerequisites
24 ------------------------
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.
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:
36 ---------------------------------------------------------------------------
38 make -f src/extras/Makefile.install <osname>
39 ---------------------------------------------------------------------------
41 Well-tested values for <osname> include:
43 * `debian-jessie` for Debian 8.0
44 * `debian-wheezy` for Debian 7.0
45 * `ubuntu-trusty` for Ubuntu 14.04
46 * `ubuntu-xenial` for Ubuntu 16.04
47 * `fedora` for Fedora 17 and later
49 Patches and suggestions for improvement from users of these distributions,
50 or others, are welcome!
52 When the prerequisite installer reaches the Perl module stage, you may
53 be prompted for configuration of Comprehensive Perl Archive Network (CPAN)
54 on your server. You can generally accept the defaults by pressing <return>
55 for all of the prompts, except for the country configuration.
57 Preamble: Developer instructions
58 --------------------------------
61 Skip this section if you are using an official release tarball downloaded
62 from http://evergreen-ils.org/downloads
64 Developers working directly with the source code from the Git repository,
65 rather than an official release tarball, must install some extra packages
66 and perform one step before they can proceed with the `./configure` step.
68 As the *root* Linux account, install the following packages:
74 As the *user* Linux account, issue the following command in the OpenSRF
75 source directory to generate the configure script and Makefiles:
78 ------------------------------------------------------------------------------
80 ------------------------------------------------------------------------------
82 Configuration and compilation instructions
83 ------------------------------------------
85 Use the `configure` command to configure OpenSRF, and the `make` command to
86 build OpenSRF. The default installation prefix (PREFIX) for OpenSRF is
89 If you are building OpenSRF for Evergreen, issue the following commands as
90 the *user* Linux account to configure and build OpenSRF:
93 ---------------------------------------------------------------------------
94 ./configure --prefix=/openils --sysconfdir=/openils/conf
96 ---------------------------------------------------------------------------
98 By default, OpenSRF includes C, Perl, and JavaScript support.
99 You can add the `--enable-python` option to the configure command
100 to build Python support and `--enable-java` for Java support.
102 Installation instructions
103 -------------------------
105 1. Once you have configured and compiled OpenSRF, issue the following
106 command as the *root* Linux account to install OpenSRF:
109 ---------------------------------------------------------------------------
111 ---------------------------------------------------------------------------
113 Create and set up the opensrf Unix user environment
114 ---------------------------------------------------
116 This user is used to start and stop all OpenSRF processes, and must own all
117 files contained in the PREFIX directory hierarchy. Issue the following
118 commands as the *root* Linux account to create the `opensrf` user and set up
119 its environment, substituting <PREFIX> with the value you passed to `--prefix`
120 in your configure command:
122 .Creating the `opensrf` user
124 ---------------------------------------------------------------------------
125 useradd -m -s /bin/bash opensrf
126 echo "export PATH=\$PATH:/<PREFIX>/bin" >> /home/opensrf/.bashrc
128 chown -R opensrf:opensrf /<PREFIX>
129 ---------------------------------------------------------------------------
131 Define your public and private OpenSRF domains
132 ----------------------------------------------
134 For security purposes, OpenSRF uses Jabber domains to separate services
135 into public and private realms. Throughout these instructions, we will use
136 the example domains `public.localhost` and `private.localhost`.
138 On a single-server system, the easiest way to define public and private
139 domains is to define separate hostnames by adding entries to the `/etc/hosts`
140 file. Here are entries that you could add to a stock `/etc/hosts` file for our
143 .Example added entries for `/etc/hosts`
145 ---------------------------------------------------------------------------
146 127.0.1.2 public.localhost public
147 127.0.1.3 private.localhost private
148 ---------------------------------------------------------------------------
150 Adjust the system dynamic library path
151 --------------------------------------
153 Add `<PREFIX>/lib/` to the system's dynamic library path, and then run
154 `ldconfig` as the *root* Linux account.
156 On Debian, Ubuntu, and Fedora systems, run the following commands as the *root*
159 .Adjusting the system dynamic library path
161 ---------------------------------------------------------------------------
162 echo <PREFIX>/lib > /etc/ld.so.conf.d/opensrf.conf
164 ---------------------------------------------------------------------------
166 On most other systems, you can add these entries to `/etc/ld.so.conf`, or
167 create a file within the `/etc/ld.so.conf.d/` directory, and then run
168 `ldconfig` as the *root* Linux account.
170 Configure the ejabberd server
171 -----------------------------
173 OpenSRF requires an XMPP (Jabber) server. For performance reasons, ejabberd is
174 the Jabber server of choice for the OpenSRF project. In most cases, you only
175 have to make a few changes to the default configuration file to make ejabberd
178 1. Stop ejabberd before making any changes to its configuration by issuing the
179 following command as the *root* Linux account:
181 .(Debian / Ubuntu Trusty) Stopping ejabberd
183 ---------------------------------------------------------------------------
184 /etc/init.d/ejabberd stop
185 ---------------------------------------------------------------------------
187 .(Fedora / Ubuntu Xenial) Stopping ejabberd
189 ---------------------------------------------------------------------------
190 systemctl stop ejabberd.service
191 ---------------------------------------------------------------------------
193 2. Edit the ejabberd config file.
195 (Debian Wheezy / Ubuntu Trusty) Ejabberd 2.x.x::
196 Open `/etc/ejabberd/ejabberd.cfg` and make the following
198 a. Define your public and private domains in the `hosts` directive. For
202 ---------------------------------------------------------------------------
203 {hosts, ["localhost", "private.localhost", "public.localhost"]}.
204 ---------------------------------------------------------------------------
206 b. Change all `maxrate` values to 500000
207 c. Increase the `max_user_sessions` value to 10000
208 d. Comment out the `mod_offline` directive
210 (Debian Jessie) Ejabberd 13.x and 14.x::
211 Open `/etc/ejabberd/ejabberd.yml` and make the following
213 a. Define your public and private domains in the `hosts` directive. For
217 ---------------------------------------------------------------------------
220 - "private.localhost"
222 ---------------------------------------------------------------------------
224 b. Change `shaper:` `normal` and `fast` values to 500000
225 c. Increase the `max_user_sessions:` `all:` value to 10000
226 d. Comment out the `mod_offline` directive
228 -----------------------
230 ##access_max_user_messages: max_user_offline_messages
231 -----------------------
233 (Ubuntu Xenial) Ejabberd 16.x::
234 Open `/etc/ejabberd/ejabberd.yml` and make the following
236 a. Define your public and private domains in the `hosts` directive. For
240 ---------------------------------------------------------------------------
243 - "private.localhost"
245 ---------------------------------------------------------------------------
247 b. Change `auth_password_format` to plain
248 c. Change `shaper:` `normal` and `fast` values to 500000
249 d. Increase the `max_user_sessions:` `all:` value to 10000
250 e. Comment out the `mod_offline` directive
252 -----------------------
254 ##access_max_user_messages: max_user_offline_messages
255 -----------------------
257 3. Restart the ejabberd server to make the changes take effect:
259 .(Debian / Ubuntu Trusty) Starting ejabberd
261 ---------------------------------------------------------------------------
262 /etc/init.d/ejabberd start
263 ---------------------------------------------------------------------------
265 .(Fedora / Ubuntu Xenial) Starting ejabberd
267 ---------------------------------------------------------------------------
268 systemctl start ejabberd.service
269 ---------------------------------------------------------------------------
271 Create the OpenSRF Jabber users
272 -------------------------------
274 On each domain, you need two Jabber users to manage the OpenSRF communications:
276 * a `router` user, to whom all requests to connect to an OpenSRF service
277 will be routed; this Jabber user must be named `router`
278 * an `opensrf` user, which clients use to connect to OpenSRF services; this
279 user can be named anything you like
281 Create the Jabber users by issuing the following commands as the *root* Linux
282 account. Substitute `<password>` for your chosen passwords for each user
285 .Creating the OpenSRF Jabber users
287 ---------------------------------------------------------------------------
288 ejabberdctl register router private.localhost <password>
289 ejabberdctl register opensrf private.localhost <password>
290 ejabberdctl register router public.localhost <password>
291 ejabberdctl register opensrf public.localhost <password>
292 ---------------------------------------------------------------------------
294 Update the OpenSRF configuration files
295 --------------------------------------
297 About the OpenSRF configuration files
298 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
299 There are several configuration files that you must update to make OpenSRF
300 work. SYSCONFDIR is `/opensrf/etc` by default, or the value that you passed to
301 `--sysconfdir` during the configuration phase.
303 * `SYSCONFDIR/opensrf.xml` - this file lists the services that this
304 OpenSRF installation supports; if you create a new OpenSRF service,
305 you need to add it to this file.
306 ** The `<hosts>` element at the bottom of the file lists the services
307 that should be started for each hostname. You can force the system
308 to use `localhost`, so in most cases you will leave this section
311 * `SYSCONFDIR/opensrf_core.xml` - this file lists the Jabber connection
312 information that will be used for the system, as well as determining
313 logging verbosity and defining which services will be exposed on the
316 * `~/.srfsh.xml` - this file gives a Linux account the ability to use
317 the `srfsh` interpreter to communicate with OpenSRF services.
319 Updating the OpenSRF configuration files
320 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
321 1. As the *opensrf* Linux account, copy the example configuration files
322 to create your locally customizable OpenSRF configuration files:
324 .Copying the example OpenSRF configuration files
326 ---------------------------------------------------------------------------
328 cp opensrf_core.xml.example opensrf_core.xml
329 cp opensrf.xml.example opensrf.xml
330 ---------------------------------------------------------------------------
332 2. Edit the `SYSCONFDIR/opensrf_core.xml` file to update the four username
333 / password pairs to match the Jabber user accounts you just created:
335 a. `<config><opensrf>` = use the private Jabber `opensrf` user
336 b. `<config><gateway>` = use the public Jabber `opensrf` user
337 c. `<config><routers><router>` = use the public Jabber `router` user
338 d. `<config><routers><router>` = use the private Jabber `router` user
339 3. Create a `.srfsh.xml` file in the home directory of each user
340 that you want to use `srfsh` to communicate with OpenSRF services. For
341 example, to enable the *opensrf* Linux account to use `srfsh`:
342 a. `cp SYSCONFDIR/srfsh.xml.example ~/.srfsh.xml`
343 b. Open `~/.srfsh.xml` in your text editor of choice and update the
344 password to match the password you set for the Jabber `opensrf` user
345 at the `private.localhost` domain.
347 Starting and stopping OpenSRF services
348 --------------------------------------
350 To start all OpenSRF services with a hostname of `localhost`, issue the
351 following command as the *opensrf* Linux account:
354 ---------------------------------------------------------------------------
355 osrf_control --localhost --start-all
356 ---------------------------------------------------------------------------
358 To stop all OpenSRF services with a hostname of `localhost`, issue the
359 following command as the *opensrf* Linux account:
362 ---------------------------------------------------------------------------
363 osrf_control --localhost --stop-all
364 ---------------------------------------------------------------------------
366 Testing the default OpenSRF services
367 ------------------------------------
369 By default, OpenSRF ships with an `opensrf.math` service that performs basic
370 calculations involving two integers. Once you have started the OpenSRF
371 services, test the services as follows:
373 1. Start the `srfsh` interactive OpenSRF shell by issuing the following
374 command as the *opensrf* Linux account:
376 .Starting the `srfsh` interactive OpenSRF shell
378 ---------------------------------------------------------------------------
380 ---------------------------------------------------------------------------
382 2. Issue the following request to test the `opensrf.math` service:
385 ---------------------------------------------------------------------------
386 srfsh# request opensrf.math add 2,2
387 ---------------------------------------------------------------------------
389 You should receive the value `4`.
391 Optional: Websockets installation instructions
392 ----------------------------------------------
393 Websockets are new to OpenSRF 2.4+ and are required for operating the new web-based
394 staff client for Evergreen. Complete the following steps as the *root* Linux
397 1. Install git if not already present:
400 ---------------------------------------------------------------------------
401 apt-get install git-core
402 ---------------------------------------------------------------------------
404 2. Install the apache-websocket module:
407 ---------------------------------------------------------------------------
408 # Use a temporary directory
410 git clone https://github.com/disconnect/apache-websocket
412 apxs2 -i -a -c mod_websocket.c
413 ---------------------------------------------------------------------------
415 3. Create the websocket Apache instance (more information about this in
416 `/usr/share/doc/apache2/README.multiple-instances`)
420 ---------------------------------------------------------------------------
421 sh /usr/share/doc/apache2.2-common/examples/setup-instance websockets
422 ---------------------------------------------------------------------------
424 .(Ubuntu Trusty / Xenial)
426 ---------------------------------------------------------------------------
427 sh /usr/share/doc/apache2/examples/setup-instance websockets
428 ---------------------------------------------------------------------------
430 4. Remove from the main apache instance
433 ---------------------------------------------------------------------------
435 ---------------------------------------------------------------------------
437 5. Copy into place the config files
441 ---------------------------------------------------------------------------
442 cp examples/apache2/websockets/apache2.conf /etc/apache2-websockets/
443 ---------------------------------------------------------------------------
445 .(Ubuntu Trusty / Xenial)
447 ---------------------------------------------------------------------------
448 cp examples/apache_24/websockets/apache2.conf /etc/apache2-websockets/
449 ---------------------------------------------------------------------------
451 6. OPTIONAL: add these configuration variables to `/etc/apache2-websockets/envvars`
452 and adjust as needed.
455 ---------------------------------------------------------------------------
456 export OSRF_WEBSOCKET_IDLE_TIMEOUT=120
457 export OSRF_WEBSOCKET_IDLE_CHECK_INTERVAL=5
458 export OSRF_WEBSOCKET_CONFIG_FILE=/openils/conf/opensrf_core.xml
459 export OSRF_WEBSOCKET_CONFIG_CTXT=gateway
460 export OSRF_WEBSOCKET_MAX_REQUEST_WAIT_TIME=600
461 ---------------------------------------------------------------------------
463 * `IDLE_TIMEOUT` specifies how long we will allow a client to stay connected
464 while idle. A longer timeout means less network traffic (from fewer
465 websocket CONNECT calls), but it also means more Apache processes are
466 tied up doing nothing.
467 * `IDLE_CHECK_INTERVAL` specifies how often we wake to check the idle status
468 of the connected client.
469 * `MAX_REQUEST_WAIT_TIME` is the maximum amount of time the gateway will
470 wait before declaring a client as idle when there is a long-running
471 outstanding request, yet no other activity is occurring. This is
472 primarily a fail-safe to allow idle timeouts when one or more requests
473 died on the server, and thus no response was ever delivered to the gateway.
474 * `CONFIG_FILE / CTXT` are the standard opensrf core config options.
476 7. Before you can start websockets, you must install a valid SSL certificate
477 in `/etc/apache2/ssl/`. It is possible, but not recommended, to generate a
478 self-signed SSL certificate. For example, if you need to test with a self-signed
479 certicate on Chrome or Chromimum browsers, one workaround is to start the browser
480 with `--ignore-certificate-errors`.
482 8. After OpenSRF is up and running (or after any re-install),
483 fire up the secondary Apache instance. Errors will appear in
484 `/var/log/apache2-websockets/error.log`. Start apache2-websockets with:
487 ---------------------------------------------------------------------------
488 /etc/init.d/apache2-websockets start
489 ---------------------------------------------------------------------------
491 Troubleshooting note for Python users
492 -------------------------------------
494 If you are running a Python client and trying to connect to OpenSRF running on
495 localhost rather than a hostname that can be resolved via DNS, you will
496 probably receive exceptions about `dns.resolver.NXDOMAIN`. If this happens,
497 you need to install the `dnsmasq` package, configure it to serve up a DNS
498 entry for localhost, and point your local DNS resolver to `dnsmasq`. For example,
499 on Ubuntu you can issue the following commands as the *root* Linux account:
501 .(Debian / Ubuntu) Installing and starting `dnsmasq`
503 ---------------------------------------------------------------------------
504 aptitude install dnsmasq
505 /etc/init.d/dnsmasq restart
506 ---------------------------------------------------------------------------
508 Then edit `/etc/resolv.conf` and ensure that `nameserver 127.0.0.1` is the
509 first entry in the file.
514 Need help installing or using OpenSRF? Join the mailing lists at
515 http://evergreen-ils.org/communicate/mailing-lists/ or contact us
516 on the Freenode IRC network on the #evergreen channel.