Auto-deploy-sap-and-keepalive

Auto-SAP应用部署说明文档

概述

本项目是自动部署argo隧道或直连节点到SAP Cloud平台，试用版提供完美的自动保活的方案,并适配企业版部署，企业版无需保活

• 视频教程：https://www.youtube.com/watch?v=MU_ySjg98F8
• telegram交流反馈群组：https://t.me/eooceu

前置要求

• GitHub 账户：需要有一个 GitHub 账户来创建仓库和设置工作流
• SAP Cloud 账户：需要有 SAP Cloud 有效账户,点此注册：https://www.sap.com

部署步骤

1. Fork本仓库

2. 在Actions菜单允许 I understand my workflows, go ahead and enable them 按钮

3. 在 GitHub 仓库中设置以下 secrets（Settings → Secrets and variables → Actions → New repository secret）：

• EMAIL: SAP(试用版或企业版)登录邮箱(必填)
• PASSWORD: SAP(试用版或企业版)登录密码(必填)

1. 设置Docker容器环境变量(也是在secrets里设置)

   • 使用固定隧道token部署，请在cloudflare里设置端口为8001
   • 设置基础环境变量：
     • UUID(节点uuid),如果开启了哪吒v1,部署完一个之后一定要修改UUID,否则agnet会被覆盖
     • ARGO_DOMAIN(固定隧道域名,未设置将使用临时隧道),使用直连镜像时没有此变量
     • ARGO_AUTH(固定隧道json或token,未设置将使用临时隧道),使用直连镜像时没有此变量
     • SUB_PATH(订阅token,未设置默认是sub)
   • 可选环境变量
     • ARGO_PORT(自定义argo隧道端口,不设置默认为8001)
     • NEZHA_SERVER(v1形式: nezha.xxx.com:8008 v0形式：nezha.xxx.com)
     • NEZHA_PORT(V1哪吒没有这个)
     • NEZHA_KEY(v1的NZ_CLIENT_SECRET或v0的agent密钥)
     • CFIP(优选域名或优选ip),使用直连镜像时没有此变量
     • CFPORT(优选域名或优选ip对应端口),使用直连镜像时没有此变量
     • DOCKER_IMAGE(使用的docker镜像),默认使用argo隧道CDN

2. 开始部署

• 试用版第二区域和企业版创建区域后,请一定要创建一个空间,名称随意,否则无法运行
• 在GitHub仓库的Actions页面找到"自动部署代理到SAP"工作流
• 点击"Run workflow"按钮
• 根据需要选择或填写以下参数：
  • type: 选择部署类型(Argo隧道CDN/ws直连/xhttp直连)默认Argo隧道
  • region: 选择部署区域（SG(free)和US(free)为试用版,其他为企业版，请选择和开设的平台对应,aws,gcp,azure）
  • app_name: (可选)指定应用名称,留空随机生成
• 点击绿色的"Run workflow"按钮开始部署

1. 获取节点信息

• 点开运行的actions，点击详细部署信息 查看服务链接，访问域名显示Hello world说明正常
• 订阅： 域名/$SUB_PATH SUB_PATH变量没设置默认是sub 即订阅为：域名/sub

保活(选择其中一种即可)

vps或NAT小鸡保活

• 推荐使用keep.sh在vps或nat小鸡上精准保活，下载keep.sh文件到本地或vps上，在开头添加必要的环境变量和保活url然后执行bash keep.sh即可

1. 下载文件到vps或本地

wget https://raw.githubusercontent.com/eooce/Auto-deploy-sap-and-keepalive/refs/heads/main/keep.sh && chmod +x keep.sh

1. 修改keep.sh开头4-8行中的变量和保活url
2. bash keep.sh运行即可

Github Actions保活

• actions保活可能存在时间误差，建议根据前两天的情况进行适当调整自动保活SAP.yml里的cron时间

Cloudflare workers保活

1. 登录你的Cloudflare账户 Cloudflare Dashboard
2. 点击 Workers and pages创建一个workers，编辑代码，全选_worker-keep.js文件里的代码粘贴到workers中
3. 在开头添加登录email和登录密码(telegram通知配置可选)、项目URL和项目名称，右上角点击部署
4. 部署成功后返回到该worker设置中选择添加触发事件，添加cron触发器--cron表达式，设置为：*/2 0 * * * 保存，意思是北京时间早上8-9点每2分钟检查一次

注意事项

1. 确保所有必需的GitHub Secrets已正确配置
2. 多区域部署需先开通权限，确保US区域有内存
3. 试用版第二区域和企业版创建区域后,请一定要创建一个空间,名称随意,否则无法运行
4. 部署区域（SG(free)和US(free)为试用版,其他为企业版，请选择和开设的平台对应,aws,gcp,azure
5. 建议设置SUB_PATH订阅token,防止节点泄露