LP#1315531 Quick clarification about which Ubuntu we mean.
[working/Evergreen.git] / docs / installation / server_installation.txt
1 Installing the Evergreen server
2 ===============================
3 :toc:
4 :numbered:
5
6 Preamble: referenced user accounts
7 ----------------------------------
8
9 In subsequent sections, we will refer to a number of different accounts, as
10 follows:
11
12   * Linux user accounts:
13     ** The *user* Linux account is the account that you use to log onto the
14        Linux system as a regular user.
15     ** The *root* Linux account is an account that has system administrator
16        privileges. On Debian and Fedora you can switch to this account from
17        your *user* account by issuing the `su -` command and entering the
18        password for the *root* account when prompted. On Ubuntu you can switch
19        to this account from your *user* account using the `sudo su -` command
20        and entering the password for your *user* account when prompted.
21     ** The *opensrf* Linux account is an account that you create when installing
22        OpenSRF. You can switch to this account from the *root* account by
23        issuing the `su - opensrf` command.
24     ** The *postgres* Linux account is created automatically when you install
25        the PostgreSQL database server. You can switch to this account from the
26        *root* account by issuing the `su - postgres` command.
27   * PostgreSQL user accounts:
28     ** The *evergreen* PostgreSQL account is a superuser account that you will
29        create to connect to the PostgreSQL database server.
30   * Evergreen administrator account:
31     ** The *egadmin* Evergreen account is an administrator account for
32        Evergreen that you will use to test connectivity and configure your
33        Evergreen instance.
34
35 Preamble: developer instructions
36 --------------------------------
37
38 [NOTE]
39 Skip this section if you are using an official release tarball downloaded
40 from http://evergreen-ils.org/downloads
41
42 Developers working directly with the source code from the Git repository,
43 rather than an official release tarball, must install some extra packages
44 and perform one step before they can proceed with the `./configure` step.
45
46 As the *root* Linux account, install the following packages:
47
48   * autoconf
49   * automake
50   * libtool
51
52 As the *user* Linux account, issue the following command in the Evergreen
53 source directory to generate the configure script and Makefiles:
54
55 [source, bash]
56 ------------------------------------------------------------------------------
57 autoreconf -i
58 ------------------------------------------------------------------------------
59
60 Installing prerequisites
61 ------------------------
62
63 Evergreen has a number of prerequisite packages that must be installed
64 before you can successfully configure, compile, and install Evergreen.
65
66 1. Begin by installing the most recent version of OpenSRF (2.3.0 or later).
67    You can download OpenSRF releases from http://evergreen-ils.org/opensrf-downloads/
68 2. On many distributions, it is necessary to install PostgreSQL 9 from external
69    repositories.
70 +
71   * On Debian Squeeze, open `/etc/apt/sources.list` in a text editor as the
72     *root* Linux account and add the following line:
73 +
74 [source, bash]
75 ------------------------------------------------------------------------------
76 deb http://backports.debian.org/debian-backports squeeze-backports main contrib
77 ------------------------------------------------------------------------------
78 +
79   * On Ubuntu Lucid, you can use a PPA (personal package archive), which are 
80     package sources hosted on Launchpad. The one most commonly used by Evergreen
81     Community members is maintained by Martin Pitt, who also maintains the
82     official PostgreSQL packages for Ubuntu. As the *root* Linux account, issue
83     the following commands to add the PPA source:
84 +
85 [source, bash]
86 ------------------------------------------------------------------------------
87 apt-get install python-software-properties
88 add-apt-repository ppa:pitti/postgresql
89 ------------------------------------------------------------------------------
90 +
91   * Ubuntu Precise comes with PostgreSQL 9, so no additional steps are required.
92 +
93   * Fedora comes with PostgreSQL 9, so no additional steps are required.
94 +
95 3. On Debian and Ubuntu, run `aptitude update` as the *root* Linux account to
96    retrieve the new packages from the backports repository.
97 4. Issue the following commands as the *root* Linux account to install
98    prerequisites using the `Makefile.install` prerequisite installer,
99    substituting `debian-squeeze`, `debian-wheezy`, `fedora`, `ubuntu-lucid`, or
100    `ubuntu-precise` for <osname> below:
101 +
102 [source, bash]
103 ------------------------------------------------------------------------------
104 make -f Open-ILS/src/extras/Makefile.install <osname>
105 ------------------------------------------------------------------------------
106 +
107 5. Add the libdbi-libdbd libraries to the system dynamic library path by
108    issuing the following commands as the *root* Linux account:
109 +
110 [NOTE]
111 You should skip this step if installing on Ubuntu Precise or Trusty. The ubuntu
112 targets use libdbd-pgsql from packages.
113 +
114 .Debian
115 [source, bash]
116 ------------------------------------------------------------------------------
117 echo "/usr/local/lib/dbd" > /etc/ld.so.conf.d/eg.conf
118 ldconfig
119 ------------------------------------------------------------------------------
120 +
121 .Fedora
122 [source, bash]
123 ------------------------------------------------------------------------------
124 echo "/usr/lib64/dbd" > /etc/ld.so.conf.d/eg.conf
125 ldconfig
126 ------------------------------------------------------------------------------
127
128 Configuration and compilation instructions
129 ------------------------------------------
130
131 For the time being, we are still installing everything in the `/openils/`
132 directory. From the Evergreen source directory, issue the following commands as
133 the *user* Linux account to configure and build Evergreen:
134
135 [source, bash]
136 ------------------------------------------------------------------------------
137 PATH=/openils/bin:$PATH ./configure --prefix=/openils --sysconfdir=/openils/conf
138 make
139 ------------------------------------------------------------------------------
140
141 These instructions assume that you have also installed OpenSRF under `/openils/`.
142 If not, please adjust PATH as needed so that the Evergreen `configure` script
143 can find `osrf_config`.
144
145 Installation instructions
146 -------------------------
147
148 1. Once you have configured and compiled Evergreen, issue the following
149    command as the *root* Linux account to install Evergreen, build the server
150    portion of the staff client, and copy example configuration files to
151    `/openils/conf`.
152    Change the value of the `STAFF_CLIENT_STAMP_ID` variable to match the version
153    of the staff client that you will use to connect to the Evergreen server.
154 +
155 [source, bash]
156 ------------------------------------------------------------------------------
157 make STAFF_CLIENT_STAMP_ID=rel_name install
158 ------------------------------------------------------------------------------
159 +
160 2. The server portion of the staff client expects `http://hostname/xul/server`
161    to resolve. Issue the following commands as the *root* Linux account to
162    create a symbolic link pointing to the `server` subdirectory of the server
163    portion of the staff client that we just built using the staff client ID
164    'rel_name':
165 +
166 [source, bash]
167 ------------------------------------------------------------------------------
168 cd /openils/var/web/xul
169 ln -sf rel_name/server server
170 ------------------------------------------------------------------------------
171
172 Change ownership of the Evergreen files
173 ---------------------------------------
174
175 All files in the `/openils/` directory and subdirectories must be owned by the
176 `opensrf` user. Issue the following command as the *root* Linux account to
177 change the ownership on the files:
178
179 [source, bash]
180 ------------------------------------------------------------------------------
181 chown -R opensrf:opensrf /openils
182 ------------------------------------------------------------------------------
183
184 Additional Instructions for Developers
185 --------------------------------------
186
187 [NOTE]
188 Skip this section if you are using an official release tarball downloaded
189 from http://evergreen-ils.org/downloads
190
191 Developers working directly with the source code from the Git repository,
192 rather than an official release tarball, need to install the Dojo Toolkit
193 set of JavaScript libraries. The appropriate version of Dojo is included in
194 Evergreen release tarballs. Developers should install the Dojo 1.3.3 version
195 of Dojo by issuing the following commands as the *opensrf* Linux account:
196
197 [source, bash]
198 ------------------------------------------------------------------------------
199 wget http://download.dojotoolkit.org/release-1.3.3/dojo-release-1.3.3.tar.gz
200 tar -C /openils/var/web/js -xzf dojo-release-1.3.3.tar.gz
201 cp -r /openils/var/web/js/dojo-release-1.3.3/* /openils/var/web/js/dojo/.
202 ------------------------------------------------------------------------------
203
204
205 Configure the Apache Web server
206 -------------------------------
207
208 1. Use the example configuration files in `Open-ILS/examples/apache/` (for
209 Apache versions below 2.4) or `Open-ILS/examples/apache_24/` (for Apache
210 versions 2.4 or greater) to configure your Web server for the Evergreen
211 catalog, staff client, Web services, and administration interfaces. Issue the
212 following commands as the *root* Linux account:
213 +
214 .Debian and Ubuntu Precise
215 [source,bash]
216 ------------------------------------------------------------------------------
217 cp Open-ILS/examples/apache/eg.conf       /etc/apache2/sites-available/
218 cp Open-ILS/examples/apache/eg_vhost.conf /etc/apache2/
219 cp Open-ILS/examples/apache/eg_startup    /etc/apache2/
220 # Now set up SSL
221 mkdir /etc/apache2/ssl
222 cd /etc/apache2/ssl
223 ------------------------------------------------------------------------------
224 +
225 .Ubuntu Trusty
226 [source,bash]
227 ------------------------------------------------------------------------------------
228 cp Open-ILS/examples/apache_24/eg_24.conf       /etc/apache2/sites-available/eg.conf
229 cp Open-ILS/examples/apache_24/eg_vhost_24.conf /etc/apache2/eg_vhost.conf
230 cp Open-ILS/examples/apache/eg_startup          /etc/apache2/
231 # Now set up SSL
232 mkdir /etc/apache2/ssl
233 cd /etc/apache2/ssl
234 ------------------------------------------------------------------------------------
235 +
236 .Fedora
237 [source,bash]
238 ------------------------------------------------------------------------------
239 cp Open-ILS/examples/apache_24/eg_24.conf       /etc/httpd/conf.d/
240 cp Open-ILS/examples/apache_24/eg_vhost_24.conf /etc/httpd/eg_vhost.conf
241 cp Open-ILS/examples/apache/eg_startup          /etc/httpd/
242 # Now set up SSL
243 mkdir /etc/httpd/ssl
244 cd /etc/httpd/ssl
245 ------------------------------------------------------------------------------
246 +
247 2. The `openssl` command cuts a new SSL key for your Apache server. For a
248 production server, you should purchase a signed SSL certificate, but you can
249 just use a self-signed certificate and accept the warnings in the staff client
250 and browser during testing and development. Create an SSL key for the Apache
251 server by issuing the following command as the *root* Linux account:
252 +
253 [source,bash]
254 ------------------------------------------------------------------------------
255 openssl req -new -x509 -days 365 -nodes -out server.crt -keyout server.key
256 ------------------------------------------------------------------------------
257 +
258 3. As the *root* Linux account, edit the `eg.conf` file that you copied into
259 place.
260   a. To enable access to the offline upload / execute interface from any
261      workstation on any network, make the following change (and note that
262      you *must* secure this for a production instance):
263      * (Apache 2.2): Replace `Allow from 10.0.0.0/8` with `Allow from all`
264      * (Apache 2.4): Replace `Require host 10.0.0.0/8` with `Require all granted`
265   b. (Fedora): Change references from the non-existent `/etc/apache2/` directory
266      to `/etc/httpd/`.
267 4. Change the user for the Apache server.
268   * (Debian and Ubuntu): As the *root* Linux account, edit
269     `/etc/apache2/envvars`.  Change `export APACHE_RUN_USER=www-data` to 
270     `export APACHE_RUN_USER=opensrf`.
271   * (Fedora): As the *root* Linux account , edit `/etc/httpd/conf/httpd.conf`.
272     Change `User apache` to `User opensrf`.
273 5. Configure Apache with performance settings appropriate for Evergreen:
274   * (Debian and Ubuntu): As the *root* Linux account, edit
275     `/etc/apache2/apache2.conf`:
276   * (Fedora): As the *root* Linux account, edit `/etc/httpd/conf/httpd.conf`:
277     a. Change `KeepAliveTimeout` to `1`. Higher values reduce the chance of
278        a request timing out unexpectedly, but increase the risk of using up
279        all available Apache child processes.
280     b. 'Optional': Change `MaxKeepAliveRequests` to `100`
281     c. (Debian, Ubuntu Precise, and Fedora) Update the prefork configuration 
282        section to suit your environment. The following settings apply to a busy 
283        system:
284 +
285 [source,bash]
286 ------------------------------------------------------------------------------
287 <IfModule mpm_prefork_module>
288    StartServers           20
289    MinSpareServers         5
290    MaxSpareServers        15
291    MaxClients            150
292    MaxRequestsPerChild 10000
293 </IfModule>
294 ------------------------------------------------------------------------------
295     d. (Ubuntu Trusty) As the *root* user, edit 
296        /etc/apache2/mods-available/mpm_prefork.conf to match the above values.  
297        Then, also as the *root* user, enable the mpm_prefork module by doing:
298 +
299 [source,bash]
300 ------------------------------------------------------------------------------
301 a2dismod mpm_event
302 a2enmod mpm_prefork
303 ------------------------------------------------------------------------------
304 +
305 6. (Fedora): As the *root* Linux account, edit the `/etc/httpd/eg_vhost.conf`
306    file to change references from the non-existent `/etc/apache2/` directory
307    to `/etc/httpd/`.
308 7. (Debian and Ubuntu Precise): As the *root* Linux account, enable the Evergreen site:
309 +
310 [source,bash]
311 ------------------------------------------------------------------------------
312 a2dissite default  # OPTIONAL: disable the default site (the "It Works" page)
313 a2ensite eg.conf
314 ------------------------------------------------------------------------------
315 (Ubuntu Trusty):
316 +
317 [source,bash]
318 ------------------------------------------------------------------------------
319 a2dissite 000-default  # OPTIONAL: disable the default site (the "It Works" page)
320 a2ensite eg.conf
321 ------------------------------------------------------------------------------
322
323 8. (Ubuntu): As the *root* Linux account, enable Apache to write
324    to the lock directory; this is currently necessary because Apache
325    is running as the `opensrf` user:
326 +
327 [source,bash]
328 ------------------------------------------------------------------------------
329 chown opensrf /var/lock/apache2
330 ------------------------------------------------------------------------------
331
332 Configure OpenSRF for the Evergreen application
333 -----------------------------------------------
334 There are a number of example OpenSRF configuration files in `/openils/conf/`
335 that you can use as a template for your Evergreen installation. Issue the
336 following commands as the *opensrf* Linux account:
337
338 [source, bash]
339 ------------------------------------------------------------------------------
340 cp -b /openils/conf/opensrf_core.xml.example /openils/conf/opensrf_core.xml
341 cp -b /openils/conf/opensrf.xml.example /openils/conf/opensrf.xml
342 ------------------------------------------------------------------------------
343
344 When you installed OpenSRF, you created four Jabber users on two
345 separate domains and edited the `opensrf_core.xml` file accordingly. Please
346 refer back to the OpenSRF README and, as the *opensrf* Linux account, edit the
347 Evergreen version of the `opensrf_core.xml` file using the same Jabber users
348 and domains as you used while installing and testing OpenSRF.
349
350 [NOTE]
351 The `-b` flag tells the `cp` command to create a backup version of the
352 destination file. The backup version of the destination file has a tilde (`~`)
353 appended to the file name, so if you have forgotten the Jabber users and
354 domains, you can retrieve the settings from the backup version of the files.
355
356 `eg_db_config`, described in the following section, sets the database
357 connection information in `opensrf.xml` for you.
358
359 Creating the Evergreen database
360 -------------------------------
361
362 Setting up the PostgreSQL server
363 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
364
365 For production use, most libraries install the PostgreSQL database server on a
366 dedicated machine. Therefore, by default, the `Makefile.install` prerequisite
367 installer does *not* install the PostgreSQL 9 database server that is required
368 by every Evergreen system. You can install the packages required by Debian or
369 Ubuntu Lucid on the machine of your choice using the following commands as the
370 *root* Linux account:
371
372 .(Debian / Ubuntu / Fedora) Installing PostgreSQL server packages
373
374 Each OS build target provides the postgres server installation packages
375 required for each operating system.  To install Postgres server packages, 
376 use the make target 'postgres-server-<OSTYPE>'.  Choose the most appropriate 
377 command below based on your operating system.
378
379 [source, bash]
380 ------------------------------------------------------------------------------
381 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-wheezy
382 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-squeeze
383 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-precise
384 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-trusty
385 make -f Open-ILS/src/extras/Makefile.install postgres-server-fedora
386 ------------------------------------------------------------------------------
387
388 .(Fedora) Postgres initialization
389
390 Installing Postgres on Fedora also requires you to initialize the PostgreSQL
391 cluster and start the service. Issue the following commands as the *root* user:
392
393 [source, bash]
394 ------------------------------------------------------------------------------
395 postgresql-setup initdb
396 systemctl start postgresql
397 ------------------------------------------------------------------------------
398
399 For a standalone PostgreSQL server, install the following Perl modules for your
400 distribution as the *root* Linux account:
401
402 .(Ubuntu Precise)
403 [source,bash]
404 ---------------------------------------------------------------------------------
405 apt-get install gcc libxml-libxml-perl libxml-libxslt-perl libbusiness-isbn-perl
406 apt-get install libjson-xs-perl liblibrary-callnumber-lc-perl libmarc-record-perl
407 apt-get install libmarc-xml-perl libuuid-tiny-perl
408 cpan Rose::URI
409 ---------------------------------------------------------------------------------
410
411 .(Debian "wheezy" and Ubuntu Trusty) 
412 standalone PostgreSQL 9 server
413 [source,bash]
414 ---------------------------------------------------------------------------------
415 apt-get install gcc libxml-libxml-perl libxml-libxslt-perl libbusiness-isbn-perl
416 apt-get install libjson-xs-perl liblibrary-callnumber-lc-perl libmarc-record-perl
417 apt-get install libmarc-xml-perl libuuid-tiny-perl librose-uri-perl
418 ---------------------------------------------------------------------------------
419
420 .(Fedora)
421 [source, bash]
422 ------------------------------------------------------------------------------
423 yum install gcc perl-XML-LibXML perl-XML-LibXSLT perl-Business-ISBN
424 yum install perl-Library-CallNumber-LC perl-MARC-Record perl-MARC-Charset
425 yum install perl-MARC-File-XML perl-UUID-Tiny
426 ------------------------------------------------------------------------------
427
428 You need to create a PostgreSQL superuser to create and access the database.
429 Issue the following command as the *postgres* Linux account to create a new
430 PostgreSQL superuser named `evergreen`. When prompted, enter the new user's
431 password:
432
433 [source, bash]
434 ------------------------------------------------------------------------------
435 createuser -s -P evergreen
436 ------------------------------------------------------------------------------
437
438 .Enabling connections to the PostgreSQL database
439
440 Your PostgreSQL database may be configured by default to prevent connections,
441 for example, it might reject attempts to connect via TCP/IP or from other
442 servers. To enable TCP/IP connections from localhost, check your `pg_hba.conf`
443 file, found in the `/etc/postgresql/` directory on Debian and Ubuntu, and in
444 the `/var/lib/pgsql/data/` directory on Fedora. A simple way to enable TCP/IP
445 connections from localhost to all databases with password authentication, which
446 would be suitable for a test install of Evergreen on a single server, is to
447 ensure the file contains the following entries _before_ any "host ... ident"
448 entries:
449
450 ------------------------------------------------------------------------------
451 host    all             all             ::1/128                 md5
452 host    all             all             127.0.0.1/32            md5
453 ------------------------------------------------------------------------------
454
455 When you change the `pg_hba.conf` file, you will need to reload PostgreSQL to
456 make the changes take effect.  For more information on configuring connectivity
457 to PostgreSQL, see
458 http://www.postgresql.org/docs/devel/static/auth-pg-hba-conf.html
459
460 Creating the Evergreen database and schema
461 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
462
463 Once you have created the *evergreen* PostgreSQL account, you also need to
464 create the database and schema, and configure your configuration files to point
465 at the database server. Issue the following command as the *root* Linux account
466 from inside the Evergreen source directory, replacing <user>, <password>,
467 <hostname>, <port>, and <dbname> with the appropriate values for your
468 PostgreSQL database (where <user> and <password> are for the *evergreen*
469 PostgreSQL account you just created), and replace <admin-user> and <admin-pass>
470 with the values you want for the *egadmin* Evergreen administrator account:
471
472 [source, bash]
473 ------------------------------------------------------------------------------
474 perl Open-ILS/src/support-scripts/eg_db_config --update-config \
475        --service all --create-database --create-schema --create-offline \
476        --user <user> --password <password> --hostname <hostname> --port <port> \
477        --database <dbname> --admin-user <admin-user> --admin-pass <admin-pass>
478 ------------------------------------------------------------------------------
479
480 This creates the database and schema and configures all of the services in
481 your `/openils/conf/opensrf.xml` configuration file to point to that database.
482 It also creates the configuration files required by the Evergreen `cgi-bin`
483 administration scripts, and sets the user name and password for the *egadmin*
484 Evergreen administrator account to your requested values.
485
486 You can get a complete set of options for `eg_db_config.pl` by passing the
487 `--help` parameter.
488
489 Loading sample data
490 ~~~~~~~~~~~~~~~~~~~
491 If you add the `--load-all-sample` parameter to the `eg_db_config` command,
492 a set of authority and bibliographic records, call numbers, copies, staff
493 and regular users, and transactions will be loaded into your target
494 database. This sample dataset is commonly referred to as the _concerto_
495 sample data, and can be useful for testing out Evergreen functionality and
496 for creating problem reports that developers can easily recreate with their
497 own copy of the _concerto_ sample data.
498
499 Creating the database on a remote server
500 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
501 In a production instance of Evergreen, your PostgreSQL server should be
502 installed on a dedicated server.
503
504 PostgreSQL 9.1 and later
505 ^^^^^^^^^^^^^^^^^^^^^^^^
506 To create the database instance on a remote database server running PostgreSQL
507 9.1 or later, simply use the `--create-database` flag on `eg_db_config`.
508
509 Starting Evergreen
510 ------------------
511 1. As the *root* Linux account, start the `memcached` and `ejabberd` services
512 (if they aren't already running):
513 +
514 [source, bash]
515 ------------------------------------------------------------------------------
516 /etc/init.d/ejabberd start
517 /etc/init.d/memcached start
518 ------------------------------------------------------------------------------
519 +
520 2. As the *opensrf* Linux account, start Evergreen. The `-l` flag in the
521 following command is only necessary if you want to force Evergreen to treat the
522 hostname as `localhost`; if you configured `opensrf.xml` using the real
523 hostname of your machine as returned by `perl -ENet::Domain 'print
524 Net::Domain::hostfqdn() . "\n";'`, you should not use the `-l` flag.
525 +
526 [source, bash]
527 ------------------------------------------------------------------------------
528 osrf_control -l --start-all
529 ------------------------------------------------------------------------------
530 +
531   ** If you receive the error message `bash: osrf_control: command not found`,
532      then your environment variable `PATH` does not include the `/openils/bin`
533      directory; this should have been set in the *opensrf* Linux account's
534      `.bashrc` configuration file. To manually set the `PATH` variable, edit the
535      configuration file `~/.bashrc` as the *opensrf* Linux account and add the
536      following line:
537 +
538 [source, bash]
539 ------------------------------------------------------------------------------
540 export PATH=$PATH:/openils/bin
541 ------------------------------------------------------------------------------
542 +
543 3. As the *opensrf* Linux account, generate the Web files needed by the staff
544    client and catalogue and update the organization unit proximity (you need to do
545    this the first time you start Evergreen, and after that each time you change
546    the library hierarchy in `config.cgi`):
547 +
548 [source, bash]
549 ------------------------------------------------------------------------------
550 autogen.sh -u
551 ------------------------------------------------------------------------------
552 +
553 4. As the *root* Linux account, restart the Apache Web server:
554 +
555 [source, bash]
556 ------------------------------------------------------------------------------
557 /etc/init.d/apache2 restart
558 ------------------------------------------------------------------------------
559 +
560 If the Apache Web server was running when you started the OpenSRF services, you
561 might not be able to successfully log in to the OPAC or staff client until the
562 Apache Web server is restarted.
563
564 Testing connections to Evergreen
565 --------------------------------
566
567 Once you have installed and started Evergreen, test your connection to
568 Evergreen via `srfsh`. As the *opensrf* Linux account, issue the following
569 commands to start `srfsh` and try to log onto the Evergreen server using the
570 *egadmin* Evergreen administrator user name and password that you set using the
571 `eg_db_config` command:
572
573 [source, bash]
574 ------------------------------------------------------------------------------
575 /openils/bin/srfsh
576 srfsh% login <admin-user> <admin-pass>
577 ------------------------------------------------------------------------------
578
579 You should see a result like:
580
581     Received Data: "250bf1518c7527a03249858687714376"
582     ------------------------------------
583     Request Completed Successfully
584     Request Time in seconds: 0.045286
585     ------------------------------------
586
587     Received Data: {
588        "ilsevent":0,
589        "textcode":"SUCCESS",
590        "desc":" ",
591        "pid":21616,
592        "stacktrace":"oils_auth.c:304",
593        "payload":{
594           "authtoken":"e5f9827cc0f93b503a1cc66bee6bdd1a",
595           "authtime":420
596        }
597
598     }
599
600     ------------------------------------
601     Request Completed Successfully
602     Request Time in seconds: 1.336568
603     ------------------------------------
604
605 If this does not work, it's time to do some troubleshooting.
606
607   * As the *opensrf* Linux account, run the `settings-tester.pl` script to see
608     if it finds any system configuration problems. The script is found at
609     `Open-ILS/src/support-scripts/settings-tester.pl` in the Evergreen source
610     tree.
611   * Follow the steps in the http://evergreen-ils.org/dokuwiki/doku.php?id=troubleshooting:checking_for_errors[troubleshooting guide].
612   * If you have faithfully followed the entire set of installation steps
613     listed here, you are probably extremely close to a working system.
614     Gather your configuration files and log files and contact the
615     http://evergreen-ils.org/communicate/mailing-lists/[Evergreen development 
616 mailing list] for assistance before making any drastic changes to your system
617     configuration.
618
619 Getting help
620 ------------
621
622 Need help installing or using Evergreen? Join the mailing lists at
623 http://evergreen-ils.org/communicate/mailing-lists/ or contact us on the Freenode
624 IRC network on the #evergreen channel.
625
626 License
627 -------
628 This work is licensed under the Creative Commons Attribution-ShareAlike 3.0
629 Unported License. To view a copy of this license, visit
630 http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to Creative
631 Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA.