الوصول

افتح في متصفحك: 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

تفاصيل الطلب