sochboard/README.md

72 lines
1.2 KiB
Markdown
Raw Permalink Normal View History

# Sochboard
2026-07-23 21:06:32 +00:00
Dashboard familial pour les applications auto-hébergées.
2026-07-23 21:06:32 +00:00
## Démarrage rapide
2026-07-23 21:06:32 +00:00
```bash
docker compose up -d
2026-07-23 21:06:32 +00:00
```
L'application est accessible sur http://localhost:3000.
## Configuration
La configuration se fait via un fichier YAML monté dans le conteneur.
2026-07-23 21:06:32 +00:00
Par défaut : `config/dashboard.yml`
2026-07-23 21:06:32 +00:00
### Structure du fichier
2026-07-23 21:06:32 +00:00
```yaml
site:
name: "Soch Family"
title: "Les applications de la famille"
description: "Accès rapide à nos services"
2026-07-23 21:06:32 +00:00
theme:
mode: "dark"
accent: "#8b5cf6"
background: "gradient"
sections:
- id: "global"
title: "Global"
description: "Services accessibles à toute la famille"
links:
- id: "nextcloud"
name: "Nextcloud"
description: "Fichiers et documents"
url: "https://cloud.example.com"
icon: "Cloud"
color: "#2daae1"
openInNewTab: true
```
2026-07-23 21:06:32 +00:00
### Icônes disponibles
2026-07-23 21:06:32 +00:00
Cloud, Film, Music, Gamepad2, Router, Server, House, BookOpen, Calendar, Mail, Shield, Settings, Globe, ExternalLink
2026-07-23 21:06:32 +00:00
## Développement
```bash
npm install
npm run dev
```
## Docker
```bash
docker compose up -d
```
Modifiez `config/dashboard.yml` puis redémarrez le conteneur :
```bash
docker compose restart
```
2026-07-23 21:06:32 +00:00
## Licence
2026-07-23 21:06:32 +00:00
MIT