[vlma-devel] commit: Update INSTALL. (Adrien Grand )

[git version control]

vlma | branch: master | Adrien Grand <jpountz at videolan.org> | Thu Sep 11 17:45:15 2008 +0200| [1fdb2e8298d4647f461a85f46e159115314f4865] | committer: Adrien Grand 

Update INSTALL.

> http://git.videolan.org/gitweb.cgi/vlma.git/?a=commit;h=1fdb2e8298d4647f461a85f46e159115314f4865
---

 INSTALL |   89 +++++++++++++++++++++++++++++++++++++++++++++++++++++----------
 1 files changed, 75 insertions(+), 14 deletions(-)

diff --git a/INSTALL b/INSTALL
index 67ca84c..0d610c4 100644
--- a/INSTALL
+++ b/INSTALL
@@ -1,8 +1,15 @@
 Build and installation instructions
 ===================================
 
+If you downloaded VLMa from a mirror, you can directly go to the
+"Installation instructions" section.
+
+
+Build instructions
+------------------
+
 Prerequisities
- * Java 5 SDK or later
+ * Java 5.0 SDK or later
  * Maven 2
 
 VLMa uses Maven 2 as a build system. If you are not familiar with this
@@ -13,18 +20,72 @@ To build the project, run the following command from the root folder:
 
 Maven will then download VLMa dependencies and compile source code.
 
-Several files named vlmad-${version}-bin (where ${version} is the
+Several files named vlma-${version}-bin (where ${version} is the
 version of VLMa you have built) should have been created under the
-vlma-distribution/target folder. Extract one of them to the folder of
-your choice. The daemon installation is then complete, the main
-executable being available under the bin folder.
-
-For example:
-  % cd /usr/local
-  % tar -xvzf /path/to/vlma-distribution/target/vlmad-${version}-bin.tar.gz
-  % vlmad-${version}/bin/vlmad start
-
-To enable the web interface, you have to deploy the file named vlma.war
-in your favorite servlet container, on the same computer as the one on
-which you launched the daemon.
+vlma-distribution/target folder.
+
+
+Installation instructions
+-------------------------
+
+Prerequisities
+ * Java 5.0 SDK or later
+ * VLMa binary distribution (either dowloaded from a mirror or built from
+   source)
+
+First extract VLMa distribution archive to the folder of your choice, you
+should see the following folders:
+ - bin/      Command line wrappers to manage VLMa
+ - conf/     Configuration
+ - data/     Data
+ - lib/      Dependencies
+ - logs/     Log directory
+ - webapps/  Webapps to deploy
+ - work/     Folder needed by the servlet container
+
+-- PLATFORM DEPENDANT SETTINGS --
+
+** UNIX **
+
+Ensure that the JAVA_HOME environment variable has been set. Run the following
+command:
+ % echo $JAVA_HOME
+
+If it does not print anything to the standard input but whitespaces, this means
+that JAVA_HOME has not been set. You can set JAVA_HOME using the following
+command:
+ % export JAVA_HOME=/path/to/your/JDK/installation
+
+Then open a terminal and go to the folder where you extracted VLMa. You can run
+VLMa daemon by running the following command:
+ % bin/vlmad start
+
+To run the web UI, open a new terminal and run:
+ % bin/vlmaw start
+
+
+** Windows **
+
+Ensure that the JAVA_HOME environment variable has been set and that it points
+to a valid JDK installation. To do this, have a look at:
+  http://support.microsoft.com/kb/310519 for Windows XP,
+  http://support.microsoft.com/kb/931715 for Windows Vista.
+
+Then open a prompt and change directory to where you extracted VLMa. You can
+run VLMa daemon by running the following command:
+ % bin\vlmad.bat start
+
+To run the web UI, open a new prompt and run:
+ % bin\vlmaw.bat start
+
+
+-- END OF PLATFORM DEPENDANT SETTINGS --
+
+To finish with, go to http://localhost:8080, you should see VLMa dashboard
+which tells you which medias are currently streamed and the list of servers
+VLMa didn't manage to contact through their telnet interface.
+
+The use of the embedded servlet container is a convenience for testing. If you
+plan to use VLMa in production, we recommend you make a complete installation
+of a servlet container like Tomcat, Jetty or whichever other servlet container.