个性化配置¶

.env 文件¶

您可以通过.env文件的来自定义安装和启动脚本（例如，系统资源，服务端口等）。

Tip

自定义 .env 需要您的 docker compose 版本不小于 2.17.0。

$ docker-compose version

Docker Compose version v2.17.0

假设，您遵循了开始使用文档的安装步骤，此时，您的目录结构如下：

cd /opt/beatsight

.
|-- beatsight-docker-1.3.0-ce
|   |-- README.md
|   |-- backup.sh
|   |-- backups
|   |-- beatsight_install_log-2024-10-26_04-10-18.txt
|   |-- docker-compose.yaml
|   |-- install
|   |-- install.sh
|   |-- logs
|   |-- runtime
|   |-- start.sh
|   `-- stop.sh
|-- logs
|   |-- beatsight
|   |-- nginx
|   `-- supervisor
`-- runtime
    |-- beatsight.nginx.conf
    |-- beatsight_settings.py
    `-- gunicorn.conf.py

其中，beatsight-docker-1.3.0-ce/.env 包含了一些可以自定义配置的参数，例如：

BEATSIGHT_BIND=8999    # 服务绑定的端口
BEATSIGHT_IMAGE=reg.beatsight.com/beatsight/beatsight:v1.3.0  # 当前的镜像版本
MIN_RAM_HARD=4000  # 系统最低内存要求
MIN_CPU_HARD=2  # 系统最低 CPU 核心数要求

您可以在安装目录下新建 .env 来覆盖这些参数。

服务端口¶

Beatsgiht 默认占用了系统的 8999 端口，如果您需要更改，操作如下：

打开 /opt/beatsight/.env 文件，vi /opt/beatsight/.env，

BEATSIGHT_BIND=8999

修改为合适的端口后，保存退出，再重启服务即可。

系统资源¶

安装脚本默认需要您的系统资源达到2核4G，您也可以调低该参数，操作如下：

打开 /opt/beatsight/.env 文件，vi /opt/beatsight/.env，

MIN_RAM_HARD=4000
MIN_CPU_HARD=2

修改完成后，重新执行 ./install.sh 即可。

Tip

如果您的系统资源过低，系统可能会出现不稳定的情况。如果是正式使用，建议符合我们官方推荐的系统资源要求。

beatsight_settings.py¶

域名¶

如果您的服务器ip变动或者配置了域名，需要配置以下两个变量，系统才能正常工作。具体如下，

打开 runtime/beatsight_settings.py

vi runtime/beatsight_settings.py

假设你当前的 Beatsight 访问地址为：http://test.example.com:8999

# 配置 ALLOWED_HOSTS
ALLOWED_HOSTS = [
    'test.example.com',  # 允许的主机名
]

# 配置 CSRF_TRUSTED_ORIGINS
CSRF_TRUSTED_ORIGINS = [
    'http://test.example.com:8999',  # 允许的来源
]

保存重启服务后，Beatsight 将能够正确响应来自 http://test.example.com:8999 的请求，同时保障 CSRF 保护机制的有效性。

邮件服务¶

Beatsight 的一些功能（例如，重置密码）用到了邮件发送服务，需要配置上您的邮件服务才能正常使用。具体如下，

打开 runtime/beatsight_settings.py

vi runtime/beatsight_settings.py

定位到 Email settings，类似如下设置：

# Email settings
EMAIL_BACKEND = 'django.core.mail.backends.smtp.EmailBackend'
EMAIL_HOST = 'smtp.mail.com'
EMAIL_PORT = 587
EMAIL_USE_TLS = True  # Use TLS
EMAIL_HOST_USER = 'xxx@mail.com'  # Your email address
EMAIL_HOST_PASSWORD = 'yyy'  # Your email passwrod
DEFAULT_FROM_EMAIL = 'zzz'  # Default from email address

写入您单位或个人的邮件账号密码。以下是一些常见邮箱的示例，供参考。

QQ 邮箱126 邮箱Gmail 邮箱

EMAIL_USE_SSL = False
EMAIL_HOST = 'smtp.qq.com'
EMAIL_HOST_USER = 'username@qq.com'
EMAIL_HOST_PASSWORD = 'xxx'
EMAIL_PORT = 465
DEFAULT_FROM_EMAIL = EMAIL_HOST_USER
SERVER_EMAIL = EMAIL_HOST_USER

EMAIL_USE_TLS = True
EMAIL_HOST = 'smtp.vip.126.com'
EMAIL_HOST_USER = 'test@vip.126.com'
EMAIL_HOST_PASSWORD = 'password'
EMAIL_PORT = 587
DEFAULT_FROM_EMAIL = EMAIL_HOST_USER
SERVER_EMAIL = EMAIL_HOST_USER

EMAIL_USE_TLS = True
EMAIL_HOST = 'smtp.gmail.com'
EMAIL_HOST_USER = 'user@gmail.com'
EMAIL_HOST_PASSWORD = 'password'
EMAIL_PORT = 587
DEFAULT_FROM_EMAIL = EMAIL_HOST_USER
SERVER_EMAIL = EMAIL_HOST_USER

Tip

EMAIL_USE_TLS 为 True/False 取决于您邮件服务的配置，一般来说，587 端口的邮件服务需要设置为 True。具体请参考：https://docs.djangoproject.com/zh-hans/4.2/ref/settings/#email-use-tls