Skip to content

Commit

Permalink
add language
Browse files Browse the repository at this point in the history
  • Loading branch information
leo committed Dec 18, 2024
1 parent 23305fd commit 6ddc500
Show file tree
Hide file tree
Showing 4 changed files with 110 additions and 9 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,10 @@

<h1 align="center">Dify Workflow Scheduler</h1>

<p align="center">Schedule workflow execution and send notifications</p>
<p align="center">Since Dify doesn't have a built-in scheduling feature, executing workflow tasks on a schedule can be challenging. This project leverages GitHub Actions to run workflows daily and send notifications automatically.</p>

[中文文档](./README_zh.md)
[中文文档](./README_CN.md)
[日本語](./README_JA.md)

## How to Use?
There are two ways to use automated workflows: Quick Start (Online) and Private Deployment (Local)
Expand Down Expand Up @@ -46,9 +47,9 @@ Automated Runtime: 06:30 AM Beijing Time

## Preview

| Dify Workflow Execution |
|:-----------:|
| ![Dify Workflow Execution](./static/chat.png) |
| Dify Workflow Execution - wechat | Dify Workflow Execution - email |
|:-----------:|:-----------:|
| ![Dify Workflow Execution](./static/chat.png) | ![Dify Workflow Execution](./static/chat2.png) |

## QingLong Panel Usage

Expand Down
8 changes: 4 additions & 4 deletions README_ZH.md → README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

<h1 align="center">Dify工作流定时助手</h1>

<p align="center">定时执行工作流,并发送通知</p>
<p align="center">由于Dify官方没有定时任务功能,对于一些工作流如果想执行定时任务会比较麻烦,所以才会有这个项目,利用github action 每天定时执行工作流,并发送通知</p>


## 如何使用?
Expand Down Expand Up @@ -45,9 +45,9 @@

## 预览

| Dify工作流执行 |
|:-----------:|
| ![Dify工作流执行](https://user-images.githubusercontent.com/24502299/156475511-342cfcd8-3b66-4b9c-8614-215e0b4e08a1.jpg) |
| Dify工作流执行-微信 | Dify工作流执行-邮件|
|:-----------:| :-----------:|
| ![Dify工作流执行](./static/chat.png) |![Dify工作流执行](./static/chat2.png) |

## 青龙面板使用

Expand Down
100 changes: 100 additions & 0 deletions README_JA.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
<section align="center">
<a href="https://github.com/leochen-g/dify-schedule" target="_blank">
<img src="./static/logo.png" alt="Dify" width="260" />
</a>
</section>

<h1 align="center">Difyワークフロースケジューラー</h1>

<p align="center">Dify公式にスケジュール機能が実装されていないため、定期的なワークフロー実行が困難でした。そこで、GitHub Actionsを活用して毎日定期的にワークフローを実行し、通知を送信する本プロジェクトが誕生しました。</p>

## 使用方法
自動化ワークフローには、オンラインでの即時利用とローカルでの自己ホスティングの2つの方法があります:

- クイックスタート(オンライン):[使い方を見る](#使い方)
- Qinglongパネルでのタスク追加:[Qinglong使用方法を見る](#Qinglong使用方法)

## 使い方

自動実行タスク:複数のDifyワークフローに対応\
自動実行時間:北京時間 午前06:30

1. [リポジトリをフォーク](https://github.com/leochen-g/dify-schedule)

2. リポジトリ -> Settings -> Secrets -> New repository secretで、以下の環境変数を追加:

| 名前 || 必須 |
| --- | --- | --- |
| DIFY_BASE_URL | DifyのベースURL。自己ホスティングの場合は、パブリックアクセス可能なURLを指定。未設定の場合はhttps://api.dify.ai/v1がデフォルト | 任意 |
| DIFY_TOKENS | DifyワークフローのAPIキー。必須項目。複数指定する場合は`;`で区切る | 必須 |
| DIFY_INPUTS | Difyワークフローで必要な変数。必須項目がある場合は必ず設定してください。JSON形式である必要があります | 任意 |
| EMAIL_USER | 送信元メールアドレス(SMTP有効化が必要) | 任意 |
| EMAIL_PASS | 送信元メールパスワード(SMTPパスワード) | 任意 |
| EMAIL_TO | 受信者メールアドレス。複数指定する場合は`, `で区切る(例:`a@163.com, b@qq.com`| 任意 |
| DINGDING_WEBHOOK | DingDingボットのWEBHOOK URL | 任意 |
| PUSHPLUS_TOKEN | [Pushplus](http://www.pushplus.plus/)で取得したトークン。WeChatプッシュ通知に対応 | 任意 |
| SERVERPUSHKEY | [Server酱](https://sct.ftqq.com//)で取得したキー。WeChatプッシュ通知に対応 | 任意 |
| WEIXIN_WEBHOOK | 企業WeChatボットのWEBHOOK URL | 任意 |
| FEISHU_WEBHOOK | Feishuボットのウェブフック URL | 任意 |
| AIBOTK_KEY | [AI秘書](https://wechat.aibotk.com?r=dBL0Bn&f=difySchedule)のAPIキー | 任意 |
| AIBOTK_ROOM_RECIVER | [AI秘書](https://wechat.aibotk.com?r=dBL0Bn&f=difySchedule)で送信するグループ名 | 任意 |
| AIBOTK_CONTACT_RECIVER | [AI秘書](https://wechat.aibotk.com?r=dBL0Bn&f=difySchedule)で送信する友達のニックネーム | 任意 |

4. リポジトリ -> Actionsで、Workflowsを確認して有効化。

## プレビュー

| Difyワークフロー実行 - WeChat | Difyワークフロー実行 - メール |
|:-----------:| :-----------:|
| ![Difyワークフロー実行](./static/chat.png) |![Difyワークフロー実行](./static/chat2.png) |

## Qinglong使用方法

1. Qinglongパネルでサブスクリプションを追加

```shell
ql repo https://github.com/leochen-g/ql-juejinhelper.git "ql_" "utils" "sdk"
```

2. パネルメニューの依存関係管理からNodeJsの依存関係として`axios`を追加

3. 環境変数に`DIFY_TOKENS``DIFY_BASE_URL`を追加

Qinglongパネルで環境変数`DIFY_TOKENS``DIFY_BASE_URL`を追加。複数のワークフロートークンは`;`で区切って指定可能

4. デフォルトでQinglong組み込みの通知を使用。適宜設定してください

## よくある質問

### Difyワークフロートークンの取得方法

Difyウェブサイトにアクセス

> ワークフローアプリケーションのみ対応。他のアプリケーションタイプは現在サポートされていません:
<img width="1156" alt="gettoken" src="./static/dify1.png">
<img width="1156" alt="gettoken" src="./static/dify2.png">

### アクセスできない場合

自己ホスティングのDifyを使用している場合は、パブリックアクセスが可能であることを確認してください。ローカルデプロイされたサービスにGitHub Workflowsからアクセスすることはできません。

### 実行エラーについて

1. まず、アプリケーションがワークフローアプリケーションであることを確認してください。現在はワークフローアプリケーションのみサポートしています

2. 必須入力変数がある場合は、環境変数`DIFY_INPUTS`を設定してください。JSON形式である必要があります。オンラインJSONバリデーターで確認してから入力することをお勧めします

3. エラーメッセージを注意深く確認し、指示に従って問題を解決するか、ログを添付してissuesを作成してください。その際は機密情報を必ず削除してください

## 貢献

アイデアは[プルリクエスト](https://github.com/leochen-g/dify-schedule/pulls)または[GitHubイシュー](https://github.com/leochen-g/dify-schedule/issues)として提出できます。

## サポート
### ☕️WeChatでの投げ銭
<img src="./static/zan.jpg" alt="WeChatでの投げ銭" width="300" />

## ライセンス

[MIT](./LICENSE)
Binary file added static/chat2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 6ddc500

Please sign in to comment.