加密鸽(cryptgeon)Docker部署笔记

加密鸽(cryptgeon)Docker部署笔记

hash070 1,599 2022-07-08

简介

加密鸽 是一个受 PrivNote项目启发的安全、开源共享密信和文件共享服务器,可以很方便地加密分享文本和文件。

官方项目地址:https://github.com/cupcakearmy/cryptgeon

官方中文文档地址(我翻译的>w<):https://github.com/cupcakearmy/cryptgeon/blob/main/README_zh-CN.md

Docker 部署

环境要求

你的服务器需要部署有dockerdocker-compose环境,安装方法如下

https://www.hash070.top/archives/docker-and-docker-compose-install.html

创建docker-compose描述文件

首先我们新建一个文件夹并填写docker-compose描述文件

mkdir cryptgeon && cd cryptgeon/
vim docker-compose.yml

docker-compose.yml中填写以下内容:

version: '3.7'
services:
  memcached:
    image: memcached:1-alpine
    entrypoint: memcached -m 128M -I 4M # 限制到最大 128 MB 内存占用,每条密信最大 4Mb 占用, 请根据自己的服务器内存的实际情况设置。

  app:
    image: cupcakearmy/cryptgeon:latest
    depends_on:
      - memcached
    environment:
      SIZE_LIMIT: 4M  #这一条的值应当与上面第五行-I后面的值对应
    ports:
      - 8099:5000  #冒号左边的端口可以随意修改为你服务器没有被占用的端口

注:加密鸽不会将数据持久化到磁盘上,因此无需挂载数据卷。

上线容器

当你将compose描述文件正确填写并保存后,在当前文件夹下,通过执行下面这行命令就可以上线你的加密鸽容器了。

docker-compose up -d

附 docker-compose常用命令:

# 上线容器
docker-compose up -d
# 停止容器
docker-compose stop
# 启动容器
docker-compose start
# 重启容器
docker-compose restart
# 下线(删除)容器
docker-compose down
# 删除容器不会导致你的数据丢失,你的数据库保存在了当前目录下的data文件夹内,请妥善保管该目录

Nginx反向代理

我的反向代理配置文件如下,可供参考

    location / {
      proxy_pass http://127.0.0.1:8099;
      proxy_set_header Host $http_host;
      proxy_http_version 1.1;
      proxy_set_header Upgrade $http_upgrade;
      proxy_set_header Connection "upgrade";
      proxy_set_header X-Real-IP $remote_addr;
      proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
      proxy_set_header X-Forwarded-Proto https;
      proxy_set_header X-Nginx-Proxy true;
      proxy_redirect off;
    }

注:反向代理必须配置SSL证书,否则你的数据将全程裸奔(直接化身泄密鸽(狗头))而且可能导致加密鸽无法正常工作。

使用方法

发送加密文本

基础用法

在文本框中输入你要发送的密信,然后点击create按钮即可生成一个带密钥的加密链接,该链接默认被查看一次,即该内容通过密链被查看一次后将被永久删除。

image-20220708155724222

image-20220708155922881

查看效果:

image-20220708155953849

高级设置

打开高级设置按钮,即可设置本次发送的密信的高级设置

其中,mode按钮用于设置限制类型,即限制最大查看次数还是限制有效期。

image-20220708160242312

发送加密文件

打开左下角的file开关即可进入文件发送模式,(由于加密鸽的所有数据都存储在内存中,所以非常不适合发送大文件。

image-20220708160442800