Rephl3x/Magent
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Zak Bearman
2026-01-22 22:54:13 +13:00
parent 6425345c69
commit 3eb4b3f09f
1 changed files with 26 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@@ -1,6 +1,29 @@
# Magent # 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) ## Backend (FastAPI)
@@ -49,7 +72,7 @@ Open http://localhost:3000
Admin panel: http://localhost:3000/admin 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) ## Docker (Testing)
@@ -62,7 +85,7 @@ Frontend: http://localhost:3000
## Public Hosting Notes ## 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) - `NEXT_PUBLIC_API_BASE=/api` (browser uses same-origin)
- `BACKEND_INTERNAL_URL=http://backend:8000` (container-to-container) - `BACKEND_INTERNAL_URL=http://backend:8000` (container-to-container)