Skip to content

Latest commit

 

History

History
83 lines (57 loc) · 3.31 KB

README.md

File metadata and controls

83 lines (57 loc) · 3.31 KB
Raw

Changelog: https://github.com/mlhartme/lavender/blob/master/CHANGELOG.md

Lavender

Lavender is a tool set for static resources. It enables you to serve static resources for your Java Web Applications via dedicated servers.

Lavender has two components:

  • a publisher to upload resources to your dedicated servers
  • a servlet filter to rewrite resource references

The typical scenario is this:

You create a new Java Web Application, packaging static resources into the respective war file. Fine. Later, you want to optimize resource handling in your application, you want to use dedicated servers that support

  • parallel requests
  • far-future expires headers

You start using lavender:

  • you setup dedicated servers
  • you add the publishing tool to your deployment process: resources from the war file will be synced to the docroot of your servers
  • you add the servlet filter to your application: references to your resource (e.g. images tags in html) will be re-written to point to your servers.

Finally, you can shrink your war files by not packaging resources into it; the publisher can pick resources from svn instead of the war file.

TODO: currently, lavender supports Pustefix Applications only.

Setup

Add Lavender to your pom.xml:

 <dependency>
   <groupId>net.oneandone</groupId>
   <artifactId>lavender</artifactId>
   <version>2.10.1</version>
 </dependency>

Add the Servlet Filter to your web.xml:

  <filter>
    <filter-name>Lavender</filter-name>
    <filter-class>net.oneandone.lavender.filter.Lavender</filter-class>
  </filter>
  <filter-mapping>
    <filter-name>Lavender</filter-name>
    <url-pattern>/*</url-pattern>
  </filter-mapping>

Add module WEB-INF/lavender.properties.

Optionally, you can configure logging for the category net.oneandone.lavender.

Properties

There are two types of property file in Lavender - host.properties and lavender.properties.

Lavender Properties

lavender.properties in wars specify Lavender Application Modules; in jar files, they specify normal Lavender modules. Lavender scans the war for WEB-INF/lavender.properties files and all container jars for module META-INF/lavender.properties files and extracts files from the war/jar and optionally from external resource paths to publish the files on the target cluster.

A typical lavender.properties specifies where for load resources from, it looks like this

scm.webapp=scm\:git\:ssh\://git@bitbucket.1and1.org/sa/telesales-de.git
scm.webapp.devel=scm\:git\:ssh\://git@bitbucket.1and1.org/sa/telesales-de.git
scm.webapp.tag=feature/SHOPYELLOW-2671
scm.webapp.includes=**/*.gif, **/*.png, **/*.jpg, **/*.jpeg, **/*.pdf
scm.webapp.excludes=htdocs/**/*
scm.webapp.path=src/main/resources
scm.webapp.resourcePathPrefix=

Host Properties

Lavender's host.properties defines the network- and secrets configuration to use. You'll usually have a single file on your workstation

## host.properties file
network=svn:https://svn.1and1.org/svn/sales/tools/lavender/config/network.xml
secrets=~/.fault/com.oneandone.sales:shop-wars/lavender.secrets

Bitbucket access uses ssh with username/password. You define a repository like this:

myrepo=git:ssh://git@bitbucket.your-company.com/yourproject/
myrepo.username=foo
myrepo.password=bar