Access
- Otwórz w przeglądarce:
https://<SERVER_IP> - Zaakceptuj ostrzeżenie SSL (certyfikat self-signed).
- Utwórz nowe konto przez interfejs webowy.
- Pierwsze utworzone konto automatycznie staje się kontem administratora.
Configuration
Zmienne środowiskowe są przechowywane w: /root/karakeep/.env
Edit .env or docker-compose.yml to apply changes:
docker compose -f /root/karakeep/docker-compose.yml up -d
Wyłącz publiczną rejestrację (opcjonalnie)
Edit .env and modify DISABLE_SIGNUPS:
DISABLE_SIGNUPS=true
Apply changes:
docker compose -f /root/karakeep/docker-compose.yml up -d
Włącz funkcje AI (opcjonalnie)
Edit /root/karakeep/docker-compose.yml under the web service:
environment:
# OPENAI_API_KEY: "your_openai_api_key_here"
Odkomentuj linię i wstaw swój klucz API OpenAI API:
environment:
OPENAI_API_KEY: "sk-xxxxxxxxxxxxxxxxxxxxxxxx"
Apply changes:
docker compose -f /root/karakeep/docker-compose.yml up -d
Ważne pliki i katalogi
- Application directory:
/root/karakeep - Plik Docker Compose:
/root/karakeep/docker-compose.yml - Environment file:
/root/karakeep/.env - KaraKeep data:
/var/lib/docker/volumes/karakeep_data/_data - Meilisearch data:
/var/lib/docker/volumes/karakeep_meilisearch/_data - Nginx configuration:
/etc/nginx/sites-available/karakeep - SSL certificates:
/etc/nginx/ssl/
Włączanie SSL z domeną (opcjonalnie)
1. Wskaż domenę na adres IP serwera.
2. Edit the /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 zastąp oba wystąpienia server_name <IP>; na swoją domenę (<your-domain>) w blokach HTTP (port 80) i HTTPS (port 443):
vim /etc/nginx/sites-available/karakeep
5. Install Certbot:
apt install -y certbot python3-certbot-nginx
6. Uruchom poniższe 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. Zrestartuj Nginx, aby zastosować zmiany:
systemctl restart nginx
9. Otwórz przeglądarkę i przejdź pod adres: https://yourdomain.com
