matrixdotorg/panopticon

panopticon

镜像概述和主要用途

panopticon是一款专注于记录家庭服务器使用指标的工具，旨在收集、存储和暴露家庭服务器的各类使用数据，帮助用户监控服务器运行状态和资源利用情况。

核心功能和特性

• 支持多数据库驱动（MySQL、SQLite等）
• 可配置HTTP服务端口，方便数据访问
• 提供测试专用Dockerfile，简化测试流程
• 兼容Go和Python环境的配置需求

使用场景和适用范围

适用于家庭服务器环境下的使用指标监控场景，可帮助个人用户或小型家庭网络跟踪服务器资源使用、访问频率等关键指标，适用于对家庭服务器运行状态有监控需求的场景。

构建与测试

本地构建

构建panopticon需先安装Go环境，然后执行以下步骤安装依赖并构建：

安装依赖：

sh
go get github.com/mattn/go-sqlite3
go get github.com/go-sql-driver/mysql

执行构建：

sh
go build

测试

提供Dockerfile-testing用于构建测试环境，仅需本地安装Docker，无需Go环境或其他依赖。执行测试命令：

sh
docker-tests.sh

添加新测试时，可参考tests目录中的现有文件结构。

部署使用

环境变量配置

Go镜像环境变量

• PANOPTICON_DB_DRIVER：数据库驱动类型（例如：mysql或sqlite）
• PANOPTICON_DB：数据库连接信息（MySQL连接字符串或SQLite文件名）
• PANOPTICON_PORT：panopticon暴露的HTTP端口

Python镜像环境变量

• PANOPTICON_DB_NAME：数据库名称
• PANOPTICON_DB_USER：数据库用户名
• PANOPTICON_DB_PASSWORD：数据库密码
• PANOPTICON_DB_HOST：数据库主机地址
• PANOPTICON_DB_PORT：数据库端口

Docker部署示例

MySQL数据库示例（Go镜像）

sh
docker run -d \
  -e PANOPTICON_DB_DRIVER=mysql \
  -e PANOPTICON_DB="user:password@tcp(mysql-host:3306)/panopticon?charset=utf8mb4&parseTime=True&loc=Local" \
  -e PANOPTICON_PORT=8080 \
  -p 8080:8080 \
  --name panopticon \
  docker.xuanyuan.run/panopticon:latest

SQLite数据库示例（Go镜像）

sh
docker run -d \
  -e PANOPTICON_DB_DRIVER=sqlite \
  -e PANOPTICON_DB=/data/panopticon.db \
  -e PANOPTICON_PORT=8080 \
  -p 8080:8080 \
  -v /path/to/local/data:/data \
  --name panopticon \
  panopticon:latest