安装方法

您可以选择以下三种方式运行

1. 源码编译运行

1. git clone https://github.com/soxft/busuanzi.git && cd busuanzi
2. go build -o busuanzi main.go
3. 根据提示修改 config.yml
4. 编辑dist/busuanzi.js或编译dist/busuanzi.ts, 替换链接为自己部署的。
5. 通过命令 ./busuanzi 启动程序

2. 使用 Docker 运行 (Recommend)

在一个空文件夹中创建名为 docker-compose.yaml 的文件, 内容如下或见 docker-compose.yaml

version: "3.8"

services:
  redis:
    image: "redis:alpine"
    volumes:
      - ./data/redis:/data
  
  bsz:
    image: "xcsoft/busuanzi:latest"
    ports:
      - "8080:8080"                            # 修改映射到宿主机的端口 host:container
    links:
      - redis
    depends_on:
      - redis
    environment:
      WEB_LOG: true                                     # 是否开启日志
      WEB_DEBUG: false                                  # 是否开启debug模式
      WEB_CORS: "*"                                     # 跨域访问
      BSZ_EXPIRE: 0                                     # 统计数据过期时间 单位秒, 请输入整数 (无任何访问, 超过这个时间后, 统计数据将被清空, 0为不过期)
      BSZ_SECRET: "bsz"                                 # 签名密钥 // 请设置为任意长度的随机值
      API_SERVER: http://127.0.0.1:8080                 # 填写你的 API 地址
      REDIS_ADDRESS: redis:6379                         # redis 地址
      BSZ_PATHSTYLE: true
      BSZ_ENCRYPT: MD516

环境变量设置

环境变量	参数说明
API_SERVER	busuanzi.js API地址
WEB_LOG	是否开启日志，默认 true
REDIS_ADDRESS	Redis 地址, 默认为 redis:6379
REDIS_PASSWORD	Redis 密码，默认空
BSZ_SECRET	签名密钥, 使用任意长度的字符串填充

执行 docker compose up -d 服务将会运行在 8080 端口, 也可以自行修改 docker-compose.yml 指定端口

您也可以修改 ~/data/bsz/config.yaml 自定义配置, 后重启容器。

通用环境变量

Tips: 所有 config 内的设置, 均可使用 环境变量 覆盖

Ex. BSZ_SECRET = 123 将覆盖 config.yaml 中的 Bsz.Secret

API 转译

仅在 2.8.6 之前需要进行转译

例如, 如果您的部署网址为 https://busuanzi.9420.ltd, 则请在 env 中填写 https:\/\/busuanzi.9420.ltd

即 对于网址中的 https:// 将其替换为 https:\/\/

3. 二进制文件运行

# 部分静态资源并未打包在 二进制文件内, 因此需要 clone 整个项目到本地

$ git clone https://github.com/soxft/busuanzi && cd busuanzi

# 在 Release 中选择适合自己系统版本的二进制文件 (在 v2.8.0 后, 所有二进制文件由 Github Action 自动构建) 此处以常见服务器 (Linux & amd64) 作为演示

$ wget https://github.com/soxft/busuanzi/releases/download/v2.8.7/busuanzi-linux-amd64-v2.8.7 -o busuanzi

$ chmod +x busuanzi

# 运行 busuanzi
$ ./busuanzi