Plausible Community Edition 按照和使用文档

Plausible Community Edition 按照和使用文档

community-edition Example docker-compose setups for hosting Plausible Community Edition 项目地址: https://gitcode.com/gh_mirrors/comm/community-edition

1. 项目的目录结构及介绍

Plausible Community Edition 是一个开源的网站分析工具，它的目录结构如下：

plausible-ce/
├── clickhouse/
│   └── ... # ClickHouse 数据库相关文件
├── .gitignore
├── LICENSE
├── README.md
├── compose.yml
└── .env

目录和文件说明：

• clickhouse/：包含 ClickHouse 数据库的相关文件。
• .gitignore：指定 Git 忽略的文件和目录。
• LICENSE：项目使用的 MIT 许可证文件。
• README.md：项目的自述文件，包含项目介绍和使用说明。
• compose.yml：Docker Compose 文件，用于定义和运行多容器 Docker 应用。
• .env：环境变量配置文件。

2. 项目的启动文件介绍

项目的启动主要通过 docker-compose 来完成。以下是启动项目的基本步骤：

1. 克隆项目仓库到本地：

   git clone -b v2.1.5 --single-branch https://github.com/plausible/community-edition plausible-ce
   

2. 进入项目目录：

   cd plausible-ce
   

3. 创建和配置环境变量文件 .env：

   touch .env
   echo "BASE_URL=https://plausible.example.com" >> .env
   echo "SECRET_KEY_BASE=$(openssl rand -base64 48)" >> .env
   

   确保 BASE_URL 设置为你计划托管服务的实际域名。域名必须有一个指向你的服务器的 DNS 记录，以便正确解析和自动颁发 Let's Encrypt TLS 证书。

4. 暴露 Plausible 服务器到网络，创建一个 compose.override.yml 文件：

   echo "HTTP_PORT=80" >> .env
   echo "HTTPS_PORT=443" >> .env
   cat > compose.override.yml << EOF
   services:
     plausible:
       ports:
         - 80:80
         - 443:443
   EOF
   

   设置 HTTP_PORT=80 和 HTTPS_PORT=443 可以启用自动 Let's Encrypt TLS 证书颁发。如果你打算在反向代理后面运行 Plausible，你可能需要选择不同的值。

5. 使用 Docker Compose 启动服务：

   docker compose up -d
   

6. 访问你的实例 BASE_URL 并创建第一个用户。

3. 项目的配置文件介绍

项目的配置主要通过 .env 文件来进行。以下是 .env 文件中可能需要配置的一些关键环境变量：

• BASE_URL：设置 Plausible 实例的基 URL。
• SECRET_KEY_BASE：一个随机生成的密钥，用于确保应用的安全性。
• HTTP_PORT：HTTP 服务的端口号，默认为 80。
• HTTPS_PORT：HTTPS 服务的端口号，默认为 443。

确保正确配置这些环境变量，以便 Plausible 能够正确运行和访问。

community-edition Example docker-compose setups for hosting Plausible Community Edition 项目地址: https://gitcode.com/gh_mirrors/comm/community-edition