Public Repository

Last pushed: a year ago
Short Description
Spotlight is a simple dashboard for your devshop.
Full Description

Spotlight 🔦

Synopsis

Spotlight is a simple dashboard for your devshop that:

  • Allows people to easily create a dashboard and manage widgets from a predefined set of widgets.
  • Is wrapped in a container that can easily be downloaded and installed on any environment.
  • Lets you view Continuous Integration build status for the various projects is the primary goal.
  • Lets you add new widgets from a list of predefined ones, or create your own.

Motivation

Software developers are increasingly adopting agile and lean approaches to the software development lifecycle. One key component for agile software processes is that of Continuous Integration (CI). With the ubiquity of inexpensive hardware like flat panel displays and Raspberry Pis (single board computer), the DIY approach to building custom information displays is gaining increasing appeal.

We believe there is a need for a simple, hassle free approach to CI monitors.

Running the Spotlight Dashboard

We recommend installing the Spotlight dashboard as a Docker instance on the target machine.

Installing

  1. Install the Docker Toolbox.

  2. In your working folder, create a new file: docker-compose.yml

     db:
         image: postgres
     web:
         image: neosgspotlight/spotlight-rails
         command: bundle exec foreman start
         environment:
             - SECRET_KEY_BASE=<change_me!>
         ports:
             - "3030:3000"
         links:
             - db
    

    Remember to add your own SECRET_KEY_BASE.

Starting the Spotlight Docker instance

  1. Run the following command:

    docker-compose up -d
    docker-compose run --rm web rake db:create db:migrate
    
  2. You can now access the dashboard via the container IP address (e.g. http://192.168.99.100:3030).

    You can find out the IP address of the docker machine by running docker-machine ls.

Stopping Spotlight

To stop the Spotlight dashboard:

docker-compose stop

Accessing Spotlight on your network

To make this dashboard available to your local area network (LAN), you should map one of your host OS's public ports to the Docker Machine's port 3030.

Here's a nice write up on how to do so.

Docker Pull Command
Owner
neosgspotlight

Comments (0)