You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-3Lines changed: 10 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,20 +16,27 @@ Plugins Server is used by some built-in plugins on Typing Mind (e.g., Web Page R
16
16
17
17
Plugins Server is open-sourced and is intended to be self-hosted by individual users for private use only.
18
18
19
+
**Note**: The Plugins Server only provides an endpoint for retrieving server-side processing results. To make the plugin work, you must also install a TypingMind's plugin configured to send requests to this server endpoint.
20
+
19
21
## 🔌 How to use (for Typing Mind users)
20
22
21
23
Two simple steps:
22
24
23
-
1. Deploy this repo on any hosting provider that supports NodeJS (e.g., Render.com, AWS, etc.). (We also provide a Dockerfile for easy deployment on Docker-supported hosting providers)
24
-
2. Use the server endpoint URL in your Settings page of Typing Mind's plugins.
25
+
1. Deploy this repo on any hosting provider that supports NodeJS (e.g., Render.com, AWS, etc.). (We also provide a Dockerfile for easy deployment on Docker-supported hosting providers).
26
+
27
+
2. Install your desired TypingMind's plugin. Update the server endpoint URL in your Settings page.
25
28
26
29
Follow this guide for detailed instructions: [How to Deploy Plugins Server on Render.com](https://docs.typingmind.com/plugins/plugins-server/how-to-deploy-plugins-server-on-render)
27
30
31
+
Follow this guide for setting up a TypingMind's plugin: [Build a TypingMind Plugin](https://docs.typingmind.com/plugins/build-a-typingmind-plugin)
32
+
28
33
## List of available endpoints
29
34
30
35
After deploying, visit your Plugins Server URL to see the list of available endpoints (served in Swagger UI).
31
36
32
-
Here are the latest endpoints from our public servers: https://plugins.typingmind.com/ (**Note**: this public server only hosts the API documentation. You cannot use this Public Server as your proxy. You must deploy your own Plugins Server to use all the available endpoints).
37
+
In your local development environment, visit http://localhost:3000 to access the page.
38
+
39
+
**Note**: this public server only hosts the API documentation. You cannot use this Public Server as your proxy. You must deploy your own Plugins Server to use all the available endpoints.
33
40
34
41
## 🛠️ Development (for Typing Mind plugins developers)
0 commit comments