mirror of
				https://github.com/open-webui/openapi-servers
				synced 2025-06-26 18:17:04 +00:00 
			
		
		
		
	feat: docker support
Adds docker support to the example server. this allows the example servers to be run in a containerized environment.
This commit is contained in:
		
							parent
							
								
									4254ff37f1
								
							
						
					
					
						commit
						d2239bbe12
					
				| @ -30,6 +30,13 @@ pip install -r requirements.txt | |||||||
| uvicorn main:app --host 0.0.0.0 --reload | uvicorn main:app --host 0.0.0.0 --reload | ||||||
| ``` | ``` | ||||||
| 
 | 
 | ||||||
|  | Or using Docker: | ||||||
|  | 
 | ||||||
|  | ```bash | ||||||
|  | cd servers/filesystem | ||||||
|  | docker compose up | ||||||
|  | ``` | ||||||
|  | 
 | ||||||
| Now, simply point your OpenAPI-compatible clients or AI agents to your local or publicly deployed URL—no configuration headaches, no complicated transports. | Now, simply point your OpenAPI-compatible clients or AI agents to your local or publicly deployed URL—no configuration headaches, no complicated transports. | ||||||
| 
 | 
 | ||||||
| ## 📂 Server Examples | ## 📂 Server Examples | ||||||
|  | |||||||
							
								
								
									
										34
									
								
								servers/filesystem/.dockerignore
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										34
									
								
								servers/filesystem/.dockerignore
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,34 @@ | |||||||
|  | # Include any files or directories that you don't want to be copied to your | ||||||
|  | # container here (e.g., local build artifacts, temporary files, etc.). | ||||||
|  | # | ||||||
|  | # For more help, visit the .dockerignore file reference guide at | ||||||
|  | # https://docs.docker.com/go/build-context-dockerignore/ | ||||||
|  | 
 | ||||||
|  | **/.DS_Store | ||||||
|  | **/__pycache__ | ||||||
|  | **/.venv | ||||||
|  | **/.classpath | ||||||
|  | **/.dockerignore | ||||||
|  | **/.env | ||||||
|  | **/.git | ||||||
|  | **/.gitignore | ||||||
|  | **/.project | ||||||
|  | **/.settings | ||||||
|  | **/.toolstarget | ||||||
|  | **/.vs | ||||||
|  | **/.vscode | ||||||
|  | **/*.*proj.user | ||||||
|  | **/*.dbmdl | ||||||
|  | **/*.jfm | ||||||
|  | **/bin | ||||||
|  | **/charts | ||||||
|  | **/docker-compose* | ||||||
|  | **/compose.y*ml | ||||||
|  | **/Dockerfile* | ||||||
|  | **/node_modules | ||||||
|  | **/npm-debug.log | ||||||
|  | **/obj | ||||||
|  | **/secrets.dev.yaml | ||||||
|  | **/values.dev.yaml | ||||||
|  | LICENSE | ||||||
|  | README.md | ||||||
							
								
								
									
										51
									
								
								servers/filesystem/Dockerfile
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										51
									
								
								servers/filesystem/Dockerfile
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,51 @@ | |||||||
|  | # syntax=docker/dockerfile:1 | ||||||
|  | 
 | ||||||
|  | # Comments are provided throughout this file to help you get started. | ||||||
|  | # If you need more help, visit the Dockerfile reference guide at | ||||||
|  | # https://docs.docker.com/go/dockerfile-reference/ | ||||||
|  | 
 | ||||||
|  | # Want to help us make this template better? Share your feedback here: https://forms.gle/ybq9Krt8jtBL3iCk7 | ||||||
|  | 
 | ||||||
|  | ARG PYTHON_VERSION=3.10.12 | ||||||
|  | FROM python:${PYTHON_VERSION}-slim as base | ||||||
|  | 
 | ||||||
|  | # Prevents Python from writing pyc files. | ||||||
|  | ENV PYTHONDONTWRITEBYTECODE=1 | ||||||
|  | 
 | ||||||
|  | # Keeps Python from buffering stdout and stderr to avoid situations where | ||||||
|  | # the application crashes without emitting any logs due to buffering. | ||||||
|  | ENV PYTHONUNBUFFERED=1 | ||||||
|  | 
 | ||||||
|  | WORKDIR /app | ||||||
|  | 
 | ||||||
|  | # Create a non-privileged user that the app will run under. | ||||||
|  | # See https://docs.docker.com/go/dockerfile-user-best-practices/ | ||||||
|  | ARG UID=10001 | ||||||
|  | RUN adduser \ | ||||||
|  |     --disabled-password \ | ||||||
|  |     --gecos "" \ | ||||||
|  |     --home "/nonexistent" \ | ||||||
|  |     --shell "/sbin/nologin" \ | ||||||
|  |     --no-create-home \ | ||||||
|  |     --uid "${UID}" \ | ||||||
|  |     appuser | ||||||
|  | 
 | ||||||
|  | # Download dependencies as a separate step to take advantage of Docker's caching. | ||||||
|  | # Leverage a cache mount to /root/.cache/pip to speed up subsequent builds. | ||||||
|  | # Leverage a bind mount to requirements.txt to avoid having to copy them into | ||||||
|  | # into this layer. | ||||||
|  | RUN --mount=type=cache,target=/root/.cache/pip \ | ||||||
|  |     --mount=type=bind,source=requirements.txt,target=requirements.txt \ | ||||||
|  |     python -m pip install -r requirements.txt | ||||||
|  | 
 | ||||||
|  | # Switch to the non-privileged user to run the application. | ||||||
|  | USER appuser | ||||||
|  | 
 | ||||||
|  | # Copy the source code into the container. | ||||||
|  | COPY . . | ||||||
|  | 
 | ||||||
|  | # Expose the port that the application listens on. | ||||||
|  | EXPOSE 8000 | ||||||
|  | 
 | ||||||
|  | # Run the application. | ||||||
|  | CMD uvicorn 'main:app' --host=0.0.0.0 --port=8000 | ||||||
							
								
								
									
										7
									
								
								servers/filesystem/compose.yaml
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										7
									
								
								servers/filesystem/compose.yaml
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,7 @@ | |||||||
|  | services: | ||||||
|  |   server: | ||||||
|  |     build: | ||||||
|  |       context: . | ||||||
|  |     ports: | ||||||
|  |       - 8000:8000 | ||||||
|  | 
 | ||||||
							
								
								
									
										34
									
								
								servers/memory/.dockerignore
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										34
									
								
								servers/memory/.dockerignore
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,34 @@ | |||||||
|  | # Include any files or directories that you don't want to be copied to your | ||||||
|  | # container here (e.g., local build artifacts, temporary files, etc.). | ||||||
|  | # | ||||||
|  | # For more help, visit the .dockerignore file reference guide at | ||||||
|  | # https://docs.docker.com/go/build-context-dockerignore/ | ||||||
|  | 
 | ||||||
|  | **/.DS_Store | ||||||
|  | **/__pycache__ | ||||||
|  | **/.venv | ||||||
|  | **/.classpath | ||||||
|  | **/.dockerignore | ||||||
|  | **/.env | ||||||
|  | **/.git | ||||||
|  | **/.gitignore | ||||||
|  | **/.project | ||||||
|  | **/.settings | ||||||
|  | **/.toolstarget | ||||||
|  | **/.vs | ||||||
|  | **/.vscode | ||||||
|  | **/*.*proj.user | ||||||
|  | **/*.dbmdl | ||||||
|  | **/*.jfm | ||||||
|  | **/bin | ||||||
|  | **/charts | ||||||
|  | **/docker-compose* | ||||||
|  | **/compose.y*ml | ||||||
|  | **/Dockerfile* | ||||||
|  | **/node_modules | ||||||
|  | **/npm-debug.log | ||||||
|  | **/obj | ||||||
|  | **/secrets.dev.yaml | ||||||
|  | **/values.dev.yaml | ||||||
|  | LICENSE | ||||||
|  | README.md | ||||||
							
								
								
									
										51
									
								
								servers/memory/Dockerfile
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										51
									
								
								servers/memory/Dockerfile
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,51 @@ | |||||||
|  | # syntax=docker/dockerfile:1 | ||||||
|  | 
 | ||||||
|  | # Comments are provided throughout this file to help you get started. | ||||||
|  | # If you need more help, visit the Dockerfile reference guide at | ||||||
|  | # https://docs.docker.com/go/dockerfile-reference/ | ||||||
|  | 
 | ||||||
|  | # Want to help us make this template better? Share your feedback here: https://forms.gle/ybq9Krt8jtBL3iCk7 | ||||||
|  | 
 | ||||||
|  | ARG PYTHON_VERSION=3.10.12 | ||||||
|  | FROM python:${PYTHON_VERSION}-slim as base | ||||||
|  | 
 | ||||||
|  | # Prevents Python from writing pyc files. | ||||||
|  | ENV PYTHONDONTWRITEBYTECODE=1 | ||||||
|  | 
 | ||||||
|  | # Keeps Python from buffering stdout and stderr to avoid situations where | ||||||
|  | # the application crashes without emitting any logs due to buffering. | ||||||
|  | ENV PYTHONUNBUFFERED=1 | ||||||
|  | 
 | ||||||
|  | WORKDIR /app | ||||||
|  | 
 | ||||||
|  | # Create a non-privileged user that the app will run under. | ||||||
|  | # See https://docs.docker.com/go/dockerfile-user-best-practices/ | ||||||
|  | ARG UID=10001 | ||||||
|  | RUN adduser \ | ||||||
|  |     --disabled-password \ | ||||||
|  |     --gecos "" \ | ||||||
|  |     --home "/nonexistent" \ | ||||||
|  |     --shell "/sbin/nologin" \ | ||||||
|  |     --no-create-home \ | ||||||
|  |     --uid "${UID}" \ | ||||||
|  |     appuser | ||||||
|  | 
 | ||||||
|  | # Download dependencies as a separate step to take advantage of Docker's caching. | ||||||
|  | # Leverage a cache mount to /root/.cache/pip to speed up subsequent builds. | ||||||
|  | # Leverage a bind mount to requirements.txt to avoid having to copy them into | ||||||
|  | # into this layer. | ||||||
|  | RUN --mount=type=cache,target=/root/.cache/pip \ | ||||||
|  |     --mount=type=bind,source=requirements.txt,target=requirements.txt \ | ||||||
|  |     python -m pip install -r requirements.txt | ||||||
|  | 
 | ||||||
|  | # Switch to the non-privileged user to run the application. | ||||||
|  | USER appuser | ||||||
|  | 
 | ||||||
|  | # Copy the source code into the container. | ||||||
|  | COPY . . | ||||||
|  | 
 | ||||||
|  | # Expose the port that the application listens on. | ||||||
|  | EXPOSE 8000 | ||||||
|  | 
 | ||||||
|  | # Run the application. | ||||||
|  | CMD uvicorn 'main:app' --host=0.0.0.0 --port=8000 | ||||||
							
								
								
									
										7
									
								
								servers/memory/compose.yaml
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										7
									
								
								servers/memory/compose.yaml
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,7 @@ | |||||||
|  | services: | ||||||
|  |   server: | ||||||
|  |     build: | ||||||
|  |       context: . | ||||||
|  |     ports: | ||||||
|  |       - 8000:8000 | ||||||
|  | 
 | ||||||
							
								
								
									
										34
									
								
								servers/time/.dockerignore
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										34
									
								
								servers/time/.dockerignore
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,34 @@ | |||||||
|  | # Include any files or directories that you don't want to be copied to your | ||||||
|  | # container here (e.g., local build artifacts, temporary files, etc.). | ||||||
|  | # | ||||||
|  | # For more help, visit the .dockerignore file reference guide at | ||||||
|  | # https://docs.docker.com/go/build-context-dockerignore/ | ||||||
|  | 
 | ||||||
|  | **/.DS_Store | ||||||
|  | **/__pycache__ | ||||||
|  | **/.venv | ||||||
|  | **/.classpath | ||||||
|  | **/.dockerignore | ||||||
|  | **/.env | ||||||
|  | **/.git | ||||||
|  | **/.gitignore | ||||||
|  | **/.project | ||||||
|  | **/.settings | ||||||
|  | **/.toolstarget | ||||||
|  | **/.vs | ||||||
|  | **/.vscode | ||||||
|  | **/*.*proj.user | ||||||
|  | **/*.dbmdl | ||||||
|  | **/*.jfm | ||||||
|  | **/bin | ||||||
|  | **/charts | ||||||
|  | **/docker-compose* | ||||||
|  | **/compose.y*ml | ||||||
|  | **/Dockerfile* | ||||||
|  | **/node_modules | ||||||
|  | **/npm-debug.log | ||||||
|  | **/obj | ||||||
|  | **/secrets.dev.yaml | ||||||
|  | **/values.dev.yaml | ||||||
|  | LICENSE | ||||||
|  | README.md | ||||||
							
								
								
									
										51
									
								
								servers/time/Dockerfile
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										51
									
								
								servers/time/Dockerfile
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,51 @@ | |||||||
|  | # syntax=docker/dockerfile:1 | ||||||
|  | 
 | ||||||
|  | # Comments are provided throughout this file to help you get started. | ||||||
|  | # If you need more help, visit the Dockerfile reference guide at | ||||||
|  | # https://docs.docker.com/go/dockerfile-reference/ | ||||||
|  | 
 | ||||||
|  | # Want to help us make this template better? Share your feedback here: https://forms.gle/ybq9Krt8jtBL3iCk7 | ||||||
|  | 
 | ||||||
|  | ARG PYTHON_VERSION=3.10.12 | ||||||
|  | FROM python:${PYTHON_VERSION}-slim as base | ||||||
|  | 
 | ||||||
|  | # Prevents Python from writing pyc files. | ||||||
|  | ENV PYTHONDONTWRITEBYTECODE=1 | ||||||
|  | 
 | ||||||
|  | # Keeps Python from buffering stdout and stderr to avoid situations where | ||||||
|  | # the application crashes without emitting any logs due to buffering. | ||||||
|  | ENV PYTHONUNBUFFERED=1 | ||||||
|  | 
 | ||||||
|  | WORKDIR /app | ||||||
|  | 
 | ||||||
|  | # Create a non-privileged user that the app will run under. | ||||||
|  | # See https://docs.docker.com/go/dockerfile-user-best-practices/ | ||||||
|  | ARG UID=10001 | ||||||
|  | RUN adduser \ | ||||||
|  |     --disabled-password \ | ||||||
|  |     --gecos "" \ | ||||||
|  |     --home "/nonexistent" \ | ||||||
|  |     --shell "/sbin/nologin" \ | ||||||
|  |     --no-create-home \ | ||||||
|  |     --uid "${UID}" \ | ||||||
|  |     appuser | ||||||
|  | 
 | ||||||
|  | # Download dependencies as a separate step to take advantage of Docker's caching. | ||||||
|  | # Leverage a cache mount to /root/.cache/pip to speed up subsequent builds. | ||||||
|  | # Leverage a bind mount to requirements.txt to avoid having to copy them into | ||||||
|  | # into this layer. | ||||||
|  | RUN --mount=type=cache,target=/root/.cache/pip \ | ||||||
|  |     --mount=type=bind,source=requirements.txt,target=requirements.txt \ | ||||||
|  |     python -m pip install -r requirements.txt | ||||||
|  | 
 | ||||||
|  | # Switch to the non-privileged user to run the application. | ||||||
|  | USER appuser | ||||||
|  | 
 | ||||||
|  | # Copy the source code into the container. | ||||||
|  | COPY . . | ||||||
|  | 
 | ||||||
|  | # Expose the port that the application listens on. | ||||||
|  | EXPOSE 8000 | ||||||
|  | 
 | ||||||
|  | # Run the application. | ||||||
|  | CMD uvicorn 'main:app' --host=0.0.0.0 --port=8000 | ||||||
							
								
								
									
										7
									
								
								servers/time/compose.yaml
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										7
									
								
								servers/time/compose.yaml
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,7 @@ | |||||||
|  | services: | ||||||
|  |   server: | ||||||
|  |     build: | ||||||
|  |       context: . | ||||||
|  |     ports: | ||||||
|  |       - 8000:8000 | ||||||
|  | 
 | ||||||
		Loading…
	
		Reference in New Issue
	
	Block a user