cupcakearmy/cryptgeon

cryptgeon

镜像概述和主要用途

cryptgeon 是一个安全的开源笔记和文件分享服务，灵感来源于 PrivNote。它包含服务器、网页界面和CLI客户端，专为安全分享自毁型笔记或文件设计，所有内容通过客户端加密，确保服务器无法获取敏感信息。

核心功能和特性

• 多类型分享：支持发送文本或文件
• 客户端加密：内容在客户端采用AES-GCM模式加密，服务器无法解密
• 访问控制：可设置查看次数限制或时间过期限制
• 内存存储：数据仅保存在内存中，无持久化存储，提升安全性
• 深色模式：内置深色模式支持，优化用户体验

使用场景和适用范围

适用于需要临时、安全分享敏感信息的场景，如：

• 临时分享密码、API密钥等机密信息
• 传输敏感文档，确保接收后自动销毁
• 企业内部安全信息传递，防止数据泄露
• 个人间私密内容分享，无需担心信息被长期存储

工作原理

每个笔记会生成256位的id和256位的key。id用于笔记的存储和检索，key则在客户端对笔记内容进行AES-GCM加密。加密后的内容发送至服务器，仅在内存中暂存，服务器从未接触加密密钥，因此无法解密任何笔记内容。

环境变量配置

部署方法

⚠️ 注意：必须使用https协议，否则浏览器可能不支持加密功能。 ⚠️ 健康检查端点：/api/health/，返回状态码200（正常）或503（异常）。

Docker Compose部署

Docker是推荐的部署方式，官方镜像地址：https://hub.docker.com/r/cupcakearmy/cryptgeon%E3%80%82

yaml
# docker-compose.yml
version: '3.8'

services:
  redis:
    image: docker.xuanyuan.run/redis:7-alpine
    # 可选：设置内存限制（参考Redis内存淘汰策略：https://redis.io/docs/manual/eviction/）
    # command: redis-server --maxmemory 1gb --maxmemory-policy allkeys-lru

  app:
    image: docker.xuanyuan.run/cupcakearmy/cryptgeon:latest
    depends_on:
      - redis
    environment:
      # 单条笔记大小限制，示例设为4 MiB
      SIZE_LIMIT: 4 MiB
    ports:
      - 80:8000

    # 可选健康检查配置
    # healthcheck:
    #   test: ["CMD", "curl", "--fail", "http://127.0.0.1:8000/api/live/"]
    #   interval: 1m
    #   timeout: 3s
    #   retries: 2
    #   start_period: 5s

其他部署方式

• NGINX代理：参考https://github.com/cupcakearmy/cryptgeon/tree/main/examples/nginx%EF%BC%8C%E5%8C%85%E5%90%AB%E5%9F%BA%E7%A1%80%E4%BB%A3%E7%90%86%E5%92%8CHTTPS%E9%85%8D%E7%BD%AE%E7%A4%BA%E4%BE%8B%EF%BC%88%E9%9C%80%E8%87%AA%E8%A1%8C%E9%85%8D%E7%BD%AE%E5%9F%9F%E5%90%8D%E5%92%8C%E8%AF%81%E4%B9%A6%EF%BC%89%E3%80%82
• Traefik 2：参考https://github.com/cupcakearmy/cryptgeon/tree/main/examples/traefik%E9%85%8D%E7%BD%AE%E7%A4%BA%E4%BE%8B%E3%80%82
• 手动部署：参考https://github.com/cupcakearmy/cryptgeon/tree/main/examples/scratch%EF%BC%8C%E5%8C%85%E5%90%AB%E4%BB%8E%E6%BA%90%E7%A0%81%E5%AE%89%E8%A3%85%E7%9A%84%E6%8C%87%E5%8D%97%E3%80%82
• Synology NAS：可参考第三方指南如何在Synology NAS上安装cryptgeon。

演示与使用

网页版

访问官方演示站点体验：cryptgeon.org

CLI客户端

bash
# 发送文本笔记示例
npx cryptgeon send text "这是一条秘密笔记"

更多CLI用法详见https://github.com/cupcakearmy/cryptgeon/blob/main/packages/cli/README.md%E3%80%82