Karakeep

An app to save, organize, and manage your data and bookmarks.

Akses

  • Buka di browser Anda: https://<SERVER_IP>
  • Terima peringatan SSL (sertifikat yang ditandatangani sendiri).
  • Create a new account via the web interface.
  • Akun pertama yang dibuat menjadi pengguna admin.

Konfigurasi

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

Edit .env atau docker-compose.yml to apply changes:

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

Disable Public Signups (Optional)

Edit .env and modify DISABLE_SIGNUPS:

DISABLE_SIGNUPS=true

Terapkan perubahan:

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

Enable AI Features (Optional)

Edit /root/karakeep/docker-compose.yml under the web layanan:

environment:
  # OPENAI_API_KEY: "your_openai_api_key_here"

Uncomment the line and insert your OpenAI API key:

environment:
  OPENAI_API_KEY: "sk-xxxxxxxxxxxxxxxxxxxxxxxx"

Terapkan perubahan:

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

Berkas dan Direktori Penting

  • Direktori aplikasi: /root/karakeep
  • Berkas Docker Compose: /root/karakeep/docker-compose.yml
  • Berkas lingkungan: /root/karakeep/.env
  • KaraKeep data: /var/lib/docker/volumes/karakeep_data/_data
  • Meilisearch data: /var/lib/docker/volumes/karakeep_meilisearch/_data
  • Konfigurasi Nginx: /etc/nginx/sites-available/karakeep
  • Sertifikat SSL: /etc/nginx/ssl/

Enabling SSL with a Domain (Optional)

1. Arahkan domain Anda ke alamat IP server.

2. Edit /root/karakeep/docker-compose.yml Berkas untuk mengatur nama domain Anda: NEXTAUTH_URL=https://your.domain.com

3. Membuat ulang layanan:

cd /root/karakeep/
docker compose up -d

4. Edit konfigurasi Nginx dan ganti keduanya server_name <IP>; dengan domain Anda (<your-domain>) untuk blok HTTP (port 80) dan HTTPS (port 443):

vim /etc/nginx/sites-available/karakeep

5. Instal Certbot:

apt install -y certbot python3-certbot-nginx

6. Jalankan perintah berikut untuk menghasilkan sertifikat Let’s Encrypt yang valid:

certbot certonly --nginx --non-interactive --agree-tos --email [email protected] -d yourdomain.com

7. Ganti jalur SSL di konfigurasi Nginx (bagian 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. Restart Nginx untuk menerapkan perubahan:

systemctl restart nginx

9. Buka browser Anda dan kunjungi: https://yourdomain.com

Rincian Aplikasi