Zugang

Öffnen Sie in Ihrem Browser: https://<SERVER_IP>
SSL-Warnung akzeptieren (selbstsigniertes Zertifikat).
Create a new account via the web interface.
Das erste erstellte Konto wird zum Admin-Benutzer.

Konfiguration

Environment variables are stored in: /root/karakeep/.env

Bearbeiten .env oder docker-compose.yml to apply changes:

docker compose -f /root/karakeep/docker-compose.yml up -d

Disable Public Signups (Optional)

Bearbeiten .env and modify DISABLE_SIGNUPS:

DISABLE_SIGNUPS=true

Änderungen übernehmen:

docker compose -f /root/karakeep/docker-compose.yml up -d

Enable AI Features (Optional)

Bearbeiten /root/karakeep/docker-compose.yml under the web Dienstleistung:

environment:
  # OPENAI_API_KEY: "your_openai_api_key_here"

Uncomment the line and insert your OpenAI API key:

environment:
  OPENAI_API_KEY: "sk-xxxxxxxxxxxxxxxxxxxxxxxx"

Änderungen übernehmen:

docker compose -f /root/karakeep/docker-compose.yml up -d

Wichtige Dateien und Verzeichnisse

Anwendungsverzeichnis: /root/karakeep
Docker Compose-Datei: /root/karakeep/docker-compose.yml
Umgebungsdatei: /root/karakeep/.env
KaraKeep data: /var/lib/docker/volumes/karakeep_data/_data
Meilisearch data: /var/lib/docker/volumes/karakeep_meilisearch/_data
Nginx-Konfiguration: /etc/nginx/sites-available/karakeep
SSL-Zertifikate: /etc/nginx/ssl/

Enabling SSL with a Domain (Optional)

1. Richten Sie Ihre Domain auf die Server-IP aus.

2. Bearbeiten Sie die /root/karakeep/docker-compose.yml Datei zum Festlegen Ihres Domainnamens: NEXTAUTH_URL=https://your.domain.com

3. Die Dienste neu erstellen:

cd /root/karakeep/
docker compose up -d

4. Bearbeiten Sie die Nginx-Konfiguration und ersetzen Sie beide server_name <IP>; mit Ihrer Domain (<your-domain>) sowohl für HTTP- (Port 80) als auch für HTTPS-Blöcke (Port 443):

vim /etc/nginx/sites-available/karakeep

5. Certbot installieren:

apt install -y certbot python3-certbot-nginx

6. Führen Sie den folgenden Befehl aus, um ein gültiges Let’s Encrypt-Zertifikat zu generieren:

certbot certonly --nginx --non-interactive --agree-tos --email [email protected] -d yourdomain.com

7. Ersetzen Sie die SSL-Pfade in der Nginx-Konfiguration (TLS-Abschnitt):

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. Starten Sie Nginx neu, um die Änderungen zu übernehmen:

systemctl restart nginx

9. Öffnen Sie Ihren Browser und besuchen Sie: https://yourdomain.com

Karaoke

Anwendungsdetails