Dromara Orion Visor

Appearance

使用须知

在使用本项目前，请您仔细阅读 法律风险，并确保您已充分理解其中的内容。您的使用行为将视为对本声明全部内容的认可和接受。

提示

从 v2.4.2 版本开始, 项目支持在以下镜像仓库中进行存储, 并兼容 linux/amd64 和 linux/arm64 架构。您可以根据自己的网络状况以及支持的服务, 在 docker-compose.yaml 文件中修改对应的镜像仓库地址和服务名称。

镜像源源地址及命名空间
Docker Hublijiahangmax/*
GitHub 容器注册表ghcr.io/dromara/*
阿里云容器镜像服务(默认)registry.cn-hangzhou.aliyuncs.com/orionsec/*
服务名称必要服务描述备注
ui✔前端 nginx
service✔后端服务
mysql✔mysql 数据库服务
redis✔redis 缓存服务
influxdb❌监控数据存储若不开启需要设置 INFLUXDB_ENABLED=false
guacd❌RDP, VNC 访问服务
adminer❌数据库访问服务

所需环境 ​

  • Docker 20.10.14+
  • Docker Compose 2.3.3+

由于国内无法访问 DockerHub, 可以修改一下配置加速镜像 /etc/docker/daemon.json, 如果没有此文件可以创建此文件 (Linux系统, Window 和 Mac 直接可以通过 Docker 的 Dashboard 修改)

❌ 由于 Docker 镜像的管控, 大部分镜像源都无法使用, 请自行搜索并且设置为可用的镜像源

json
{
 "registry-mirrors": [
   "https://registry.docker-cn.com",
   "https://registry.cn-hangzhou.aliyuncs.com",
   "https://mirror.ccs.tencentyun.com",
   "https://docker.mirrors.ustc.edu.cn"
 ]
}

拉取代码 ​

shell
# github
git clone --depth=1 https://github.com/dromara/orion-visor
# gitee
git clone --depth=1 https://gitee.com/dromara/orion-visor
# atomgit
git clone --depth=1 https://atomgit.com/dromara/orion-visor
# 进入仓库目录
cd orion-visor

修改配置 ​

不管用哪种方式启动, 都需要修改 API_HOST 或 API_URL 否则无法和 agent 进行通信

使用 docker-compose.yaml 配置 ​

bash
# 直接修改 docker-compose.yaml 中的 environment
vim docker-compose.yaml

使用 .env 配置 (推荐) ​

bash
# 创建名为 .env 的 .env.example 副本, 将其中的值删除以保持默认或将其修改为合适的的值
cp .env.example .env
text
# VOLUME_BASE             你希望数据持久化保存的目录, 如果不提前创建将以 docker 进程宿主身份创建 (通常是 root)

# SERVICE_PORT            你希望服务监听的端口
# SPRING_PROFILES_ACTIVE  后端启动的环境

# DEMO_MODE               演示模式

# API_CORS                是否允许跨域
# API_HOST                对外服务主机地址 (必须要修改, 需要改为 agent 访问 <ip>:9200 可以通的网络地址)
# API_URL                 对外服务接口地址 (API_URL 不满足可以进行修改)
# API_IP_HEADERS          获取 IP 的请求头
# API_EXPOSE_TOKEN        对外服务 token
# SECRET_KEY              加密密钥

# NGINX_SERVICE_HOST      nginx 服务所在的主机
# NGINX_SERVICE_PORT      nginx 服务监听的端口

# MYSQL_HOST              mysql 服务所在的主机, 如果你没有现有的 MySQL 请保持值为 mysql, 如果你有自部署的请在 docker-compose.yaml 中移除 services.mysql 以节约性能
# MYSQL_PORT              mysql 监听的端口
# MYSQL_DATABASE          mysql 数据库
# MYSQL_USER              mysql 用户名
# MYSQL_PASSWORD          mysql 用户密码
# MYSQL_ROOT_PASSWORD     mysql root 密码

# REDIS_HOST              redis 服务所在的主机, 如果你没有现有的 Redis 请保持值为 redis, 如果你有自部署的请在 docker-compose.yaml 中移除 services.redis 以节约性能
# REDIS_PASSWORD          redis 密码
# REDIS_DATABASE          redis 数据库
# REDIS_DATA_VERSION      redis 数据版本

# GUACD_HOST              guacd 服务所在的主机, 如果你没有现有的 Redis 请保持值为 redis, 如果你有自部署的请在 docker-compose.yaml 中移除 services.guacd 以节约性能
# GUACD_PORT              guacd 端口
# GUACD_DRIVE_PATH        guacd 数据挂载目录

# INFLUXDB_ENABLED        是否启用 influxdb (若不需要监控可以设置为 false)
# INFLUXDB_HOST           influxdb 服务所在的主机, 如果你没有现有的 influxdb 请保持值为 influxdb, 如果你有自部署的请在 docker-compose.yaml 中移除 services.influxdb 以节约性能
# INFLUXDB_PORT           influxdb 端口
# INFLUXDB_ORG            influxdb 组织
# INFLUXDB_BUCKET         influxdb bucket
# INFLUXDB_TOKEN          influxdb token   
# INFLUXDB_ADMIN_USERNAME influxdb 控制台用户名
# INFLUXDB_ADMIN_PASSWORD influxdb 控制台密码

启动 ​

原生启动

shell
docker compose pull && docker compose up -d

脚本启动

shell
chmod +x docker-upgrade.sh && ./docker-upgrade.sh --pull

修改 MySQL 账户的加密方式 (可选) ​

访问 adminer: http://localhost:8081
服务器: mysql
用户名: root
密  码: Data@123456
数据库: orion_visor

点击左侧 SQL命令 输入:
ALTER USER 'root'@'%' IDENTIFIED WITH mysql_native_password BY 'Data@123456';
执行 OK

测试访问 ​

等待后端服务启动后 (2min±) 在浏览器中输入 http://localhost:1081/ 访问
账号: admin
密码: admin