Skip to content

Commit 68ddb3b

Browse files
committed
Merge branch 'main' into dependabot/npm_and_yarn/asteasolutions/zod-to-openapi-7.3.0
2 parents b3fb14c + 5a4271a commit 68ddb3b

18 files changed

+2869
-73
lines changed

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,20 +16,27 @@ Plugins Server is used by some built-in plugins on Typing Mind (e.g., Web Page R
1616

1717
Plugins Server is open-sourced and is intended to be self-hosted by individual users for private use only.
1818

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+
1921
## 🔌 How to use (for Typing Mind users)
2022

2123
Two simple steps:
2224

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.
2528

2629
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)
2730

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+
2833
## List of available endpoints
2934

3035
After deploying, visit your Plugins Server URL to see the list of available endpoints (served in Swagger UI).
3136

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.
3340

3441
## 🛠️ Development (for Typing Mind plugins developers)
3542

0 commit comments

Comments
 (0)