Skip to content

Commit 3c03e4c

Browse files
authored
Merge pull request #50 from contextforge-org/chore/prettier-root-markdown
chore: format root markdown with Prettier
2 parents b7330ac + 2df66ba commit 3c03e4c

2 files changed

Lines changed: 11 additions & 11 deletions

File tree

DOCKER.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,11 @@ this compose file's own `redis` service (`docker-compose.yml` defaults
3636
Full reference: `.env.example` (each var has an inline comment).
3737
Summary, grouped the same way:
3838

39-
| Group | Vars | Notes |
40-
|---|---|---|
41-
| 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. |
42-
| 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. |
43-
| 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`. |
39+
| Group | Vars | Notes |
40+
| -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
41+
| 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. |
42+
| 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. |
43+
| 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`. |
4444

4545
The image itself (`Dockerfile`) sets **none** of these — it ships
4646
respecting `config.ts`'s own defaults untouched. All configuration comes

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ The web interface for ContextForge, the open source AI gateway that federates
44
tools, agents, and APIs into one endpoint.
55

66
The backing service is a separate process in a separate repository
7-
([IBM/mcp-context-forge](https://github.com/IBM/mcp-context-forge)).
7+
([IBM/mcp-context-forge](https://github.com/IBM/mcp-context-forge)).
88
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:
99

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

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

0 commit comments

Comments
 (0)