1 README for OpenSRF 2.0.2
2 ========================
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 for Evergreen.
31 Issue the following commands as the root user to install prerequisites
32 using the Makefile.install prerequisite installer, substituting your
33 operating system identifier for <osname> below:
35 ---------------------------------------------------------------------------
37 make -f src/extras/Makefile.install <osname>
38 ---------------------------------------------------------------------------
40 Well-tested values for <osname> include:
42 * `debian-lenny` for Debian 5.0
43 * `debian-squeeze` for Debian 6.0.0
44 * `ubuntu-hardy` for Ubuntu 8.04
45 * `ubuntu-lucid` for Ubuntu 10.04
46 * `ubuntu-precise` for Ubuntu 12.04
47 * `fedora` for Fedora 16
49 Less-tested values for <osname> include:
51 * `centos` for CentOS 5
52 * `rhel` for Red Hat Enterprise Linux 5
54 Patches and suggestions for improvement from users of these distributions,
55 or others, are welcome!
57 When the prerequisite installer reaches the Perl module stage, you may
58 be prompted for configuration of Comprehensive Perl Archive Network (CPAN)
59 on your server. You can generally accept the defaults by pressing <return>
60 for all of the prompts, except for the country configuration.
62 Preamble: Developer instructions
63 --------------------------------
66 Skip this section if you are using an official release tarball downloaded
67 from http://evergreen-ils.org/downloads
69 Developers working directly with the source code from the Git repository,
70 rather than an official release tarball, must install some extra packages
71 and perform one step before they can proceed with the `./configure` step.
73 As the *root* Linux account, install the following packages:
79 As the *user* Linux account, issue the following command in the OpenSRF
80 source directory to generate the configure script and Makefiles:
83 ------------------------------------------------------------------------------
85 ------------------------------------------------------------------------------
87 Configuration and compilation instructions
88 ------------------------------------------
90 Use the `configure` command to configure OpenSRF, and the `make` command to
91 build OpenSRF. The default installation prefix (PREFIX) for OpenSRF is
94 If you are building OpenSRF for Evergreen, issue the following commands as
95 the *user* Linux account to configure and build OpenSRF:
97 ---------------------------------------------------------------------------
98 ./configure --prefix=/openils --sysconfdir=/openils/conf
100 ---------------------------------------------------------------------------
102 By default, OpenSRF includes C, Perl, and JavaScript support.
103 You can add the `--enable-python` option to the configure command
104 to build Python support and `--enable-java` for Java support.
106 Installation instructions
107 -------------------------
109 1. Once you have configured and compiled OpenSRF, issue the following
110 command as the *root* Linux account to install OpenSRF:
113 ---------------------------------------------------------------------------
115 ---------------------------------------------------------------------------
117 Create and set up the opensrf Unix user environment
118 ---------------------------------------------------
120 This user is used to start and stop all OpenSRF processes, and must own all
121 files contained in the PREFIX directory hierarchy. Issue the following
122 commands as the *root* Linux account to create the `opensrf` user and set up
123 its environment, substituting <PREFIX> with the value you passed to `--prefix`
124 in your configure command:
126 .Creating the `opensrf` user
128 ---------------------------------------------------------------------------
129 useradd -m -s /bin/bash opensrf
130 echo "export PATH=\$PATH:/<PREFIX>/bin" >> /home/opensrf/.bashrc
132 chown -R opensrf:opensrf /<PREFIX>
133 ---------------------------------------------------------------------------
135 Define your public and private OpenSRF domains
136 ----------------------------------------------
138 For security purposes, OpenSRF uses Jabber domains to separate services
139 into public and private realms. Throughout these instructions, we will use
140 the example domains `public.localhost` and `private.localhost`.
142 On a single-server system, the easiest way to define public and private
143 domains is to define separate hostnames by adding entries to the `/etc/hosts`
144 file. Here are entries that you could add to a stock `/etc/hosts` file for our
147 .Example added entries for `/etc/hosts`
148 ---------------------------------------------------------------------------
149 127.0.1.2 public.localhost public
150 127.0.1.3 private.localhost private
151 ---------------------------------------------------------------------------
153 Adjust the system dynamic library path
154 --------------------------------------
156 Add `<PREFIX>/lib/` to the system's dynamic library path, and then run
157 `ldconfig` as the *root* Linux account.
159 On Debian, Ubuntu, and Fedora systems, run the following commands as the *root*
162 .Adjusting the system dynamic library path
164 ---------------------------------------------------------------------------
165 echo <PREFIX>/lib > /etc/ld.so.conf.d/opensrf.conf
167 ---------------------------------------------------------------------------
169 On most other systems, you can add these entries to `/etc/ld.so.conf`, or
170 create a file within the `/etc/ld.so.conf.d/` directory, and then run
171 `ldconfig` as the *root* Linux account.
173 Configure the ejabberd server
174 -----------------------------
176 OpenSRF requires an XMPP (Jabber) server. For performance reasons, ejabberd is
177 the Jabber server of choice for the OpenSRF project. In most cases, you only
178 have to make a few changes to the default `ejabberd.cfg` file to make ejabberd
181 1. Stop ejabberd before making any changes to its configuration by issuing the
182 following command as the *root* Linux account:
184 .(Debian / Ubuntu) Stopping ejabberd
186 ---------------------------------------------------------------------------
187 /etc/init.d/ejabberd stop
188 ---------------------------------------------------------------------------
190 .(Fedora) Stopping ejabberd
192 ---------------------------------------------------------------------------
193 systemctl stop ejabberd.service
194 ---------------------------------------------------------------------------
196 2. Open `/etc/ejabberd/ejabberd.cfg` and make the following
198 a. Define your public and private domains in the `hosts` directive. For
201 ---------------------------------------------------------------------------
202 {hosts, ["localhost", "private.localhost", "public.localhost"]}.
203 ---------------------------------------------------------------------------
205 b. Comment out the `mod_offline` directive
206 c. Increase the `max_user_sessions` value to 10000
207 d. Change all `max_stanza_size` values to 2000000
208 e. Change all `maxrate` values to 500000
210 3. Restart the ejabberd server to make the changes take effect:
212 .(Debian / Ubuntu) Starting ejabberd
214 ---------------------------------------------------------------------------
215 /etc/init.d/ejabberd start
216 ---------------------------------------------------------------------------
218 .(Fedora) Starting ejabberd
220 ---------------------------------------------------------------------------
221 systemctl start ejabberd.service
222 ---------------------------------------------------------------------------
224 Create the OpenSRF Jabber users
225 -------------------------------
227 On each domain, you need two Jabber users to manage the OpenSRF communications:
229 * a `router` user, to whom all requests to connect to an OpenSRF service
230 will be routed; this Jabber user must be named `router`
231 * an `opensrf` user, which clients use to connect to OpenSRF services; this
232 user can be named anything you like
234 Create the Jabber users by issuing the following commands as the *root* Linux
235 account. Substitute `<password>` for your chosen passwords for each user
238 .Creating the OpenSRF Jabber users
240 ---------------------------------------------------------------------------
241 ejabberdctl register router private.localhost <password>
242 ejabberdctl register opensrf private.localhost <password>
243 ejabberdctl register router public.localhost <password>
244 ejabberdctl register opensrf public.localhost <password>
245 ---------------------------------------------------------------------------
247 Update the OpenSRF configuration files
248 --------------------------------------
250 About the OpenSRF configuration files
251 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
252 There are several configuration files that you must update to make OpenSRF
253 work. SYSCONFDIR is `/opensrf/etc` by default, or the value that you passed to
254 `--sysconfdir` during the configuration phase.
256 * `SYSCONFDIR/opensrf.xml` - this file lists the services that this
257 OpenSRF installation supports; if you create a new OpenSRF service,
258 you need to add it to this file.
259 ** The `<hosts>` element at the bottom of the file lists the services
260 that should be started for each hostname. You can force the system
261 to use `localhost`, so in most cases you will leave this section
264 * `SYSCONFDIR/opensrf_core.xml` - this file lists the Jabber connection
265 information that will be used for the system, as well as determining
266 logging verbosity and defining which services will be exposed on the
269 * `~/.srfsh.xml` - this file gives a Linux account the ability to use
270 the `srfsh` interpreter to communicate with OpenSRF services.
272 Updating the OpenSRF configuration files
273 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
274 1. As the *opensrf* Linux account, copy the example configuration files
275 to create your locally customizable OpenSRF configuration files:
277 .Copying the example OpenSRF configuration files
279 ---------------------------------------------------------------------------
281 cp opensrf_core.xml.example opensrf_core.xml
282 cp opensrf.xml.example opensrf.xml
283 ---------------------------------------------------------------------------
285 2. Edit the `SYSCONFDIR/opensrf_core.xml` file to update the four username
286 / password pairs to match the Jabber user accounts you just created:
288 a. `<config><opensrf>` = use the private Jabber `opensrf` user
289 b. `<config><gateway>` = use the public Jabber `opensrf` user
290 c. `<config><routers><router>` = use the public Jabber `router` user
291 d. `<config><routers><router>` = use the private Jabber `router` user
292 3. Create a `.srfsh.xml` file in the home directory of each user
293 that you want to use `srfsh` to communicate with OpenSRF services. For
294 example, to enable the *opensrf* Linux account to use `srfsh`:
295 a. `cp SYSCONFDIR/srfsh.xml.example ~/.srfsh.xml`
296 b. Open `~/.srfsh.xml` in your text editor of choice and update the
297 password to match the password you set for the Jabber `opensrf` user
298 at the `private.localhost` domain.
300 Starting and stopping OpenSRF services
301 --------------------------------------
303 To start all OpenSRF services with a hostname of `localhost`, issue the
304 following command as the *opensrf* Linux account:
307 ---------------------------------------------------------------------------
308 osrf_ctl.sh -l -a start_all
309 ---------------------------------------------------------------------------
311 To stop all OpenSRF services with a hostname of `localhost`, issue the
312 following command as the *opensrf* Linux account:
315 ---------------------------------------------------------------------------
316 osrf_ctl.sh -l -a stop_all
317 ---------------------------------------------------------------------------
319 Testing the default OpenSRF services
320 ------------------------------------
322 By default, OpenSRF ships with an `opensrf.math` service that performs basic
323 calculations involving two integers. Once you have started the OpenSRF
324 services, test the services as follows:
326 1. Start the `srfsh` interactive OpenSRF shell by issuing the following
327 command as the *opensrf* Linux account:
329 .Starting the `srfsh` interactive OpenSRF shell
331 ---------------------------------------------------------------------------
333 ---------------------------------------------------------------------------
335 2. Issue the following request to test the `opensrf.math` service:
337 ---------------------------------------------------------------------------
338 srfsh# request opensrf.math add 2,2
339 ---------------------------------------------------------------------------
341 You should receive the value `4`.
343 Troubleshooting note for Python users
344 -------------------------------------
346 If you are running a Python client and trying to connect to OpenSRF running on
347 localhost rather than a hostname that can be resolved via DNS, you will
348 probably receive exceptions about `dns.resolver.NXDOMAIN`. If this happens,
349 you need to install the `dnsmasq` package, configure it to serve up a DNS
350 entry for localhost, and point your local DNS resolver to `dnsmasq`. For example,
351 on Ubuntu you can issue the following commands as the *root* Linux account:
353 .(Debian / Ubuntu) Installing and starting `dnsmasq`
355 ---------------------------------------------------------------------------
356 aptitude install dnsmasq
357 /etc/init.d/dnsmasq restart
358 ---------------------------------------------------------------------------
360 Then edit `/etc/resolv.conf` and ensure that `nameserver 127.0.0.1` is the
361 first entry in the file.
366 Need help installing or using OpenSRF? Join the mailing lists at
367 http://evergreen-ils.org/listserv.php or contact us on the Freenode
368 IRC network on the #evergreen channel.