Доступ

Откройте в браузере: https://<SERVER_IP>
Принять предупреждение SSL (самоподписанный сертификат).
Create a new account via the web interface.
Первый созданный аккаунт становится аккаунтом администратора.

Конфигурация

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

Редактировать .env или docker-compose.yml to apply changes:

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

Disable Public Signups (Optional)

Редактировать .env and modify DISABLE_SIGNUPS:

DISABLE_SIGNUPS=true

Применить изменения:

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

Enable AI Features (Optional)

Редактировать /root/karakeep/docker-compose.yml under the web услуга:

environment:
  # OPENAI_API_KEY: "your_openai_api_key_here"

Uncomment the line and insert your OpenAI API key:

environment:
  OPENAI_API_KEY: "sk-xxxxxxxxxxxxxxxxxxxxxxxx"

Применить изменения:

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

Важные файлы и каталоги

Каталог приложений: /root/karakeep
Файл Docker Compose: /root/karakeep/docker-compose.yml
Файл окружения: /root/karakeep/.env
KaraKeep data: /var/lib/docker/volumes/karakeep_data/_data
Meilisearch data: /var/lib/docker/volumes/karakeep_meilisearch/_data
Конфигурация Nginx: /etc/nginx/sites-available/karakeep
SSL-сертификаты: /etc/nginx/ssl/

Enabling SSL with a Domain (Optional)

1. Направьте ваш домен на IP-адрес сервера.

2. Отредактируйте /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. Установите 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

Karakeep

Детали заявки