lionel/202512docs
Archived
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add Shlink go-links documentation and update index

Browse Source
This commit is contained in:
Lionel Dupré
2025-12-23 03:25:00 +01:00
parent c15da603a6
commit 6942125240
4 changed files with 207 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files

107
docs/index.md
View File

@@ -2,65 +2,76 @@
Bienvenue sur le portail de documentation de **Talloires**, le serveur domestique Raspberry Pi 5. 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 ## Services
### 🎬 Média ### Media
| Service | URL | Description | | Service | Go Link | URL complete |
|---------|-----|-------------| |---------|---------|--------------|
| Jellyfin | [jellyfin.talloires.local](https://jellyfin.talloires.local) | Streaming média | | Jellyfin | [go/jf](https://go/jf) | jellyfin.talloires.1871.zt |
| Transmission | [transmission.talloires.local](https://transmission.talloires.local) | Client torrent | | Transmission | [go/transmission](https://go/transmission) | transmission.talloires.1871.zt |
### ✅ Productivité ### Productivite
| Service | URL | Description | | Service | Go Link | URL complete |
|---------|-----|-------------| |---------|---------|--------------|
| Vikunja | [vikunja.talloires.local](https://vikunja.talloires.local) | Gestion de tâches (Todoist-like) | | Vikunja | [go/vikunja](https://go/vikunja) | vikunja.talloires.1871.zt |
| Outline | [outline.talloires.local](https://outline.talloires.local) | Wiki collaboratif | | Outline | [go/outline](https://go/outline) | outline.talloires.1871.zt |
| Linkwarden | [linkwarden.talloires.local](https://linkwarden.talloires.local) | Bookmarks avancés | | Linkwarden | [go/lw](https://go/lw) | linkwarden.talloires.1871.zt |
| LanguageTool | [languagetool.talloires.local](https://languagetool.talloires.local) | Correcteur grammatical | | LanguageTool | [go/lt](https://go/lt) | languagetool.talloires.1871.zt |
| CryptPad | [go/cryptpad](https://go/cryptpad) | cryptpad.1871.zt |
### 🔧 Infrastructure ### Infrastructure
| Service | URL | Description | | Service | Go Link | URL complete |
|---------|-----|-------------| |---------|---------|--------------|
| Portainer | [portainer.talloires.local](https://portainer.talloires.local) | Gestion Docker | | Portainer | [go/portainer](https://go/portainer) | portainer.talloires.1871.zt |
| Dockge | [dockge.talloires.local](https://dockge.talloires.local) | Docker Compose UI | | Dockge | [go/dockge](https://go/dockge) | dockge.talloires.1871.zt |
| Gitea | [git.talloires.local](https://git.talloires.local) | Git self-hosted | | Gitea | [go/git](https://go/git) | git.talloires.1871.zt |
| MkDocs | [docs.talloires.local](https://docs.talloires.local) | Documentation | | MkDocs | [go/docs](https://go/docs) | docs.talloires.1871.zt |
| Shlink | [go/shlink](https://go/shlink) | shlink.talloires.1871.zt |
### 📊 Monitoring ### Monitoring
| Service | URL | Description | | Service | Go Link | URL complete |
|---------|-----|-------------| |---------|---------|--------------|
| Grafana | [grafana.talloires.local](https://grafana.talloires.local) | Dashboards | | Grafana | [go/grafana](https://go/grafana) | grafana.talloires.1871.zt |
| Netdata | [netdata.talloires.local](https://netdata.talloires.local) | Monitoring temps réel | | Netdata | [go/netdata](https://go/netdata) | netdata.talloires.1871.zt |
| Uptime Kuma | [uptime.talloires.local](https://uptime.talloires.local) | Status des services | | Uptime Kuma | [go/uptime](https://go/uptime) | uptime.talloires.1871.zt |
| Cockpit | [cockpit.talloires.local](https://cockpit.talloires.local) | Admin système | | Cockpit | [go/cockpit](https://go/cockpit) | cockpit.talloires.1871.zt |
### 🏠 Domotique ### Domotique
| Service | URL | Description | | Service | Go Link | URL complete |
|---------|-----|-------------| |---------|---------|--------------|
| Home Assistant | [homeassistant.talloires.local](https://homeassistant.talloires.local) | Domotique | | Home Assistant | [go/ha](https://go/ha) | homeassistant.talloires.1871.zt |
### 🔐 Sécurité ### Securite
| Service | URL | Description | | Service | Go Link | URL complete |
|---------|-----|-------------| |---------|---------|--------------|
| Authelia | [auth.talloires.local](https://auth.talloires.local) | SSO / 2FA | | Authelia | [go/auth](https://go/auth) | auth.talloires.1871.zt |
| CrowdSec | - | Protection intrusion | | CrowdSec | - | (service interne) |
## Accès ZeroTier (externe) ---
Services accessibles via ZeroTier (sans Authelia) : ## Acces rapide
| 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
- [Vue ensemble des services](services/overview.md) - [Vue ensemble des services](services/overview.md)
- [Configuration Shlink](services/shlink.md)
- [Configuration SSO](services/authelia.md) - [Configuration SSO](services/authelia.md)
- [Backup](services/backup.md) - [Backup](services/backup.md)
- [Ports utilisés](reference/ports.md) - [Ports utilises](reference/ports.md)
- [Commandes utiles](reference/commands.md) - [Commandes utiles](reference/commands.md)
- [Scripts de maintenance](reference/scripts.md)

50
docs/reference/ports.md
View File

@@ -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 | | Port | Service | Protocol | Notes |
|------|---------|----------|-------| |------|---------|----------|-------|
| 80 | Caddy (redirect HTTPS) | TCP | Redirige vers 443 | | 80 | Caddy (redirect HTTPS) | TCP | Redirige vers 443 |
| 443 | Caddy (reverse proxy) | TCP | Point d'entrée principal | | 443 | Caddy (reverse proxy) | TCP | Point entree principal |
| 8096 | Jellyfin | TCP | Accès direct (optionnel) | | 8096 | Jellyfin | TCP | Acces direct (optionnel) |
| 3030 | Gitea HTTP | TCP | Mappé depuis 3000 interne | | 3030 | Gitea HTTP | TCP | Mappe depuis 3000 interne |
| 2222 | Gitea SSH | TCP | Mappé depuis 22 interne | | 2222 | Gitea SSH | TCP | Mappe depuis 22 interne |
| 8123 | Home Assistant | TCP | Mode host network | | 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 | | 1514 | Syslog-ng | TCP/UDP | Collecte syslog |
| 51413 | Transmission P2P | TCP/UDP | BitTorrent | | 51413 | Transmission P2P | TCP/UDP | BitTorrent |
@@ -19,25 +19,48 @@
| Port | Service(s) | Notes | | Port | Service(s) | Notes |
|------|------------|-------| |------|------------|-------|
| 3001 | Uptime Kuma | | | 3001 | Uptime Kuma | |
| 3100 | Loki | Agrégation logs | | 3100 | Loki | Agregation logs |
| 3456 | Vikunja | | | 3456 | Vikunja | |
| 5001 | Dockge | | | 5001 | Dockge | |
| 5432 | PostgreSQL | Linkwarden-db, Outline-db | | 5432 | PostgreSQL | Linkwarden-db, Outline-db |
| 6379 | Redis | Outline-redis | | 6379 | Redis | Outline-redis |
| 8000 | MkDocs | | | 8000 | MkDocs | |
| 8010 | LanguageTool | | | 8010 | LanguageTool | |
| 8080 | Shlink, Shlink-web | Go Links |
| 9000 | Portainer | | | 9000 | Portainer | |
| 9091 | Authelia, Transmission Web | | | 9091 | Authelia, Transmission Web | |
| 19999 | Netdata | | | 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 ## URLs par domaine
### Accès local (.talloires.local) - avec Authelia ### Acces local (.talloires.local) - avec Authelia
| Service | URL | Authentification | | Service | URL | Authentification |
|---------|-----|------------------| |---------|-----|------------------|
| Go Links | https://go | Shlink |
| Homepage | https://talloires.local | Authelia | | Homepage | https://talloires.local | Authelia |
| Auth | https://auth.talloires.local | - | | Auth | https://auth.talloires.local | - |
| Shlink Admin | https://shlink.talloires.local | Authelia |
| Git | https://git.talloires.local | OIDC Authelia | | Git | https://git.talloires.local | OIDC Authelia |
| Jellyfin | https://jellyfin.talloires.local | Authelia | | Jellyfin | https://jellyfin.talloires.local | Authelia |
| Grafana | https://grafana.talloires.local | Header Auth | | Grafana | https://grafana.talloires.local | Header Auth |
@@ -54,20 +77,21 @@
| Cockpit | https://cockpit.talloires.local | Authelia | | Cockpit | https://cockpit.talloires.local | Authelia |
| Home Assistant | https://homeassistant.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 | | Service | URL | Auth native |
|---------|-----|-------------| |---------|-----|-------------|
| Go Links | https://go | Shlink |
| Vikunja | https://vikunja.talloires.1871.zt | Vikunja login | | Vikunja | https://vikunja.talloires.1871.zt | Vikunja login |
| Outline | https://outline.talloires.1871.zt | OIDC Authelia | | Outline | https://outline.talloires.1871.zt | OIDC Authelia |
| Linkwarden | https://linkwarden.1871.zt | Linkwarden login | | Linkwarden | https://linkwarden.1871.zt | Linkwarden login |
| LanguageTool | https://languagetool.talloires.1871.zt | Aucune (API) | | 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) | | Talloires | 10.144.221.22 | Serveur principal (Pi5) |
| Annecy | 10.144.78.193 | NAS Synology (backup) | | Annecy | 10.144.78.193 | NAS Synology (backup) |

109
docs/services/shlink.md Normal file
View File

@@ -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 <short-code>
```
## 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
}
```

3
mkdocs.yml
View File

@@ -21,13 +21,14 @@ nav:
- Accueil: index.md - Accueil: index.md
- Services: - Services:
- Vue ensemble: services/overview.md - Vue ensemble: services/overview.md
- Shlink Go Links: services/shlink.md
- Authelia SSO: services/authelia.md - Authelia SSO: services/authelia.md
- Backup: services/backup.md - Backup: services/backup.md
- Configuration: - Configuration:
- Caddy: config/caddy.md - Caddy: config/caddy.md
- Docker Stacks: config/docker-stacks.md - Docker Stacks: config/docker-stacks.md
- Troubleshooting: config/troubleshooting.md - Troubleshooting: config/troubleshooting.md
- Référence: - Reference:
- Ports: reference/ports.md - Ports: reference/ports.md
- Commandes: reference/commands.md - Commandes: reference/commands.md
- Scripts: reference/scripts.md - Scripts: reference/scripts.md