Přístup

Otevřít v prohlížeči: https://<SERVER_IP>
Přijmout varování SSL (vlastnoručně podepsaný certifikát).
Create a new account via the web interface.
První vytvořený účet se stane uživatelem s právy správce.

Konfigurace

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

Upravit .env nebo docker-compose.yml to apply changes:

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

Disable Public Signups (Optional)

Upravit .env and modify DISABLE_SIGNUPS:

DISABLE_SIGNUPS=true

Použít změny:

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

Enable AI Features (Optional)

Upravit /root/karakeep/docker-compose.yml under the web služba:

environment:
  # OPENAI_API_KEY: "your_openai_api_key_here"

Uncomment the line and insert your OpenAI API key:

environment:
  OPENAI_API_KEY: "sk-xxxxxxxxxxxxxxxxxxxxxxxx"

Použít změny:

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

Důležité soubory a adresáře

Adresář aplikace: /root/karakeep
Soubor Docker Compose: /root/karakeep/docker-compose.yml
Soubor prostředí: /root/karakeep/.env
KaraKeep data: /var/lib/docker/volumes/karakeep_data/_data
Meilisearch data: /var/lib/docker/volumes/karakeep_meilisearch/_data
Konfigurace Nginx: /etc/nginx/sites-available/karakeep
SSL certifikáty: /etc/nginx/ssl/

Enabling SSL with a Domain (Optional)

1. Nasměrujte svou doménu na IP adresu serveru.

2. Upravte /root/karakeep/docker-compose.yml soubor pro nastavení názvu domény: NEXTAUTH_URL=https://your.domain.com

3. Obnovte služby:

cd /root/karakeep/
docker compose up -d

4. Upravte konfiguraci Nginx a nahraďte oba server_name <IP>; s vaší doménou (<your-domain>) pro bloky HTTP (port 80) i HTTPS (port 443):

vim /etc/nginx/sites-available/karakeep

5. Nainstalujte Certbot:

apt install -y certbot python3-certbot-nginx

6. Spusťte následující příkaz k vygenerování platného certifikátu Let’s Encrypt:

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

7. Nahraďte cesty SSL v konfiguraci Nginx (sekce 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. Restartujte Nginx, aby se změny projevily:

systemctl restart nginx

9. Otevřete prohlížeč a přejděte na adresu: https://yourdomain.com

Karakeep

Podrobnosti o aplikaci