documentation

README.md

@@ -71,17 +71,16 @@ Docker is the easiest way. There is the [official image here](https://hub.docker
 ```yaml
 # docker-compose.yml
 
-version: '3.7'
+version: '3.8'
 
 services:
-  memcached:
-    image: memcached:1-alpine
-    entrypoint: memcached -m 128M -I 4M # Limit to 128 MB Ram, 4M per entry, customize at free will.
+  redis:
+    image: redis:7-alpine
 
   app:
     image: cupcakearmy/cryptgeon:latest
     depends_on:
-      - memcached
+      - redis
     environment:
       SIZE_LIMIT: 4M
     ports:
@@ -109,16 +108,15 @@ networks:
     external: true
 
 services:
-  memcached:
-    image: memcached:1-alpine
+  redis:
+    image: redis:7-alpine
     restart: unless-stopped
-    entrypoint: memcached -m 128M -I 4M # Limit to 128 MB Ram, 4M per entry, customize at free will.
 
   app:
     image: cupcakearmy/cryptgeon:latest
     restart: unless-stopped
     depends_on:
-      - memcached
+      - redis
     networks:
       - default
       - proxy

README_zh-CN.md

@@ -48,8 +48,8 @@ _加密鸽_ 是一个受 [_PrivNote_](https://privnote.com)项目启发的安全
 ## 环境变量
 
 | 变量名称          | 默认值           | 描述                                                                              |
-| ------------------ | ----------------- | ------------------------------------------------------------ |
-| `MEMCACHE`         | `memcached:11211` | Memcached 连接 URL                                           |
+| ----------------- | ---------------- | --------------------------------------------------------------------------------- |
+| `REDIS`           | `redis://redis/` | Redis URL to connect to.                                                          |
 | `SIZE_LIMIT`      | `1 KiB`          | 最大请求体(body)限制。有关支持的数值请查看 [字节单位](https://docs.rs/byte-unit/) |
 | `MAX_VIEWS`       | `100`            | 密信最多查看次数限制                                                              |
 | ` MAX_EXPIRATION` | `360`            | 密信最长过期时间限制(分钟)                                                        |
@@ -67,17 +67,16 @@ Docker是最简单的部署方式。这里是[官方镜像的地址](https://hub
 
 ```yaml
 # docker-compose.yml
-version: '3.7'
+version: '3.8'
 
 services:
-  memcached:
-    image: memcached:1-alpine
-    entrypoint: memcached -m 128M -I 4M # 限制到最大 128 MB 内存占用,每个密信最大 4Mb 占用, 请根据自己的服务器内存的实际情况设置。
+  redis:
+    image: redis:7-alpine
 
   app:
     image: cupcakearmy/cryptgeon:latest
     depends_on:
-      - memcached
+      - redis
     environment:
       SIZE_LIMIT: 4M
     ports:
@@ -105,16 +104,15 @@ networks:
     external: true
 
 services:
-  memcached:
-    image: memcached:1-alpine
+  redis:
+    image: redis:7-alpine
     restart: unless-stopped
-    entrypoint: memcached -m 128M -I 4M # Limit to 128 MB Ram, 4M per entry, customize at free will.
 
   app:
     image: cupcakearmy/cryptgeon:latest
     restart: unless-stopped
     depends_on:
-      - memcached
+      - redis
     networks:
       - default
       - proxy
@@ -157,7 +155,7 @@ pnpm run dev
 
 在根目录执行 `pnpm run dev` 会开启下列服务:
 
-- 一个 memcache docker 容器
+- 一个 redis docker 容器
 - 无热重载的 rust 后端
 - 可热重载的客户端
 
@@ -166,4 +164,3 @@ pnpm run dev
 ###### Attributions
 
 本项目所使用的图标由<a href="https://www.flaticon.com/" title="Flaticon">www.flaticon.com 的<a href="https://www.freepik.com" title="Freepik">freepik</a>制作</a>
-

docker-compose.yml

@@ -1,7 +1,7 @@
 # DEV Compose file.
 # For a production file see: README.md
 
-version: '3.7'
+version: '3.8'
 
 services:
   redis:

examples/nginx/docker-compose.yaml

@@ -1,14 +1,13 @@
 version: '3.8'
 
 services:
-  memcached:
-    image: memcached:1-alpine
-    entrypoint: memcached -m 256 -I 128 # Limit to 128 MB Ram, customize at free will. -m must be at least double than -I.
+  redis:
+    image: redis:7-alpine
 
   app:
     image: cupcakearmy/cryptgeon:latest
     depends_on:
-      - memcached
+      - redis
     
   proxy:
     image: nginx:alpine

examples/scratch/README.md

@@ -7,7 +7,7 @@ This is a tiny guide to install cryptgeon on (probably) any unix system (and may
 3. Run the cryptgeon.
 4. [Optional] install watchtower to keep up to date.
 
-## Install Docker & DOcker Compose
+## Install Docker & Docker Compose
 
 - [Docker](https://docs.docker.com/engine/install/)
 - [Compose](https://docs.docker.com/compose/install/)
@@ -107,16 +107,15 @@ networks:
     external: true
 
 services:
-  memcached:
-    image: memcached:1-alpine
+  redis:
+    image: redis:7-alpine
     restart: unless-stopped
-    entrypoint: memcached -m 256M -I 4M # Limit to 128 MB Ram, customize at free will.
 
   app:
     image: cupcakearmy/cryptgeon:latest
     restart: unless-stopped
     depends_on:
-      - memcached
+      - redis
     environment:
       SIZE_LIMIT: 4 MiB
     networks: