Skip to content

chore: format root markdown with Prettier #50

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
marekdano merged 1 commit into from
Aug 19, 2026
Merged

chore: format root markdown with Prettier #50

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions DOCKER.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,11 @@ this compose file's own `redis` service (`docker-compose.yml` defaults
Full reference: `.env.example` (each var has an inline comment).
Summary, grouped the same way:

| Group | Vars | Notes |
|---|---|---|
| Works out of the box | `COOKIE_SECURE=false` | Required (or set `PUBLIC_ORIGIN`/`TRUST_PROXY`) for a zero-config boot — `server/src/config.ts` fails closed otherwise. |
| Must be set | `CONTEXTFORGE_URL` | No safe default reaches your gateway from inside the container. **No boot-time check catches a missing/wrong value** — it just fails every `/api/*` call at request time. Top thing to check if API calls all connection-refuse. |
| Fine as-is for dev | `PORT`, `HOST`, `CONTEXTFORGE_AUTH_HEADER_NAME`, `SESSION_TTL_SECONDS`, `REDIS_KEY_PREFIX`, `COOKIE_DOMAIN`, `TRUST_PROXY`, `PUBLIC_ORIGIN`, `SSE_SESSION_RECHECK_SECONDS`, `LOG_LEVEL` | Defaults match `server/src/config.ts`. |
| Group | Vars | Notes |
| -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Works out of the box | `COOKIE_SECURE=false` | Required (or set `PUBLIC_ORIGIN`/`TRUST_PROXY`) for a zero-config boot — `server/src/config.ts` fails closed otherwise. |
| Must be set | `CONTEXTFORGE_URL` | No safe default reaches your gateway from inside the container. **No boot-time check catches a missing/wrong value** — it just fails every `/api/*` call at request time. Top thing to check if API calls all connection-refuse. |
| Fine as-is for dev | `PORT`, `HOST`, `CONTEXTFORGE_AUTH_HEADER_NAME`, `SESSION_TTL_SECONDS`, `REDIS_KEY_PREFIX`, `COOKIE_DOMAIN`, `TRUST_PROXY`, `PUBLIC_ORIGIN`, `SSE_SESSION_RECHECK_SECONDS`, `LOG_LEVEL` | Defaults match `server/src/config.ts`. |

The image itself (`Dockerfile`) sets **none** of these — it ships
respecting `config.ts`'s own defaults untouched. All configuration comes
Expand Down
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ The web interface for ContextForge, the open source AI gateway that federates
tools, agents, and APIs into one endpoint.

The backing service is a separate process in a separate repository
([IBM/mcp-context-forge](https://github.com/IBM/mcp-context-forge)).
([IBM/mcp-context-forge](https://github.com/IBM/mcp-context-forge)).
This repository holds the BFF and client that sit in front of it. The table below also documents the API for naming reference, though it lives in a separate repo:

| Component | Lives in | Role |
| --------- | -------- | ---- |
| **ContextForge API** | separate repo | FastAPI service that owns auth and all business data |
| **BFF** | `server/` | Fastify app holding the session/CSRF boundary in front of the API |
| **Client** | `src/` | React SPA, served as static files by the BFF |
| Component | Lives in | Role |
| -------------------- | ------------- | ----------------------------------------------------------------- |
| **ContextForge API** | separate repo | FastAPI service that owns auth and all business data |
| **BFF** | `server/` | Fastify app holding the session/CSRF boundary in front of the API |
| **Client** | `src/` | React SPA, served as static files by the BFF |

Throughout this README, "the API", "the BFF", and "the client" refer to those
three. The browser only ever talks to the BFF, never directly to the API.
Expand Down
Loading