tuxgyver
b3ddc2117b
Le dépôt annonçait une licence « à définir », et la page À propos le signalait en rouge. C'est désormais la GNU GPL v3. Le texte est copié de la référence système plutôt que retranscrit : une licence altérée, même par inadvertance, ne vaut rien. Le README en expose la portée, y compris ce que la GPL implique pour qui redistribue une version modifiée. La page À propos porte la licence et le copyright dans son onglet Auteur, et sa pastille passe au vert.
49 lines
1.5 KiB
Markdown
49 lines
1.5 KiB
Markdown
# 🖥️ Noxely — serveur
|
|
|
|
Le serveur porte tout ce qui coûtait de la batterie au téléphone : la recherche dans les
|
|
catalogues, le guet des radios, l'enregistrement et le téléchargement. Le mobile ne fait plus que
|
|
récupérer des fichiers prêts.
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
make server-venv # crée le venv et installe les dépendances
|
|
cp server/.env.example server/.env # puis renseigner NOXELY_TOKEN
|
|
make server-run # lancement au premier plan, pour essayer
|
|
```
|
|
|
|
L'interface de pilotage est à `http://<hôte>:8710` — recherche, guets, file et bibliothèque.
|
|
Le jeton se saisit une fois dans l'en-tête de la page.
|
|
|
|
## En service
|
|
|
|
```bash
|
|
make server-install # unité systemd (sudo demandé)
|
|
make server-status # état
|
|
make server-logs # journal suivi
|
|
```
|
|
|
|
## API
|
|
|
|
| Route | Qui l'utilise |
|
|
|---|---|
|
|
| `GET /api/health` | tout le monde, sans jeton |
|
|
| `GET /api/library?since=<curseur>` | **le mobile** — uniquement ce qui a changé |
|
|
| `GET /api/media/{id}/file` | **le mobile** — le fichier |
|
|
| `GET /api/search`, `/api/tracks`, `POST /api/queue` | l'interface web |
|
|
| `GET/POST/DELETE /api/watches`, `POST /api/watches/sweep` | l'interface web |
|
|
|
|
Toutes les routes sauf `/api/health` exigent l'en-tête `X-Noxely-Token`.
|
|
|
|
## Licence
|
|
|
|
GPL v3, comme le reste du projet — voir [`../LICENSE`](../LICENSE).
|
|
|
|
## Données
|
|
|
|
```
|
|
$NOXELY_DATA/
|
|
├── noxely.sqlite3 index des médias et des guets
|
|
└── media/ les fichiers eux-mêmes
|
|
```
|