- Preamble: Referenced User Accounts
- Preamble: Developer Instructions
- Installing Prerequisites
- Extra Steps for Web Staff Client
- Configuration and Compilation Instructions
- Installation Instructions
- Change Ownership of the Evergreen Files
- Run ldconfig
- Additional Instructions for Developers
- Configure the Apache Web Server
- Configure OpenSRF for the Evergreen Application
- Creating the Evergreen Database
- Starting Evergreen
- Testing Connections to Evergreen
- Getting Help
- License
In subsequent sections, we will refer to a number of different accounts, as follows:
- The
userLinux account: The account that you use to log onto the Linux system as a regular user. - The
rootLinux account: An account that has system administrator privileges.- On Debian, you can switch to this account from your
useraccount by issuingsu -and entering the password for therootaccount when prompted. - On Ubuntu, you can switch to this account from your
useraccount usingsudo su -and entering the password for youruseraccount when prompted.
- On Debian, you can switch to this account from your
- The
opensrfLinux account: An account that you create when installing OpenSRF. You can switch to this account from therootaccount by issuingsu - opensrf. - The
postgresLinux account: Created automatically when you install the PostgreSQL database server. You can switch to this account from therootaccount by issuingsu - postgres.
- The
evergreenPostgreSQL account: A superuser account that you will create to connect to the PostgreSQL database server.
- The
egadminEvergreen account: An administrator account for Evergreen that you will use to test connectivity and configure your Evergreen instance.
Note
Skip this section if you are using an official release tarball downloaded from evergreen-ils.org/egdownloads.
Developers working directly with the source code from the Git repository, rather than an official release tarball, must perform one step before they can proceed with the ./configure step.
As the user Linux account, issue the following command in the Evergreen source directory to generate the configure script and Makefiles:
autoreconf -i- PostgreSQL: The minimum supported version is 14.
- Linux: Evergreen has been tested on:
- Debian Trixie (13)
- Debian Bookworm (12)
- Debian Bullseye (11)
- Debian Buster (10)
- Ubuntu Noble Numbat (24.04)
- Ubuntu Jammy Jellyfish (22.04) (If you are running an older version of these distributions, you may want to upgrade before upgrading Evergreen. For instructions, visit the Debian or Ubuntu websites.)
- OpenSRF: The minimum supported version of OpenSRF is 3.3.0.
Evergreen has a number of prerequisite packages that must be installed before you can successfully configure, compile, and install Evergreen.
-
Begin by installing the most recent version of OpenSRF (3.3.0 or later). You can download OpenSRF releases from OpenSRF Downloads.
-
Issue the following commands as the
rootLinux account to install prerequisites using theMakefile.installprerequisite installer, substitutingdebian-bookworm,debian-bullseye,debian-buster,ubuntu-jammy, orubuntu-noblefor<osname>below:make -f Open-ILS/src/extras/Makefile.install <osname>
[!TIP] To save time while installing prerequisites, set the environment variable
NO_CPAN_TESTto1:NO_CPAN_TEST=1 make -f Open-ILS/src/extras/Makefile.install <osname>
To perform certain developer tasks from a Git source code checkout, additional packages are required. As the root Linux account:
- Web dependencies: To install packages needed for retrieving and managing web dependencies, use the
<osname>-developerMakefile.install target (currently only needed for building and installing the web staff client). - Testing: To optionally run Angular and AngularJS tests, you will need to manually install Firefox and your choice of Chromium or Chrome.
make -f Open-ILS/src/extras/Makefile.install <osname>-developer- Translations: To install packages required for building Evergreen translations, use the
<osname>-translatorMakefile.install target:
make -f Open-ILS/src/extras/Makefile.install <osname>-translator- Release bundles: To install packages required for building Evergreen release bundles, use the
<osname>-packagerMakefile.install target:
make -f Open-ILS/src/extras/Makefile.install <osname>-packagerNote
Skip this entire section if you are using an official release tarball downloaded from evergreen-ils.org/downloads. Otherwise, ensure you have installed the Optional Developer Additions before proceeding.
-
Navigate to the staff JS web root:
cd $EVERGREEN_ROOT/Open-ILS/web/js/ui/default/staff/
-
Install project-local dependencies via
npm:npm ci # fetch JS dependencies -
Run the production build script:
npm run build-prod
-
OPTIONAL: Test web client code (requires
<osname>-developerpackages and browsers installed):CHROME_BIN=/path/to/chrome npm run test
-
Navigate to the Angular staff root:
cd $EVERGREEN_ROOT/Open-ILS/src/eg2/
-
Install project-local dependencies:
npm ci # fetch JS dependencies -
Run the build script:
npx ng build --configuration=production
[!NOTE] This can be a memory-intensive build. If the process does not finish and you get the message
"Killed"in the console, try running it with an explicit max-old-space-size option to encourage more garbage collection. For example, on a machine with 4GB of memory, limit it to 3GB with:NODE_OPTIONS=--max-old-space-size=3072 npx ng build --configuration=production
-
OPTIONAL: Test eg2 web client code:
CHROME_BIN=/path/to/chrome npm run test MOZ_HEADLESS=1 npx ng e2e
-
Navigate to the OPAC dependencies root:
cd $EVERGREEN_ROOT/Open-ILS/web/opac/deps
-
Install project-local dependencies:
npm ci # fetch JS and CSS dependencies(Note: There is no build step.)
-
OPTIONAL: Test OPAC JavaScript code:
npm run test
For the time being, we are still installing everything in the /openils/ directory. From the Evergreen source directory, issue the following commands as the user Linux account to configure and build Evergreen:
PATH=/openils/bin:$PATH ./configure --prefix=/openils --sysconfdir=/openils/conf
makeNote
These instructions assume that you have also installed OpenSRF under /openils/. If not, please adjust PATH as needed so that the Evergreen configure script can find osrf_config.
Once you have configured and compiled Evergreen, issue the following command as the root Linux account to install Evergreen and copy example configuration files to /openils/conf:
make installAll files in the /openils/ directory and subdirectories must be owned by the opensrf user. Issue the following command as the root Linux account:
chown -R opensrf:opensrf /openilsOn Ubuntu or Debian, run the following command as the root user:
ldconfigNote
Skip this section if you are using an official release tarball downloaded from evergreen-ils.org/egdownloads.
Developers working directly with the source code from the Git repository, rather than an official release tarball, need to install the Dojo Toolkit set of JavaScript libraries. The appropriate version of Dojo is included in Evergreen release tarballs. Developers should install Dojo version 1.3.3 by issuing the following commands as the opensrf Linux account:
wget https://download.dojotoolkit.org/release-1.3.3/dojo-release-1.3.3.tar.gz
tar -C /openils/var/web/js -xzf dojo-release-1.3.3.tar.gz
cp -r /openils/var/web/js/dojo-release-1.3.3/* /openils/var/web/js/dojo/.-
Copy example configuration files for the Evergreen catalog, web staff client, web services, and administration interfaces. Issue the following commands as the
rootLinux account:cp Open-ILS/examples/apache_24/eg_24.conf /etc/apache2/sites-available/eg.conf cp Open-ILS/examples/apache_24/eg_vhost_24.conf /etc/apache2/eg_vhost.conf cp Open-ILS/examples/apache_24/eg_startup /etc/apache2/ # Set up SSL mkdir /etc/apache2/ssl cd /etc/apache2/ssl
-
Generate SSL Key & Certificate: The
opensslcommand cuts a new SSL key for your Apache server. For a production server, purchase a signed SSL certificate; for testing/development, a self-signed certificate can be used:openssl req -new -x509 -days 365 -nodes -out server.crt -keyout server.key
-
Edit
eg.conf: As therootLinux account, edit the/etc/apache2/sites-available/eg.conffile:- To enable access to the offline upload / execute interface from any workstation on any network (ensure this is secured for production!):
- Replace
Require host 10.0.0.0/8withRequire all granted
- Replace
- To enable access to the offline upload / execute interface from any workstation on any network (ensure this is secured for production!):
-
Change the Apache user:
- Edit
/etc/apache2/envvarsasroot. - Change
export APACHE_RUN_USER=www-datato:export APACHE_RUN_USER=opensrf
- Edit
-
Configure Apache KeepAlive settings: Higher values can improve client performance by allowing multiple requests over the same TCP connection, but increase the risk of using up Apache child processes and memory.
- Edit
/etc/apache2/apache2.confasroot:- Change
KeepAliveTimeoutto1 - Change
MaxKeepAliveRequeststo100
- Change
- Edit
-
Configure the prefork module: Set up
/etc/apache2/mods-available/mpm_prefork.confwith values suitable for a default Evergreen site:<IfModule mpm_prefork_module> StartServers 15 MinSpareServers 5 MaxSpareServers 15 MaxRequestWorkers 75 MaxConnectionsPerChild 500 </IfModule>
-
Enable the
mpm_preforkmodule asroot:a2dismod mpm_event a2enmod mpm_prefork
-
Enable the Evergreen site:
a2dissite 000-default # OPTIONAL: disable the default "It Works" page a2ensite eg.conf -
Allow Apache to write to the lock directory (skip this step on Debian 13):
chown opensrf /var/lock/apache2
There are example OpenSRF configuration files in /openils/conf/ that serve as templates. Issue the following commands as the opensrf Linux account:
cp -b /openils/conf/opensrf_core.xml.example /openils/conf/opensrf_core.xml
cp -b /openils/conf/opensrf.xml.example /openils/conf/opensrf.xmlNote
The -b flag tells cp to create a backup file with a tilde (~) appended.
When installing OpenSRF, you created four Jabber users on two separate domains. Edit /openils/conf/opensrf_core.xml using those exact Jabber users and domains.
eg_db_config (detailed in Creating the Evergreen Database) will automatically configure database connection parameters in opensrf.xml.
If using the Redis variant of OpenSRF, modify /openils/conf/opensrf_core.xml to use the Redis settings instead of Ejabberd.
For each configuration block that contains both Ejabberd and Redis sections, comment out Ejabberd and un-comment Redis:
Before:
<!-- Ejabberd -->
<passwd>password</passwd>
<port>5222</port>
<!-- === -->
<!-- Redis -->
<!--
<passwd>456fc340-beba-4489-9070-0d6b49e9952b</passwd>
<port>6379</port>
-->
<!-- === -->After:
<!-- Ejabberd -->
<!--
<passwd>password</passwd>
<port>5222</port>
-->
<!-- === -->
<!-- Redis -->
<passwd>456fc340-beba-4489-9070-0d6b49e9952b</passwd>
<port>6379</port>
<!-- === -->Action Triggers provide hooks for the system to perform actions when a given event occurs (e.g., generating reminder or overdue notices via checkout.due).
To enable the default set of hooks, issue the following command as the opensrf Linux account:
cp -b /openils/conf/action_trigger_filters.json.example /openils/conf/action_trigger_filters.jsonFor production use, most libraries install PostgreSQL on a dedicated machine. Therefore, by default, Makefile.install does not install the PostgreSQL server package.
Install the required PostgreSQL packages as the root Linux account using the make target matching your distribution and target PostgreSQL version:
Warning
PostgreSQL 12+ JIT (Just-in-Time compilation): Do not turn on PostgreSQL's JIT capabilities. Evergreen's queries, especially complex ones used for search, are intentionally tuned for non-JIT execution, and JIT has been shown to be harmful in some circumstances.
Recommended minimum tweak to postgresql.conf:
jit_above_cost = -1PostgreSQL 14
make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-trixie-14
make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-bookworm-14
make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-bullseye-14
make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-buster-14
make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-jammy-14
make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-noble-14PostgreSQL 15
make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-trixie-15
make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-bookworm-15
make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-bullseye-15
make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-buster-15
make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-jammy-15
make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-noble-15PostgreSQL 16
make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-trixie-16
make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-bookworm-16
make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-bullseye-16
make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-buster-16
make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-jammy-16
make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-noble-16PostgreSQL 17
make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-trixie-17
make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-bookworm-17
make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-bullseye-17
make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-buster-17
make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-jammy-17
make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-noble-17PostgreSQL 18
make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-trixie-18
make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-bookworm-18
make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-bullseye-18
make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-buster-18
make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-jammy-18
make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-noble-18Issue the following command as the postgres Linux account to create a new superuser named evergreen. When prompted, enter a secure password:
createuser -s -P evergreenCheck your pg_hba.conf file (located under /etc/postgresql/ on Debian and Ubuntu). To allow TCP/IP connections from localhost with password authentication for testing, ensure the following lines appear before any host ... ident entries:
host all all ::1/128 md5
host all all 127.0.0.1/32 md5
Reload PostgreSQL after updating pg_hba.conf for changes to take effect.
From inside the Evergreen source directory, run eg_db_config as the root Linux account:
perl Open-ILS/src/support-scripts/eg_db_config --update-config \
--service all --create-database --create-schema --create-offline \
--user <user> --password <password> --hostname <hostname> --port <port> \
--database <dbname> --admin-user <admin-user> --admin-pass <admin-pass><user>&<password>: Credentials for theevergreenPostgreSQL account.<admin-user>&<admin-pass>: Desired credentials for theegadminEvergreen administrator account.
(Run with --help to inspect all available options.)
- Standard Concerto Dataset:
Add
--load-all-sampletoeg_db_configto load authority/bibliographic records, call numbers, copies, staff/regular users, and sample transactions. - Enhanced Concerto Dataset:
Use
--load-concerto-enhancedfor additional testing data, including:- Friendly organization unit names
- Acquisitions and billing scenarios
- Shelving locations & settings
- Multilingual bibliographic records (Japanese, Spanish, French, Czech)
- Metarecord holds & item stat categories
- Bookings, pre-created OPAC carousels, and serials data
To provision the database on a remote dedicated server, include the --create-database flag when running eg_db_config.
-
Start background services as
root:/etc/init.d/ejabberd start /etc/init.d/memcached start
-
Start OpenSRF / Evergreen services as
opensrf:osrf_control -l --start-all
(Note: The
-lflag forceslocalhost. Omit it if you configuredopensrf.xmlusing your machine's fully qualified domain name.)[!TIP] If you see
bash: osrf_control: command not found, add/openils/binto yourPATHin~/.bashrc:export PATH=$PATH:/openils/bin
-
Generate web files and org unit proximity as
opensrf:autogen.sh
(Run this whenever library organization unit configurations change.)
-
Restart Apache as
root:/etc/init.d/apache2 restart
Test system connectivity using srfsh as the opensrf Linux account:
/openils/bin/srfsh
srfsh% login <admin-user> <admin-pass>Expected output:
Received Data: "250bf1518c7527a03249858687714376"
------------------------------------
Request Completed Successfully
Request Time in seconds: 0.045286
------------------------------------
Received Data: {
"ilsevent":0,
"textcode":"SUCCESS",
"desc":" ",
"pid":21616,
"stacktrace":"oils_auth.c:304",
"payload":{
"authtoken":"e5f9827cc0f93b503a1cc66bee6bdd1a",
"authtime":420
}
}
------------------------------------
Request Completed Successfully
Request Time in seconds: 1.336568
------------------------------------
- Run
Open-ILS/src/support-scripts/settings-tester.plasopensrfto identify configuration issues. - Consult the Evergreen Troubleshooting Guide.
- Contact the Evergreen Development Mailing List with your configuration and log files.
- Mailing Lists: evergreen-ils.org/communicate/mailing-lists
- IRC:
#evergreenon the Libera.Chat / Freenode network
This work is licensed under the Creative Commons Attribution-ShareAlike 3.0 Unported License. (Creative Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA)
-
Install project-local dependencies:
npm ci # fetch JS and CSS dependencies(Note: There is no build step.)
-
OPTIONAL: Test OPAC JavaScript code:
npm run test
For the time being, we are still installing everything in the /openils/ directory. From the Evergreen source directory, issue the following commands as the user Linux account to configure and build Evergreen:
PATH=/openils/bin:$PATH ./configure --prefix=/openils --sysconfdir=/openils/conf
makeNote
These instructions assume that you have also installed OpenSRF under /openils/. If not, please adjust PATH as needed so that the Evergreen configure script can find osrf_config.
Once you have configured and compiled Evergreen, issue the following command as the root Linux account to install Evergreen and copy example configuration files to /openils/conf:
make installAll files in the /openils/ directory and subdirectories must be owned by the opensrf user. Issue the following command as the root Linux account:
chown -R opensrf:opensrf /openilsOn Ubuntu or Debian, run the following command as the root user:
ldconfigNote
Skip this section if you are using an official release tarball downloaded from evergreen-ils.org/egdownloads.
Developers working directly with the source code from the Git repository, rather than an official release tarball, need to install the Dojo Toolkit set of JavaScript libraries. The appropriate version of Dojo is included in Evergreen release tarballs. Developers should install Dojo version 1.3.3 by issuing the following commands as the opensrf Linux account:
wget https://download.dojotoolkit.org/release-1.3.3/dojo-release-1.3.3.tar.gz
tar -C /openils/var/web/js -xzf dojo-release-1.3.3.tar.gz
cp -r /openils/var/web/js/dojo-release-1.3.3/* /openils/var/web/js/dojo/.-
Copy example configuration files for the Evergreen catalog, web staff client, web services, and administration interfaces. Issue the following commands as the
rootLinux account:cp Open-ILS/examples/apache_24/eg_24.conf /etc/apache2/sites-available/eg.conf cp Open-ILS/examples/apache_24/eg_vhost_24.conf /etc/apache2/eg_vhost.conf cp Open-ILS/examples/apache_24/eg_startup /etc/apache2/ # Set up SSL mkdir /etc/apache2/ssl cd /etc/apache2/ssl
-
Generate SSL Key & Certificate: The
opensslcommand cuts a new SSL key for your Apache server. For a production server, purchase a signed SSL certificate; for testing/development, a self-signed certificate can be used:openssl req -new -x509 -days 365 -nodes -out server.crt -keyout server.key
-
Edit
eg.conf: As therootLinux account, edit the/etc/apache2/sites-available/eg.conffile:- To enable access to the offline upload / execute interface from any workstation on any network (ensure this is secured for production!):
- Replace
Require host 10.0.0.0/8withRequire all granted
- Replace
- To enable access to the offline upload / execute interface from any workstation on any network (ensure this is secured for production!):
-
Change the Apache user:
- Edit
/etc/apache2/envvarsasroot. - Change
export APACHE_RUN_USER=www-datato:export APACHE_RUN_USER=opensrf
- Edit
-
Configure Apache KeepAlive settings: Higher values can improve client performance by allowing multiple requests over the same TCP connection, but increase the risk of using up Apache child processes and memory.
- Edit
/etc/apache2/apache2.confasroot:- Change
KeepAliveTimeoutto1 - Change
MaxKeepAliveRequeststo100
- Change
- Edit
-
Configure the prefork module: Set up
/etc/apache2/mods-available/mpm_prefork.confwith values suitable for a default Evergreen site:<IfModule mpm_prefork_module> StartServers 15 MinSpareServers 5 MaxSpareServers 15 MaxRequestWorkers 75 MaxConnectionsPerChild 500 </IfModule>
-
Enable the
mpm_preforkmodule asroot:a2dismod mpm_event a2enmod mpm_prefork
-
Enable the Evergreen site:
a2dissite 000-default # OPTIONAL: disable the default "It Works" page a2ensite eg.conf -
Allow Apache to write to the lock directory (skip this step on Debian 13):
chown opensrf /var/lock/apache2
There are example OpenSRF configuration files in /openils/conf/ that serve as templates. Issue the following commands as the opensrf Linux account:
cp -b /openils/conf/opensrf_core.xml.example /openils/conf/opensrf_core.xml
cp -b /openils/conf/opensrf.xml.example /openils/conf/opensrf.xmlNote
The -b flag tells cp to create a backup file with a tilde (~) appended.
When installing OpenSRF, you created four Jabber users on two separate domains. Edit /openils/conf/opensrf_core.xml using those exact Jabber users and domains.
eg_db_config (detailed in Creating the Evergreen Database) will automatically configure database connection parameters in opensrf.xml.
If using the Redis variant of OpenSRF, modify /openils/conf/opensrf_core.xml to use the Redis settings instead of Ejabberd.
For each configuration block that contains both Ejabberd and Redis sections, comment out Ejabberd and un-comment Redis:
Before:
<!-- Ejabberd -->
<passwd>password</passwd>
<port>5222</port>
<!-- === -->
<!-- Redis -->
<!--
<passwd>456fc340-beba-4489-9070-0d6b49e9952b</passwd>
<port>6379</port>
-->
<!-- === -->After:
<!-- Ejabberd -->
<!--
<passwd>password</passwd>
<port>5222</port>
-->
<!-- === -->
<!-- Redis -->
<passwd>456fc340-beba-4489-9070-0d6b49e9952b</passwd>
<port>6379</port>
<!-- === -->Action Triggers provide hooks for the system to perform actions when a given event occurs (e.g., generating reminder or overdue notices via checkout.due).
To enable the default set of hooks, issue the following command as the opensrf Linux account:
cp -b /openils/conf/action_trigger_filters.json.example /openils/conf/action_trigger_filters.jsonFor production use, most libraries install PostgreSQL on a dedicated machine. Therefore, by default, Makefile.install does not install the PostgreSQL server package.
Install the required PostgreSQL packages as the root Linux account using the make target matching your distribution and target PostgreSQL version:
Warning
PostgreSQL 12+ JIT (Just-in-Time compilation): Do not turn on PostgreSQL's JIT capabilities. Evergreen's queries, especially complex ones used for search, are intentionally tuned for non-JIT execution, and JIT has been shown to be harmful in some circumstances.
Recommended minimum tweak to postgresql.conf:
jit_above_cost = -1PostgreSQL 14
make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-trixie-14
make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-bookworm-14
make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-bullseye-14
make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-buster-14
make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-jammy-14
make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-noble-14PostgreSQL 15
make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-trixie-15
make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-bookworm-15
make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-bullseye-15
make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-buster-15
make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-jammy-15
make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-noble-15PostgreSQL 16
make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-trixie-16
make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-bookworm-16
make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-bullseye-16
make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-buster-16
make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-jammy-16
make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-noble-16PostgreSQL 17
make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-trixie-17
make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-bookworm-17
make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-bullseye-17
make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-buster-17
make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-jammy-17
make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-noble-17PostgreSQL 18
make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-trixie-18
make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-bookworm-18
make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-bullseye-18
make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-buster-18
make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-jammy-18
make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-noble-18Issue the following command as the postgres Linux account to create a new superuser named evergreen. When prompted, enter a secure password:
createuser -s -P evergreenCheck your pg_hba.conf file (located under /etc/postgresql/ on Debian and Ubuntu). To allow TCP/IP connections from localhost with password authentication for testing, ensure the following lines appear before any host ... ident entries:
host all all ::1/128 md5
host all all 127.0.0.1/32 md5
Reload PostgreSQL after updating pg_hba.conf for changes to take effect.
From inside the Evergreen source directory, run eg_db_config as the root Linux account:
perl Open-ILS/src/support-scripts/eg_db_config --update-config \
--service all --create-database --create-schema --create-offline \
--user <user> --password <password> --hostname <hostname> --port <port> \
--database <dbname> --admin-user <admin-user> --admin-pass <admin-pass><user>&<password>: Credentials for theevergreenPostgreSQL account.<admin-user>&<admin-pass>: Desired credentials for theegadminEvergreen administrator account.
(Run with --help to inspect all available options.)
- Standard Concerto Dataset:
Add
--load-all-sampletoeg_db_configto load authority/bibliographic records, call numbers, copies, staff/regular users, and sample transactions. - Enhanced Concerto Dataset:
Use
--load-concerto-enhancedfor additional testing data, including:- Friendly organization unit names
- Acquisitions and billing scenarios
- Shelving locations & settings
- Multilingual bibliographic records (Japanese, Spanish, French, Czech)
- Metarecord holds & item stat categories
- Bookings, pre-created OPAC carousels, and serials data
To provision the database on a remote dedicated server, include the --create-database flag when running eg_db_config.
-
Start background services as
root:/etc/init.d/ejabberd start /etc/init.d/memcached start
-
Start OpenSRF / Evergreen services as
opensrf:osrf_control -l --start-all
(Note: The
-lflag forceslocalhost. Omit it if you configuredopensrf.xmlusing your machine's fully qualified domain name.)[!TIP] If you see
bash: osrf_control: command not found, add/openils/binto yourPATHin~/.bashrc:export PATH=$PATH:/openils/bin
-
Generate web files and org unit proximity as
opensrf:autogen.sh
(Run this whenever library organization unit configurations change.)
-
Restart Apache as
root:/etc/init.d/apache2 restart
Test system connectivity using srfsh as the opensrf Linux account:
/openils/bin/srfsh
srfsh% login <admin-user> <admin-pass>Expected output:
Received Data: "250bf1518c7527a03249858687714376"
------------------------------------
Request Completed Successfully
Request Time in seconds: 0.045286
------------------------------------
Received Data: {
"ilsevent":0,
"textcode":"SUCCESS",
"desc":" ",
"pid":21616,
"stacktrace":"oils_auth.c:304",
"payload":{
"authtoken":"e5f9827cc0f93b503a1cc66bee6bdd1a",
"authtime":420
}
}
------------------------------------
Request Completed Successfully
Request Time in seconds: 1.336568
------------------------------------
- Run
Open-ILS/src/support-scripts/settings-tester.plasopensrfto identify configuration issues. - Consult the Evergreen Troubleshooting Guide.
- Contact the Evergreen Development Mailing List with your configuration and log files.
- Mailing Lists: evergreen-ils.org/communicate/mailing-lists
- IRC:
#evergreenon the Libera.Chat / Freenode network
This work is licensed under the Creative Commons Attribution-ShareAlike 3.0 Unported License. (Creative Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA)