visibilityspots/smashing

smashing Docker镜像文档

镜像概述和主要用途

本镜像用于在Docker容器中运行https://github.com/Smashing/smashing%E2%80%94%E2%80%94%E4%B8%80%E6%AC%BE%E5%BC%80%E6%BA%90%E7%9A%84%E5%AE%9E%E6%97%B6%E6%95%B0%E6%8D%AE%E4%BB%AA%E8%A1%A8%E6%9D%BF%E5%B7%A5%E5%85%B7%E3%80%82%E9%80%9A%E8%BF%87Docker%E5%AE%B9%E5%99%A8%E5%8C%96%E9%83%A8%E7%BD%B2%EF%BC%8C%E5%8F%AF%E7%AE%80%E5%8C%96smashing%E7%9A%84%E5%AE%89%E8%A3%85%E9%85%8D%E7%BD%AE%E6%B5%81%E7%A8%8B%EF%BC%8C%E5%AE%9E%E7%8E%B0%E5%BF%AB%E9%80%9F%E5%90%AF%E5%8A%A8%E5%92%8C%E7%81%B5%E6%B4%BB%E5%AE%9A%E5%88%B6%E3%80%82

核心功能和特性

• 便捷部署：无需手动配置Ruby环境，直接通过Docker命令启动smashing服务
• 端口自定义：支持通过环境变量修改容器内smashing服务端口
• 数据持久化：通过卷挂载支持自定义仪表板、任务脚本、组件及配置文件
• 组件扩展：支持通过Gist ID或本地文件安装自定义widgets
• 依赖管理：可通过环境变量指定并自动安装所需Ruby gems
• 配置灵活：支持自定义静态资源（favicon、404页面）及核心配置文件

使用场景和适用范围

适用于需要快速部署实时数据仪表板的场景，如：

• 系统监控数据可视化展示
• 业务指标实时监控面板
• 团队协作数据共享看板
• 自定义数据采集与展示平台

尤其适合需要频繁调整仪表板布局、数据来源或集成第三方服务的用户。

详细的使用方法和配置说明

基本运行

通过以下命令启动默认配置的smashing服务：

bash
docker run -d -p 8080:3030 visibilityspots/smashing

服务启动后，通过浏览器访问 http://localhost:8080 即可查看默认仪表板。

配置选项

环境变量配置

卷挂载配置

高级配置示例

1. 自定义服务端口

修改容器内服务端口为8080，并映射到主机80端口：

bash
docker run -d -e PORT=8080 -p 80:8080 visibilityspots/smashing

2. 挂载自定义仪表板

部署本地自定义仪表板（需确保本地目录包含仪表板文件及layout.erb）：

bash
docker run -v /my/custom/dashboards:/dashboards -d -p 8080:3030 visibilityspots/smashing

3. 安装Gist widgets及依赖gems

安装"Instagram photos by location" widget及其依赖的instagram gem：

bash
docker run -d \
  -e GEMS="instagram" \
  -e WIDGETS=5278790 \
  -p 8080:3030 \
  visibilityspots/smashing

4. 完整自定义配置（多卷挂载）

同时挂载自定义仪表板、jobs和widgets：

bash
docker run -d \
  -v /my/dashboards:/dashboards \
  -v /my/jobs:/jobs \
  -v /my/widgets:/widgets \
  -v /my/public:/public \
  -e PORT=8080 \
  -p 80:8080 \
  visibilityspots/smashing

Docker Compose配置示例

创建docker-compose.yml文件，配置完整部署环境：

yaml
version: '3'
services:
  smashing:
    image: visibilityspots/smashing
    container_name: smashing-dashboard
    restart: always
    ports:
      - "80:3030"  # 主机80端口映射到容器3030端口
    environment:
      - PORT=3030  # 容器内服务端口
      - GEMS="mysql redis"  # 安装依赖gems
      - WIDGETS="5641535 6246149"  # 安装指定Gist widgets
    volumes:
      - ./dashboards:/dashboards  # 自定义仪表板
      - ./jobs:/jobs  # 自定义任务脚本
      - ./widgets:/widgets  # 本地widgets
      - ./public:/public  # 自定义静态资源
      - ./config:/config  # 自定义配置文件

启动服务：

bash
docker-compose up -d

致谢

• https://github.com/mattgruter - 重要贡献者
• https://github.com/rowanu - https://gist.github.com/rowanu/6246149
• https://github.com/munkius - Hotness Widget的https://gist.github.com/munkius/9209839
• https://github.com/chelsea - https://gist.github.com/chelsea/5641535
• https://github.com/bemehow - 官方Ruby Docker镜像实现

许可证

采用MIT许可证分发。详情参见https://opensource.org/licenses/MIT%E3%80%82