updated documentation to reflect additions of new project, settings, and UI restructure
This commit is contained in:
@@ -32,6 +32,7 @@ or inference services — all traffic flows through orchestration.
|
||||
| MODELS_MANIFEST_PATH | Yes | — | Path to `models.json` manifest file |
|
||||
|
||||
## Internal Structure
|
||||
|
||||
```
|
||||
src/
|
||||
├── services/
|
||||
@@ -44,6 +45,7 @@ src/
|
||||
├── routes/
|
||||
│ ├── chat.js # POST /chat and POST /chat/stream route handlers
|
||||
│ ├── sessions.js # Session list, history, rename, and delete routes
|
||||
│ ├── projects.js # Project CRUD routes — proxies to memory service
|
||||
│ └── models.js # GET /models — reads models.json manifest from disk
|
||||
└── index.js # Express app entry point
|
||||
```
|
||||
@@ -87,6 +89,7 @@ the client.
|
||||
count to the client.
|
||||
|
||||
## Prompt Structure
|
||||
|
||||
```
|
||||
[System prompt]
|
||||
|
||||
@@ -174,6 +177,17 @@ are added or removed.
|
||||
| PATCH | /sessions/:sessionId | Rename a session |
|
||||
| DELETE | /sessions/:sessionId | Delete a session and all its episodes |
|
||||
|
||||
### Projects
|
||||
|
||||
Projects are proxied directly from the memory service with no transformation.
|
||||
|
||||
| Method | Path | Description |
|
||||
|---|---|---|
|
||||
| GET | /projects | Get all projects |
|
||||
| POST | /projects | Create a new project |
|
||||
| PATCH | /projects/:id | Update a project |
|
||||
| DELETE | /projects/:id | Delete a project |
|
||||
|
||||
### Models
|
||||
|
||||
| Method | Path | Description |
|
||||
@@ -279,4 +293,27 @@ Returns the parsed contents of `models.json`:
|
||||
]
|
||||
```
|
||||
|
||||
Returns `500` if the manifest file cannot be read or parsed.
|
||||
Returns `500` if the manifest file cannot be read or parsed.
|
||||
|
||||
## Caddy Configuration
|
||||
|
||||
The Caddy reverse proxy on Mini PC 2 must have a handle block for each route
|
||||
prefix the client needs to reach. Current required blocks:
|
||||
|
||||
```
|
||||
handle /chat* {
|
||||
reverse_proxy localhost:4000
|
||||
}
|
||||
handle /sessions* {
|
||||
reverse_proxy localhost:4000
|
||||
}
|
||||
handle /models* {
|
||||
reverse_proxy localhost:4000
|
||||
}
|
||||
handle /projects* {
|
||||
reverse_proxy localhost:4000
|
||||
}
|
||||
```
|
||||
|
||||
When adding new top-level routes to the orchestration service, add a matching
|
||||
block here and reload Caddy: `caddy reload --config /path/to/Caddyfile`
|
||||
Reference in New Issue
Block a user