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. By default, Lightstreamer Allegro, Presto, and Vivace run with a Demo license, which can be used for evaluation, development, and testing, but not for production. The Demo license has a limit of maximum 20 users' sessions at the same time. If you need to evaluate Lightstreamer without this limit, or need any information on the other license types, please contact info@lightstreamer.com. Please read the Software License Agreement carefully before using Lightstreamer. =================== SYSTEM REQUIREMENTS =================== - Make sure you have a Java SE platform implementation installed on your system. You can get the latest version of the JDK (Java SE Development Kit) from Oracle (http://www.oracle.com/technetwork/java/javase/downloads/index.html). Lightstreamer Server requires Java 6 or newer. However, it is recommended that you use a recent JDK for best performance. Note: Use a Java SE implementation that enables the "-server" optimization flag in the launch script. For instance, if you already have a JRE (Java Runtime Environment) for Java 7 installed on a 32-bit Windows system, you should upgrade to the JDK. - 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 Linux, Mac, or Unix system: Extract the contents of the "Lightstreamer_Allegro-Presto-Vivace" 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_Allegro-Presto-Vivace" 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) Choose Your TCP Ports ------------------------ By default, this installation uses TCP ports 8080 and 8888. 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) ----------------- 3) Configure Java ----------------- JAVA_HOME must point to your JDK installation. * On a Linux, Mac, or Unix system: Edit the "LS.sh" file under the "bin/unix-like" directory and set JAVA_HOME according to your environment. * On a Windows system: Edit the "LS.bat" file under the "bin\windows" directory and set JAVA_HOME according to your environment. -------------------- 4) Launch the Server -------------------- * On a Linux, Mac, or Unix 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". ------------------ 5) 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: - In real web applications, the pages, including Lightstreamer Libraries, will be deployed on your own Web Server; see DOCS-SDKs/sdk_client_javascript/doc/JavaScript Client Guide.pdf for details on how to test that on the included demos. - 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. See bin/unix-like/README.TXT for tips on how you can achieve this in the Linux case. - To use HTTPS instead of HTTP, you should activate HTTPS within lightstreamer_conf.xml and provide a valid certificate or add the default one as a security exception in your browser. ------------------ 6) Stop the Server ------------------ * On a Linux, Mac, or Unix 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". ----------------------------- 7) 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 plain TCP sockets. A Client connects to Lightstreamer Server to subscribe to the real-time data provided by your data sources. To develop a Lightstreamer Client, you can choose among many different technologies, including JavaScript, iOS, Android, Flash/Flex, Silverlight, Java SE, .NET, and BlackBerry. 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_javascript/doc/JavaScript Client Guide.pdf * A "Hello World" tutorial that covers the development of a simple Java Data Adapter (server side) and a JavaScript client: --> http://www.lightstreamer.com/docs/articles/JavaScript-Client_and_Java-Data-Adapter_Tutorial_Colosseo/index.htm * A version of the "Hello World" tutorial focused on server-side .NET, where both a C# and a Visual Basic Data Adapter are shown: --> http://www.lightstreamer.com/docs/articles/DotNET-Data-Adapter_Tutorial_Colosseo/index.htm * 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://forums.lightstreamer.com