访问
- 在浏览器中打开:
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. 打开浏览器并访问: https://yourdomain.com