Access
- ブラウザで開く:
https://<SERVER_IP> - SSL の警告を承認する(自己署名証明書)。
- ウェブインターフェースから新しいアカウントを作成してください。
- 最初に作成したアカウントが管理者ユーザーになります。
Configuration
環境変数の保存先: /root/karakeep/.env
Edit .env or docker-compose.yml to apply changes:
docker compose -f /root/karakeep/docker-compose.yml up -d
パブリックサインアップを無効にする(任意)
Edit .env and modify DISABLE_SIGNUPS:
DISABLE_SIGNUPS=true
Apply changes:
docker compose -f /root/karakeep/docker-compose.yml up -d
AI 機能を有効にする(任意)
Edit /root/karakeep/docker-compose.yml under the web service:
environment:
# OPENAI_API_KEY: "your_openai_api_key_here"
該当行のコメントアウトを外して、OpenAI の API キーを入力してください:
environment:
OPENAI_API_KEY: "sk-xxxxxxxxxxxxxxxxxxxxxxxx"
Apply changes:
docker compose -f /root/karakeep/docker-compose.yml up -d
主要なファイルとディレクトリ
- Application directory:
/root/karakeep - Docker Compose ファイル:
/root/karakeep/docker-compose.yml - Environment file:
/root/karakeep/.env - KaraKeep data:
/var/lib/docker/volumes/karakeep_data/_data - Meilisearch data:
/var/lib/docker/volumes/karakeep_meilisearch/_data - Nginx configuration:
/etc/nginx/sites-available/karakeep - SSL certificates:
/etc/nginx/ssl/
ドメインで SSL を有効にする(オプション)
1. ドメインをサーバーのIPアドレスに向けてください。
2. Edit the /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. Install 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 設定(TLS セクション)の SSL パスを置き換えます:
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