birdhousebuilder.recipe.tomcat 0.3.3
A Buildout recipe to install and configure tomcat with conda.
License: Apache License 2
Keywords: buildout recipe birdhouse tomcat conda anaconda

******************************
birdhousebuilder.recipe.tomcat
******************************

.. image:: https://travis-ci.org/bird-house/birdhousebuilder.recipe.tomcat.svg?branch=master
   :target: https://travis-ci.org/bird-house/birdhousebuilder.recipe.tomcat
   :alt: Travis Build

Introduction
************

``birdhousebuilder.recipe.tomcat`` is a `Buildout`_ recipe to install ``Apache Tomcat`` application server with `Anaconda`_. This recipe is used by the `Birdhouse`_ project. 

.. _`Buildout`: http://buildout.org/
.. _`Anaconda`: http://www.continuum.io/
.. _`Supervisor`: http://supervisord.org/
.. _`Apache Tomcat`: https://tomcat.apache.org/
.. _`Birdhouse`: http://bird-house.github.io/

Usage
*****

The recipe requires that Anaconda is already installed. You can use the buildout option ``anaconda-home`` to set the prefix for the anaconda installation. Otherwise the environment variable ``CONDA_PREFIX`` (variable is set when activating a conda environment) is used as conda prefix. 

It installs the ``apache-tomcat`` package from a conda channel in a conda enviroment defined by ``CONDA_PREFIX``. The intallation folder is given by the ``prefix`` buildout option. It deploys a `Supervisor`_ configuration in ``${prefix}/etc/supervisor/conf.d/tomcat.conf``. Supervisor can be started with ``${prefix}/etc/init.d/supervisord start``.

By default Tomcat will be available on http://localhost:8080/.

The recipe depends on ``birdhousebuilder.recipe.conda`` and ``birdhousebuilder.recipe.supervisor``.

Supported options
=================

This recipe supports the following options:

``anaconda-home``
   Buildout option pointing to the root folder of the Anaconda installation. Default: ``$HOME/anaconda``.

``http_port``
   HTTP Port for Tomcat service. Default: 8080

``Xms``
   Initial Java heap size: Default: 128m

``Xmx``
   Maximum Java heap size: Default: 1024m

``MaxPermSize``
   Maximum Java permanent heap size: Default: 128m

``ncwms_password``
   Enable ncWMS2 admin web interface by setting a password: Default: disabled


Example usage
=============

The following example ``buildout.cfg`` installs ``tomcat`` as a Supervisor service::

  [buildout]
  parts = tomcat

  [tomcat]
  recipe = birdhousebuilder.recipe.tomcat
  http_port = 8080
  Xms = 256m
  Xmx = 2048m
  MaxPermSize = 128m




Authors
*******

Carsten Ehbrecht ehbrecht at dkrz.de

Changes
*******

0.3.3 (2016-12-13)
==================

* pep8
* updated MANIFEST.in: ignore tempfiles.
* python 3.5 test activated in travis.
* updated versions.cfg.

0.3.2 (2016-08-19)
==================

* added java user_prefs in setenv.sh

0.3.1 (2016-07-26)
==================

* configure logging.properties.

0.3.0 (2016-07-25)
==================

* using zc.recipe.deployment.
* cleaned up doctests.
* updated travis.

0.2.9 (2016-01-07)
==================

* fixed permissions of catalina-wrapper.sh.

0.2.8 (2015-12-07)
==================

* using latest supervisor recipe.

0.2.7 (2015-10-20)
==================

* added ncwms-password option for tomcat-users.xml

0.2.6 (2015-10-19)
==================

* add tomcat_home() and unzip() methods.

0.2.5 (2015-08-04)
==================

* using OpenJDK from conda package.
* setting JAVA_HOME in cataling wrapper.

0.2.4 (2015-06-30)
==================

* Java options ``Xms``, ``Xmx``, ``MaxPermSize`` are configurable.

0.2.3 (2015-06-26)
==================

* added user option.

0.2.2 (2015-06-17)
==================

* added content_root().
* using catalina-wrapper.sh script for supervisor.
* added option ``http_port``.

0.2.1 (2015-02-24)
==================

* installing in conda enviroment ``birdhouse``.
* using ``$ANACONDA_HOME`` environment variable.
* separation of anaconda-home and installation prefix.

0.1.4 (2014-12-06)
==================

* Don't update conda on buildout update.

0.1.3 (2014-12-04)
==================

* Update tomcat config.

0.1.2 (2014-07-31)
==================

* Update documentation.

0.1.1 (2014-07-22)
==================

* Configure tomcat-users.xml.

0.1.0 (2014-07-10)
==================

* Initial Release.