Dostęp

Otwórz w przeglądarce: https://<SERVER_IP>
Zaakceptuj ostrzeżenie SSL (certyfikat z podpisem własnym).
Create a new account via the web interface.
Pierwsze utworzone konto staje się kontem administratora.

Konfiguracja

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

Edytuj .env lub docker-compose.yml to apply changes:

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

Disable Public Signups (Optional)

Edytuj .env and modify DISABLE_SIGNUPS:

DISABLE_SIGNUPS=true

Zastosuj zmiany:

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

Enable AI Features (Optional)

Edytuj /root/karakeep/docker-compose.yml under the web usługa:

environment:
  # OPENAI_API_KEY: "your_openai_api_key_here"

Uncomment the line and insert your OpenAI API key:

environment:
  OPENAI_API_KEY: "sk-xxxxxxxxxxxxxxxxxxxxxxxx"

Zastosuj zmiany:

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

Ważne pliki i katalogi

Katalog aplikacji: /root/karakeep
Plik Docker Compose: /root/karakeep/docker-compose.yml
Plik środowiska: /root/karakeep/.env
KaraKeep data: /var/lib/docker/volumes/karakeep_data/_data
Meilisearch data: /var/lib/docker/volumes/karakeep_meilisearch/_data
Konfiguracja Nginx: /etc/nginx/sites-available/karakeep
Certyfikaty SSL: /etc/nginx/ssl/

Enabling SSL with a Domain (Optional)

1. Skieruj swoją domenę na adres IP serwera.

2. Edytuj /root/karakeep/docker-compose.yml plik, aby ustawić nazwę domeny: NEXTAUTH_URL=https://your.domain.com

3. Odtwórz usługi:

cd /root/karakeep/
docker compose up -d

4. Edytuj konfigurację Nginx i zamień oba elementy. server_name <IP>; z Twoją domeną (<your-domain>) zarówno dla bloków HTTP (port 80), jak i HTTPS (port 443):

vim /etc/nginx/sites-available/karakeep

5. Zainstaluj Certbot:

apt install -y certbot python3-certbot-nginx

6. Uruchom następujące polecenie, aby wygenerować ważny certyfikat Let’s Encrypt:

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

7. Zastąp ścieżki SSL w konfiguracji Nginx (sekcja 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. Uruchom ponownie Nginx, aby zastosować zmiany:

systemctl restart nginx

9. Otwórz przeglądarkę i przejdź do strony: https://yourdomain.com

Karakeep

Szczegóły aplikacji