Merge branch 'improvement/JAL-3449_add_install4j_installer_getdown_versions_to_jalvie...

[jalview.git] / doc / building.md

diff --git a/doc/building.md b/doc/building.md
index badb593..33e1fec 100644 (file)
--- a/doc/building.md
+++ b/doc/building.md
@@ -486,6 +486,11 @@ There are several values of `CHANNEL` that can be chosen, with a default of `LOC
     - `appbase` as `http://www.jalview.org/getdown/SCRATCH-NAME/JAVA_VERSION`
     - application subdir as `alt`
     - Getdown launcher cannot use a `file://` scheme appbase.
+* `TEST-LOCAL`:  Like `SCRATCH` but with a specific `test-local` channel name and a local filesystem appbase.  This is meant for testing an over-the-air update on the local filesystem.  An extra property `LOCALDIR` must be given (e.g. `-PLOCALDIR=/home/user/tmp/test`)
+  It will set
+    - `appbase` as `file://${LOCALDIR}`
+    - application subdir as `alt`
+    - Getdown launcher can use a `file://` scheme appbase.
 * `TEST-RELEASE`:  Like `SCRATCH` but with a specific `test-release` channel name.  This won't become live until the actual getdown artefact is synced to the web server.  This is meant for testing an over-the-air update without interfering with the live `release` or `develop` channels.
   It will set
     - `appbase` as `http://www.jalview.org/getdown/test-release/JAVA_VERSION`