mirror of
https://github.com/we-promise/sure.git
synced 2026-04-20 04:24:06 +00:00
Update Docker Compose file for AI optional features (#1349)
* Guard docs workflow to upstream repo Agent-Logs-Url: https://github.com/jjmata/sure/sessions/230a651a-b564-49fa-9563-4986fc5f2c13 Co-authored-by: jjmata <187772+jjmata@users.noreply.github.com> * Limit docs workflow token permissions Agent-Logs-Url: https://github.com/jjmata/sure/sessions/230a651a-b564-49fa-9563-4986fc5f2c13 Co-authored-by: jjmata <187772+jjmata@users.noreply.github.com> * Add OpenClaw service to AI compose example * Adjust OpenClaw compose and Pipelock defaults * Keep OpenClaw gateway running when unconfigured * Include Ollama in external-assistant profile * Tidy up language/simplify names * Make `profile` name more explicit (local-ai) * Clarify `local-ai` is included in OpenClaw profile * Correct internal roting for OpenClaw --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: jjmata <187772+jjmata@users.noreply.github.com>
This commit is contained in:
2
.github/workflows/update-docs.yml
vendored
2
.github/workflows/update-docs.yml
vendored
@@ -7,6 +7,8 @@ on:
|
|||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
update-docs:
|
update-docs:
|
||||||
|
if: github.repository == 'we-promise/sure'
|
||||||
|
permissions: {}
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/github-script@v8
|
- uses: actions/github-script@v8
|
||||||
|
|||||||
@@ -1,14 +1,15 @@
|
|||||||
# ===========================================================================
|
# ===========================================================================
|
||||||
# Example Docker Compose file with Ollama (local LLM) and Pipelock (agent
|
# Example Docker Compose file with Ollama (local LLM), OpenClaw (external AI
|
||||||
# security proxy)
|
# assistant), and Pipelock (agent security proxy)
|
||||||
# ===========================================================================
|
# ===========================================================================
|
||||||
#
|
#
|
||||||
# Purpose:
|
# Purpose:
|
||||||
# --------
|
# --------
|
||||||
#
|
#
|
||||||
# This file extends the standard Sure setup with two optional capabilities:
|
# This file extends the standard Sure setup with optional AI capabilities:
|
||||||
#
|
#
|
||||||
# Pipelock — agent security proxy (always runs)
|
# Pipelock — agent security proxy
|
||||||
|
# (always runs)
|
||||||
# - Forward proxy (port 8888): scans outbound HTTPS from Faraday-based
|
# - Forward proxy (port 8888): scans outbound HTTPS from Faraday-based
|
||||||
# clients (e.g. ruby-openai). NOT covered: SimpleFin, Coinbase, or
|
# clients (e.g. ruby-openai). NOT covered: SimpleFin, Coinbase, or
|
||||||
# anything using Net::HTTP/HTTParty directly. HTTPS_PROXY is
|
# anything using Net::HTTP/HTTParty directly. HTTPS_PROXY is
|
||||||
@@ -20,8 +21,16 @@
|
|||||||
# on web port 3000 (auth token required); Pipelock adds scanning
|
# on web port 3000 (auth token required); Pipelock adds scanning
|
||||||
# but Docker Compose cannot enforce network-level routing.
|
# but Docker Compose cannot enforce network-level routing.
|
||||||
#
|
#
|
||||||
# Ollama + Open WebUI — local LLM inference (optional, --profile ai)
|
# Ollama + Open WebUI — local LLM inference
|
||||||
# - Only starts when you run: docker compose --profile ai up
|
# (optional, --profile local-ai)
|
||||||
|
# - Only starts when you run: docker compose --profile local-ai up
|
||||||
|
#
|
||||||
|
# Ollama + Open WebUI + OpenClaw — external AI assistant
|
||||||
|
# (optional, --profile external-assistant)
|
||||||
|
# - Local LLM inference available via Ollama + Open WebUI
|
||||||
|
# - Starts an OpenClaw locally for Sure's external assistant mode.
|
||||||
|
# - Set EXTERNAL_ASSISTANT_URL to http://openclaw:18789/v1/chat/completions
|
||||||
|
# for internal routing.
|
||||||
#
|
#
|
||||||
# Setup:
|
# Setup:
|
||||||
# ------
|
# ------
|
||||||
@@ -36,7 +45,7 @@
|
|||||||
#
|
#
|
||||||
# If you run into problems, you should open a Discussion here:
|
# If you run into problems, you should open a Discussion here:
|
||||||
#
|
#
|
||||||
# https://github.com/we-promise/sure/discussions/categories/general
|
# https://github.com/we-promise/sure/discussions/categories/ai-usage
|
||||||
#
|
#
|
||||||
|
|
||||||
x-db-env: &db_env
|
x-db-env: &db_env
|
||||||
@@ -63,7 +72,7 @@ x-rails-env: &rails_env
|
|||||||
HTTPS_PROXY: "http://pipelock:8888"
|
HTTPS_PROXY: "http://pipelock:8888"
|
||||||
HTTP_PROXY: "http://pipelock:8888"
|
HTTP_PROXY: "http://pipelock:8888"
|
||||||
# Skip proxy for internal Docker network services (including ollama for local LLM calls)
|
# Skip proxy for internal Docker network services (including ollama for local LLM calls)
|
||||||
NO_PROXY: "db,redis,pipelock,ollama,localhost,127.0.0.1"
|
NO_PROXY: "db,redis,pipelock,ollama,openclaw,localhost,127.0.0.1"
|
||||||
AI_DEBUG_MODE: "true" # Useful for debugging, set to "false" in production
|
AI_DEBUG_MODE: "true" # Useful for debugging, set to "false" in production
|
||||||
# Ollama using OpenAI API compatible endpoints
|
# Ollama using OpenAI API compatible endpoints
|
||||||
OPENAI_ACCESS_TOKEN: token-can-be-any-value-for-ollama
|
OPENAI_ACCESS_TOKEN: token-can-be-any-value-for-ollama
|
||||||
@@ -80,7 +89,7 @@ x-rails-env: &rails_env
|
|||||||
# Set EXTERNAL_ASSISTANT_URL + TOKEN to activate, then either set ASSISTANT_TYPE=external
|
# Set EXTERNAL_ASSISTANT_URL + TOKEN to activate, then either set ASSISTANT_TYPE=external
|
||||||
# here (forces all families) or choose "External" in Settings > Self-Hosting > AI Assistant.
|
# here (forces all families) or choose "External" in Settings > Self-Hosting > AI Assistant.
|
||||||
ASSISTANT_TYPE: ${ASSISTANT_TYPE:-}
|
ASSISTANT_TYPE: ${ASSISTANT_TYPE:-}
|
||||||
EXTERNAL_ASSISTANT_URL: ${EXTERNAL_ASSISTANT_URL:-}
|
EXTERNAL_ASSISTANT_URL: ${EXTERNAL_ASSISTANT_URL:-http://openclaw:18789/v1/chat/completions}
|
||||||
EXTERNAL_ASSISTANT_TOKEN: ${EXTERNAL_ASSISTANT_TOKEN:-}
|
EXTERNAL_ASSISTANT_TOKEN: ${EXTERNAL_ASSISTANT_TOKEN:-}
|
||||||
EXTERNAL_ASSISTANT_AGENT_ID: ${EXTERNAL_ASSISTANT_AGENT_ID:-main}
|
EXTERNAL_ASSISTANT_AGENT_ID: ${EXTERNAL_ASSISTANT_AGENT_ID:-main}
|
||||||
EXTERNAL_ASSISTANT_SESSION_KEY: ${EXTERNAL_ASSISTANT_SESSION_KEY:-agent:main:main}
|
EXTERNAL_ASSISTANT_SESSION_KEY: ${EXTERNAL_ASSISTANT_SESSION_KEY:-agent:main:main}
|
||||||
@@ -121,7 +130,8 @@ services:
|
|||||||
# Note: You still have to download models manually using the ollama CLI or via Open WebUI
|
# Note: You still have to download models manually using the ollama CLI or via Open WebUI
|
||||||
ollama:
|
ollama:
|
||||||
profiles:
|
profiles:
|
||||||
- ai
|
- local-ai
|
||||||
|
- external-assistant
|
||||||
volumes:
|
volumes:
|
||||||
- ollama:/root/.ollama
|
- ollama:/root/.ollama
|
||||||
container_name: ollama
|
container_name: ollama
|
||||||
@@ -146,7 +156,8 @@ services:
|
|||||||
|
|
||||||
ollama-webui:
|
ollama-webui:
|
||||||
profiles:
|
profiles:
|
||||||
- ai
|
- local-ai
|
||||||
|
- external-assistant
|
||||||
image: ghcr.io/open-webui/open-webui
|
image: ghcr.io/open-webui/open-webui
|
||||||
container_name: ollama-webui
|
container_name: ollama-webui
|
||||||
volumes:
|
volumes:
|
||||||
@@ -169,6 +180,57 @@ services:
|
|||||||
networks:
|
networks:
|
||||||
- sure_net
|
- sure_net
|
||||||
|
|
||||||
|
# OpenClaw gateway for Sure's "external assistant" mode.
|
||||||
|
# Based on OpenClaw Docker install docs:
|
||||||
|
# https://docs.openclaw.ai/install/docker
|
||||||
|
openclaw:
|
||||||
|
profiles:
|
||||||
|
- external-assistant
|
||||||
|
image: ${OPENCLAW_IMAGE:-ghcr.io/openclaw/openclaw:latest}
|
||||||
|
hostname: openclaw
|
||||||
|
restart: unless-stopped
|
||||||
|
init: true
|
||||||
|
environment:
|
||||||
|
HOME: /home/node
|
||||||
|
TERM: xterm-256color
|
||||||
|
TZ: ${OPENCLAW_TZ:-UTC}
|
||||||
|
OPENCLAW_GATEWAY_TOKEN: ${EXTERNAL_ASSISTANT_TOKEN:-changeme}
|
||||||
|
OPENCLAW_ALLOW_INSECURE_PRIVATE_WS: ${OPENCLAW_ALLOW_INSECURE_PRIVATE_WS:-}
|
||||||
|
command:
|
||||||
|
[
|
||||||
|
"node",
|
||||||
|
"dist/index.js",
|
||||||
|
"gateway",
|
||||||
|
# OpenClaw may exit with "Missing config" on first boot in example setups.
|
||||||
|
# `--allow-unconfigured` keeps the gateway running until you complete `openclaw setup`.
|
||||||
|
"pass",
|
||||||
|
"--allow-unconfigured",
|
||||||
|
"--bind",
|
||||||
|
"${OPENCLAW_GATEWAY_BIND:-lan}",
|
||||||
|
"--port",
|
||||||
|
"18789",
|
||||||
|
]
|
||||||
|
healthcheck:
|
||||||
|
test:
|
||||||
|
[
|
||||||
|
"CMD",
|
||||||
|
"node",
|
||||||
|
"-e",
|
||||||
|
"fetch('http://127.0.0.1:18789/healthz').then((r)=>process.exit(r.ok?0:1)).catch(()=>process.exit(1))",
|
||||||
|
]
|
||||||
|
interval: 30s
|
||||||
|
timeout: 5s
|
||||||
|
retries: 5
|
||||||
|
start_period: 20s
|
||||||
|
ports:
|
||||||
|
# Expose for local onboarding/debugging. Sure uses the internal service name.
|
||||||
|
- "${OPENCLAW_GATEWAY_PORT:-18789}:18789"
|
||||||
|
volumes:
|
||||||
|
- openclaw-config:/home/node/.openclaw
|
||||||
|
- openclaw-workspace:/home/node/.openclaw/workspace
|
||||||
|
networks:
|
||||||
|
- sure_net
|
||||||
|
|
||||||
web:
|
web:
|
||||||
image: ghcr.io/we-promise/sure:stable
|
image: ghcr.io/we-promise/sure:stable
|
||||||
volumes:
|
volumes:
|
||||||
@@ -271,7 +333,10 @@ volumes:
|
|||||||
redis-data:
|
redis-data:
|
||||||
ollama:
|
ollama:
|
||||||
ollama-webui:
|
ollama-webui:
|
||||||
|
openclaw-config:
|
||||||
|
openclaw-workspace:
|
||||||
|
|
||||||
networks:
|
networks:
|
||||||
sure_net:
|
sure_net:
|
||||||
driver: bridge
|
driver: bridge
|
||||||
|
name: sure_net
|
||||||
|
|||||||
@@ -52,7 +52,7 @@ mcp_tool_scanning:
|
|||||||
detect_drift: true
|
detect_drift: true
|
||||||
|
|
||||||
mcp_tool_policy:
|
mcp_tool_policy:
|
||||||
enabled: true
|
enabled: false
|
||||||
action: warn
|
action: warn
|
||||||
# Redirect profiles (v2.0): route matched tool calls to audited handler programs
|
# Redirect profiles (v2.0): route matched tool calls to audited handler programs
|
||||||
# instead of blocking. The handler returns a synthetic MCP response.
|
# instead of blocking. The handler returns a synthetic MCP response.
|
||||||
|
|||||||
Reference in New Issue
Block a user