User Tools

Site Tools


Getting started with Evergreen development

NOTE: This page is still being updated and the instructions are no longer working as of 2013-04-16 (master has changed quite a bit). Please follow the existing README for the Download area and install OpenSRF/Evergreen from scratch on Ubuntu 12.04 Server or Debian 6.

Evergreen is built on the OpenSRF application framework. If you're interested in implementing new services in Evergreen, or in calling Evergreen APIs (and who wouldn't be?!), you should probably start by reading through the Easing Gently into OpenSRF article to get an overview of how OpenSRF works.

You should also work through this tutorial that focuses on getting up and developing with Evergreen.

We have also documented the norms and processes for contributing to the Evergreen project to help you settle into our community.

To enable you to get hands-on with the code as quickly as possible, the developer virtual image available from is current with OpenSRF and Evergreen Master as of 2013-04-15. NOTICE: If you are using this virtual machine, there are a small configuration steps needed.

  1. Enable listening on https (port 443)
    1. (as root) Open /etc/apache2/ports.conf in your favorite editor, then uncomment the first “Listen 443” line
    2. (as root) Restart Apache
  2. If using the pre-built client, set it as a supported version
    1. (as opensrf)
      cd /openils/var/web/xul
      ln -s master02102012/ 0master_b324da2
    2. To then start the client
      1. Click on the launcher menu (lower-left corner) and choose “Run”
      2. Command to run: xulrunner-1.9.1 /home/opensrf/Evergreen/Open-ILS/xul/staff_client/build/application.ini

The developer virtual image has a checkout of both OpenSRF and Evergreen's Git repositories, found in the opensrf user's home directory. Detailed instructions for installing are available via each project's README file, or via the example below.

Grab the updated code from Git (as opensrf)
cd /home/opensrf/Evergreen && git pull
Upgrade dependencies (as root)
cd /home/opensrf/Evergreen && make -f Open-ILS/src/extras/Makefile.install 
Compile the code (ss opensrf)
cd /home/opensrf/Evergreen && ./configure --prefix=/openils --sysconfdir=/openils/conf
Install the updated code (as root)
cd /home/opensrf/Evergreen && make STAFF_CLIENT_STAMP_ID=SomeStamp install
cd /openils/var/web/xul
rm server
ln -sf SomeStamp/server server
Change ownership of /openils (as root)
chown -R opensrf:opensrf /openils
Upgrade the Database (as opensrf)
cd /home/opensrf/Evergreen/Open-ILS/src/sql/Pg && /home/opensrf/Evergreen/build/tools/ localhost evergreen evergreen
Restart Evergreen Services -l -a restart_all
dev/quick-start_introduction_and_virtual_image.txt · Last modified: 2013/04/16 08:30 by mrpeters

© 2008-2014 GPLS and others. Evergreen is open source software, freely licensed under GNU GPLv2 or later.
The Evergreen Project is a member of Software Freedom Conservancy.