Skip to content

Commit 35b7bb9

Browse files
AlienResidentsAlienResidents
committed
docs: update OKF entries for sidecar architecture, fonts, oauth2
- Update server.md: sidecar architecture, ports 8000+3000, k8s tags - Update webui.md: Nulshock+Science Gothic fonts, sidecar resource path - Update kubernetes.md: two-container pod, ingress routing, sidecar table - Update helm.md: webui values, ingress.className, middlewares - Update container.md: two ports, webui entrypoint, static assets Authored by Ornith 1.0 35B Q4_K_M (256K context) 👽 Directed by Chrispy <alienresidents@gmail.com>
1 parent 67bc73a commit 35b7bb9

5 files changed

Lines changed: 64 additions & 31 deletions

File tree

‎okf/deployment/container.md‎

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
type: deployment
33
title: Container Build
4-
description: Podman and Docker containerization for the REMEMBER server.
4+
description: Podman and Docker containerization for the REMEMBER server. Single image runs both MCP server and webui sidecar.
55
resource: server/Containerfile
6-
tags: [container, podman, docker, containerfile]
7-
timestamp: 2026-07-06T00:00:00Z
6+
tags: [container, podman, docker, containerfile, sidecar]
7+
timestamp: 2026-07-07T00:00:00Z
88
---
99

1010
# Container Build
@@ -28,10 +28,17 @@ docker build -f Dockerfile -t remember-server:latest .
2828
## Running
2929

3030
```bash
31+
# MCP server only
3132
podman run -p 8000:8000 \
3233
-e REMEMBER_DATABASE_URL=postgresql+asyncpg://db:5432/remember \
3334
-e REMEMBER_AUTH_DEV_MODE=true \
3435
remember-server:latest
36+
37+
# Web UI only (sidecar mode)
38+
podman run -p 3000:3000 \
39+
-e REMEMBER_DATABASE_URL=postgresql+asyncpg://db:5432/remember \
40+
-e REMEMBER_AUTH_DEV_MODE=true \
41+
remember-server:latest --command="python -m remember.web"
3542
```
3643

3744
## Image Details
@@ -41,8 +48,9 @@ podman run -p 8000:8000 \
4148
| Base image | python:3.14-slim |
4249
| User | non-root (`remember`) |
4350
| Filesystem | read-only (except `/tmp`) |
44-
| Exposed port | 8000 |
45-
| Entrypoint | `python -m remember.server` |
51+
| Exposed ports | 8000 (MCP), 3000 (webui) |
52+
| Entrypoint | `python -m uvicorn remember.server:app` (server) or `python -m remember.web` (webui) |
53+
| Static assets | `webui/` directory (index.html, styles.css, app.js, fonts/) |
4654

4755
## Related Concepts
4856

‎okf/deployment/helm.md‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
type: deployment
33
title: Helm Chart
4-
description: Helm chart for easy REMEMBER deployment and configuration.
4+
description: Helm chart for easy REMEMBER deployment and configuration. Includes webui sidecar and oauth2-proxy integration.
55
resource: helm/remember/
6-
tags: [helm, charts, deployment]
7-
timestamp: 2026-07-06T00:00:00Z
6+
tags: [helm, charts, deployment, sidecar, oauth2]
7+
timestamp: 2026-07-07T00:00:00Z
88
---
99

1010
# Helm Chart
@@ -39,7 +39,11 @@ helm/remember/
3939
| `auth.devMode` | Enable dev auth | `false` |
4040
| `auth.github.enabled` | Enable GitHub OAuth | `false` |
4141
| `ingress.enabled` | Enable ingress | `true` |
42+
| `ingress.className` | Ingress class (traefik/nginx) | `nginx` |
43+
| `ingress.middlewares` | Traefik middlewares (oauth2-proxy, etc.) | `traefik-https-redirect@kubernetescrd` |
4244
| `database.url` | Database connection string | Required |
45+
| `webui.enabled` | Enable webui sidecar | `true` |
46+
| `webui.replicaCount` | Webui replicas | `1` |
4347

4448
## Install
4549

‎okf/deployment/kubernetes.md‎

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
type: deployment
33
title: Kubernetes
4-
description: Kubernetes manifests for production deployment.
4+
description: Kubernetes manifests for production deployment. Two containers per pod: server (MCP) + webui (sidecar).
55
resource: k8s/base/
6-
tags: [kubernetes, deployment, production]
7-
timestamp: 2026-07-06T00:00:00Z
6+
tags: [kubernetes, deployment, production, sidecar]
7+
timestamp: 2026-07-07T00:00:00Z
88
---
99

1010
# Kubernetes
@@ -17,13 +17,22 @@ Kubernetes manifests for production deployment. Includes Deployment, Service, In
1717

1818
| Manifest | Purpose |
1919
|----------|---------|
20-
| `server-deployment.yaml` | Stateless server deployment (2 replicas default) |
21-
| `server-service.yaml` | ClusterIP service on port 8000 |
22-
| `ingress.yaml` | Ingress with `/mcp` path |
20+
| `server-deployment.yaml` | Deployment with server + webui sidecar containers |
21+
| `server-service.yaml` | ClusterIP service exposing ports 8000 (MCP) and 3000 (webui) |
22+
| `ingress.yaml` | Ingress routing `/mcp` → server:8000, `/` → webui:3000 |
2323
| `hpa.yaml` | Horizontal pod autoscaler (2-10 replicas) |
2424
| `pdb.yaml` | Pod disruption budget (minAvailable: 1) |
2525
| `secret-example.yaml` | Secret template (fill in values) |
2626

27+
## Container Architecture
28+
29+
Each pod runs two containers:
30+
31+
| Container | Image Command | Port | Purpose |
32+
|-----------|---------------|------|---------|
33+
| `server` | `uvicorn remember.server:app` | 8000 | FastMCP server for AI assistants |
34+
| `webui` | `python -m remember.web` | 3000 | Sci-fi themed web interface |
35+
2736
## Deployment
2837

2938
```bash

‎okf/server.md‎

Lines changed: 24 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
type: server
33
title: REMEMBER Server
4-
description: Stateless FastMCP server for team memory storage and retrieval. Horizontally scalable with pluggable authentication.
4+
description: Stateless FastMCP server for team memory storage and retrieval. Horizontally scalable with pluggable authentication. Runs alongside webui sidecar in Kubernetes.
55
resource: https://github.com/AlienResidents/remember
6-
tags: [fastmcp, python, stateless, mcp]
7-
timestamp: 2026-07-06T00:00:00Z
6+
tags: [fastmcp, python, stateless, mcp, kubernetes]
7+
timestamp: 2026-07-07T00:00:00Z
88
---
99

1010
# REMEMBER Server
@@ -23,14 +23,18 @@ Developer workstations Kubernetes Cluster
2323
│ + CLI tool │──MCP/HTTPS──▶│ ┌────────────────────┐ │
2424
└─────────────────────┘ │ │ remember-server │ │
2525
│ │ (FastMCP, Python) │ │
26-
│ │ N replicas, stateless│ │
27-
│ └─────────┬──────────┘ │
28-
│ │ SQL │
29-
│ ▼ │
30-
│ ┌────────────────────┐ │
31-
│ │ remember-db │ │
32-
│ │ Postgres + pgvector│ │
33-
│ └────────────────────┘ │
26+
│ │ + webui sidecar │ │
27+
│ │ N replicas, state- │ │
28+
│ │ less │ │
29+
│ └──────┬───────┬─────┘ │
30+
│ │ │ │
31+
│ MCP │ SQL │ / │
32+
│ (tools) │ │ (web) │
33+
│ ▼ ▼ │
34+
│ ┌────────────────────────┐│
35+
│ │ remember-db ││
36+
│ │ Postgres + pgvector ││
37+
│ └────────────────────────┘│
3438
└──────────────────────────┘
3539
```
3640

@@ -66,11 +70,19 @@ All configuration via environment variables (prefixed `REMEMBER_`) or YAML confi
6670

6771
See [config.example.yaml](../server/config.example.yaml) for full YAML format.
6872

73+
## Ports
74+
75+
| Port | Service |
76+
|------|---------|
77+
| 8000 | MCP server (FastMCP) |
78+
| 3000 | Web UI (FastAPI, sidecar) |
79+
| 9090 | Prometheus metrics |
80+
6981
## Monitoring
7082

7183
| Endpoint | Purpose |
7284
|----------|---------|
73-
| `/healthz` | Health check |
85+
| `/healthz` | Health check (both containers) |
7486
| `/metrics` | Prometheus metrics |
7587

7688
## Related Concepts

‎okf/webui.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
type: webui
33
title: Web Interface
4-
description: Sci-fi themed FastAPI web UI for browsing and managing memories.
5-
resource: webui/
6-
tags: [webui, fastapi, sci-fi]
7-
timestamp: 2026-07-06T00:00:00Z
4+
description: Sci-fi themed FastAPI web UI for browsing and managing memories. Runs as sidecar container on port 3000.
5+
resource: server/webui/
6+
tags: [webui, fastapi, sci-fi, sidecar]
7+
timestamp: 2026-07-07T00:00:00Z
88
---
99

1010
# Web Interface
@@ -31,7 +31,7 @@ Sci-fi themed web interface for browsing and managing memories without an AI ass
3131
| Backend | FastAPI |
3232
| Frontend | Vanilla JS, CSS animations |
3333
| Styling | Custom sci-fi theme (neon cyan/purple) |
34-
| Fonts | Orbitron (display), Rajdhani (body) |
34+
| Fonts | Nulshock (display, local), Science Gothic (body, Google Fonts) |
3535

3636
## Running
3737

0 commit comments

Comments
 (0)