LIGHTSTREAMER QUICK SETUP ========================= These notes will guide you through the installation of Lightstreamer Server, to get it up and running in a very short time. In order to use Lightstreamer Server, Moderato Edition, you need a valid Free License. If you do not request and install a Free License, Lightstreamer Server will run in unregistered mode (that is, the Server will shut down after one hour and a periodic message will be broadcast to the clients reminding that the Server has not been registered yet). You can get a Free License from: http://www.lightstreamer.com/downloadfree.htm Please read the Software License Agreement carefully before using Lightstreamer. =================== SYSTEM REQUIREMENTS =================== Make sure you have a JDK (Java SE Development Kit) installed on your system. You can get the latest JDK version from Oracle (http://www.oracle.com/technetwork/java/javase/downloads/index.html). Lightstreamer Server requires Java 5 or newer. However, it is recommended that you use a recent JDK (possibly JDK 6 for best performance). Note: If you already have a JRE (Java Runtime Environment) installed on a 32-bit Windows system, you should upgrade to the JDK, in order to enable the "-server" optimization flag in the launch script. For Linux, Solaris, and 64-bit Windows, the JRE should be enough. ========== QUICKSTART ========== ---------------------- 1) Extract the Archive ---------------------- * On a Unix or Linux system: Extract the contents of the "Lightstreamer_Moderato.tar.gz" archive to your hard drive (a short base path is recommended, because the archive contains quite long path names). GNU tar should be used, to handle long pathnames correctly). A "Lightstreamer" directory will be created, which is your installation home directory. * On a Windows system: Unzip the "Lightstreamer_Moderato.zip" file to your hard drive (a short base path is recommended, e.g. "C:\", because the zip file contains quite long path names). A "Lightstreamer" directory will be created, which is your installation home directory. ------------------------- 2) Configure your License ------------------------- Copy your Moderato license file to the "conf" directory (you can get a Free License file from http://www.lightstreamer.com/downloadfree.htm). Edit the "lightstreamer_conf.xml" file, located under the "conf" directory. Place your ClientID in the element. Place the name of your license file in the element. ------------------------ 3) Choose Your TCP Ports ------------------------ By default, this installation uses TCP ports 8080 and 9999. If any of these ports are already in use on your system, please change them by editing the following elements in "lightstreamer_conf.xml": (inside the block) (inside the block) ----------------- 4) 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 point to your JDK installation. -------------------- 5) 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". ------------------ 6) Test the Server ------------------ Point your browser to "http://localhost:8080" (change the port number if you configured a different port in step 3). You should see a welcome page containing the links to some pre-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. After that, give a try to the Monitor Console, a tool for monitoring the state of the Lightstreamer Server in real-time, which you will probably use a lot when you go into production. By default, the Monitor Console is publicly accessible from "http://localhost:8080/monitor". Please remember to protect the Monitor before going into production! ***IMPORTANT*** Carefully read the "PRODUCTION_SECURITY_NOTES.TXT" document to know what you must do before making your Lightstreamer installation production ready. NOTES: - To deploy the provided demo pages on an external web server of your choice, please follow the instructions in the "pages/demos/HOW_TO_DEPLOY_ON_YOUR_WEB_SERVER.TXT" file. - In production, it is recommended to make Lightstreamer Server listen on standard HTTP/HTTPS ports (80/443). Using non-standard ports (like default 8080) will prevent some external users from accessing the Server, due to security constraints. ------------------ 7) 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". ----------------------------- 8) 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, Silverlight, Java SE, BlackBerry/Java ME, Android, .NET and direct HTTP connections. [Note: Lightstreamer Moderato only supports JavaScript (AJAX) clients and a bridge for Flash/Flex] To grasp the main concepts regarding Lightstreamer development, we suggest to start from the following readings: * General theory: --> DOCS-SDKs/General Concepts.pdf * HTML client development theory: --> DOCS-SDKs/sdk_client_html/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 The tutorials above make reference to Lightstreamer Server v.3.4 and Web Client v.4.2, however, they apply to the current version as well. * 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/