Harden private media and backup recovery; add V2 deployment and migration guides
This commit is contained in:
parent
c549c34f60
commit
ffaa1f6afa
19 changed files with 623 additions and 14 deletions
44
docs/AI.md
Normal file
44
docs/AI.md
Normal file
|
|
@ -0,0 +1,44 @@
|
|||
# AI connections and verification
|
||||
|
||||
Settings → AI manages provider connections and model routing. Add a connection, test it,
|
||||
discover models where supported (or add a custom model), enable models and select defaults
|
||||
for generation, chat, explanations and vision. Output limits, capabilities, pricing and
|
||||
reasoning settings can be edited per model. Catalog prices are estimates, not billing records.
|
||||
|
||||
Adapters use OpenAI Responses, Anthropic Messages, Gemini generateContent, OpenAI-compatible
|
||||
Chat Completions and Ollama's native chat API. Configure the endpoint as shown in Settings.
|
||||
Local models are reached **from the server/container**: `localhost` inside Docker is the
|
||||
container itself, not your workstation or Unraid host. Use a reachable LAN address instead.
|
||||
|
||||
Keys are encrypted with AES-256-GCM in SQLite using `/data/secret.key` or `APP_SECRET`.
|
||||
Only the server decrypts them. Keep the key with backups; changing it breaks decryption.
|
||||
Documents are sent to the selected provider when you request AI processing; extraction and
|
||||
full-text indexing otherwise run locally. OCR requires a compatible vision/PDF model.
|
||||
Retrieval uses chunked SQLite FTS search; it is lexical retrieval, not embedding similarity.
|
||||
Review generated nursing content and source references before using it for study.
|
||||
|
||||
## ChatGPT account investigation (2026-11-11)
|
||||
|
||||
The official [Sign in with ChatGPT quickstart](https://developers.openai.com/siwc/quickstart)
|
||||
now describes plan access for eligible integrations. The
|
||||
[official implementation guide](https://developers.openai.com/cookbook/articles/sign-in-with-chatgpt)
|
||||
distinguishes local personal/open-source tools from remotely hosted apps, which require
|
||||
access approval. This Unraid/reverse-proxy deployment is a hosted web application; eligibility
|
||||
for its private client has not been established. Therefore V2 currently uses conventional API
|
||||
connections, and does not advertise ChatGPT plan access or reuse another client's credentials.
|
||||
|
||||
To add this later, obtain the appropriate approval/registration and implement the documented
|
||||
OAuth/PKCE flow, verified identity, encrypted refresh tokens, approved callbacks and plan-scoped
|
||||
model discovery. Keep this separate from the single administrator's local login. Never copy
|
||||
ChatGPT browser session tokens or a Codex client's registration/credentials into Study Desk.
|
||||
|
||||
## What has been tested
|
||||
|
||||
Mock protocol tests cover request translation, streams, tools, usage and error handling.
|
||||
Integration tests use a local OpenAI-compatible mock to generate/edit/save drafts, search
|
||||
documents with citations and exercise confirmed assistant actions. They cost no API credits.
|
||||
No successful real-provider inference or real ChatGPT OAuth authorization is claimed.
|
||||
|
||||
For manual local AI testing: `npx tsx scripts/mock-ai.ts` starts a scripted mock at
|
||||
`http://localhost:4010/v1` with key `mock-key`. It returns clearly labeled synthetic material.
|
||||
Do not use mock output as nursing guidance. Stop the mock and remove its connection after QA.
|
||||
Loading…
Add table
Add a link
Reference in a new issue