Skip to content
This repository has been archived by the owner on Jul 24, 2018. It is now read-only.

Commit

Permalink
improve doc and bump version
Browse files Browse the repository at this point in the history
  • Loading branch information
antoineco committed Dec 18, 2014
1 parent 5c4ab7a commit 8073b8e
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 5 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
###0.4.1

* Document missing parameter `installation_support`
* Improve documentation

###0.4.0

* Support installation from archive
Expand Down
19 changes: 15 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@

##Overview

The tomcat module installs and configures Apache Tomcat instances from the available packages in your distribution's repositories.
The tomcat module installs and configures Apache Tomcat instances from either the packages available in your distribution's repositories, or from any archive file you provide to it.

##Module description

Almost all Linux distributions provide one or more maintained packages of the Tomcat application server. These are available either from the distribution repositories or third-party sources ([JPackage](http://www.jpackage.org), [EPEL](https://fedoraproject.org/wiki/EPEL), ...). This module will install the desired version of tomcat and its dependencies from the repositories available on the target system.
This module will install the desired version of the Apache Tomcat Web Application Container from almost any possible source, including the repositories available on the target system (distribution repositories or third-party sources like [JPackage](http://www.jpackage.org) and [EPEL](https://fedoraproject.org/wiki/EPEL)
A long list of parameters permit a fine-tuning of the server and the JVM. It is for example possible to configure admin applications, install extra tomcat libraries, configure log4j as the standard logger, or enable the remote JMX listener.
The creation of individual instances is also supported via a custom type.

Expand All @@ -40,6 +40,15 @@ include ::tomcat

####A couple of examples

Install from archive instead of package

```puppet
class { '::tomcat':
installation_support => 'archive',
version => '8.0.15'
}
```

Use a non-default JVM and run it with custom options

```puppet
Expand Down Expand Up @@ -158,12 +167,14 @@ Primary class and entry point of the module

**Packages and service**

#####`installation_support`
What type of source to install from. The module will download the necessary files by itself. Valid values are `package` and `archive`. Defaults to `package`.
#####`archive_source`
Source of the tomcat server archive, if installed from archive. Supports local files, puppet://, http://, https:// and ftp://. Defaults to `http://archive.apache.org/dist/tomcat/tomcat-${maj_version}/v${version}/bin/apache-tomcat-${version}.tar.gz`
#####`version`
Tomcat full version number. The valid format is 'x.y.z'. Default depends on the distribution.
*Note:* if you install tomcat from package and define this value manually, please make **sure** this version of tomcat if available in your system's repositories, since several sub-parameters depend on it
A list of available versions in each supported distribution is present withing the `params` class.
#####`archive_source`
Source of the tomcat server archive, if installed from archive. Defaults to `http://archive.apache.org/dist/tomcat/tomcat-${maj_version}/v${version}/bin/apache-tomcat-${version}.tar.gz`
#####`package_name`
Tomcat package name. Ignored if installed from archive. Default depends on the distribution.
#####`tomcat_native`
Expand Down
2 changes: 1 addition & 1 deletion metadata.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "aco-tomcat",
"summary": "Puppet module for Tomcat",
"author": "Antoine Cotten",
"version": "0.4.0",
"version": "0.4.1",
"license": "Apache-2.0",
"project_page": "https://github.com/tOnI0/aco-tomcat",
"source": "git://github.com/tOnI0/aco-tomcat.git",
Expand Down

0 comments on commit 8073b8e

Please sign in to comment.