Skip to content

Commit 507a311

Browse files
authored
Merge pull request #608 from monksy/main
Added more instructions to the OpenAPI Tools Section
2 parents c9a197c + 78efcaa commit 507a311

1 file changed

Lines changed: 23 additions & 0 deletions

File tree

docs/openapi-servers/index.mdx

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,36 @@ Get started quickly with our reference FastAPI-based implementations provided in
3333
```bash
3434
git clone https://github.com/open-webui/openapi-servers
3535
cd openapi-servers
36+
```
37+
38+
### With Bash
3639

40+
```bash
3741
# Example: Installing dependencies for a specific server 'filesystem'
3842
cd servers/filesystem
3943
pip install -r requirements.txt
4044
uvicorn main:app --host 0.0.0.0 --reload
4145
```
4246

47+
The filesystem server should be reachable from: [http://localhost:8000](http://localhost:8000)
48+
49+
The documentation path will be: [http://localhost:8000](http://localhost:8000)
50+
51+
### With Docker
52+
53+
If you have docker compose installed, bring the servers up with:
54+
55+
```bash
56+
docker compose up
57+
```
58+
59+
The services will be reachable from:
60+
61+
* [Filesystem localhost:8081](http://localhost:8081)
62+
* [memory server localhost:8082](http://localhost:8082)
63+
* [time-server localhost:8083](http://localhost:8083)
64+
65+
4366
Now, simply point your OpenAPI-compatible clients or AI agents to your local or publicly deployed URL—no configuration headaches, no complicated transports.
4467

4568
## 🌱 Open WebUI Community

0 commit comments

Comments
 (0)