Karakeep

Een app om je gegevens en bladwijzers op te slaan, te ordenen en te beheren.

Toegang

  • Open in uw browser: https://<SERVER_IP>
  • SSL-waarschuwing accepteren (zelfondertekend certificaat).
  • Create a new account via the web interface.
  • Het eerste aangemaakte account wordt de beheerder.

Configuratie

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

Bewerken .env of docker-compose.yml to apply changes:

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

Disable Public Signups (Optional)

Bewerken .env and modify DISABLE_SIGNUPS:

DISABLE_SIGNUPS=true

Wijzigingen toepassen:

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

Enable AI Features (Optional)

Bewerken /root/karakeep/docker-compose.yml under the web dienst:

environment:
  # OPENAI_API_KEY: "your_openai_api_key_here"

Uncomment the line and insert your OpenAI API key:

environment:
  OPENAI_API_KEY: "sk-xxxxxxxxxxxxxxxxxxxxxxxx"

Wijzigingen toepassen:

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

Belangrijke bestanden en mappen

  • Toepassingsdirectory: /root/karakeep
  • Docker Compose-bestand: /root/karakeep/docker-compose.yml
  • Milieu-bestand: /root/karakeep/.env
  • KaraKeep data: /var/lib/docker/volumes/karakeep_data/_data
  • Meilisearch data: /var/lib/docker/volumes/karakeep_meilisearch/_data
  • Nginx-configuratie: /etc/nginx/sites-available/karakeep
  • SSL-certificaten: /etc/nginx/ssl/

Enabling SSL with a Domain (Optional)

1. Wijs uw domein naar het IP-adres van de server.

2. Bewerk de /root/karakeep/docker-compose.yml bestand om uw domeinnaam in te stellen: NEXTAUTH_URL=https://your.domain.com

3. De diensten opnieuw creëren:

cd /root/karakeep/
docker compose up -d

4. Bewerk de Nginx-configuratie en vervang beide server_name <IP>; met uw domein (<your-domain>) voor zowel HTTP (poort 80) als HTTPS (poort 443) blokken:

vim /etc/nginx/sites-available/karakeep

5. Certbot installeren:

apt install -y certbot python3-certbot-nginx

6. Voer de volgende opdracht uit om een geldig Let's Encrypt-certificaat te genereren:

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

7. Vervang SSL-paden in Nginx-configuratie (TLS-sectie):

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. Start Nginx opnieuw op om de wijzigingen toe te passen:

systemctl restart nginx

9. Open uw browser en ga naar: https://yourdomain.com

Details van de aanvraag