plugins/karakeep
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

verified against a live instance

Browse Source 
Every response shape written from source was right: lists, bookmarks, search and
the bookmark item's own fields. The door answers 200 with an API key and 401
without, from outside over the public hostname, first attempt - no NEXTAUTH_URL,
no cookies, no container recreate, which is the whole argument for this upstream.

The loopback trap caught this instance too: alpha:3001 answers 200 from anywhere
except alpha, where the name resolves to 127.0.1.1 and nothing is bound. Officer
runs there, so the config holds 127.0.0.1:3001.
This commit is contained in:
pastilhas
2026-09-05 21:38:47 +01:00
parent 58688365f0
commit bf6d9f5cb3
1 changed files with 23 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+23 -7
View File
@@ -62,14 +62,30 @@ Both were bugs found by running it, and both are upstream-agnostic:
repeats. Karakeep should never need this; it is here because a proxy that is correct only for the repeats. Karakeep should never need this; it is here because a proxy that is correct only for the
traffic its author happened to test is a trap for whoever changes the upstream later. traffic its author happened to test is a trap for whoever changes the upstream later.
## State ## Verified against a live instance
Written against the source, **not yet run**. The response shapes below come from 2026-09-05, against Karakeep on alpha. Every shape written from source turned out to be right:
`packages/api/routes/`, and are the first thing to verify against a live instance:
- `GET /api/v1/lists` → `{ lists: [...] }` | | |
- `GET /api/v1/bookmarks` → `{ bookmarks: [...], nextCursor }` | --- | --- |
- `GET /api/v1/bookmarks/search?q=` → the same, paginated | `GET /api/v1/lists` | `{ lists: [...] }` |
- `GET /api/v1/lists/:listId/bookmarks` → the same | `GET /api/v1/bookmarks` | `{ bookmarks: [...], nextCursor }` |
| `GET /api/v1/bookmarks/search?q=` | the same, paginated |
| a bookmark | `title`, `tags[]`, `content: { type: 'link', url, title, description }` |
And the door works from outside, over the public hostname, first attempt:
```
https://<officer>/api/karakeep/kk/api/v1/bookmarks
with an API key → 200, 20 bookmarks
without one → 401
```
No `NEXTAUTH_URL`, no cookies, no container recreate — which is the entire argument for this upstream
over the last one.
**The address the sidecar dials is loopback**, `http://127.0.0.1:3001`, and this bit again: `alpha:3001`
answers 200 from anywhere else and **000 from alpha itself**, because the name resolves to 127.0.1.1
there and Karakeep binds 127.0.0.1 and 100.64.0.1. Officer runs on that host.
No provisioning yet — `api/accounts.ts` is the next piece. No provisioning yet — `api/accounts.ts` is the next piece.