**chore(docs):** add .gitignore for docs and introduce bun.lock file
All checks were successful
CI / build-test (push) Successful in 1m2s
All checks were successful
CI / build-test (push) Successful in 1m2s
- Add `.gitignore` to exclude `node_modules/`, `.vitepress/cache/`, and `.vitepress/dist/` directories - Include `bun.lock` for dependency management with Bun
This commit is contained in:
19
docs/guide/index.md
Normal file
19
docs/guide/index.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# Getting Started
|
||||
|
||||
For quick setup instructions, see the [README](https://gitea.jeanlucmakiola.de/makiolaj/DiunDashboard#readme).
|
||||
|
||||
For development and contributing guidelines, see [CONTRIBUTING.md](https://gitea.jeanlucmakiola.de/makiolaj/DiunDashboard/src/branch/main/CONTRIBUTING.md).
|
||||
|
||||
## Overview
|
||||
|
||||
DIUN Webhook Dashboard is a Go web app that receives [DIUN](https://crazymax.dev/diun/) webhook events and shows Docker image updates in a modern React dashboard. Events are persisted to SQLite so they survive restarts.
|
||||
|
||||
## Features
|
||||
|
||||
- Receives DIUN webhooks at `POST /webhook`
|
||||
- Serves a React SPA dashboard at `/`
|
||||
- REST API for updates, tags, and acknowledgements
|
||||
- Persistent storage via SQLite
|
||||
- Tag/group system to organize images
|
||||
- Dismiss (acknowledge) updates you've reviewed
|
||||
- Optional webhook authentication via `WEBHOOK_SECRET`
|
||||
Reference in New Issue
Block a user