Initial commit of README.md

README.md

@@ -0,0 +1,140 @@
+# Logscape
+## An Open-Source log management tool
+[Logscape Commercial Website](http://www.logscape.com) | [Logscape Blog](http://blog.logscape.com) | [Logscape Support](http://support.logscape.com)
+
+Logscape is a big-data analysis tool. Using your logs and other data, Logscape produces clear dashboards and provides real-time alerts. All data is indexed on your system, whether locally, or using a centralised index store. Once indexed you can search the entire stack for a single term, or use precise functions and filters. Logscape is deployed on your infrastructure and provides a straight forward web interface, with enterprise ready access controls.
+
+## Features
+* Search log files at scale
+* Tail files in real-time
+* Analyse each event
+* Interactive Search and Discovery
+* Automatic JSON and CSV extraction
+* [Read them all](http://logscape.com/product.html)
+
+## Installation
+If you are just intending to run Logscape then we reccomend using one of our [pre-built releases](www.github.com) and read our [getting started guide](http://logscape.github.io/tutorials-walkthrough.html).
+Pre-requisites -
+*  JRE 8 or above
+
+Then run Logscape by following these steps.
+* Extract the .zip folder
+* Configure your [agents role](https://logscape.github.io/deploy.html) (Default: Manager) via the `configure.sh` located in ```/logscape/scripts/```
+* Start your agent via `logscape.sh start` or `logscape.bat`
+## Using Logscape
+
+Logscape is a monitoring tool for both log file analysis and environment wide instrumentation. Using [Logscape Apps](logscape.github.io/apps.html) it is possible to extract data from almost any system. Each installation ships with the Unix App and Windows App installed, and more can be downloaded from the [App page](logscape.github.io/apps.html) or alternatively you can [create your own](http://logscape.github.io/app-develop.html).
+## Deployment
+Logscape managers can be used in isolation however Logscape is best leveraged around your entire environment with [Forwarders](http://logscape.github.io/deploy-forwarder.html) shipping logs to [dedicated nodes](http://logscape.github.io/deploy-indexstore.html), the [Logscape support site](http://logscape.github.io/) features a [full deployment guide](http://logscape.github.io/deploy.html).
+
+## Docker
+You are welcome to build your own docker containers using Logscape, however we also offer pre-built containers on [dockerhub.](https://hub.docker.com/r/logscape/logscape/)
+
+## Build from Source
+If you are looking to modify the code, or would rather build from source than download a pre-compiled executable then follow these steps.
+Pre-requisites -
+* JDK 8 or above
+* [Ant build tool](http://ant.apache.org/)
+
+Then build from source by follow these steps
+* Navigate to your checkout directory
+* Navigate to the master folder `/LogScape/master`
+* Execute `ant clean dist`
+
+On a succesful build this will generate -
+* Distributable zip located in `/Logscape/master/dist`
+* Expanded build located in `Logscape/master/build`
+
+The artifacts of this build are as follows -
+```
+.
+├── logscape.sh // Used for running Logscape on Unix based systems
+├── logscape.bat // Used for running Logscape on Windows
+├── readme.txt // Explains how to run and configure Logscape
+├── agent-log4j.properties // Log4j configuration file
+├── log4j.properties // Log4j configuration file
+├── boot.properties // Used to configure boot parameters of this agent
+├── boot.jar //Used by Logscape scripts
+├── boot.sh //Used by Logscape scripts
+├── boot.bat //Used by Logscape scripts
+├── downloads
+|   └── contains downloaded files which will be distributed across the entire deployment
+├── apps
+|   └── Jetty configiguration
+├── etc
+|   └── Service configuration
+├── libs
+|   └── Common Libs
+├── pids
+|   └── Used in the tracking of the currently active Logscape pids
+├── scripts
+|   └── Contains groovy scripts, as well as utility shell and bash scripts
+├── space
+|   └── Contains data storage .`journal` files generated by system modules
+├── ssl
+|   └── Contains SSL key files
+├── deployed-bundles
+|   └── Contains the expanded contents of the `downloads` folder
+└── system-bundles
+```
+
+## Module Breakdown
+`Boot` - Responsible for bootstrapping the agent process and managing its life cycle.
+
+`Common` - Contains a series of commonly used low level classes.
+
+`DashboardServer` - Responsible for the web front-end.
+
+`Lib` - Contains libraries commonly used throughout the project.
+
+`Master` - Storage of scripts to perform high level operations.
+
+`Play` - Main web module.
+
+`Print` - Generates reports.
+
+`Replicator` - Manages the distribution of the contents of the `download` folder.
+
+`Root` - Displays the Logscape loading page.
+
+`SaaS-Meter` - Allows for multi-tenanted environments with data quotas.
+
+`Transport` - Non-blocking socket communication layer and RabbitMQ integration.
+
+`vs-admin` - User administration.
+
+`vs-log` - Stores and indexes searches, dashboards, alerts etc
+
+`vs-log-disco` - Extracts fields from data at ingest and search time.
+
+`vs-log-server` - Ships logs from Forwarders to Indexers.
+
+`vso` - VScape orchestration.
+
+`vs-orm` - Maps objects into the VSpace datastore.
+
+`vspace` - Storage of space objects and VScape services.
+
+`vs-socket-server` - Logscape Socket Server
+
+`vs-syslog-server` - Logscape Syslog Server
+
+`vs-util` - Utlity module for chargeback and costing.
+
+## Contact
+Please direct any queries to support@logscape.com
+
+## License
+Copyright 2017 Logscape
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License