Empower Curiosity / Redshift analytics platform
JavaScript Ruby HTML CSS
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app return back testing change Feb 21, 2018
bin align option name Jun 15, 2016
config fix front end bug where the check for current_user.role was incorrect… Sep 8, 2017
db primogenic commit Jun 6, 2016
docker_demo disentangle playground into demo and minimal setups Jun 13, 2016
docker_playground add dockerfile for playground/minimal setup Jun 14, 2016
docs add documentation about new features DE-12180 Sep 14, 2017
images add banner to readme, add link to video Jun 17, 2016
lib csv service should be in charge of deleting tmp file on failure, fix … Sep 8, 2017
playground_data primogenic commit Jun 6, 2016
public primogenic commit Jun 6, 2016
script primogenic commit Jun 6, 2016
spec csv service should be in charge of deleting tmp file on failure, fix … Sep 8, 2017
vendor/assets Use key bindings Mar 27, 2017
.coveralls.yml primogenic commit Jun 6, 2016
.gitignore primogenic commit Jun 6, 2016
.travis.yml use trusty dist for travis #67 Sep 6, 2017
CHANGELOG.md release 0.2.0 - gemspec and changelog Sep 13, 2017
Gemfile primogenic commit Jun 6, 2016
Gemfile.lock primogenic commit Jun 6, 2016
LICENSE Initial commit Apr 25, 2016
Procfile primogenic commit Jun 6, 2016
README.md add documentation about new features DE-12180 Sep 14, 2017
ROADMAP.md primogenic commit Jun 6, 2016
Rakefile primogenic commit Jun 6, 2016
aleph.gemspec release 0.2.0 - gemspec and changelog Sep 13, 2017
config.ru primogenic commit Jun 6, 2016
package.json primogenic commit Jun 6, 2016

README.md

Aleph

Aleph is a Redshift analytics platform that focuses on aggregating institutional data investigation techniques.

aleph

Build Status

Quickstart

If you want to connect to your own Redshift cluster, the follow instructions should get you up and running.

Docker Install

The fastest way to get started: Docker

Configure your Redshift and run
  docker run -ti -p 3000:3000 lumos/aleph-playground /bin/bash -c "aleph setup_minimal -H {host} -D {db} -p {port} -U {user} -P  {password}; redis-server & aleph run_demo"
Open in browser
  open http://$(docker-machine ip):3000

Gem Install

You must be using PostgreSQL 9.2beta3 or later client libraries

Install and run Redis
brew install redis  && redis-server &
Install gem
gem install aleph_analytics
Configure your Redshift and run
aleph setup_minimal -H {host} -D {db} -p {port} -U {user} -P {password}
aleph run_demo

Aleph should be running at localhost:3000

Aleph Gem

Aleph is packaged as a Rubygem.

To list gem executables, just type aleph --help

Find out more about the gem executables here.

Installation

Dependencies

For a proper production installation, Aleph needs an external Redis instance and operational database. The locations of these services can be configured using environment variables. More detailed instructions on configuration can be found here. Example configurations can be found here.

The app

There are a number of ways to install and deploy Aleph. The simplest is to set up a Dockerfile that installs aleph as a gem:

FROM ruby:2.1.6

# we need postgres client libs
RUN apt-get update && apt-get install -y postgresql-client --no-install-recommends && rm -rf /var/lib/apt/lists/*

# make a log location
RUN mkdir -p /var/log/aleph
ENV SERVER_LOG_ROOT /var/log/aleph

# make /tmp writeable
RUN chmod 777 /tmp

# bundle install inside the aleph gem
RUN gem install aleph_analytics

# copy our aleph configuration over to the image
ENV ALEPH_CONFIG_PATH /etc/aleph/
COPY aleph_config/. /etc/aleph/.

# install the aleph dependencies
RUN aleph deps

You can then deploy and run the main components of Aleph as separate services using the gem executables:

  • web_server - aleph web_server --worker-process 2
  • query workers - aleph workers
  • clock (used to trigger alerts) - aleph clock

At runtime, you can inject all the secrets as environment variables.

We highly recommend that you have a git repo for your queries and s3 location for you results.

Advanced setup and configuration details (including how to use Aleph roles for data access, using different auth providers, creating users, and more) can be found here.

Contribute

Aleph is Rails on the backend, Angular on the front end. It uses Resque workers to run queries against Redshift. Here are few things you should have before developing:

  • Redshift cluster
  • Postgres and Redis installed
  • Git Repo (for query versions)
  • S3 Location (store results)

While the demo/playground version does not use a git repo or S3, we highly recommend that you use them in general.

Setup

Postgres

createuser -s -P postgres
initdb --encoding=utf8 --auth=md5 --auth-host=md5 --auth-local=md5 --username=postgres --pwprompt /usr/local/var/postgres
  • development password should be "password"
  • Restart Postgres

Database

bundle exec rake db:create db:migrate
RAILS_ENV=test bundle exec rake db:setup db:test:prepare

Karma/Jasmine

npm install

Testing

RAILS_ENV=test bundle exec rspec spec
bundle exec rake karma:run

Running

bundle exec foreman start

You can manage your env variables in a .env file

Links

Unless otherwise noted, all Aleph source files are made available under the terms of the MIT License