milesmcc/shynet

Shynet 镜像文档

概述

Shynet 是一款现代、注重隐私且无Cookie的自托管网络分析工具。与传统分析工具不同，它无需将访客数据交给第三方，不依赖Cookie跟踪（因此无需烦人的Cookie通知），仅收集必要的有用数据，同时保持开源和易用性。Shynet 名称融合了"Skynet"（寓意强大数据能力）和"shy"（寓意尊重隐私），旨在提供全面分析的同时保护访客隐私。

核心功能与特性

架构设计

• 灵活部署：可在单台机器上以单个Docker容器运行，也可扩展至大型Kubernetes集群（配合Redis缓存和独立后端工作节点处理数据库IO）
• 基于Django构建：简化部署、更新和数据迁移流程
• 多用户多站点支持：单个实例可支持多个用户，每个用户可跟踪多个不同网站

跟踪能力

• 无需JavaScript：若JavaScript不可用，自动回退至1x1透明跟踪像素
• 轻量级脚本：跟踪脚本体积小于1KB，且外观不同于典型跟踪脚本
• 不易被屏蔽：由于自托管特性，通常不在广告拦截列表中
• 主键集成：可轻松将Shynet中的访客与您网站上的用户账户关联（如需要）

数据指标

Shynet可提供以下访客信息：

• Hits：网站页面被打开/查看的次数
• Sessions：网站被访问的次数（本质上是一系列Hits的集合）
• 页面加载时间：网站页面的加载时长
• 跳出率：仅浏览一个页面后离开的访客百分比
• 停留时间：访客在网站上的停留时长
• 引荐来源：访客进入网站的链接来源
• 页面位置：网站各页面的相对受欢迎程度
• 操作系统：访客使用的操作系统（基于用户代理）
• 浏览器：访客使用的浏览器（基于用户代理）
• 地理位置与网络：访客大致位置（基于IP）
• 设备类型：访客使用的设备类型（桌面、平板或手机，基于用户代理）

使用场景与适用范围

Shynet 适合个人项目和中小型网站，尤其适合注重用户隐私、希望掌控数据所有权的场景。但不推荐用于超高流量站点，且部署和维护需要一定技术知识，不适合寻求"一键解决方案"的用户。

关键概念

• 服务（Services）：您希望跟踪的网络属性，通常对应网站或顶级域名，每个服务生成一个独立的跟踪嵌入代码
• 点击（Hits）：网站单个页面的打开/查看行为
• 会话（Sessions）：同一浏览器在短时间内产生的一系列点击（或单个点击）的集合

部署与使用

支持的部署方式

Shynet 支持多种部署方式，包括：

• 单个Docker容器
• Docker Compose
• Heroku
• Kubernetes集群（需配置Redis缓存和后端工作节点）

基本部署步骤

详细部署指南请参考官方Usage Guide，以下为常见部署方式概述：

Docker Compose部署（推荐）

创建docker-compose.yml文件，配置数据库、Redis等服务，示例结构如下（具体配置请参考官方文档）：

yaml
version: '3'
services:
  web:
    image: docker.xuanyuan.run/milesmcc/shynet
    depends_on:
      - db
      - redis
    environment:
      - DATABASE_URL=postgres://user:password@db:5432/shynet
      - REDIS_URL=redis://redis:6379/0
      - SECRET_KEY=your_secret_key
    ports:
      - "8000:8000"
  db:
    image: docker.xuanyuan.run/postgres:13
    volumes:
      - postgres_data:/var/lib/postgresql/data/
  redis:
    image: docker.xuanyuan.run/redis:6
volumes:
  postgres_data:

单容器部署

使用以下命令启动基本单容器实例（需提前配置数据库）：

bash
docker run -d -p 8000:8000 \
  -e DATABASE_URL=postgres://user:password@host:port/shynet \
  -e SECRET_KEY=your_secret_key \
  docker.xuanyuan.run/milesmcc/shynet

配置说明

核心环境变量配置：

• SECRET_KEY：Django应用密钥，需设置为强随机字符串
• DATABASE_URL：数据库连接URL（支持PostgreSQL等）
• REDIS_URL：Redis连接URL（用于缓存和工作节点通信，可选）
• ALLOWED_HOSTS：允许访问的主机名列表

常见问题

DNT信号支持

Shynet 支持"请勿跟踪（DNT）"信号，可按服务配置是否收集DNT启用用户的数据。默认情况下，Shynet不会收集启用DNT用户的数据。

GDPR合规性

合规性取决于具体使用方式。若关注GDPR合规，建议咨询专业人士，官方不提供建议。

故障排除

遇到问题可参考官方故障排除指南，或在GitHub仓库https://github.com/milesmcc/shynet/issues/new%E6%8A%A5%E5%91%8Abug%E6%88%96%E5%8A%9F%E8%83%BD%E5%BB%BA%E8%AE%AE%E3%80%82

发展路线图

未来计划功能包括：数据聚合、异常检测、详细数据导出、双因素认证和数据删除工具，详见官方https://github.com/milesmcc/shynet/projects/1%E3%80%82

开源许可

Shynet 基于 Apache License, version 2.0 开源协议发布。