Skip to content

使用须知

在使用本项目前,请您仔细阅读 开源协议免责声明,确保您已充分理解其中的内容

所需环境

  • jdk 1.8
  • mysql 8.0.+
  • redis 6.0.+
  • node 16.16.+ (16及以下, 16+ 不可以)
  • maven 3.5.+

⚡ maven 推荐使用阿里云 mirror
⚡ npm 建议使用淘宝镜像 npm config set registry https://registry.npmmirror.com/
⚡ yarn 建议使用淘宝镜像 yarn config set registry https://registry.npmmirror.com/
⚡ windows 环境二次开发需要安装 OpenSSH Server

拉取代码

shell
# github
git clone --depth=1 https://github.com/lijiahangmax/orion-ops
# gitee
git clone --depth=1 https://gitee.com/lijiahangmax/orion-ops

初始化数据库

# 执行DDL脚本
orion-ops/sql/init-1-schema.sql
# 执行默认数据脚本 [默认用户, 默认应用环境, 常用命令模板] (可选)
orion-ops/sql/init-2-data.sql

修改后端配置

# 修改配置文件
orion-ops/orion-ops-api/orion-ops-web/src/main/resources/application-dev.properties
# 修改全局加密密钥, 为了密码安全考虑 (推荐修改)
orion-ops/orion-ops-api/orion-ops-web/src/main/resources/application.properties value.mix.secret.key

修改前端配置

shell
# 进入代码目录
cd orion-ops/orion-ops-vue
# 下载 yarn
npm i -g yarn
# 下载依赖
yarn install
# 运行
npm run serve:dev

运行

后端服务启动时需要设置启动参数 --generator-admin 来生成默认管理员用户 (已执行 init-2-data.sql 则可以忽略)
启动参数 idea 中设置 应用设置 > Environment > Program arguments

测试访问

在浏览器中输入 http://localhost:10010/ops 访问
账号: orionadmin
密码: orionadmin

swagger

地址: http://127.0.0.1:9119/doc.html#/home
文档只有在 dev 环境才可以访问

配置系统

登录后需要配置宿主机 SSH 信息, 本地调试阶段宿主机可以改为远程机器
如果是密码登录: 机器管理 > 机器列表 > 宿主机 > 更多 > 编辑 > 选择认证方式为密码 > 输入密码 > 确定
如果是密钥登陆: 机器管理 > 机器密钥 > 新建
配置完成后测试连接: 机器管理 > 机器列表 > 宿主机 > 更多 > 测试连接
创建应用环境: 应用管理 > 环境管理 > 添加 (已执行 init-2-data.sql 则可以忽略)

启动参数

启动项目时提供了一些可选的执行参数

关闭IP过滤器 --disable-ip-filter
生成默认管理员账号 --generator-admin 账号: orionadmin 密码: orionadmin
重置默认管理员账号 --reset-admin 账号: orionadmin 密码: orionadmin

Released under the Apache 2.0 License.