/lumify

Primary LanguageJavaApache License 2.0Apache-2.0

Lumify

Lumify Logo

Lumify is an open source big data analysis and visualization platform. Please see http://lumify.io for more details and videos.

Getting Started

To get started quickly, you can try out a hosted installation of Lumify, or download a virtual machine image with Lumify installed and pre-configured.

Quick Start

  1. Install and start Docker per their instructions: https://docs.docker.com/installation. Only follow the instructions to install & start docker skipping any exercises or other steps beyond installation & starting Docker.

    • Docker will not run natively on OSX or Windows, however, you can use Boot2Docker, a lightweight Linux Virtual Machine, to host Docker on these platforms. After installing Boot2Docker you'll need to initialize and start Boot2Docker with sufficient memory to run the system.

    • Initialize and start boot2docker on OSX/Windows with sufficient memory. The instructions below illustrate initializing boot2docker with 4GB of memory, however, this can be increased if more memory is needed.

       boot2docker init -m 4096
       boot2docker start
    • Set the Docker environment variables that are returned from the following Boot2Docker command. To avoid setting environment variables each time Docker is started, configure these environment variables perminantly for your OS/shell.

       boot2docker shellinit
       
       Writing <user home dir>/.boot2docker/certs/boot2docker-vm/ca.pem
       Writing <user home dir>/.boot2docker/certs/boot2docker-vm/cert.pem
       Writing <user home dir>/.boot2docker/certs/boot2docker-vm/key.pem
       export DOCKER_HOST=tcp://192.168.59.103:2376
       export DOCKER_CERT_PATH=<user home dir>/.boot2docker/certs/boot2docker-vm
       export DOCKER_CERT_PATH=<user home dir>/.boot2docker/certs/boot2docker-vm
  2. Install node and npm per their instructions: http://nodejs.org/

  3. Clone the Lumify repo:

    git clone https://github.com/lumifyio/lumify.git

    This will clone the repo to a lumify directory in your current working directory. This absolute path will be referred to as <cloned_repo_dir> for the remainder of these steps.

  4. Install the Lumify npm dependencies:

    cd <cloned_repo_dir>/web/war/src/main/webapp
    npm install -g inherits bower grunt
    npm install -g grunt-cli
  5. Update your hosts file:

    • Linux

      echo '127.0.0.1 lumify-dev' >> /etc/hosts
    • OS X

      echo "$(boot2docker ip 2>/dev/null) lumify-dev" >> /etc/hosts
  6. Create the docker image:

    cd <cloned_repo_dir>
    docker/build-dev.sh
  7. Run the docker image: (This will start ZooKeeper, HDFS, YARN, ElasticSearch, and RabbitMQ)

    docker/run-dev.sh
  8. Run the web server. Choose one of the following:

See docker/README.md for more information on the docker dev image.

See docs/developer.md for more information on developing for Lumify.

See datasets for sample datasets to get started.

Developing / Contributing

If you're a system administrator or developer looking to install your own instance of Lumify or do custom development, please read our Developer Guide.

License

Copyright 2014 Altamira Technologies Corporation

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.