Debian 11 使用 Docker 安装 Plausible Analytics 自建网站统计

原文地址 u.sb

本文将指导如何在 Debian 11 下使用 Docker 安装 Plausible Analytics 自建网站统计。

PS：本文同时适用于任何可安装 Docker 的 Linux 发行版。

为什么要自建网站统计？#

原因很简单，自己网站的数据当然要自己保管，你希望你网站的数据都被第三方卖给「所谓的」大数据分析公司吗？

Plausible Analytics 是一款以隐私保护著称的网站统计软件，经过几个月的试用，基本可以满足所有的需求，可以取代商业化的 Google Analytics 等产品。

安装 Plausible Analytics#

建议安装在 /opt/plausible 目录：

1
mkdir -p /opt/plausible
2
cd /opt/plausible

首先，我们需要建立一个 docker-compose.yaml 文件，请按照实际需求修改参数：

1
version: "3.8"
2
services:
3
  mail:
4
    image: bytemark/smtp
5
    restart: always
6

7
  plausible_db:
8
    image: postgres:12
9
    volumes:
10
      - db-data:/var/lib/postgresql/data
11
    environment:
12
      - POSTGRES_PASSWORD=postgres
13
    restart: always
14

15
  plausible_events_db:
16
    image: yandex/clickhouse-server:21.3.2.5
17
    volumes:
18
      - event-data:/var/lib/clickhouse
19
      - ./clickhouse/clickhouse-config.xml:/etc/clickhouse-server/config.d/logging.xml:ro
20
      - ./clickhouse/clickhouse-user-config.xml:/etc/clickhouse-server/users.d/logging.xml:ro
21
    ulimits:
22
      nofile:
23
        soft: 262144
24
        hard: 262144
25
    restart: always
26

27
  plausible:
28
    image: plausible/analytics:latest
29
    command: sh -c "sleep 10 && /entrypoint.sh db createdb && /entrypoint.sh db migrate && /entrypoint.sh db init-admin && /entrypoint.sh run"
30
    depends_on:
31
      - plausible_db
32
      - plausible_events_db
33
      - mail
34
      - geoip
35
    volumes:
36
      - ./geoip:/geoip:ro
37
    ports:
38
      - 127.0.0.1:8000:8000
39
    env_file:
40
      - plausible-conf.env
41
    restart: always
42

43
  geoip:
44
    image: maxmindinc/geoipupdate
45
    env_file:
46
      - geoip.env
47
    volumes:
48
      - ./geoip:/usr/share/GeoIP
49

50
volumes:
51
  db-data:
52
    driver: local
53
  event-data:
54
    driver: local
55
  geoip:
56
    driver: local

然后我们在相同目录建立一个 geoip 的文件夹和 plausible-conf.env 的文件：

1
mkdir -p geoip
2
touch plausible-conf.env
3
touch geoip.env

修改 plausible-conf.env，按照官网的教程进行配置，假设你的网址是 https://stat.example.com/，举例如下：

1
ADMIN_USER_EMAIL=管理员邮箱
2
ADMIN_USER_NAME=管理员用户名
3
ADMIN_USER_PWD=管理员密码
4
BASE_URL=https://stat.example.com/
5
SECRET_KEY_BASE=随机字符
6
MAILER_EMAIL=网站通知邮箱
7
SMTP_HOST_ADDR=SMTP 主机名
8
SMTP_HOST_PORT=SMTP 端口
9
SMTP_USER_NAME=SMTP 用户名
10
SMTP_USER_PWD=SMTP 密码
11
DISABLE_REGISTRATION=true
12
GEOLITE2_COUNTRY_DB=/geoip/GeoLite2-Country.mmdb

SECRET_KEY_BASE 需要一串 64 位的随机字符，可以试用 openssl rand -base64 64 或者 pwgen 64 生成。

DISABLE_REGISTRATION 设置 true 即关闭用户注册。

SMTP 可以使用市面上所有的邮件发送产品，或者懒人也可以直接用 Gmail 之类的免费服务，也可以自己搭建 Mailcow 自己用，教程在这儿。

然后我们注册个 Maxmind 帐号，注册成功后在左侧菜单 Account > Manage License Keys 里点击 Generate new license key 获取一个 License key 并记录 Account ID 和这个 License key：

然后修改 geoip.env，并填入如下信息：

1
GEOIPUPDATE_EDITION_IDS=GeoLite2-Country
2
GEOIPUPDATE_FREQUENCY=168
3
GEOIPUPDATE_ACCOUNT_ID=你的 Account ID
4
GEOIPUPDATE_LICENSE_KEY=你的 License Key

然后抓取镜像并启动：

1
docker-compose pull
2
docker-compose up -d

启动完成后即可试用 http://127.0.0.1:8000/ 访问 Plausible，如果需要对外进行服务，我们还需要配置 Nginx 反向代理。

重启 Nginx 后生效我们即可访问 https://stat.example.com/

更新 Plausible Analytics#

万能的 Docker 更新大法：

1
docker-compose pull
2

3
docker-compose up -d
4

5
docker system prune

备份 Plausible Analytics#

备份#

1
#!/usr/bin/env sh
2

3
docker-compose stop
4
docker run --rm -v plausible_db-data:/volume -v `pwd`:/backup loomchild/volume-backup backup plausible_db-data
5
docker run --rm -v plausible_event-data:/volume -v `pwd`:/backup loomchild/volume-backup backup plausible_event-data
6
docker-compose start -d

导入脚本

1
#!/usr/bin/env sh
2

3
docker-compose stop
4
docker run --rm -v plausible_db-data:/volume -v `pwd`:/backup loomchild/volume-backup restore -f plausible_db-data
5
docker run --rm -v plausible_event-data:/volume -v `pwd`:/backup loomchild/volume-backup restore -f plausible_event-data
6
docker-compose start -d

卸载 Plausible Analytics#

1
docker-compose down
2
rm -rf /opt/plausible
3
docker image rm postgres:12
4
docker image rm maxmindinc/geoipupdate:latest
5
docker image rm plausible/analytics:latest
6
docker image rm yandex/clickhouse-server:21.3.2.5
7
docker image rm bytemark/smtp:latest
8
docker volume rm plausible_db-data
9
docker volume rm plausible_event-data

WordPress 添加方法#

直接修改你使用的主题的 header.php 文件，在 <?php wp_head(); ?> 后面添加统计代码即可。

不想修改主题的也可以直接装官方的插件。

VuePress 添加方法#

如果你使用 VuePress v1.x，那么修改 .vuepress/config.js 文件，在 module.exports 加入：

1
['script', {}, `
2
const script = document.createElement('script');
3
script.async = true;
4
script.defer = true;
5
script['data-domain'] = '统计域名';
6
script.src = 'https://stat.example.com/js/plausible.js';
7
document.head.appendChild(script);`
8
],

如果你试用 VuePress v2.x，那么修改 .vuepress/config.ts 文件，在 export default 加入：

1
['script', {}, `
2
const script = document.createElement('script');
3
script.async = true;
4
script.defer = true;
5
script['data-domain'] = '统计域名';
6
script.src = 'https://stat.example.com/js/plausible.js';
7
document.head.appendChild(script);`
8
],

Next.js 添加方法#

安装 next-plausible 这个包，然后使用类似如下的代码：

1
import PlausibleProvider from 'next-plausible'
2

3
export default function MyApp({ Component, pageProps }) {
4
  return (
5
    <PlausibleProvider domain="统计域名" customDomain="https://stat.example.com" selfHosted>
6
      <Component {...pageProps} />
7
    </PlausibleProvider>
8
  )
9
}

更多的添加方法请查看官网的文档。