Skip to content

环境变量说明

SuperUser 通过环境变量进行系统配置,以下是完整的环境变量列表。

数据库配置

变量名默认值说明
DB_TYPEmongodb数据库类型:mongodb / mysql / elasticsearch
DB_HOSTlocalhost数据库主机地址
DB_PORT27017数据库端口
DB_NAMEsuperuser数据库名称
DB_USER-数据库用户名(MySQL 必填)
DB_PASSWORD-数据库密码
DB_AUTH_SOURCEadminMongoDB 认证数据库

服务配置

变量名默认值说明
PORT8080服务监听端口
BASE_URLhttp://localhost:8080对外访问地址(影响邮件链接等)
JWT_SECRET随机生成JWT 签名密钥(生产环境必须手动设置)
JWT_EXPIRE7dJWT 过期时间

存储配置

变量名默认值说明
STORAGE_TYPElocal文件存储类型:local / s3 / oss
STORAGE_PATH/data/uploads本地存储路径
S3_BUCKET-S3 Bucket 名称(STORAGE_TYPE=s3 时必填)
S3_REGION-S3 区域
S3_ACCESS_KEY-S3 Access Key
S3_SECRET_KEY-S3 Secret Key

邮件配置(可选)

变量名默认值说明
SMTP_HOST-SMTP 服务器地址
SMTP_PORT465SMTP 端口
SMTP_USER-SMTP 用户名
SMTP_PASS-SMTP 密码
SMTP_FROM-发件人地址

示例:完整 docker-compose.yml

yaml
version: '3'
services:
  superuser:
    image: superuser/superuser:latest
    ports:
      - "8080:8080"
    environment:
      - DB_TYPE=mongodb
      - DB_HOST=mongodb
      - DB_PORT=27017
      - DB_NAME=superuser
      - JWT_SECRET=your-very-secret-key-change-this
      - BASE_URL=https://your-domain.com
      - STORAGE_TYPE=local
      - STORAGE_PATH=/data/uploads
    volumes:
      - uploads_data:/data/uploads
    depends_on:
      - mongodb
  mongodb:
    image: mongo:6
    volumes:
      - mongo_data:/data/db

volumes:
  mongo_data:
  uploads_data:

基于 MIT 许可发布