Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ximing/memos-reminder
memos 每日提醒 基于飞书
https://github.com/ximing/memos-reminder
Last synced: 15 days ago
JSON representation
memos 每日提醒 基于飞书
- Host: GitHub
- URL: https://github.com/ximing/memos-reminder
- Owner: ximing
- License: apache-2.0
- Created: 2023-05-07T08:50:16.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-05-25T11:58:07.000Z (8 months ago)
- Last Synced: 2025-01-05T23:35:25.683Z (19 days ago)
- Language: TypeScript
- Size: 45.9 KB
- Stars: 1
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Memos Reminder
基于 `github actions` 的定时推送 memo 服务，灵感来自 flomo `每日提醒` 功能。
momos 版本>=0.15.0 [see access-tokens](https://usememos.com/docs/access-tokens)
## 功能
- 支持通过 cron 表达式配置推送时间，默认在每天 `9:00`、`12:00`、`18:00` 进行推送
- 支持纯文本和图片
- 支持自定义要推送的 memo 标签
## 用法
1. **fork** 此仓库
2. 如果要修改推送时间，在 `.github` -> `workflows` -> `main.yaml` 中编辑 `on:schedule:cron` 这一项的为合法的 cron
表达式即可，请关注[注意事项](#注意)
3. 在**自己的 github 仓库**里，定位到 `Settings` -> `Security` -> `Secrets and variables` -> `Actions`
3. 在 `Secrets` 这一栏中，点击右边的按钮 `New repository secret`，添加如下表参数。如果配置了多个通道的 token，则会发送多个通道推送
| 参数 | 说明 | 示例 | 必填 |
|--------------------|--------------------------------|-----------------------------------------------------|----|
| MEMOS_ACCESS_TOKEN | memos 设置中 MEMOS_ACCESS_TOKEN 值 | 12345678 ｜ xxxxxxxx | ✅ |
| MEMOS_SERVER_URL | memos 服务端地址 | https://custom.memos.com | |
| FEISHU_URL | 飞书推送的 url | https://www.feishu.cn/flow/api/trigger-webhook/xxxx | |
| PUSH_TAGS | 推动的 tags | aBcDefg1234HijkLmn | |
1. 在 `Variables` 栏中，点击按钮 `New repository variable`，添加如下表参数
| 参数 | 说明 | 示例 | 必填 |
|-----------|-----------------------------------------------------------------------------|---------------------------------|----|
| PUSH_TAGS | 要推送的 tags，用**英文逗号**分隔。如果设置了「读书」，会推送「读书」标签下所有的子标签 | 学习/前端/知识体系,读书,名言 | |
| PUSH_CRON | 推送时间的 CRON 表达式，默认为 "0 1,4,10 \* \* \*"（时间要减去时区偏差 8）, 即每天 9 点、12 点、18 点 推送一次 | 0 0/2 \* \* \* （从零点开始每两个小时推送一次） |
## 调试
拉取代码到本地并安装依赖之后，新建一个 `.env` 文件，把环境变量填进去，示例如下：
```
// ./.env
MEMOS_ACCESS_TOKEN=abcddd
MEMOS_SERVER_URL=https://memos.com/api/memo
FEISHU_URL=https://www.feishu.cn/flow/api/trigger-webhook/xxxx
```
然后运行本地调试命令：
```shell
yarn start
```
观察 console 信息即可。
## 更新
定期拉取此仓库代码即可。
## 注意
1. 由于 github 的 action 机制，**推送时间不会完全准确**。高峰时期实测大概会延迟 40-50 分钟推送，可以酌情考虑把设置推送时间比想要推送的时间稍微提前一些。
2. 推送时间的 CRON 表达式，**时间要减去时区偏差 8**，例如每天 `9、12、18` 点推送要写成 `"0 1,4,10 * * *"`。
## 反馈
请直接提 `issue`，谢谢！
## 感谢
[flomo](https://flomoapp.com)