Access
- 在浏览器中打开：
https://<SERVER_IP> - 接受 SSL 警告（自签名证书）。
- 通过 Web 界面创建新账户。
- 第一个创建的账户将成为管理员账户。
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. 打开浏览器，访问： https://yourdomain.com
