Доступ

Відкрийте у своєму браузері: 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

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