baseURL 修改注意事项
如果你不得不变更统 baseURL,请先了解以下影响范围,并做好变更计划,以便保障你的团队正常使用系统。我们强烈建议你遵循以下步骤,完成 baseURL 变更过程。
变更步骤:
- 变更前准备
- 阅读下面的 baseURL 修改影响范围与解决方案列表(表1),并确保你对其中每一项都没有疑问;
- 准备新的 baseURL(域名或者 IP),并确保终端用户可以在浏览器通过新的 baseURL 访问 ONES 系统;
- 挑选变更时间
- 因为 baseURL 的变更可能会导致一部分功能异常,需要对其进行调整后才可以恢复正常使用。因此我们强烈建议在非工作时间进行baseURL 配置变更。并且预留足够的时间(建议起码 2天)对受影响的功能进行调整以及测试,确保正常使用。
- 通知所有成员
- 变更前通知:终端用户使用新的 baseURL 进行访问需要重新登录;
- 变更前通知:新 baseURL 正式可用时间;
- 变更前通知:其他可能受影响的使用;
- 执行变更
- 在「高级设置」模块填入新 baseURL 值,然后更新;
- 调整其他受影响的功能与配置项
- 对照受影响的功能列表(表1),根据指引逐一对受影响功能进行调整,并验证正常可用;
- 团队成员通过新 baseURL 正常使用系统
- 配置变更结束,告知团队成员可以通过新 baseURL 正常使用系统。
表1:baseURL 修改影响范围与解决方案
业务模块 | 影响范围(以下情况可能发生) | 解决方案 |
工单小程序 |
| 调整后,需要在「企业微信管理」后台调整 ONES 的回调地址; |
插件 |
| 调整插件实现,更新插件版本; |
wps |
| 调整后,需要在 wps 后台 调整 ONES 的回调地址; |
第三方登录 |
| baseURL 变更后,需要在调整第三方集成的回调地址后,第三方集成才可以恢复正常使用。各集成调整方式如下:
|
邮件通知、企业微信通知 | 变更前发送的旧邮件内包含的链接可能无法打开,包括以下通知类型:
| 无解决方案 |
对象存储 | 以下情况可能发生: 附件不可上传、下载、预览; Wiki 页面无法查看、编辑、新建; 头像、logo、ico不可上传、查看; | 存储类型为 【对象存储】,需要到对象存储管理后台调整跨域配置; |
Devops |
| 需要到对接的流水线那边,调整ONES的回调地址
a. 系统自动重置webhook:点击「重置webhook」; b. 手工配置webhook:在对应的代码仓中点击:Settings→Webhook 将 Webhook URL 中的内容中 project 前内替 换成 baseURL内容。 c. Github 和公有Gitlab 对应应用中的 Redirect URI 中的 project 前内容替换成 baseURL内容。
|
导入工具 |
| 需要到导入工具那边,调整ONES的回调地址 |