在 Cloudzy VPS 上部署 Karakeep

访问

在浏览器中打开： https://<SERVER_IP>
接受 SSL 警告（自签名证书）。
通过 Web 界面创建新账户。
第一个创建的账户将成为管理员账户。

配置

环境变量存储于： /root/karakeep/.env

编辑 .env or docker-compose.yml 应用更改

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

禁用公开注册（可选）

编辑 .env 并修改 DISABLE_SIGNUPS:

DISABLE_SIGNUPS=true

应用更改

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

启用 AI 功能（可选）

编辑 /root/karakeep/docker-compose.yml 在...下方 web 服务:

environment:
  # OPENAI_API_KEY: "your_openai_api_key_here"

取消注释该行并填入你的 OpenAI API 密钥：

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
保留数据 /var/lib/docker/volumes/karakeep_data/_data
Meilisearch 数据 /var/lib/docker/volumes/karakeep_meilisearch/_data
Nginx 配置： /etc/nginx/sites-available/karakeep
SSL 证书: /etc/nginx/ssl/

为域名启用 SSL（可选）

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 配置（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 以应用更改：