Hermes Agent
136 lines
4.2 KiB
Markdown
136 lines
4.2 KiB
Markdown
# AliasVault VPS Deployment mit Icons für Unraid
|
||
|
||
Dieses Repository enthält die optimierte Docker Compose-Konfiguration für die Bereitstellung von AliasVault auf einem VPS, inklusive Icons für Unraid und andere Docker Management-UIs.
|
||
|
||
## 📁 **Dateistruktur**
|
||
|
||
```
|
||
aliasvault-vps/
|
||
├── docker-compose.vps.yml # Optimierte Compose-Datei mit Icon-Labels
|
||
├── .env.example # Deutsche Konfigurationsvorlage
|
||
├── README.md # Diese Dokumentation
|
||
├── setup.sh # Automatisches Setup-Skript
|
||
└── aliasvault-icon.png # Haupticon für AliasVault
|
||
```
|
||
|
||
## 🎨 **Icons für Services**
|
||
|
||
Die `docker-compose.vps.yml` enthält jetzt **Icon-Labels** für jeden Service:
|
||
|
||
### **Verwendete Labels**
|
||
- `com.docker.compose.service-icon` – Standard Docker Compose Label
|
||
- `com.unraid.icon` – Unraid-spezifisches Label
|
||
- `icon` – Generisches Label für andere Tools
|
||
|
||
### **Service-Icons**
|
||
Jeder Service hat ein passendes Icon von [FlatIcon](https://www.flaticon.com):
|
||
|
||
| Service | Icon | Zweck |
|
||
|---------|------|-------|
|
||
| **postgres** | 🐘 PostgreSQL Icon | Datenbank |
|
||
| **client** | 🌐 Web Icon | Web Client |
|
||
| **api** | ⚙️ API Icon | API Server |
|
||
| **admin** | 🛡️ Admin Icon | Admin Interface |
|
||
| **smtp** | ✉️ Email Icon | SMTP Server |
|
||
| **task-runner** | 🏃 Runner Icon | Background Tasks |
|
||
| **reverse-proxy** | 🔄 Proxy Icon | Nginx Reverse Proxy |
|
||
|
||
## 🔄 **Dockhand-Workflow**
|
||
|
||
Da du **Dockhand** für das Management verwendest:
|
||
|
||
1. **Git Repository** → `docker-compose.vps.yml` (Konfiguration + Icons)
|
||
2. **Dockhand** → `.env` Verwaltung (Sensible Daten)
|
||
3. **Dockhand Deployment** → Container auf Hosts
|
||
|
||
### **Dockhand-spezifische Hinweise**
|
||
- **Icons werden automatisch** von Unraid/Portainer angezeigt, wenn sie die Labels unterstützen
|
||
- **Environment Variablen** bleiben in Dockhand verwaltet
|
||
- **.env.example** dient als Vorlage für Dockhand-Configuration
|
||
|
||
## 🚀 **Schnelle Bereitstellung**
|
||
|
||
```bash
|
||
# 1. Repository klonen
|
||
git clone https://git.schoettler-mk.de/schoettik/aliasvault-vps.git /opt/aliasvault
|
||
cd /opt/aliasvault
|
||
|
||
# 2. Setup ausführen
|
||
chmod +x setup.sh
|
||
./setup.sh
|
||
```
|
||
|
||
## ⚙️ **Konfiguration in `.env`**
|
||
|
||
### **Für öffentlichen Zugang:**
|
||
```env
|
||
HOSTNAME=aliasvault.deinedomain.com
|
||
LETSENCRYPT_ENABLED=true
|
||
FORCE_HTTPS_REDIRECT=true
|
||
```
|
||
|
||
### **Für privaten Zugang:**
|
||
```env
|
||
ADMIN_IP_ALLOWLIST=private
|
||
LETSENCRYPT_ENABLED=false
|
||
```
|
||
|
||
## 🔧 **Icon-Anpassung**
|
||
|
||
### **Icons ändern**
|
||
Ändere die Icon-URLs in `docker-compose.vps.yml`:
|
||
|
||
```yaml
|
||
labels:
|
||
com.docker.compose.service-icon: "https://neue-url-zum-icon.png"
|
||
com.unraid.icon: "https://neue-url-zum-icon.png"
|
||
icon: "https://neue-url-zum-icon.png"
|
||
```
|
||
|
||
### **Lokale Icons verwenden**
|
||
Falls Unraid lokale Pfade unterstützt:
|
||
|
||
```yaml
|
||
labels:
|
||
icon: "./aliasvault-icon.png" # Relativer Pfad
|
||
```
|
||
|
||
## 🖥️ **Unraid Integration**
|
||
|
||
Unraid zeigt die Icons im **Docker Tab** an, wenn:
|
||
- Das `icon` oder `com.unraid.icon` Label gesetzt ist
|
||
- Die URL/der Pfad erreichbar ist
|
||
- Unraid die Label-Syntax unterstützt
|
||
|
||
## 🔄 **Updates**
|
||
|
||
```bash
|
||
# Änderungen pushen
|
||
git add .
|
||
git commit -m "Icon-Labels hinzugefügt"
|
||
git push origin main
|
||
|
||
# Auf dem VPS aktualisieren
|
||
cd /opt/aliasvault
|
||
git pull origin main
|
||
docker-compose -f docker-compose.vps.yml up -d --force-recreate
|
||
```
|
||
|
||
## ❓ **Häufige Fragen**
|
||
|
||
**Q: Werden die Icons von allen Docker Tools unterstützt?**
|
||
A: Portainer, Docker Desktop und Unraid unterstützen oft Icon-Labels, aber die genauen Labels variieren.
|
||
|
||
**Q: Kann ich eigene Icons hochladen?**
|
||
A: Ja, lade deine Icon-Dateien ins Repository und passe die URLs/Pfade an.
|
||
|
||
**Q: Funktioniert das auch mit Dockhand?**
|
||
A: Ja, Dockhand überträgt die Compose-Datei inklusive Labels an die Docker Hosts.
|
||
|
||
**Q: Was, wenn Unraid die Icons nicht anzeigt?**
|
||
A: Prüfe die Unraid-Dokumentation zu Docker Labels oder experimentiere mit anderen Label-Namen wie `net.unraid.docker.icon`.
|
||
|
||
## 🔗 **Links**
|
||
- [Offizielle AliasVault Dokumentation](https://docs.aliasvault.net)
|
||
- [Docker Compose Labels Dokumentation](https://docs.docker.com/compose/compose-file/compose-file-v3/#labels)
|
||
- [Unraid Docker Management](https://wiki.unraid.net/Docker_Management) |