LIGHTSTREAMER QUICK SETUP
=========================

This document will guide you through the installation process of
Lightstreamer Server. You will get it up and running in a very
short time.

In order to use a commercial edition of Lightstreamer Server
(that is, Lightstreamer Allegro, Presto, or Vivace), you need a
valid license. Two types of license are available:

- Evaluation License: It consists of a ClientID string that can be
  obtained online and usually lasts for 30 days. The ClientID will
  be validated by Lightstreamer Server once a day by connecting to
  our central license server through the Internet.
  Please notice that the ClientID is not the Username that you used
  to register on Lightstreamer site. You can get your ClientID from
  http://www.lightstreamer.com/vb/ls_eval_request.php

- Production/Development/Test/Demo License: It is comprised of a
  ClientID string and a license file. This license does not access
  the Internet for validation and in many cases is bound to the MAC
  address of the box. To get this type of license you need to contact
  info@lightstreamer.com.

For more information on the different kinds of licenses, please see
http://www.lightstreamer.com/vb/faq.php?faq=sales#faq_licenses


===================
SYSTEM REQUIREMENTS
===================

- Make sure you have a JDK (Java SE Development Kit) installed on
  your system. You can get the latest JDK version from Sun
  (http://java.sun.com/javase/downloads/index.jsp).
  
  Note: If you already have a JRE (Java Runtime Environment)
  installed, you should upgrade to the JDK, in order to enable the
  "-server" optimization flag in the launch script.

- If you are using an Evaluation License, your system needs to access
  the Internet in order to validate the license.


==========
QUICKSTART
==========

----------------------
1) Extract the Archive
----------------------

* On a Unix or Linux system:
Extract the contents of the "Lightstreamer.tar.gz" archive (GNU tar
should be used, to handle long pathnames correctly). A "Lightstreamer"
directory will be created, that is your installation home directory.

* On a Windows system:
Unzip the "Lightstreamer.zip" file. A "Lightstreamer" directory will
be created, that is your installation home directory.

-------------------------
2) Configure your License
-------------------------

* If you own an Evaluation License:

Edit the "lightstreamer_conf.xml" file, located under the "conf"
directory. Place your ClientID in the <client_id> element, located
under the <trial> element. If the machine that hosts Lightstreamer
Server needs a proxy server to access the Internet, then you should
configure the following elements, after uncommenting them:
<proxy_host>, <proxy_port>, <proxy_user>, <proxy_password>.

* If you own a Dev/Test/Prod/Demo License:

Copy your license file to the "conf" directory.
Edit the "lightstreamer_conf.xml" file, located under the "conf"
directory. Entirely remove the <trial> element block (from <trial>
to </trial>) and replace it with the following element:

     <!-- Mandatory when a Development or Production License is used. -->
     <production>
        <!-- Mandatory. ClientId of the customer. -->
        <client_id>PUT YOUR CLIENTID HERE</client_id>

        <!-- Mandatory. Path and name of the license file for Lightstreamer Server,
             relative to the conf directory. -->
        <license_path>mylicensefile.license</license_path>

        <!-- Mandatory. Path of the directory in which to store the audit
             log files, relative to the conf directory. -->
        <audit_logs>../audit</audit_logs>
     </production>

Place your ClientID in the <client_id> element.
Place the name of your license file in the <license_path> element.

------------------------
3) Choose Your TCP Ports
------------------------

By default, this installation uses TCP ports 8080, 9999 and 6666. If
any of these ports are already in use on your system, please change
them by editing the following elements in "lightstreamer_conf.xml":
     <port> (inside the <http_server> block)
     <jmxmp_connector_port>
     <html_adaptor_port>

-------------------------------
4) Activate the Monitor Console
-------------------------------

Lightstreamer features an internal Monitor Console that provides
the state of the Server in real time through an HTML page.
The default configuration comes with the Monitor Console not
activated, to avoid accidentally keeping it unprotected in production
environments. To activate the Monitor Console, edit the
"lightstreamer_conf.xml" file: go to the <monitor_provider> block and
change <public> from N to Y; then change <available_on_all_servers>
from N to Y.
For production environments, remember to protect the Monitor Console
through a user id and a password.

-----------------
5) Configure Java
-----------------

* On a Unix or Linux system:
Edit the "LS.sh" file under the "bin/unix-like" directory and set
LS_HOME and JAVA_HOME according to your environment.

* On a Windows system:
Edit the "LS.bat" file under the "bin\windows" directory and set
LS_HOME and JAVA_HOME according to your environment.

LS_HOME must point to your installation home directory.
JAVA_HOME must poin to your JDK installation.

--------------------
6) Launch the Server
--------------------

* On a Unix or Linux system:
Go to the "bin/unix-like" directory and execute "start.sh".

* On a Windows system:
Go to the "bin\windows" directory and execute
 "Start_LS_as_Application.bat".

------------------
7) Test the Server
------------------

Point your browser to "http://localhost:8080" (change the port number
if you configured a different port at step 3).

You should see a welcome page containing the links to the installed
demos. Click on the links to run the demos.

In case of problems, errors are reported in the "Lightstreamer.log"
file under the "logs" directory.

NOTE: 
To deploy the provided StockList Demo pages on an external web server
of your choice, please follow the "External deployment" section of
the "DOCS-SDKs/sdk_client_web/examples/StockListDemo/README.TXT" file.

------------------
8) Stop the Server
------------------

* On a Unix or Linux system:
Go to the "bin/unix-like" directory and execute "stop.sh".

* On a Windows system:
Go to the "bin\windows" directory and execute
"Stop_LS_as_Application.bat".

-----------------------------
9) Develop Your Applications!
-----------------------------

Lightstreamer Server is ready to host your own Adapters and serve
your own Clients.

An Adapter is a software component that connects Lightstreamer Server
to your data sources. To develop a Lightstreamer Adapter, you can
choose among Java, .NET, and direct sockets.

A Client connects to Lightstreamer Server to subscribe to and receive
any real-time data provided by your data sources. To develop a
Lightstreamer Client, you can choose among JavaScript (AJAX),
Flash/Flex, Java SE, Java ME, .NET, and direct HTTP connections.

To grasp the main concepts regarding Lightstreamer development, we
suggest to start from the following readings:

General theory:
--> DOCS-SDKs/General Concepts.pdf

JavaScript client development theory:
--> DOCS-SDKs/sdk_client_web/doc/Web Client Dev.pdf

A "Hello World" tutorial that covers the development of a simple Java
Data Adapter (server side) and a Web client:
--> http://www.lightstreamer.com/r/hello-cometdaily

A version of the "Hello World" tutorial focused on .NET, where both a
C# and Visual Basic Data Adapter are shown:
--> http://www.lightstreamer.com/r/hello-dotnet-cometdaily

API reference for all the Adapter and Client SDKs
--> all the sdk* folders under DOCS-SDKs contain a detailed API reference

Online support forums:
--> http://www.lightstreamer.com/vb/