From 6942125240281eeeeb5fc3c2af5aa62f720b6db4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lionel=20Dupr=C3=A9?= Date: Tue, 23 Dec 2025 03:25:00 +0100 Subject: [PATCH] Add Shlink go-links documentation and update index --- docs/index.md | 107 +++++++++++++++++++++------------------ docs/reference/ports.md | 50 +++++++++++++----- docs/services/shlink.md | 109 ++++++++++++++++++++++++++++++++++++++++ mkdocs.yml | 3 +- 4 files changed, 207 insertions(+), 62 deletions(-) create mode 100644 docs/services/shlink.md diff --git a/docs/index.md b/docs/index.md index 76dc107..a6f4539 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,65 +2,76 @@ Bienvenue sur le portail de documentation de **Talloires**, le serveur domestique Raspberry Pi 5. +## 🚀 Go Links (Raccourcis) + +Accès rapide via `https://go/xxx` : + +| Raccourci | Service | Raccourci | Service | +|-----------|---------|-----------|---------| +| [go/ha](https://go/ha) | Home Assistant | [go/jf](https://go/jf) | Jellyfin | +| [go/lw](https://go/lw) | Linkwarden | [go/lt](https://go/lt) | LanguageTool | +| [go/docs](https://go/docs) | Documentation | [go/git](https://go/git) | Gitea | +| [go/grafana](https://go/grafana) | Grafana | [go/dockge](https://go/dockge) | Dockge | +| [go/shlink](https://go/shlink) | Admin Go Links | [go/auth](https://go/auth) | Authelia | + +**Tous les go-links :** ha, homeassistant, jf, jellyfin, lw, linkwarden, docs, git, auth, grafana, dockge, portainer, transmission, netdata, uptime, cockpit, vikunja, outline, lt, languagetool, cryptpad, shlink + +[Creer un nouveau go-link](https://go/shlink) + +--- + ## Services -### 🎬 Média -| Service | URL | Description | -|---------|-----|-------------| -| Jellyfin | [jellyfin.talloires.local](https://jellyfin.talloires.local) | Streaming média | -| Transmission | [transmission.talloires.local](https://transmission.talloires.local) | Client torrent | +### Media +| Service | Go Link | URL complete | +|---------|---------|--------------| +| Jellyfin | [go/jf](https://go/jf) | jellyfin.talloires.1871.zt | +| Transmission | [go/transmission](https://go/transmission) | transmission.talloires.1871.zt | -### ✅ Productivité -| Service | URL | Description | -|---------|-----|-------------| -| Vikunja | [vikunja.talloires.local](https://vikunja.talloires.local) | Gestion de tâches (Todoist-like) | -| Outline | [outline.talloires.local](https://outline.talloires.local) | Wiki collaboratif | -| Linkwarden | [linkwarden.talloires.local](https://linkwarden.talloires.local) | Bookmarks avancés | -| LanguageTool | [languagetool.talloires.local](https://languagetool.talloires.local) | Correcteur grammatical | +### Productivite +| Service | Go Link | URL complete | +|---------|---------|--------------| +| Vikunja | [go/vikunja](https://go/vikunja) | vikunja.talloires.1871.zt | +| Outline | [go/outline](https://go/outline) | outline.talloires.1871.zt | +| Linkwarden | [go/lw](https://go/lw) | linkwarden.talloires.1871.zt | +| LanguageTool | [go/lt](https://go/lt) | languagetool.talloires.1871.zt | +| CryptPad | [go/cryptpad](https://go/cryptpad) | cryptpad.1871.zt | -### 🔧 Infrastructure -| Service | URL | Description | -|---------|-----|-------------| -| Portainer | [portainer.talloires.local](https://portainer.talloires.local) | Gestion Docker | -| Dockge | [dockge.talloires.local](https://dockge.talloires.local) | Docker Compose UI | -| Gitea | [git.talloires.local](https://git.talloires.local) | Git self-hosted | -| MkDocs | [docs.talloires.local](https://docs.talloires.local) | Documentation | +### Infrastructure +| Service | Go Link | URL complete | +|---------|---------|--------------| +| Portainer | [go/portainer](https://go/portainer) | portainer.talloires.1871.zt | +| Dockge | [go/dockge](https://go/dockge) | dockge.talloires.1871.zt | +| Gitea | [go/git](https://go/git) | git.talloires.1871.zt | +| MkDocs | [go/docs](https://go/docs) | docs.talloires.1871.zt | +| Shlink | [go/shlink](https://go/shlink) | shlink.talloires.1871.zt | -### 📊 Monitoring -| Service | URL | Description | -|---------|-----|-------------| -| Grafana | [grafana.talloires.local](https://grafana.talloires.local) | Dashboards | -| Netdata | [netdata.talloires.local](https://netdata.talloires.local) | Monitoring temps réel | -| Uptime Kuma | [uptime.talloires.local](https://uptime.talloires.local) | Status des services | -| Cockpit | [cockpit.talloires.local](https://cockpit.talloires.local) | Admin système | +### Monitoring +| Service | Go Link | URL complete | +|---------|---------|--------------| +| Grafana | [go/grafana](https://go/grafana) | grafana.talloires.1871.zt | +| Netdata | [go/netdata](https://go/netdata) | netdata.talloires.1871.zt | +| Uptime Kuma | [go/uptime](https://go/uptime) | uptime.talloires.1871.zt | +| Cockpit | [go/cockpit](https://go/cockpit) | cockpit.talloires.1871.zt | -### 🏠 Domotique -| Service | URL | Description | -|---------|-----|-------------| -| Home Assistant | [homeassistant.talloires.local](https://homeassistant.talloires.local) | Domotique | +### Domotique +| Service | Go Link | URL complete | +|---------|---------|--------------| +| Home Assistant | [go/ha](https://go/ha) | homeassistant.talloires.1871.zt | -### 🔐 Sécurité -| Service | URL | Description | -|---------|-----|-------------| -| Authelia | [auth.talloires.local](https://auth.talloires.local) | SSO / 2FA | -| CrowdSec | - | Protection intrusion | +### Securite +| Service | Go Link | URL complete | +|---------|---------|--------------| +| Authelia | [go/auth](https://go/auth) | auth.talloires.1871.zt | +| CrowdSec | - | (service interne) | -## Accès ZeroTier (externe) +--- -Services accessibles via ZeroTier (sans Authelia) : - -| Service | URL | -|---------|-----| -| Vikunja | [vikunja.talloires.1871.zt](https://vikunja.talloires.1871.zt) | -| Outline | [outline.talloires.1871.zt](https://outline.talloires.1871.zt) | -| Linkwarden | [linkwarden.talloires.1871.zt](https://linkwarden.talloires.1871.zt) | -| LanguageTool | [languagetool.talloires.1871.zt](https://languagetool.talloires.1871.zt) | - -## Accès rapide +## Acces rapide - [Vue ensemble des services](services/overview.md) +- [Configuration Shlink](services/shlink.md) - [Configuration SSO](services/authelia.md) - [Backup](services/backup.md) -- [Ports utilisés](reference/ports.md) +- [Ports utilises](reference/ports.md) - [Commandes utiles](reference/commands.md) -- [Scripts de maintenance](reference/scripts.md) diff --git a/docs/reference/ports.md b/docs/reference/ports.md index 9a6fcb0..81fd3a3 100644 --- a/docs/reference/ports.md +++ b/docs/reference/ports.md @@ -1,16 +1,16 @@ -# Ports utilisés +# Ports utilises -## Ports exposés (accessibles via réseau) +## Ports exposes (accessibles via reseau) | Port | Service | Protocol | Notes | |------|---------|----------|-------| | 80 | Caddy (redirect HTTPS) | TCP | Redirige vers 443 | -| 443 | Caddy (reverse proxy) | TCP | Point d'entrée principal | -| 8096 | Jellyfin | TCP | Accès direct (optionnel) | -| 3030 | Gitea HTTP | TCP | Mappé depuis 3000 interne | -| 2222 | Gitea SSH | TCP | Mappé depuis 22 interne | +| 443 | Caddy (reverse proxy) | TCP | Point entree principal | +| 8096 | Jellyfin | TCP | Acces direct (optionnel) | +| 3030 | Gitea HTTP | TCP | Mappe depuis 3000 interne | +| 2222 | Gitea SSH | TCP | Mappe depuis 22 interne | | 8123 | Home Assistant | TCP | Mode host network | -| 9090 | Cockpit | TCP | Admin système | +| 9090 | Cockpit | TCP | Admin systeme | | 1514 | Syslog-ng | TCP/UDP | Collecte syslog | | 51413 | Transmission P2P | TCP/UDP | BitTorrent | @@ -19,25 +19,48 @@ | Port | Service(s) | Notes | |------|------------|-------| | 3001 | Uptime Kuma | | -| 3100 | Loki | Agrégation logs | +| 3100 | Loki | Agregation logs | | 3456 | Vikunja | | | 5001 | Dockge | | | 5432 | PostgreSQL | Linkwarden-db, Outline-db | | 6379 | Redis | Outline-redis | | 8000 | MkDocs | | | 8010 | LanguageTool | | +| 8080 | Shlink, Shlink-web | Go Links | | 9000 | Portainer | | | 9091 | Authelia, Transmission Web | | | 19999 | Netdata | | +## Go Links + +Acces rapide a tous les services via `https://go/xxx` + +| Go Link | Service | +|---------|---------| +| go/ha | Home Assistant | +| go/jf | Jellyfin | +| go/lw | Linkwarden | +| go/lt | LanguageTool | +| go/docs | Documentation | +| go/git | Gitea | +| go/auth | Authelia | +| go/grafana | Grafana | +| go/dockge | Dockge | +| go/portainer | Portainer | +| go/shlink | Admin Go Links | + +[Liste complete et creation de nouveaux liens](../services/shlink.md) + ## URLs par domaine -### Accès local (.talloires.local) - avec Authelia +### Acces local (.talloires.local) - avec Authelia | Service | URL | Authentification | |---------|-----|------------------| +| Go Links | https://go | Shlink | | Homepage | https://talloires.local | Authelia | | Auth | https://auth.talloires.local | - | +| Shlink Admin | https://shlink.talloires.local | Authelia | | Git | https://git.talloires.local | OIDC Authelia | | Jellyfin | https://jellyfin.talloires.local | Authelia | | Grafana | https://grafana.talloires.local | Header Auth | @@ -54,20 +77,21 @@ | Cockpit | https://cockpit.talloires.local | Authelia | | Home Assistant | https://homeassistant.talloires.local | Authelia | -### Accès ZeroTier (.talloires.1871.zt) - sans Authelia +### Acces ZeroTier (.talloires.1871.zt) - sans Authelia -Ces URLs sont accessibles depuis l'extérieur via le réseau ZeroTier, sans passer par Authelia (authentification propre à chaque service). +Ces URLs sont accessibles depuis exterieur via le reseau ZeroTier. | Service | URL | Auth native | |---------|-----|-------------| +| Go Links | https://go | Shlink | | Vikunja | https://vikunja.talloires.1871.zt | Vikunja login | | Outline | https://outline.talloires.1871.zt | OIDC Authelia | | Linkwarden | https://linkwarden.1871.zt | Linkwarden login | | LanguageTool | https://languagetool.talloires.1871.zt | Aucune (API) | -## Réseau ZeroTier +## Reseau ZeroTier -| Serveur | IP ZeroTier | Rôle | +| Serveur | IP ZeroTier | Role | |---------|-------------|------| | Talloires | 10.144.221.22 | Serveur principal (Pi5) | | Annecy | 10.144.78.193 | NAS Synology (backup) | diff --git a/docs/services/shlink.md b/docs/services/shlink.md new file mode 100644 index 0000000..dde2d29 --- /dev/null +++ b/docs/services/shlink.md @@ -0,0 +1,109 @@ +# Shlink - Go Links + +Shlink est un service de raccourcissement d URL qui permet de creer des go-links personnalises. + +## Acces + +| Interface | URL | +|-----------|-----| +| Go Links | `https://go/xxx` | +| Admin | [go/shlink](https://go/shlink) | + +## Go Links disponibles + +| Raccourci | Destination | +|-----------|-------------| +| go/ha | Home Assistant | +| go/homeassistant | Home Assistant | +| go/jf | Jellyfin | +| go/jellyfin | Jellyfin | +| go/lw | Linkwarden | +| go/linkwarden | Linkwarden | +| go/lt | LanguageTool | +| go/languagetool | LanguageTool | +| go/docs | Documentation | +| go/git | Gitea | +| go/auth | Authelia | +| go/grafana | Grafana | +| go/dockge | Dockge | +| go/portainer | Portainer | +| go/transmission | Transmission | +| go/netdata | Netdata | +| go/uptime | Uptime Kuma | +| go/cockpit | Cockpit | +| go/vikunja | Vikunja | +| go/outline | Outline | +| go/cryptpad | CryptPad | +| go/shlink | Admin Shlink | + +## Creer un nouveau go-link + +### Via interface web + +1. Aller sur [go/shlink](https://go/shlink) +2. Cliquer sur "Create short URL" +3. Entrer l URL longue et le slug personnalise + +### Via CLI + +```bash +docker exec shlink shlink short-url:create https://example.com --custom-slug=example +``` + +### Lister tous les liens + +```bash +docker exec shlink shlink short-url:list +``` + +### Supprimer un lien + +```bash +docker exec shlink shlink short-url:delete +``` + +## Configuration + +- **Domaine** : go +- **Base de donnees** : SQLite +- **Statistiques** : Activees (visites trackees) + +## Docker Compose + +Emplacement : `~/docker/shlink/docker-compose.yml` + +```yaml +services: + shlink: + image: shlinkio/shlink:stable + container_name: shlink + environment: + - DEFAULT_DOMAIN=go + - IS_HTTPS_ENABLED=true + - DB_DRIVER=sqlite + volumes: + - ./data:/etc/shlink/data + networks: + - talloires_net + + shlink-web: + image: shlinkio/shlink-web-client:stable + container_name: shlink-web + networks: + - talloires_net +``` + +## Caddy + +``` +go, go.local, go.1871.zt { + reverse_proxy shlink:8080 + tls internal +} + +shlink.talloires.local, shlink.talloires.1871.zt { + import authelia + reverse_proxy shlink-web:8080 + tls internal +} +``` diff --git a/mkdocs.yml b/mkdocs.yml index 0573758..a0718be 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -21,13 +21,14 @@ nav: - Accueil: index.md - Services: - Vue ensemble: services/overview.md + - Shlink Go Links: services/shlink.md - Authelia SSO: services/authelia.md - Backup: services/backup.md - Configuration: - Caddy: config/caddy.md - Docker Stacks: config/docker-stacks.md - Troubleshooting: config/troubleshooting.md - - Référence: + - Reference: - Ports: reference/ports.md - Commandes: reference/commands.md - Scripts: reference/scripts.md