docs/modify plugins url (#537)

* Docs: modify plugins url * Docs: update plugins faq
2026-07-21 01:45:23 -04:00 · 2025-02-24 11:31:12 +08:00
parent 0aa6390448
commit ee9cf8ad3d
10 changed files with 69 additions and 30 deletions
@@ -187,6 +187,7 @@
    * [Plugin Privacy Protection Guidelines](plugins/publish-plugins/publish-to-dify-marketplace/plugin-privacy-protection-guidelines.md)
  * [Publish to Your Personal GitHub Repository](plugins/publish-plugins/publish-plugin-on-personal-github-repo.md)
  * [Package the Plugin File and Publish it](plugins/publish-plugins/package-plugin-file-and-publish.md)
+* [FAQ](plugins/faq.md)

 ## Development

@@ -0,0 +1,13 @@
+---
+description: 'Author: Allen'
+---
+
+# FAQ
+
+## How to handle plugin upload failure during installation?
+
+**Error Details**: The error message shows `PluginDaemonBadRequestError: plugin_unique_identifier is not valid`.
+
+**Solution**: Modify the `author` field in both the `manifest.yaml` file in the plugin project and the `.yaml` file under the `/provider` path to your GitHub ID.
+
+Retype the plugin packaging command and install the new plugin package.
@@ -186,6 +186,7 @@
    * [プラグインのプライバシー保護に関するガイドライン](plugins/publish-plugins/publish-to-dify-marketplace/plugin-privacy-protection-guidelines.md)
  * [個人GitHubリポジトリへの公開](plugins/publish-plugins/publish-plugin-on-personal-github-repo.md)
  * [ローカルでの公開と共有](plugins/publish-plugins/package-plugin-file-and-publish.md)
+* [よくある質問](plugins/faq.md)

 ## 開発 <a href="#development" id="development"></a>

@@ -0,0 +1,9 @@
+# よくある質問
+
+## プラグインのインストール時にアップロードが失敗する場合の対処方法は？
+
+**エラー詳細**：`PluginDaemonBadRequestError: plugin_unique_identifier is not valid` というエラーメッセージが表示されます。
+
+**解決方法**：プラグインプロジェクトの `manifest.yaml` ファイルと `/provider` パス配下の `.yaml` ファイルの `author` フィールドを GitHub ID に変更してください。
+
+プラグインのパッケージングコマンドを再実行し、新しいプラグインパッケージをインストールしてください。
@@ -86,7 +86,7 @@

 **プラグインの公開**

-[Difyマーケットプレイス](https://marketplace.dify.ai/)にプラグインを公開するには、必要な情報と使用方法に関するドキュメントを記入してください。その後、プラグインのコードを[GitHubリポジトリ](https://github.com/langgenius/dify-official-plugins)に提出してください。承認されると、マーケットプレイスに掲載されます。
+プラグインを[Dify Marketplace](https://marketplace.dify.ai/)で公開するには、必要な情報と利用方法に関するドキュメントを記入してください。その後、プラグインのコードを[GitHubリポジトリ](https://github.com/langgenius/dify-plugins)に提出してください。承認されると、マーケットプレイスに掲載されます。

 {% content-ref url="publish-plugins/publish-to-dify-marketplace/" %}
 [publish-to-dify-marketplace](publish-plugins/publish-to-dify-marketplace/)
@@ -187,6 +187,7 @@
    * [插件隐私政策准则](plugins/publish-plugins/publish-to-dify-marketplace/plugin-privacy-protection-guidelines.md)
  * [发布至个人 GitHub 仓库](plugins/publish-plugins/publish-plugin-on-personal-github-repo.md)
  * [本地发布与分享](plugins/publish-plugins/package-plugin-file-and-publish.md)
+* [常见问题](plugins/faq.md)

 ## 研发 <a href="#development" id="development"></a>

@@ -154,37 +154,37 @@ Flask 调试模式，开启可在接口输出 trace 信息，方便调试。

 *   CELERY\_BROKER\_URL

-    格式如下（直连模式）
+    格式如下（直连模式）：

-    <pre><code><strong>redis://<redis_username>:<redis_password>@<redis_host>:<redis_port>/<redis_database>
-    </strong><strong>  
-    </strong></code></pre>
+    ```
+    redis://<redis_username>:<redis_password>@<redis_host>:<redis_port>/<redis_database>
+  ```

    范例：`redis://:difyai123456@redis:6379/1`

-    哨兵模式
+    哨兵模式：

-    <pre><code><strong>sentinel://<sentinel_username>:<sentinel_password>@<sentinel_host>:<sentinel_port>/<redis_database>
-    </strong><strong>  
-    </strong></code></pre>
+    ```
+      sentinel://<sentinel_username>:<sentinel_password>@<sentinel_host>:<sentinel_port>/<redis_database>
+  ```

    范例：`sentinel://localhost:26379/1;sentinel://localhost:26380/1;sentinel://localhost:26381/1`
    
 *   BROKER\_USE\_SSL

-    若设置为 true，则使用 SSL 协议进行连接，默认 false
+    若设置为 true，则使用 SSL 协议进行连接，默认 false。

 *   CELERY\_USE\_SENTINEL

-    若设置为 true，则启用哨兵模式，默认 false
+    若设置为 true，则启用哨兵模式，默认 false。

 *   CELERY_SENTINEL_MASTER_NAME

-    哨兵的服务名，即 Master Name
+    哨兵的服务名，即 Master Name。

 *   CELERY_SENTINEL_SOCKET_TIMEOUT

-    哨兵连接超时时间，默认值：0.1，单位：秒
+    哨兵连接超时时间，默认值：0.1，单位：秒。

 #### CORS 配置

@@ -237,19 +237,19 @@ Flask 调试模式，开启可在接口输出 trace 信息，方便调试。
 * ALIYUN\_OSS\_BUCKET_NAME: your-bucket-name 如 'difyai'
 * ALIYUN\_OSS\_ACCESS_KEY: your-access-key 如 'difyai'
 * ALIYUN\_OSS\_SECRET_KEY: your-secret-key 如 'difyai'
-* ALIYUN\_OSS\_ENDPOINT: https://oss-ap-southeast-1-internal.aliyuncs.com # 参考文档: https://help.aliyun.com/zh/oss/user-guide/regions-and-endpoints
-* ALIYUN\_OSS\_REGION: ap-southeast-1 # 参考文档: https://help.aliyun.com/zh/oss/user-guide/regions-and-endpoints
+* ALIYUN\_OSS\_ENDPOINT: https://oss-ap-southeast-1-internal.aliyuncs.com # 参考[文档](https://help.aliyun.com/zh/oss/user-guide/regions-and-endpoints)
+* ALIYUN\_OSS\_REGION: ap-southeast-1 # 参考[文档](https://help.aliyun.com/zh/oss/user-guide/regions-and-endpoints)
 * ALIYUN\_OSS\_AUTH_VERSION: v4
-* ALIYUN\_OSS\_PATH: your-path # 路径不要使用斜线 "/" 开头，阿里云 OSS 不支持。参考文档: https://api.aliyun.com/troubleshoot?q=0016-00000005
+* ALIYUN\_OSS\_PATH: your-path # 路径不要使用斜线 "/" 开头，阿里云 OSS 不支持。参考[文档](https://api.aliyun.com/troubleshoot?q=0016-00000005)
 * HUAWEI\_OBS\_BUCKET\_NAME: your-bucket-name 如 'difyai'
 * HUAWEI\_OBS\_SECRET\_KEY: your-secret-key 如 'difyai'
 * HUAWEI\_OBS\_ACCESS\_KEY: your-access-key 如 'difyai'
-* HUAWEI\_OBS\_SERVER: your-server-url # 参考文档: https://support.huaweicloud.com/sdk-python-devg-obs/obs_22_0500.html
-* VOLCENGINE_TOS_BUCKET_NAME: your-bucket-name 如 'difyai'
-* VOLCENGINE_TOS_SECRET_KEY: your-secret-key 如 'difyai'
-* VOLCENGINE_TOS_ACCESS_KEY: your-access-key 如 'difyai'
-* VOLCENGINE_TOS_REGION: your-region 如 'cn-guangzhou' # 参考文档: https://www.volcengine.com/docs/6349/107356
-* VOLCENGINE_TOS_ENDPOINT: your-endpoint 如 'tos-cn-guangzhou.volces.com' # 参考文档: https://www.volcengine.com/docs/6349/107356
+* HUAWEI\_OBS\_SERVER: your-server-url # 参考[文档](https://support.huaweicloud.com/sdk-python-devg-obs/obs_22_0500.html)。
+* VOLCENGINE_TOS_BUCKET_NAME: your-bucket-name 如 'difyai'。
+* VOLCENGINE_TOS_SECRET_KEY: your-secret-key 如 'difyai'。
+* VOLCENGINE_TOS_ACCESS_KEY: your-access-key 如 'difyai'。
+* VOLCENGINE_TOS_REGION: your-region 如 'cn-guangzhou' # 参考[文档]( https://www.volcengine.com/docs/6349/107356)。
+* VOLCENGINE_TOS_ENDPOINT: your-endpoint 如 'tos-cn-guangzhou.volces.com' # 参考[文档](https://www.volcengine.com/docs/6349/107356)。

 #### 向量数据库配置

@@ -274,7 +274,7 @@ Flask 调试模式，开启可在接口输出 trace 信息，方便调试。
    连接 Weaviate 使用的 api-key 凭据。
 *   WEAVIATE\_BATCH\_SIZE

-    Weaviate 批量创建索引 Object 的数量，默认 100。可参考此文档：https://weaviate.io/developers/weaviate/manage-data/import#how-to-set-batch-parameters
+    Weaviate 批量创建索引 Object 的数量，默认 100。可参考此[文档](https://weaviate.io/developers/weaviate/manage-data/import#how-to-set-batch-parameters)。
 *   WEAVIATE\_GRPC\_ENABLED

    是否使用 gRPC 方式与 Weaviate 进行交互，开启后性能会大大增加，本地可能无法使用，默认为 true。
@@ -371,23 +371,23 @@ Flask 调试模式，开启可在接口输出 trace 信息，方便调试。

 -   COUCHBASE_CONNECTION_STRING

-    Couchbase 集群的连接 string 字符串
+    Couchbase 集群的连接 string 字符串。

 -   COUCHBASE_USER

-    数据库用户名
+    数据库用户名。

 -   COUCHBASE_PASSWORD

-    数据库密码
+    数据库密码。

 -   COUCHBASE_BUCKET_NAME

-     Bucket 名称
+     Bucket 名称。

 -   COUCHBASE_SCOPE_NAME

-     Scope 名称
+     Scope 名称。

 #### 知识库配置

@@ -0,0 +1,14 @@
+---
+description: 'Author: Allen'
+---
+
+# 常见问题
+
+## 安装插件时提示上传失败如何处理？
+
+**错误详情**：出现 `PluginDaemonBadRequestError: plugin_unique_identifier is not valid` 报错提示。
+
+**解决办法**：将插件项目下的 `manifest.yaml` 文件和 `/provider` 路径下的 `.yaml` 文件中的 `author` 字段修改为 GitHub ID。
+
+重新运行插件打包命令并安装新的插件包。
+
@@ -19,7 +19,7 @@

 ### 打包插件

-> 打包插件前，请确保插件的 `manifest.yaml` 文件中的 author 字段与 GitHub id 保持一致。
+> 打包插件前，请确保插件的 `manifest.yaml` 文件和 `/provider` 路径下的 `.yaml` 文件中的 `author` 字段与 GitHub ID 保持一致。

 插件项目开发完成后，请确保已完成[远程连接测试](../quick-start/develop-plugins/extension-plugin.md#tiao-shi-cha-jian)。需前往插件项目的上一级目录，运行以下插件打包命令：

@@ -56,7 +56,7 @@ git remote add origin https://github.com/<your-username>/<repository-name>.git

 ### 4. 上传插件文件

-> 推送插件项目前，请确保插件的 `manifest.yaml` 文件中的 author 字段与 GitHub id 保持一致。
+> 打包插件前，请确保插件的 `manifest.yaml` 文件和 `/provider` 路径下的 `.yaml` 文件中的 author 字段与 GitHub ID 保持一致。

 将插件项目推送到 GitHub 仓库：