From 78efcaa8111ac1bcec56b3e1a430edcb3ee55629 Mon Sep 17 00:00:00 2001 From: steven Date: Mon, 7 Jul 2025 23:47:54 -0500 Subject: [PATCH] Added in more instructions, and included docker-compose instructions. --- docs/openapi-servers/index.mdx | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/docs/openapi-servers/index.mdx b/docs/openapi-servers/index.mdx index 1ed5220a..e029f6fa 100644 --- a/docs/openapi-servers/index.mdx +++ b/docs/openapi-servers/index.mdx @@ -33,13 +33,36 @@ Get started quickly with our reference FastAPI-based implementations provided in ```bash git clone https://github.com/open-webui/openapi-servers cd openapi-servers +``` +### With Bash + +```bash # Example: Installing dependencies for a specific server 'filesystem' cd servers/filesystem pip install -r requirements.txt uvicorn main:app --host 0.0.0.0 --reload ``` +The filesystem server should be reachable from: [http://localhost:8000](http://localhost:8000) + +The documentation path will be: [http://localhost:8000](http://localhost:8000) + +### With Docker + +If you have docker compose installed, bring the servers up with: + +```bash +docker compose up +``` + +The services will be reachable from: + + * [Filesystem localhost:8081](http://localhost:8081) + * [memory server localhost:8082](http://localhost:8082) + * [time-server localhost:8083](http://localhost:8083) + + Now, simply point your OpenAPI-compatible clients or AI agents to your local or publicly deployed URL—no configuration headaches, no complicated transports. ## 🌱 Open WebUI Community