From 82506ae5773921aeee963f73b4966047ef1420f2 Mon Sep 17 00:00:00 2001 From: zhengkunwang <31820853+zhengkunwang223@users.noreply.github.com> Date: Sat, 28 Dec 2024 18:23:30 +0800 Subject: [PATCH] feat: change maddy ReadME (#2845) --- maddy-mail/README.md | 24 ++++++++++++------------ maddy-mail/README_en.md | 24 ++++++++++++------------ 2 files changed, 24 insertions(+), 24 deletions(-) diff --git a/maddy-mail/README.md b/maddy-mail/README.md index 516f9a36c..c9161af87 100644 --- a/maddy-mail/README.md +++ b/maddy-mail/README.md @@ -5,12 +5,7 @@ 证书对应域名为邮箱`MX`主机名如`mail.example.com `。 -## 2. 创建Docker存储卷 -``` -docker volume create maddydata -``` - -## 3. 安装应用 +## 2. 安装应用 应用商店安装应用， @@ -19,7 +14,12 @@ docker volume create maddydata 忽略错误，进行下一步操作。 -## 4. 域名证书存放到存储卷 +## 3. 域名证书存放到存储卷 + +如果 容器-存储卷 目录没有 maddydata ，那么需要手动执行 +``` +docker volume create maddydata +``` 存储卷默认路径如下 `/var/lib/docker/volumes/maddydata/_data/` @@ -37,8 +37,8 @@ mkdir -p tls 按要求上传完成证书文件后，容器会自动正常运行。 -## 5. 设置DKIM DNS解析 -### 5.1 获取DKIM值 +## 4. 设置DKIM DNS解析 +### 4.1 获取DKIM值 当容器正常运行后 @@ -60,14 +60,14 @@ cat /var/lib/docker/volumes/maddydata/_data/dkim_keys/example.com_default.dns default._domainkey.example.org. TXT "v=DKIM1; k=ed25519; p=nAcUUozPlhc4VPhp7hZl+owES7j7OlEv0laaDEDBAqg=" ``` -### 5.2 设置DNS TXT记录 +### 4.2 设置DNS TXT记录 根据获取的信息设置`DNS解析` 例子如下： 为 `default._domainkey.example.com` 添加`TXT`记录，值设置为`v=DKIM1; k=ed25519; p=nAcUUozPlhc4VPhp7hZl+owES7j7OlEv0laaDEDBAqg=`。 -## 6. 设置DNS解析 +## 5. 设置DNS解析 - 注意按需修改 @@ -84,7 +84,7 @@ default._domainkey.example.org. TXT "v=DKIM1; k=ed25519; p=nAcUUozPlhc4VPhp | TXT | `_mta-sts.example.com` | `v=STSv1; id=1` | | TXT | `_smtp._tls.example.com` | `v=TLSRPTv1;rua=mailto:postmaster@example.com` | -## 7. 创建发送账户 +## 6. 创建发送账户 面板`容器`界面，连接容器终端，执行以下命令 diff --git a/maddy-mail/README_en.md b/maddy-mail/README_en.md index f0c3557b4..fcf515321 100644 --- a/maddy-mail/README_en.md +++ b/maddy-mail/README_en.md @@ -7,12 +7,7 @@ Prepare a domain certificate using tools like `acme.sh`, `certbot`, or manual up The certificate domain should correspond to the mail server's `MX` hostname, such as `mail.example.com`. -## 2. Create Docker Volume -``` -docker volume create maddydata -``` - -## 3. Install the Application +## 2. Install the Application Install the application from the app store. @@ -21,7 +16,12 @@ The first installation may show an error and the container may not run properly Ignore the error and proceed to the next step. -## 4. Place the Domain Certificate into the Volume +## 3. Place the Domain Certificate into the Volume + +If the maddydata directory is not present in the container storage volume, you need to manually execute: +``` +docker volume create maddydata +``` The default path for the volume is:`/var/lib/docker/volumes/maddydata/_data/` @@ -38,8 +38,8 @@ Upload the certificate and private key to the tls folder, and rename them as: Once the certificates are correctly uploaded, the container will automatically start running. -## 5. Configure DKIM DNS Records -### 5.1 Retrieve DKIM Values +## 4. Configure DKIM DNS Records +### 4.1 Retrieve DKIM Values After the container starts running, check the path:`/var/lib/docker/volumes/maddydata/_data/dkim_keys` @@ -59,14 +59,14 @@ Example output: default._domainkey.example.org. TXT "v=DKIM1; k=ed25519; p=nAcUUozPlhc4VPhp7hZl+owES7j7OlEv0laaDEDBAqg=" ``` -### 5.2 Set DNS TXT Record +### 4.2 Set DNS TXT Record Set the `DNS records` based on the retrieved information. For example: Add a `TXT` record for `default._domainkey.example.com` with the value `v=DKIM1; k=ed25519; p=nAcUUozPlhc4VPhp7hZl+owES7j7OlEv0laaDEDBAqg=`. -## 6. Set DNS Records +## 5. Set DNS Records - Ensure modifications as needed. @@ -83,7 +83,7 @@ Add a `TXT` record for `default._domainkey.example.com` with the value `v=DKIM1; | TXT | `_mta-sts.example.com` | `v=STSv1; id=1` | | TXT | `_smtp._tls.example.com` | `v=TLSRPTv1;rua=mailto:postmaster@example.com` | -## 7. Create Sending Accounts +## 6. Create Sending Accounts Access the container terminal via the `Containers` panel and execute the following commands: