📝 修改文档.

2026-08-31 01:01:19 +08:00 · 2024-08-28 17:16:18 +08:00
parent 0526464a58
commit 27094259c3
18 changed files with 78 additions and 13 deletions
@@ -58,7 +58,7 @@

 ## 演示环境

-* 🔗 演示地址: http://101.43.254.243:1080/#/
+* 🔗 演示地址: https://do.orionsec.cn/#/
 * 🔏 演示账号: orionadmin/orionadmin
 * ⭐ 体验后可以点一下 `star` 这对我很重要! [github](https://github.com/lijiahangmax/orion-ops) [gitee](https://gitee.com/lijiahangmax/orion-ops)
 * 🌈 如果本项目对你有帮助请帮忙推广一下 让更多的人知道此项目!
@@ -68,17 +68,17 @@

 ## 快速开始

-* [文档地址](https://lijiahangmax.github.io/open-orion/orion-ops)
-* [安装文档](https://lijiahangmax.github.io/open-orion/orion-ops/quickstart/docker.html)
-* [本地调试](https://lijiahangmax.github.io/open-orion/orion-ops/quickstart/dev.html)
-* [操作手册](https://lijiahangmax.github.io/open-orion/orion-ops/operator/machine.html)
-* [常见问题](https://lijiahangmax.github.io/open-orion/orion-ops/support/faq.html)
-* [通用模板](https://lijiahangmax.github.io/open-orion/orion-ops/template/java-springboot-template.html)
+* [文档地址](https://ops.orionsec.cn)
+* [安装文档](https://ops.orionsec.cn/quickstart/docker.html)
+* [本地调试](https://ops.orionsec.cn/quickstart/dev.html)
+* [操作手册](https://ops.orionsec.cn/operator/machine.html)
+* [常见问题](https://ops.orionsec.cn/support/faq.html)
+* [通用模板](https://ops.orionsec.cn/template/java-springboot-template.html)

 ## 重构版 orion-visor

 `orion-visor` 为 `orion-ops` 的重构版本, 优化了交互逻辑以及UI风格、操作更友好、系统更快速&安全!
-[项目地址](https://lijiahangmax.github.io/open-orion/orion-visor)
+[项目地址](https://visor.orionsec.cn)

 ## 技术栈

@@ -18,23 +18,27 @@ server {
    location / {
        root   /usr/share/nginx/html;
        index  index.html index.htm;
-        proxy_set_header X-Real-IP  $remote_addr;
+        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    }

    location /orion/api {
        proxy_pass    http://localhost:9119/orion/api;
-        proxy_set_header X-Real-IP  $remote_addr;
+        proxy_set_header Host $host;
+        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+        proxy_set_header X-Forwarded-Proto $scheme;
    }

     location /orion/keep-alive {
        proxy_pass    http://localhost:9119/orion/keep-alive;
        proxy_http_version 1.1;
-        proxy_set_header X-Real-IP $remote_addr;
-        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
+        proxy_set_header Host $host;
+        proxy_set_header X-Real-IP $remote_addr;
+        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_read_timeout 3600s;
        proxy_send_timeout 3600s;
    }
@@ -5,6 +5,7 @@ import com.orion.lang.define.wrapper.DataGrid;
 import com.orion.lang.define.wrapper.HttpWrapper;
 import com.orion.lang.utils.Exceptions;
 import com.orion.lang.utils.collect.Maps;
+import com.orion.ops.annotation.DemoDisableApi;
 import com.orion.ops.annotation.EventLog;
 import com.orion.ops.annotation.RestWrapper;
 import com.orion.ops.constant.Const;
@@ -42,6 +43,7 @@ public class ApplicationEnvController {
    @Resource
    private ApplicationEnvService applicationEnvService;

+    @DemoDisableApi
    @PostMapping("/add")
    @ApiOperation(value = "添加环境变量")
    public Long addAppEnv(@RequestBody ApplicationEnvRequest request) {
@@ -52,6 +54,7 @@ public class ApplicationEnvController {
        return applicationEnvService.addAppEnv(request);
    }

+    @DemoDisableApi
    @PostMapping("/delete")
    @ApiOperation(value = "删除环境变量")
    @EventLog(EventType.DELETE_APP_ENV)
@@ -60,6 +63,7 @@ public class ApplicationEnvController {
        return applicationEnvService.deleteAppEnv(idList);
    }

+    @DemoDisableApi
    @PostMapping("/update")
    @ApiOperation(value = "更新环境变量")
    public Integer updateAppEnv(@RequestBody ApplicationEnvRequest request) {
@@ -82,6 +86,7 @@ public class ApplicationEnvController {
        return applicationEnvService.getAppEnvDetail(id);
    }

+    @DemoDisableApi
    @PostMapping("/sync")
    @ApiOperation(value = "同步环境变量到其他环境")
    @EventLog(EventType.SYNC_APP_ENV)
@@ -107,6 +112,7 @@ public class ApplicationEnvController {
        return viewType.toValue(env);
    }

+    @DemoDisableApi
    @PostMapping("/view-save")
    @ApiOperation(value = "保存环境变量视图")
    public Integer viewSave(@RequestBody ApplicationEnvRequest request) {
@@ -3,6 +3,7 @@ package com.orion.ops.controller;
 import com.orion.lang.define.wrapper.DataGrid;
 import com.orion.lang.define.wrapper.HttpWrapper;
 import com.orion.lang.utils.Exceptions;
+import com.orion.ops.annotation.DemoDisableApi;
 import com.orion.ops.annotation.EventLog;
 import com.orion.ops.annotation.RestWrapper;
 import com.orion.ops.constant.Const;
@@ -47,6 +48,7 @@ public class ApplicationInfoController {
    @Resource
    private ApplicationMachineService applicationMachineService;

+    @DemoDisableApi
    @PostMapping("/add")
    @ApiOperation(value = "添加应用")
    @EventLog(EventType.ADD_APP)
@@ -55,6 +57,7 @@ public class ApplicationInfoController {
        return applicationService.insertApp(request);
    }

+    @DemoDisableApi
    @PostMapping("/update")
    @ApiOperation(value = "更新应用")
    @EventLog(EventType.UPDATE_APP)
@@ -71,6 +74,7 @@ public class ApplicationInfoController {
        return applicationService.updateAppSort(id, Const.INCREMENT.equals(adjust));
    }

+    @DemoDisableApi
    @PostMapping("/delete")
    @ApiOperation(value = "删除应用")
    @EventLog(EventType.DELETE_APP)
@@ -122,6 +126,7 @@ public class ApplicationInfoController {
        return HttpWrapper.ok();
    }

+    @DemoDisableApi
    @PostMapping("/copy")
    @ApiOperation(value = "复制应用")
    @EventLog(EventType.COPY_APP)
@@ -131,6 +136,7 @@ public class ApplicationInfoController {
        return HttpWrapper.ok();
    }

+    @DemoDisableApi
    @PostMapping("/delete-machine")
    @ApiOperation(value = "删除发布机器")
    public Integer deleteAppMachine(@RequestBody ApplicationInfoRequest request) {
@@ -1,6 +1,7 @@
 package com.orion.ops.controller;

 import com.orion.lang.define.wrapper.DataGrid;
+import com.orion.ops.annotation.DemoDisableApi;
 import com.orion.ops.annotation.EventLog;
 import com.orion.ops.annotation.RestWrapper;
 import com.orion.ops.constant.app.StageType;
@@ -36,6 +37,7 @@ public class ApplicationPipelineController {
    @Resource
    private ApplicationPipelineService applicationPipelineService;

+    @DemoDisableApi
    @PostMapping("/add")
    @ApiOperation(value = "新增应用流水线")
    @EventLog(EventType.ADD_PIPELINE)
@@ -44,6 +46,7 @@ public class ApplicationPipelineController {
        return applicationPipelineService.addPipeline(request);
    }

+    @DemoDisableApi
    @PostMapping("/update")
    @ApiOperation(value = "修改应用流水线")
    @EventLog(EventType.UPDATE_PIPELINE)
@@ -67,6 +70,7 @@ public class ApplicationPipelineController {
        return applicationPipelineService.getPipeline(id);
    }

+    @DemoDisableApi
    @PostMapping("/delete")
    @ApiOperation(value = "删除应用流水线")
    @EventLog(EventType.DELETE_PIPELINE)
@@ -1,6 +1,7 @@
 package com.orion.ops.controller;

 import com.orion.lang.define.wrapper.DataGrid;
+import com.orion.ops.annotation.DemoDisableApi;
 import com.orion.ops.annotation.EventLog;
 import com.orion.ops.annotation.RequireRole;
 import com.orion.ops.annotation.RestWrapper;
@@ -35,6 +36,7 @@ public class ApplicationProfileController {
    @Resource
    private ApplicationProfileService applicationProfileService;

+    @DemoDisableApi
    @PostMapping("/add")
    @ApiOperation(value = "添加应用环境")
    @RequireRole(RoleType.ADMINISTRATOR)
@@ -46,6 +48,7 @@ public class ApplicationProfileController {
        return applicationProfileService.addProfile(request);
    }

+    @DemoDisableApi
    @PostMapping("/update")
    @ApiOperation(value = "更新应用环境")
    @RequireRole(RoleType.ADMINISTRATOR)
@@ -58,6 +61,7 @@ public class ApplicationProfileController {
        return applicationProfileService.updateProfile(request);
    }

+    @DemoDisableApi
    @PostMapping("/delete")
    @ApiOperation(value = "删除应用环境")
    @RequireRole(RoleType.ADMINISTRATOR)
@@ -2,6 +2,7 @@ package com.orion.ops.controller;

 import com.orion.lang.define.wrapper.DataGrid;
 import com.orion.lang.define.wrapper.HttpWrapper;
+import com.orion.ops.annotation.DemoDisableApi;
 import com.orion.ops.annotation.EventLog;
 import com.orion.ops.annotation.RestWrapper;
 import com.orion.ops.constant.app.RepositoryAuthType;
@@ -40,6 +41,7 @@ public class ApplicationRepositoryController {
    @Resource
    private ApplicationRepositoryService applicationRepositoryService;

+    @DemoDisableApi
    @PostMapping("/add")
    @ApiOperation(value = "添加版本仓库")
    @EventLog(EventType.ADD_REPOSITORY)
@@ -53,6 +55,7 @@ public class ApplicationRepositoryController {
        return applicationRepositoryService.addRepository(request);
    }

+    @DemoDisableApi
    @ApiOperation(value = "更新版本仓库")
    @PostMapping("/update")
    @EventLog(EventType.UPDATE_REPOSITORY)
@@ -62,6 +65,7 @@ public class ApplicationRepositoryController {
        return applicationRepositoryService.updateRepository(request);
    }

+    @DemoDisableApi
    @PostMapping("/delete")
    @ApiOperation(value = "删除版本仓库")
    @EventLog(EventType.DELETE_REPOSITORY)
@@ -1,6 +1,7 @@
 package com.orion.ops.controller;

 import com.orion.lang.define.wrapper.DataGrid;
+import com.orion.ops.annotation.DemoDisableApi;
 import com.orion.ops.annotation.EventLog;
 import com.orion.ops.annotation.RestWrapper;
 import com.orion.ops.constant.event.EventType;
@@ -34,6 +35,7 @@ public class CommandTemplateController {
    @Resource
    private CommandTemplateService commandTemplateService;

+    @DemoDisableApi
    @PostMapping("/add")
    @ApiOperation(value = "新增命令模板")
    @EventLog(EventType.ADD_TEMPLATE)
@@ -43,6 +45,7 @@ public class CommandTemplateController {
        return commandTemplateService.addTemplate(request);
    }

+    @DemoDisableApi
    @PostMapping("/update")
    @ApiOperation(value = "修改命令模板")
    @EventLog(EventType.UPDATE_TEMPLATE)
@@ -65,6 +68,7 @@ public class CommandTemplateController {
        return commandTemplateService.templateDetail(id);
    }

+    @DemoDisableApi
    @PostMapping("/delete")
    @ApiOperation(value = "删除命令模板")
    @EventLog(EventType.DELETE_TEMPLATE)
@@ -1,5 +1,6 @@
 package com.orion.ops.controller;

+import com.orion.ops.annotation.DemoDisableApi;
 import com.orion.ops.annotation.EventLog;
 import com.orion.ops.constant.ExportType;
 import com.orion.ops.constant.event.EventType;
@@ -28,6 +29,7 @@ import java.io.IOException;
@RequestMapping("/orion/api/data-export")
 public class DataExportController {

+    @DemoDisableApi
    @PostMapping("/export")
    @ApiOperation(value = "导出数据")
    @EventLog(EventType.DATA_EXPORT)
@@ -82,6 +82,7 @@ public class DataImportController {
        return IDataChecker.create(importType, workbook).doCheck();
    }

+    @DemoDisableApi
    @PostMapping("/import")
    @ApiOperation(value = "导入数据")
    @EventLog(EventType.DATA_IMPORT)
@@ -7,6 +7,7 @@ import com.orion.lang.utils.Strings;
 import com.orion.lang.utils.collect.Lists;
 import com.orion.lang.utils.io.Files1;
 import com.orion.lang.utils.io.Streams;
+import com.orion.ops.annotation.DemoDisableApi;
 import com.orion.ops.annotation.EventLog;
 import com.orion.ops.annotation.RestWrapper;
 import com.orion.ops.constant.Const;
@@ -58,6 +59,7 @@ public class FileTailController {
        return fileTailService.getTailToken(type, relId);
    }

+    @DemoDisableApi
    @PostMapping("/add")
    @ApiOperation(value = "添加日志文件")
    @EventLog(EventType.ADD_TAIL_FILE)
@@ -72,6 +74,7 @@ public class FileTailController {
        return fileTailService.insertTailFile(request);
    }

+    @DemoDisableApi
    @PostMapping("/update")
    @ApiOperation(value = "修改日志文件")
    @EventLog(EventType.UPDATE_TAIL_FILE)
@@ -112,6 +115,7 @@ public class FileTailController {
        return HttpWrapper.ok();
    }

+    @DemoDisableApi
    @PostMapping("/delete")
    @ApiOperation(value = "删除日志文件")
    @EventLog(EventType.DELETE_TAIL_FILE)
@@ -5,6 +5,7 @@ import com.orion.lang.define.wrapper.DataGrid;
 import com.orion.lang.define.wrapper.HttpWrapper;
 import com.orion.lang.utils.Exceptions;
 import com.orion.lang.utils.collect.Maps;
+import com.orion.ops.annotation.DemoDisableApi;
 import com.orion.ops.annotation.EventLog;
 import com.orion.ops.annotation.RestWrapper;
 import com.orion.ops.constant.Const;
@@ -42,6 +43,7 @@ public class MachineEnvController {
    @Resource
    private MachineEnvService machineEnvService;

+    @DemoDisableApi
    @PostMapping("/add")
    @ApiOperation(value = "添加环境变量")
    public Long add(@RequestBody MachineEnvRequest request) {
@@ -51,6 +53,7 @@ public class MachineEnvController {
        return machineEnvService.addEnv(request);
    }

+    @DemoDisableApi
    @PostMapping("/update")
    @ApiOperation(value = "修改环境变量")
    public Integer update(@RequestBody MachineEnvRequest request) {
@@ -59,6 +62,7 @@ public class MachineEnvController {
        return machineEnvService.updateEnv(request);
    }

+    @DemoDisableApi
    @PostMapping("/delete")
    @ApiOperation(value = "删除环境变量")
    @EventLog(EventType.DELETE_MACHINE_ENV)
@@ -81,6 +85,7 @@ public class MachineEnvController {
        return machineEnvService.getEnvDetail(id);
    }

+    @DemoDisableApi
    @PostMapping("/sync")
    @ApiOperation(value = "同步环境变量")
    @EventLog(EventType.SYNC_MACHINE_ENV)
@@ -104,6 +109,7 @@ public class MachineEnvController {
        return viewType.toValue(env);
    }

+    @DemoDisableApi
    @PostMapping("/view-save")
    @ApiOperation(value = "保存环境变量视图")
    public Integer viewSave(@RequestBody MachineEnvRequest request) {
@@ -2,6 +2,7 @@ package com.orion.ops.controller;

 import com.orion.lang.define.wrapper.DataGrid;
 import com.orion.lang.define.wrapper.HttpWrapper;
+import com.orion.ops.annotation.DemoDisableApi;
 import com.orion.ops.annotation.EventLog;
 import com.orion.ops.annotation.RestWrapper;
 import com.orion.ops.constant.event.EventType;
@@ -35,6 +36,7 @@ public class MachineKeyController {
    @Resource
    private MachineKeyService machineKeyService;

+    @DemoDisableApi
    @PostMapping("/add")
    @ApiOperation(value = "添加机器密钥")
    @EventLog(EventType.ADD_MACHINE_KEY)
@@ -44,6 +46,7 @@ public class MachineKeyController {
        return machineKeyService.addSecretKey(request);
    }

+    @DemoDisableApi
    @PostMapping("/update")
    @ApiOperation(value = "更新机器密钥")
    @EventLog(EventType.UPDATE_MACHINE_KEY)
@@ -52,6 +55,7 @@ public class MachineKeyController {
        return machineKeyService.updateSecretKey(request);
    }

+    @DemoDisableApi
    @PostMapping("/remove")
    @ApiOperation(value = "删除机器密钥")
    @EventLog(EventType.DELETE_MACHINE_KEY)
@@ -73,6 +77,7 @@ public class MachineKeyController {
        return machineKeyService.getKeyDetail(id);
    }

+    @DemoDisableApi
    @PostMapping("/bind")
    @ApiOperation(value = "绑定机器密钥")
    @EventLog(EventType.BIND_MACHINE_KEY)
@@ -2,6 +2,7 @@ package com.orion.ops.controller;

 import com.orion.lang.define.wrapper.DataGrid;
 import com.orion.lang.utils.Strings;
+import com.orion.ops.annotation.DemoDisableApi;
 import com.orion.ops.annotation.EventLog;
 import com.orion.ops.annotation.RestWrapper;
 import com.orion.ops.constant.event.EventType;
@@ -36,6 +37,7 @@ public class MachineProxyController {
    @Resource
    private MachineProxyService machineProxyService;

+    @DemoDisableApi
    @PostMapping("/add")
    @ApiOperation(value = "添加机器代理")
    @EventLog(EventType.ADD_MACHINE_PROXY)
@@ -48,6 +50,7 @@ public class MachineProxyController {
        return machineProxyService.addProxy(request);
    }

+    @DemoDisableApi
    @PostMapping("/update")
    @ApiOperation(value = "修改机器代理")
    @EventLog(EventType.UPDATE_MACHINE_PROXY)
@@ -70,6 +73,7 @@ public class MachineProxyController {
        return machineProxyService.getProxyDetail(id);
    }

+    @DemoDisableApi
    @PostMapping("/delete")
    @ApiOperation(value = "删除机器代理")
    @EventLog(EventType.DELETE_MACHINE_PROXY)
@@ -42,6 +42,7 @@ public class SystemEnvController {
    @Resource
    private SystemEnvService systemEnvService;

+    @DemoDisableApi
    @PostMapping("/add")
    @ApiOperation(value = "添加环境变量")
    @EventLog(EventType.ADD_SYSTEM_ENV)
@@ -2,6 +2,7 @@ package com.orion.ops.controller;

 import com.orion.lang.define.wrapper.DataGrid;
 import com.orion.lang.utils.Objects1;
+import com.orion.ops.annotation.DemoDisableApi;
 import com.orion.ops.annotation.EventLog;
 import com.orion.ops.annotation.RequireRole;
 import com.orion.ops.annotation.RestWrapper;
@@ -50,6 +51,7 @@ public class UserController {
        return userService.userDetail(request);
    }

+    @DemoDisableApi
    @PostMapping("/add")
    @ApiOperation(value = "添加用户")
    @RequireRole(RoleType.ADMINISTRATOR)
@@ -61,6 +63,7 @@ public class UserController {
        return userService.addUser(request);
    }

+    @DemoDisableApi
    @PostMapping("/update")
    @ApiOperation(value = "修改用户信息")
    @EventLog(EventType.UPDATE_USER)
@@ -73,6 +76,7 @@ public class UserController {
        return userService.updateUser(request);
    }

+    @DemoDisableApi
    @PostMapping("/update-avatar")
    @ApiOperation(value = "修改用户头像")
    public Integer updateAvatar(@RequestBody UserInfoRequest request) {
@@ -80,6 +84,7 @@ public class UserController {
        return userService.updateAvatar(avatar);
    }

+    @DemoDisableApi
    @PostMapping("/delete")
    @ApiOperation(value = "删除用户")
    @RequireRole(RoleType.ADMINISTRATOR)
@@ -89,6 +94,7 @@ public class UserController {
        return userService.deleteUser(id);
    }

+    @DemoDisableApi
    @PostMapping("/update-status")
    @ApiOperation(value = "停用/启用用户")
    @RequireRole(RoleType.ADMINISTRATOR)
@@ -1,6 +1,7 @@
 package com.orion.ops.controller;

 import com.orion.lang.define.wrapper.DataGrid;
+import com.orion.ops.annotation.DemoDisableApi;
 import com.orion.ops.annotation.EventLog;
 import com.orion.ops.annotation.RestWrapper;
 import com.orion.ops.constant.event.EventType;
@@ -47,6 +48,7 @@ public class WebhookConfigController {
        return webhookConfigService.getWebhookDetail(id);
    }

+    @DemoDisableApi
    @PostMapping("/add")
    @ApiOperation(value = "添加 webhook")
    @EventLog(EventType.ADD_WEBHOOK)
@@ -55,6 +57,7 @@ public class WebhookConfigController {
        return webhookConfigService.addWebhook(request);
    }

+    @DemoDisableApi
    @PostMapping("/update")
    @ApiOperation(value = "更新 webhook")
    @EventLog(EventType.UPDATE_WEBHOOK)
@@ -64,6 +67,7 @@ public class WebhookConfigController {
        return webhookConfigService.updateWebhook(request);
    }

+    @DemoDisableApi
    @PostMapping("/delete")
    @ApiOperation(value = "删除 webhook")
    @EventLog(EventType.DELETE_WEBHOOK)
@@ -31,7 +31,7 @@
        </div>
        <!-- 右侧 -->
        <div class="tools-fixed-right">
-          <a href="https://lijiahangmax.github.io/open-orion/orion-ops-extension-plugins/quickstart/download.html" target="_blank">安装文档</a>
+          <a href="https://om.orionsec.cn/quickstart/download.html" target="_blank">安装文档</a>
          <a-popconfirm title="确定执行批量安装本页监控插件?"
                        okText="确定"
                        cancelText="取消"