first commit
This commit is contained in:
46
README.md
Normal file
46
README.md
Normal file
@@ -0,0 +1,46 @@
|
||||
# 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
|
||||
- Link CRUD backed by SQLite
|
||||
- Icon blobs stored in SQLite
|
||||
- Single-container deployment
|
||||
|
||||
## Local Dev
|
||||
|
||||
```bash
|
||||
npm install
|
||||
npm run dev
|
||||
```
|
||||
|
||||
Backend runs on `http://localhost:6363`.
|
||||
|
||||
## 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.
|
||||
|
||||
## 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.
|
||||
Reference in New Issue
Block a user