Files
dify-docs/en/plugins/quick-start/debug-plugin.mdx
2025-06-19 16:56:33 +08:00

60 lines
2.6 KiB
Plaintext

---
title: Debug Plugin
---
{/*
CONTRIBUTOR NOTE:
----------------
This is a legacy document that is being deprecated.
Please DO NOT make changes to this version.
All updates should be directed to the new version at:
/plugin-dev-en/0411-remote-debug-a-plugin
*/}
<Card title="This Documentation is Being Deprecated" icon="circle-exclamation" href="/plugin-dev-en/0411-remote-debug-a-plugin">
<p>This page is being phased out as part of our documentation reorganization.</p>
<p><strong>Click this card</strong> to be redirected to the updated version with the most current information.</p>
<p>If you notice any discrepancies or areas needing improvement in the new documentation, please use the "Report an issue" button at the bottom of the page.</p>
</Card>
Once plugin development is complete, the next step is to test whether the plugin runs correctly. Dify provides remote debugging method.
Go to ["Plugin"](https://cloud.dify.ai/plugins) page to get the debugging key and remote URL.
![](https://assets-docs.dify.ai/2025/04/2779338a43687f3e00155baccdd6d06c.png)
Go back to the plugin project, copy the `.env.example` file and rename it to `.env`. Fill it with the remote server address and debug key.
`.env` file
```bash
INSTALL_METHOD=remote
REMOTE_INSTALL_URL=debug.dify.ai:5003
REMOTE_INSTALL_KEY=********-****-****-****-************
```
Run the `python -m main` command to start the plugin. You can see on the plugin page that the plugin has been installed into Workspace. Other team members can also access the plugin.
![](https://assets-docs.dify.ai/2024/12/e11acb42ccb23c824f400b7e19fb2952.png)
You can initialize this model provider by entering the API Key in **Settings → Model Provider**.
![](https://assets-docs.dify.ai/2024/12/662de537d70a3607c240a05294a9f3e1.png)
{/*
Contributing Section
DO NOT edit this section!
It will be automatically generated by the script.
*/}
---
[Edit this page](https://github.com/langgenius/dify-docs/edit/main/en/plugins/quick-start/debug-plugin.mdx) | [Report an issue](https://github.com/langgenius/dify-docs/issues/new?title=Documentation%20Issue%3A%20-plu&body=%23%23%20Issue%20Description%0A%3C%21--%20Please%20briefly%20describe%20the%20issue%20you%20found%20--%3E%0A%0A%23%23%20Page%20Link%0Ahttps%3A%2F%2Fgithub.com%2Flanggenius%2Fdify-docs%2Fblob%2Fmain%2Fen/plugins/quick-start%2Fdebug-plugin.mdx%0A%0A%23%23%20Suggested%20Changes%0A%3C%21--%20If%20you%20have%20specific%20suggestions%20for%20changes%2C%20please%20describe%20them%20here%20--%3E%0A%0A%3C%21--%20Thank%20you%20for%20helping%20improve%20our%20documentation%21%20--%3E)