yeelabs/yearning

Yearning SQL审核平台 Docker镜像文档

概述

Yearning 是一款SQL审核平台，本镜像为其官方Docker镜像，旨在简化Yearning的部署流程，支持通过Docker快速搭建SQL审核环境，实现SQL语句的审核、查询等功能。

仓库地址：https://github.com/cookieY/Yearning.git
使用及更新说明：点击查看

核心功能

• 提供SQL审核、查询等核心功能
• 支持Docker化部署，简化环境配置
• 提供初始化、升级、管理员密码重置等运维功能
• 支持多语言设置（中文/英文）
• 通过环境变量灵活配置数据库连接信息

使用场景

适用于需要规范化SQL操作流程的团队，如开发团队、数据库运维团队等，可用于SQL语句的提交、审核、执行管理，提升数据库操作的安全性和规范性。

使用方法

前置要求

• 已安装Docker或Docker Compose
• 准备MySQL数据库（可通过Docker Compose一同部署）
• 首次使用前需执行初始化操作

Docker Run 部署

通过docker run命令快速启动，需指定必要环境变量：

bash
docker run -d -it \
           -p 8000:8000 \
           -e IS_DOCKER=is_docker \
           -e SECRET_KEY=dbcjqheupqjsuwsm \
           -e MYSQL_USER=root \
           -e MYSQL_ADDR=10.0.0.3:3306 \
           -e MYSQL_PASSWORD=123123 \
           -e Y_LANG=zh_CN \
           -e MYSQL_DB=Yearning \
           yeelabs/yearning

Docker Compose 部署

推荐使用Docker Compose管理服务，可同时部署Yearning和依赖的MySQL数据库：

yaml
version: '3'

services:
    yearning:
        image: yeelabs/yearning:latest
        environment:
           MYSQL_USER: yearning          # MySQL用户名
           MYSQL_PASSWORD: ukC2ZkcG_ZTeb # MySQL密码
           MYSQL_ADDR: mysql             # MySQL地址（服务名或IP:端口）
           MYSQL_DB: yearning            # Yearning数据库名
           Y_LANG: zh_CN                 # 语言设置（zh_CN/zh_CN 或 en_US/en_US）
           SECRET_KEY: dbcjqheupqjsuwsm  # 应用密钥
           IS_DOCKER: is_docker          # Docker环境标识
        ports:
           - 8000:8000                   # 映射端口（主机:容器）
        # 首次使用请先初始化，取消下方注释
        # command: /bin/bash -c "./Yearning install && ./Yearning run"
        depends_on:
           - mysql                       # 依赖MySQL服务
        restart: always                  # 自动重启策略

    mysql:
        image: mysql:5.7                 # MySQL 5.7镜像
        environment:
           MYSQL_ROOT_PASSWORD: ukC2ZkcG_ZTeb  # MySQL root密码
           MYSQL_DATABASE: yearning           # 自动创建数据库
           MYSQL_USER: yearning               # 授权用户
           MYSQL_PASSWORD: ukC2ZkcG_ZTeb      # 用户密码
        command:
           - --character-set-server=utf8mb4   # 设置字符集
           - --collation-server=utf8mb4_general_ci
        volumes:
           - ./data/mysql:/var/lib/mysql      # 数据持久化

初始化与升级

首次安装初始化

首次部署时，需执行初始化命令创建数据库表结构。在Docker Compose配置中，取消command行注释：

yaml
command: /bin/bash -c "./Yearning install && ./Yearning run"

升级Yearning

升级时，使用以下命令迁移数据结构：

yaml
command: /bin/bash -c "./Yearning migrate"

重置管理员密码

如需重置admin用户密码，使用以下命令：

yaml
command: /bin/bash -c "./Yearning reset_super"

环境变量说明

默认账号密码

• 默认管理员账号：admin
• 默认密码：Yearning_admin

首次登录后建议立即修改密码。