Accès
- Ouvrez dans votre navigateur :
https://<SERVER_IP> - Acceptez l'avertissement SSL (certificat auto-signé).
- Créez un nouveau compte via l'interface web.
- Le premier compte créé devient l'administrateur.
Paramètres
Les variables d'environnement sont stockées dans : /root/karakeep/.env
Modifier .env or docker-compose.yml pour appliquer les modifications :
docker compose -f /root/karakeep/docker-compose.yml up -d
Désactiver les inscriptions publiques (facultatif)
Modifier .env et modifier DISABLE_SIGNUPS:
DISABLE_SIGNUPS=true
Appliquer les modifications :
docker compose -f /root/karakeep/docker-compose.yml up -d
Activer les fonctionnalités IA (facultatif)
Modifier /root/karakeep/docker-compose.yml sous le web service :
environment:
# OPENAI_API_KEY: "your_openai_api_key_here"
Décommentez la ligne et insérez votre clé API OpenAI :
environment:
OPENAI_API_KEY: "sk-xxxxxxxxxxxxxxxxxxxxxxxx"
Appliquer les modifications :
docker compose -f /root/karakeep/docker-compose.yml up -d
Fichiers et répertoires importants
- Répertoire de l'application :
/root/karakeep - Fichier Docker Compose :
/root/karakeep/docker-compose.yml - Fichier d'environnement :
/root/karakeep/.env - Données KaraKeep :
/var/lib/docker/volumes/karakeep_data/_data - Données Meilisearch :
/var/lib/docker/volumes/karakeep_meilisearch/_data - Configuration Nginx :
/etc/nginx/sites-available/karakeep - Certificats SSL :
/etc/nginx/ssl/
Activation de SSL avec un domaine (facultatif)
1. Faites pointer votre domaine vers l'IP du serveur.
2. Modifiez le fichier /root/karakeep/docker-compose.yml pour définir votre nom de domaine : NEXTAUTH_URL=https://your.domain.com
3. Recréez les services :
cd /root/karakeep/
docker compose up -d
4. Modifiez la configuration Nginx et remplacez les deux server_name <IP>; avec votre domaine (<your-domain>) dans les blocs HTTP (port 80) et HTTPS (port 443) :
vim /etc/nginx/sites-available/karakeep
5. Installez Certbot :
apt install -y certbot python3-certbot-nginx
6. Lance la commande suivante pour générer un certificat Let's Encrypt valide :
certbot certonly --nginx --non-interactive --agree-tos --email [email protected] -d yourdomain.com
7. Remplace les chemins SSL dans la config Nginx (section TLS) :
vim /etc/nginx/sites-available/karakeep
# Before:
# ssl_certificate /etc/nginx/ssl/fullchain.pem;
# ssl_certificate_key /etc/nginx/ssl/privkey.pem;
# After:
# ssl_certificate /etc/letsencrypt/live/yourdomain.com/fullchain.pem;
# ssl_certificate_key /etc/letsencrypt/live/yourdomain.com/privkey.pem;
8. Redémarrez Nginx pour appliquer les modifications :
systemctl restart nginx
9. Ouvrez votre navigateur et allez sur : https://yourdomain.com
