pivotalsingapore/spotlight-rails

Spotlight 🔦

为开发团队打造的高效仪表板

镜像概述

Spotlight是面向开发团队的简洁仪表板工具，核心目标是展示持续集成（CI）构建状态。它采用容器化包装，可快速部署到各类环境，同时支持从预定义列表添加小部件或自定义新部件，帮助团队高效管理项目信息。

核心功能

• 轻松创建仪表板并管理预定义小部件
• 容器化部署，适配本地、服务器等多种环境
• 实时查看多项目的CI构建状态
• 支持添加预定义小部件或自定义新部件

使用场景

• 开发团队实时监控CI构建结果，快速定位构建失败问题
• 团队共享信息展示（如项目进度、通知公告等）
• 小型开发环境的一站式信息聚合平台

配置与部署说明

Docker Compose部署

1. 安装Docker Toolbox（参考https://docs.docker.com/mac/step_one/%EF%BC%89%E3%80%82
2. 在工作目录创建docker-compose.yml文件：

yaml
db:
  image: docker.xuanyuan.run/postgres
api:
  image: docker.xuanyuan.run/pivotalsingapore/spotlight-rails
  command: bundle exec foreman start
  environment:
    - SECRET_KEY_BASE=<请替换为自定义密钥>
    - WEB_HOST=/
    - GOOGLE_API_CLIENT_ID=<请替换为你的Google API客户端ID>
    - GOOGLE_API_CLIENT_SECRET=<请替换为你的Google API客户端密钥>
  links:
    - db
web:
  image: docker.xuanyuan.run/pivotalsingapore/spotlight-dashboard
  ports:
    - "3030:80"
  links:
    - api

注意：需替换SECRET_KEY_BASE、GOOGLE_API_CLIENT_ID和GOOGLE_API_CLIENT_SECRET为实际有效值。

3. 启动容器：

bash
docker-compose up -d
docker-compose run --rm web rake db:create db:migrate

4. 访问仪表板：通过容器IP地址（如http://192.168.99.100:3030）访问，可使用docker-machine ls命令查看容器IP。

停止服务

bash
docker-compose stop

本地开发设置（可选）

如需贡献代码，可按以下步骤搭建本地环境：

1. 安装Ruby（使用rbenv）、PostgreSQL数据库。
2. 安装依赖：gem install bundler && bundle install。
3. 初始化数据库：bundle exec rake db:create db:migrate db:seed。
4. 启动开发服务器：foreman start，访问http://localhost:3000即可进入本地开发环境。