push-all-in-cloud

基于 push-all-in-one 和 hono 开发的云函数推送服务。支持 nodejs/docker/vercel 等部署方式

重大更新提示： push-all-in-cloud v2 版本不兼容 v1 及以下低版本，请查看 CHANGELOG 了解改动。

🏠 主页

https://github.com/CaoMeiYouRen/push-all-in-cloud#readme

🌰 Demo

https://push.cmyr.dev

主页自带 push-all-in-one 和 push-all-in-cloud 通用配置生成器，提供在线调试功能。

📦 依赖要求

• node >=18
• pnpm >= 9

🚀 部署

Vercel 部署（推荐）

如果遇到了点击 推送 按钮长时间无响应/超时的问题，请在 Vercel 控制台中将环境变量NODEJS_HELPERS设置为 0 后，重新部署，再进行测试。

点击以下按钮一键部署到 Vercel。

Docker 镜像

支持两种注册表：

• Docker Hub: caomeiyouren/push-all-in-cloud
• GitHub: ghcr.io/caomeiyouren/push-all-in-cloud

支持以下架构：

• linux/amd64
• linux/arm64

有以下几种 tags：

Docker Compose 部署

下载 docker-compose.yml

wget https://raw.githubusercontent.com/CaoMeiYouRen/push-all-in-cloud/refs/heads/master/docker-compose.yml

检查有无需要修改的配置

vim docker-compose.yml  # 也可以是你喜欢的编辑器

在公网部署时请务必修改 AUTH_PUSH_KEY、AUTH_FORWARD_KEY 环境变量

启动

docker-compose up -d

在浏览器中打开 http://{Server IP}:3000 即可查看结果

Node.js 部署

确保本地已安装 Node.js 和 pnpm。

# 下载源码
git clone https://github.com/CaoMeiYouRen/push-all-in-cloud.git  --depth=1
cd push-all-in-cloud
# 安装依赖
pnpm i --frozen-lockfile
# 构建项目
pnpm build
# 启动项目
pnpm start

在浏览器中打开 http://{Server IP}:3000 即可查看结果

👨‍💻 使用

如果在本地部署，基础路径为 http://localhost:3000

在服务器或云函数部署则为 http(s)://{Server IP}。

例如：

如果基础路径为 https://example.vercel.app，则 /push 的完整路径为 https://example.vercel.app/push

接口说明

type PushBody = {
    title: string
    desp?: string
}

type PushType = "ServerChanTurbo" | "Dingtalk" | "CustomEmail" | "WechatRobot" | "WechatApp" | "PushPlus" | "IGot" | "Qmsg" | "XiZhi" | "PushDeer" | "Discord" | "Telegram" | "OneBot"

type ForwardBody = {
    title: string
    desp?: string
    // config 相关配置请参考 MetaPushConfig 的类型定义
} & MetaPushConfig<PushType>

type PushResponse = {
    message: string
    data: PromiseSettledResult<Pick<AxiosResponse<any>, 'data' | 'headers' | 'status' | 'statusText'>>[]
}

type ForwardResponse = {
    message: string
    data: Pick<AxiosResponse<any>, 'data' | 'headers' | 'status' | 'statusText'>
}

/push 接口调用例子

// 注意：/push 接口需要先配置环境变量！！！
const url = 'http://your-server-address/push'; // 请将 http://your-server-address 替换为真实地址！
const authToken = 'your-auth-push-key'; // 请将 your-auth-push-key 替换为真实 AUTH_PUSH_KEY

const payload = {
    title: '测试推送标题',
    desp: '这是测试推送的内容'
};

fetch(url, {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${authToken}`
    },
    body: JSON.stringify(payload)
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));

/forward 接口调用例子

提示：可以前往 push-all-in-cloud 配置生成器 在线生成 push-all-in-one 和 push-all-in-cloud 通用配置。

const url = 'http://your-server-address/forward'; // 请将 http://your-server-address 替换为真实地址！
const authToken = 'your-auth-forward-key'; // 请将 your-auth-forward-key 替换为真实 AUTH_FORWARD_KEY

const payload = {
    title: '测试推送标题',
    desp: '这是测试推送的内容',
    type: 'Telegram', // 选择推送渠道，例如 Telegram
    config: { // 构造函数配置项。如果不知道怎么填，请前往 'push-all-in-cloud 配置生成器' 查看
        TELEGRAM_BOT_TOKEN: 'your-telegram-bot-token',
        TELEGRAM_CHAT_ID: 'your-telegram-chat-id'
    },
    option: {} // 附加参数选项。如果不知道怎么填，请前往 'push-all-in-cloud 配置生成器' 查看
};

fetch(url, {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${authToken}`
    },
    body: JSON.stringify(payload)
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));

环境变量配置

🛠️ 开发

npm run dev

🔧 编译

npm run build

🔍 Lint

npm run lint

👤 作者

CaoMeiYouRen

• Website: https://blog.cmyr.ltd/

• GitHub: @CaoMeiYouRen

🤝 贡献

欢迎 贡献、提问或提出新功能！
如有问题请查看 issues page.
贡献或提出新功能可以查看contributing guide.

💰 支持

如果觉得这个项目有用的话请给一颗⭐️，非常感谢

🌟 Star History

📝 License

Copyright © 2024 CaoMeiYouRen.
This project is AGPL-3.0 licensed.

This README was generated with ❤️ by cmyr-template-cli