LyEdu 配置参考
编辑日期:2026-02-26
基于 ly-edu 项目结构整理
一、配置概览
LyEdu 的配置分为以下几类:
| 类型 | 位置 | 说明 |
|---|---|---|
| 开发环境 | scripts/dev/dev-config.yml | 一键启动脚本使用的配置 |
| Python 后端 | lyedu-api-python/.env、.env.dev | 环境变量 |
| Java 后端 | lyedu-api/application.yml | Spring Boot 配置 |
| Docker 部署 | scripts/docker/.env | 镜像源、构建参数等 |
| 系统配置 | 管理后台「系统配置」 | 网站、播放器、学员端等运行时配置 |
二、开发环境配置(dev-config.yml)
路径:scripts/dev/dev-config.yml(从 dev-config.example.yml 复制)
yaml
# 示例结构
database:
host: localhost
port: 3306
user: root
password: your_password
name: lyedu
redis:
host: localhost
port: 6379
# 若本机未监听 MySQL 端口,是否自动启动 Docker MySQL+Redis
start_docker_mysql_redis: true
# 是否启动各服务
start_lyedu_api_python: true
start_lyedu_admin: true
start_lyedu_pc: truedatabase.port可用于判断是否自动执行docker compose启动 MySQL+Redis- 修改后需重新运行
.\scripts\dev\start.ps1
三、Python 后端配置(.env)
路径:lyedu-api-python/.env 或 .env.dev
bash
# 示例
ENV=dev
DATABASE_URL=mysql+aiomysql://user:password@localhost:3306/lyedu
REDIS_URL=redis://localhost:6379/0
# JWT
SECRET_KEY=your-secret-key
# Feishu(若启用)
FEISHU_APP_ID=your-app-id
FEISHU_APP_SECRET=your-app-secretDATABASE_URL:Alembic 与 SQLAlchemy 使用- Java 使用
application.yml,配置格式不同,但含义对应
四、Java 后端配置(application.yml)
路径:lyedu-api/src/main/resources/application.yml
yaml
spring:
datasource:
url: jdbc:mysql://localhost:3306/lyedu
username: root
password: your_password
redis:
host: localhost
port: 6379按 profile(dev / prod)可拆分多份配置文件。
五、Docker 部署配置(.env)
路径:scripts/docker/.env(从 .env.example 复制)
bash
# 镜像源(国内加速)
DOCKER_REGISTRY=registry.cn-hangzhou.aliyuncs.com
NPM_REGISTRY=https://registry.npmmirror.com用于 docker compose build 时的拉取与构建加速。
六、系统级配置(管理后台)
在「系统管理」→「系统配置」中可配置:
1. 网站配置
- 网站名称、Logo、版权信息等
- 影响 PC 端、学员端展示
2. 播放器配置
- 防拖拽:是否禁止视频拖拽
- 禁倍速:是否禁止调整播放倍速
- 适用于 PC 端与 H5 播放器
3. 学员端配置
- 学员端相关展示与行为
- 与 lyedu-unix 前端配合使用
4. 第三方配置
- 飞书:App ID、App Secret、回调地址
- 钉钉 / 企微:预留,可按需扩展
七、环境变量一览(Python)
| 变量 | 说明 | 示例 |
|---|---|---|
| ENV | 环境 | dev / prod |
| DATABASE_URL | 数据库连接 | mysql+aiomysql://... |
| REDIS_URL | Redis 连接 | redis://localhost:6379/0 |
| SECRET_KEY | JWT 密钥 | 随机长字符串 |
| FEISHU_APP_ID | 飞书 App ID | - |
| FEISHU_APP_SECRET | 飞书 App Secret | - |
八、配置最佳实践
- 敏感信息:密码、密钥等使用环境变量,勿提交代码库
- 多环境:dev/test/prod 使用不同配置文件或 env
- 默认值:提供
.env.example/dev-config.example.yml作为模板 - 系统配置:运行时修改的配置走管理后台,避免改代码重启
