52 lines
1.1 KiB
Markdown
52 lines
1.1 KiB
Markdown
# Jellomator
|
|
|
|
Dark, SQLite-backed dashboard for Arr* services and custom links.
|
|
|
|
## Features
|
|
|
|
- First-run admin setup
|
|
- Cookie-based admin auth
|
|
- Public dashboard with search/filter
|
|
- Dedicated protected admin page at `/admin`
|
|
- Link CRUD backed by SQLite
|
|
- Icon blobs stored in SQLite
|
|
- Single-container deployment
|
|
- Seeded Arr* presets on first run
|
|
|
|
## Local Dev
|
|
|
|
```bash
|
|
npm install
|
|
npm run dev
|
|
```
|
|
|
|
Backend runs on `http://localhost:6363`.
|
|
|
|
Open `/admin` for the protected management page.
|
|
|
|
## Docker
|
|
|
|
```bash
|
|
docker compose up --build
|
|
```
|
|
|
|
The app uses exactly one bind mount:
|
|
|
|
`./jellomator.sqlite:/app/data/jellomator.sqlite`
|
|
|
|
## SQLite
|
|
|
|
All data lives in SQLite, including uploaded icon blobs. There is no separate uploads directory.
|
|
The first-run setup also seeds editable defaults for Sonarr, Radarr, Lidarr, Readarr, Prowlarr, Bazarr, qBittorrent, Jellyfin, Jellyseerr, and Overseerr.
|
|
|
|
## Gitea CI/CD
|
|
|
|
Add these secrets in Gitea:
|
|
|
|
- `REGISTRY`
|
|
- `REGISTRY_USERNAME`
|
|
- `REGISTRY_PASSWORD`
|
|
- `IMAGE_NAME`
|
|
|
|
The workflow builds and pushes `latest` plus the commit SHA tag.
|