Docker Configuration¶
Obelisk uses Docker for containerization of both the development environment and the production deployment.
Dockerfile¶
The main Dockerfile
defines the container image for running Obelisk:
This file defines: - Base image selection - System dependencies installation - Python environment setup - Obelisk installation - Default command execution
Docker Compose Configuration¶
The docker-compose.yaml
file orchestrates the complete Obelisk stack, including optional AI components:
Key services include: - obelisk: The main Obelisk documentation server - ollama: (Optional) AI model server for local embedding and inference - openwebui: (Optional) Web interface for interacting with AI models
Development Container¶
The .devcontainer
directory contains configuration for VS Code's Development Containers feature:
devcontainer.json¶
This file configures: - Development container settings - VS Code extensions to install - Port forwarding - Environment variables - Startup commands
Dockerfile (Dev)¶
The development container Dockerfile includes: - Development-specific tools and dependencies - Debugging utilities - Additional build tools
Running with Docker¶
To run Obelisk using Docker:
-
Build the image:
-
Run with Docker:
-
Run with Docker Compose:
-
Run the full stack with AI:
Task Runner Integration¶
Docker commands are also available through the Task runner: