Access
- Відкрийте у браузері:
https://<SERVER_IP> - Прийміть попередження SSL (самопідписаний сертифікат).
- Створіть новий акаунт через вебінтерфейс.
- Перший створений обліковий запис отримує права адміністратора.
Configuration
Змінні середовища зберігаються у: /root/karakeep/.env
Edit .env or docker-compose.yml to apply changes:
docker compose -f /root/karakeep/docker-compose.yml up -d
Вимкнути публічну реєстрацію (опційно)
Edit .env and modify DISABLE_SIGNUPS:
DISABLE_SIGNUPS=true
Apply changes:
docker compose -f /root/karakeep/docker-compose.yml up -d
Увімкнути функції AI (опційно)
Edit /root/karakeep/docker-compose.yml under the web service:
environment:
# OPENAI_API_KEY: "your_openai_api_key_here"
Розкоментуйте рядок і вставте ваш API-ключ OpenAI API:
environment:
OPENAI_API_KEY: "sk-xxxxxxxxxxxxxxxxxxxxxxxx"
Apply changes:
docker compose -f /root/karakeep/docker-compose.yml up -d
Важливі файли та директорії
- Application directory:
/root/karakeep - Файл 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/
Увімкнення SSL з власним доменом (необов'язково)
1. Вкажіть ваш домен на IP-адресу сервера.
2. Edit the /root/karakeep/docker-compose.yml файл для вказання вашого доменного імені: NEXTAUTH_URL=https://your.domain.com
3. Пересоздайте сервіси:
cd /root/karakeep/
docker compose up -d
4. Відредагуйте конфіг Nginx і замініть обидва server_name <IP>; на ваш домен (<your-domain>) для блоків HTTP (порт 80) і HTTPS (порт 443):
vim /etc/nginx/sites-available/karakeep
5. Install Certbot:
apt install -y certbot python3-certbot-nginx
6. Виконайте наступну команду, щоб отримати дійсний сертифікат Let's Encrypt:
certbot certonly --nginx --non-interactive --agree-tos --email [email protected] -d yourdomain.com
7. Замініть шляхи SSL в конфізі Nginx (секція 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. Перезапустіть Nginx, щоб застосувати зміни:
systemctl restart nginx
9. Відкрийте браузер і перейдіть за адресою: https://yourdomain.com
