Metadata-Version: 1.1
Name: birdhousebuilder.recipe.tomcat
Version: 0.2.7
Summary: A Buildout recipe to install and configure tomcat for Anaconda.
Home-page: https://github.com/bird-house/birdhousebuilder.recipe.tomcat
Author: Birdhouse
Author-email: UNKNOWN
License: BSD
Description: ******************************
        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
        
        .. contents::
        
        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. It assumes that the default Anaconda location is in your home directory ``~/anaconda``. Otherwise you need to set the ``ANACONDA_HOME`` environment variable or the Buildout option ``anaconda-home``.
        
        It installs the ``apache-tomcat`` package from a conda channel in a conda enviroment named ``birdhouse``. The location of the birdhouse environment is ``.conda/envs/birdhouse``. It deploys a `Supervisor`_ configuration in ``~/.conda/envs/birdhouse/etc/supervisor/conf.d/tomcat.conf``. Supervisor can be started with ``~/.conda/envs/birdhouse/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 with the root folder of the Anaconda installation. Default: ``$HOME/anaconda``.
           The default location can also be set with the environment variable ``ANACONDA_HOME``. Example::
        
             export ANACONDA_HOME=/opt/anaconda
        
           Search priority is:
        
           1. ``anaconda-home`` in ``buildout.cfg``
           2. ``$ANACONDA_HOME``
           3. ``$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
        
          anaconda-home = /home/myself/anaconda
        
          [tomcat]
          recipe = birdhousebuilder.recipe.tomcat
          http_port = 8080
          Xms = 256m
          Xmx = 2048m
          MaxPermSize = 128m
        
        
        
        
        Authors
        *******
        
        Carsten Ehbrecht ehbrecht at dkrz.de
        
        Changes
        *******
        
        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.
        
Keywords: buildout recipe birdhouse tomcat conda anaconda
Platform: UNKNOWN
Classifier: Framework :: Buildout
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: License :: OSI Approved :: BSD License
