tschannik/caprover-umami

caprover-umami

镜像概述和主要用途

caprover-umami是一个针对Caprover平台（或其他系统）优化的Docker镜像，基于轻量级自托管网站分析工具umami构建。其核心作用是在通过Docker进行自动部署时添加必要逻辑，防止数据库在部署过程中被意外清除，确保网站分析数据的持久性。umami作为基础工具，提供了替代Google Analytics的简单、快速的网站分析功能。

核心功能和特性

• 数据库保护机制：在Caprover或其他系统自动部署时，防止数据库被清除，保障分析数据持久化
• 轻量级分析：基于umami，提供简洁、高效的网站流量分析功能，资源占用低
• 自托管：支持私有部署，数据完全由用户掌控，保护隐私
• 多数据库支持：兼容MySQL和PostgreSQL数据库
• 简单配置：通过环境变量即可完成基本配置，易于部署和维护

使用场景和适用范围

• 需要在Caprover平台部署umami的用户
• 希望通过Docker自动部署umami且需保持数据持久化的场景
• 寻求轻量级、自托管网站分析解决方案的个人或小型团队
• 对数据隐私有较高要求，不想使用第三方分析服务的用户

使用方法和配置说明

从源码安装（基础umami安装）

环境要求

• 安装Node.js 10.13或更高版本的服务器
• MySQL或PostgreSQL数据库

获取源码并安装依赖

bash
git clone https://github.com/mikecao/umami.git
cd umami
npm install

创建数据库表

为umami创建数据库后，使用以下脚本安装表结构：

MySQL:

bash
mysql -u username -p databasename < sql/schema.mysql.sql

PostgreSQL:

bash
psql -h hostname -U username -d databasename -f sql/schema.postgresql.sql

执行后将创建默认登录账户：用户名admin，密码umami。

配置umami

创建.env文件，包含以下内容：

DATABASE_URL=(数据库连接URL)
HASH_SALT=(任意随机字符串)

数据库连接URL格式：

• PostgreSQL: postgresql://username:mypassword@localhost:5432/mydb
• MySQL: mysql://username:mypassword@localhost:3306/mydb

HASH_SALT用于为安装生成唯一值。

构建应用

bash
npm run build

启动应用

bash
npm start

默认应用将在http://localhost:3000启动，可通过反向代理或修改端口直接提供服务。

Docker部署

使用docker-compose

构建umami容器并启动Postgres数据库：

bash
docker-compose up

拉取镜像

• PostgreSQL支持版本：

bash
docker pull ghcr.io/mikecao/umami:postgresql-latest

• MySQL支持版本：

bash
docker pull ghcr.io/mikecao/umami:mysql-latest

Caprover部署注意事项

在Caprover中部署时，caprover-umami镜像会自动处理数据库持久化逻辑，无需额外配置防止数据清除。建议在Caprover应用设置中正确配置数据库连接环境变量。

获取更新

如需获取最新功能，执行以下命令：

bash
git pull
npm install
npm run build

许可证

MIT许可证