Requirements:
-------------

Building from the distributed tarball:
* Apache Tomcat 8.20.0+ // JWS-3 is supported (tomcat 7 +)
* Apache Maven // ehm...nope?!

Building Instructions:
----------------------

1. Install Apache Tomcat (from RPM or by hand or however you prefer) // teoretically

2. Compile Tomcat Vault from its source directory by running // nope
    $ mvn install

3. Copy the generated jar target/vault-tomcat-X-jar-with-dependencies.jar // /usr/share/java
   to CATALINA_BASE/lib (where X is the version)

4. Add the following line to CATALINA_BASE/conf/catalina.properties
    org.apache.tomcat.util.digester.PROPERTY_SOURCE=org.apache.tomcat.vault.util.PropertySourceVault

5. Configure your vault using ./bin/vault.sh (found the related // start vault /usr/bin/tomcat-vault.sh or tomcat-vault.sh (should be on path)
   documentation in the "links" section)


6. Create a file named vault.properties in CATALINA_BASE/conf // one shouldn't created this file manually rather copy info that tomcat vault script gives you
   containing your vault information as below (all of these keys
   must be defined and NOT empty)
    KEYSTORE_URL=..
    KEYSTORE_PASSWORD=..
    KEYSTORE_ALIAS=..
    SALT=..
    ITERATION_COUNT=..
    ENC_FILE_DIR=..

7. Start Apache Tomcat


Usage:
------

Simply replace whatever property value you would like to hide
in any Apache Tomcat configuration file by ${attribut_name}

    Example
    =======
     <user username="tomcat" password="acb$123" roles="manager-gui"/>
                          from ||      -------
                               \/ to
     <user username="tomcat" password="${VAULT::TOMCAT::password::}" roles="manager-gui"/>
                                       -----------

Links:
------

How to configure Vault :
 - https://access.redhat.com/documentation/en-US/JBoss_Enterprise_Application_Platform/6.4/html/Security_Guide/Mask_the_Keystore_Password_and_Initialize_the_Password_Vault.html

$Id: INSTALL,v 1.1 2015/03/23 11:44:00 maxbeck Exp $