Branch: master
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
src
README.adoc
pom.xml

README.adoc

upNGizr

upNGizr is a privileged Tomcat web-application that is able to update your appNG instance including appNGizer.

Therefore, it must be deployed in the same Tomcat installation as appNG itself.

Warning
Currently, upNGizr is considered experimental, so it’s not recommended to be used in production environments.
Warning
upNGizr does not support clustered environments!

Installation

Just drop uppNGizr.war into your Tomcat’s webapps folder and you are read to go.

Usage

First, check if the desired version is available at http://localhost:8080/upNGizr/checkVersionAvailable/1.18.1-SNAPSHOT.

To update your appNG installation, then go to http://localhost:8080/upNGizr/update/start/1.18.1-SNAPSHOT and press the button "Update to 1.18.1-SNAPSHOT".

Configuration

The following configuration parameters are available, add them as <context-param> to WEB-INF/web.xml:

Example:

<context-param>
    <param-name>blockRemoteIPs</param-name>
    <param-value>false</param-value>
</context-param>

buildRepository

The URI pointing to the location where the appNG artifacts reside. This can be another (proxy) server or even a path in the file system (use file-protocol in this case). Note that {build} is replaced with either stable or snapshot, depending on the version you want to update to.)

If you want to use a Maven repository as the source for the artifacts, you can do this by specifying buildRepository as follows:

<context-param>
    <param-name>buildRepository</param-name>
    <param-value>http://repo1.maven.org/maven2/org/appng/appng-application/{version}/</param-value>
</context-param>
Note
The placeholder {version} is being replaced with the version you try to install.

You can also use the local filesystem:

<context-param>
    <param-name>buildRepository</param-name>
    <param-value>file:///path/to/appng-artifacts/</param-value>
</context-param>

replacePlatformContext

Default: true

Whether or not WEB-INF/conf/platformContext.xml should be replaced during the update.

replaceBin

Default: false

Whether or not WEB-INF/bin should be replaced during the update.

blockRemoteIPs

Default: true

For security reasons, by default, upNGizr only allows requests originating from the local machine. Set to false to also allow remote origins.

Warning

In this case, further actions to secure upNGizr are required, e.g. using basic authentication (enable the <security-contraint> in web.xml) or due to some firewall rules.

useFQDN

Default: false

Whether to use the fully-qualified domain name (FQDN) of the host in the responses (instead of ServletRequest.getServerName()).