From 3eb4b3f09f60d58730c9f80eb2abfb9ae35d1cdb Mon Sep 17 00:00:00 2001 From: Rephl3x Date: Thu, 22 Jan 2026 22:54:13 +1300 Subject: [PATCH] Update README --- README.md | 29 ++++++++++++++++++++++++++--- 1 file changed, 26 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a0cfd18..793bdb9 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,29 @@ # Magent -AI-powered request timeline for Jellyseerr + Arr stack. +Magent is a friendly, AI-assisted request tracker for Jellyseerr + Arr services. It shows a clear timeline of where a request is stuck, explains what is happening in plain English, and offers safe actions to help fix issues. + +## How it works + +1) Requests are pulled from Jellyseerr and stored locally. +2) Magent joins that request to Sonarr/Radarr, Prowlarr, qBittorrent, and Jellyfin using TMDB/TVDB IDs and download hashes. +3) A state engine normalizes noisy service statuses into a simple, user-friendly state. +4) The UI renders a timeline and a central status box for each request. +5) Optional AI triage summarizes the likely cause and safest next steps. + +## Core features + +- Request search by title/year or request ID. +- Recent requests list with posters and status. +- Timeline view across Jellyseerr, Arr, Prowlarr, qBittorrent, Jellyfin. +- Central status box with clear reason + next steps. +- Safe action buttons (search, resume, re-add, etc.). +- Admin settings for service URLs, API keys, profiles, and root folders. +- Health status for each service in the pipeline. +- Cache and sync controls (full sync, delta sync, scheduled syncs). +- Local database for speed and audit history. +- Users and access control (admin vs user, block access). +- Local account password changes via "My profile". +- Docker-first deployment for easy hosting. ## Backend (FastAPI) @@ -49,7 +72,7 @@ Open http://localhost:3000 Admin panel: http://localhost:3000/admin -Login uses the admin credentials above (or any other user you create in SQLite). +Login uses the admin credentials above (or any other local user you create in SQLite). ## Docker (Testing) @@ -62,7 +85,7 @@ Frontend: http://localhost:3000 ## Public Hosting Notes -The frontend now proxies `/api/*` to the backend container. Set: +The frontend proxies `/api/*` to the backend container. Set: - `NEXT_PUBLIC_API_BASE=/api` (browser uses same-origin) - `BACKEND_INTERNAL_URL=http://backend:8000` (container-to-container)