Karakeep

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

アクセス

  • ブラウザで開く: 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. Nginx設定ファイル内のSSLパスを置換(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. ブラウザを開き、次のURLにアクセスしてください: https://yourdomain.com

申請内容