Skip to content

Commit f1ab0d3

Browse files
authored
Update README.md
1 parent 8ad0199 commit f1ab0d3

File tree

1 file changed

+43
-37
lines changed

1 file changed

+43
-37
lines changed

README.md

+43-37
Original file line numberDiff line numberDiff line change
@@ -23,61 +23,64 @@ OneTimeMessagePHP 是一款使用 PHP 构建的简单安全的阅后即焚消息
2323
- **易于使用:** OneTimeMessagePHP 界面简洁直观,您只需输入消息内容,并可选择设置密码增强安全性。
2424
- **安全可靠:** OneTimeMessagePHP 采用 AES-256-CBC 加密算法和双重加密机制,对您的消息进行加密存储,确保只有拥有正确密码的人才能解密和阅读消息。
2525
- **开源免费:** OneTimeMessagePHP 是一个开源项目,您可以免费使用、修改和分发它,以满足您的特定需求。
26-
- **支持 Markdown 渲染:** 您可以使用 Markdown 语法编写消息,并在查看时选择渲染成格式化的文本。
27-
26+
- **支持 Markdown 渲染:** 您可以使用 Markdown 语法编写消息,并在查看时选择渲染成格式化的文本。
27+
- **支持 LaTeX 公式:** 在启用 Markdown 渲染时,可以使用 LaTeX 语法编写数学公式,支持行内公式和独立公式。
2828

2929
### 三、功能特点
3030

3131
- **创建阅后即焚消息:** 您可以轻松创建只能被阅读一次的消息。消息一旦被读取,就会从服务器上永久删除。
3232
- **密码保护 (可选):** 您可以为消息设置密码,增强安全保障。只有知道密码的人才能解密和阅读消息。
3333
- **发件人姓名和备注信息 (可选):** 您可以选择添加发件人姓名和备注信息,方便接收者了解消息的来源和目的。
34+
- **Markdown 支持:** 支持完整的 Markdown 语法,包括:
35+
- 标题、列表、链接
36+
- 图片、表格
37+
- 代码块(支持语法高亮)
38+
- LaTeX 数学公式:
39+
- 行内公式:使用单个美元符号,如:`$E = mc^2$`
40+
- 独立公式:使用两个美元符号,如:`$$\int_{-\infty}^{\infty} e^{-x^2} dx = \sqrt{\pi}$$`
3441

3542
### 四、使用方法
3643

37-
1. **部署应用:**
38-
- 将 OneTimeMessagePHP 的代码上传到您的 Web 服务器。
39-
- 创建一个 `.env` 文件,并在其中设置必要的环境变量(参考下文 .env 文件示例)。
40-
41-
2. **创建消息:**
42-
- 打开 OneTimeMessagePHP 应用的首页。
43-
- 在文本框中输入您的消息内容。
44-
- (可选) 设置密码以保护您的消息。
45-
- (可选) 输入发件人姓名和备注信息。
46-
- 点击 "发送" 按钮。
44+
1. **创建消息:**
45+
- 打开 OneTimeMessagePHP 应用的首页
46+
- 在文本框中输入您的消息内容
47+
- (可选) 设置密码以保护您的消息
48+
- (可选) 输入发件人姓名和备注信息
49+
- 点击 "发送" 按钮
4750

48-
3. **分享消息:**
49-
- 应用将生成一个唯一的 URL,该 URL 指向您创建的消息
50-
- 将此 URL 分享给您想要发送消息的人
51+
2. **分享消息:**
52+
- 应用将生成一个唯一的 URL,该 URL 指向您创建的消息
53+
- 将此 URL 分享给您想要发送消息的人
5154

52-
4. **阅读消息:**
53-
- 当接收者访问该 URL 时,他们将能够阅读您的消息
54-
- 如果消息设置了密码,接收者需要输入正确的密码才能查看
55-
- 一旦消息被读取,它将被自动销毁,并且该 URL 将失效
55+
3. **阅读消息:**
56+
- 当接收者访问该 URL 时,他们将能够阅读您的消息
57+
- 如果消息设置了密码,接收者需要输入正确的密码才能查看
58+
- 一旦消息被读取,它将被自动销毁,并且该 URL 将失效
5659

5760
### 五、部署方法
5861

5962
1. **使用 Git 克隆代码库:**
60-
```bash
61-
git clone https://github.com/yangtb2024/OneTimeMessagePHP.git
62-
cd OneTimeMessagePHP
63-
```
63+
```bash
64+
git clone https://github.com/yangtb2024/OneTimeMessagePHP.git
65+
cd OneTimeMessagePHP
66+
```
6467

6568
2. **配置 `.env` 文件:**
66-
- 复制 `.env.example` 文件并将其重命名为 `.env`
67-
- 使用强随机字符串替换 `ENCRYPTION_KEY` 的值。
68-
- 配置 `SITE_ICON` (站点图标) 和 `SITE_DOMAIN` (站点域名)。
69+
- 复制 `.env.example` 文件并将其重命名为 `.env`
70+
- 使用强随机字符串替换 `ENCRYPTION_KEY` 的值
71+
- 设置 `MESSAGE_EXPIRY` 的值(消息最大过期时间)
72+
- 配置 `SITE_ICON` (站点图标) 和 `SITE_DOMAIN` (站点域名)
6973

7074
3. **设置 Web 服务器:**
71-
- 将 Web 服务器的文档根目录指向 OneTimeMessagePHP 的 `public` 目录 (如果适用)。
72-
- 确保 `/messages` 目录对 Web 服务器具有写入权限。
73-
75+
- 将 Web 服务器的文档根目录指向 OneTimeMessagePHP 的目录
76+
- 确保 `/messages` 目录对 Web 服务器具有写入权限
7477

7578
### 六、安全警告
7679

77-
- **更换密钥导致消息失效:** OneTimeMessagePHP 使用 `.env` 文件中设置的 `ENCRYPTION_KEY` 进行消息加密。如果您更改此密钥,之前创建的所有消息都将无法解密和读取。请谨慎更改此密钥,并在更改后通知所有相关方
78-
- **不要将 `.env` 文件提交到代码仓库:** `.env` 文件包含敏感信息,例如加密密钥。请勿将其提交到版本控制系统(例如 Git)中,以防止密钥泄露
79-
- **确保服务器安全:** 请确保您的 Web 服务器配置正确,并采取必要的安全措施来防止未经授权的访问
80-
- **`.env` 文件和 `/messages` 目录的可读性:** 请注意,`.env` 文件和 `/messages` 目录在服务器上是可读的。虽然消息内容是加密的,但文件名和一些元数据可能会被其他人读取。如果您需要更高的安全性,请考虑使用更安全的存储机制来存储消息。 **但这并不意味着您的信息不安全,因为消息内容本身是加密存储的,只有拥有正确密钥的人才能解密和读取。**
80+
- **更换密钥导致消息失效:** 更改 `ENCRYPTION_KEY` ,之前创建的所有消息都将无法解密和读取。
81+
- **不要将 `.env` 文件提交到代码仓库:** `.env` 文件包含敏感信息,请勿将其提交到版本控制系统中
82+
- **确保服务器安全:** 请确保您的 Web 服务器配置正确,并采取必要的安全措施
83+
- **`.env` 文件和 `/messages` 目录的可读性:** 注意保护这些文件的访问权限。
8184

8285
### 七、.env 文件示例
8386

@@ -86,6 +89,10 @@ OneTimeMessagePHP 是一款使用 PHP 构建的简单安全的阅后即焚消息
8689
# 请将 ENCRYPTION_KEY 替换为一个强随机字符串
8790
ENCRYPTION_KEY=your_strong_random_string
8891
92+
# 设置消息的最大过期时间,格式为 "天:时:分:秒"
93+
# 例如:7:0:0:0 表示7天
94+
MESSAGE_EXPIRY=7:0:0:0
95+
8996
# 设置站点图标(Favicon)的 URL
9097
# 以下是一些示例图标及其类型:
9198
@@ -108,12 +115,11 @@ SITE_DOMAIN=https://yourdomain.com
108115

109116
请根据您的实际需求修改 `.env` 文件中的内容。
110117

111-
![](https://star-history.com/#yangtb2024/OneTimeMessagePHP&Date)
112-
118+
### 八、示例站点
113119

114-
### 八、总结
120+
- **演示站点:** 您可以访问 [演示站点](https://ilovelinuxdo.tech) 以了解 OneTimeMessagePHP 的实际效果。
115121

116-
OneTimeMessagePHP 提供了一种简单而有效的方式来分享敏感信息,同时确保信息安全和隐私。请务必仔细阅读安全警告,并采取必要的措施来保护您的信息
122+
如果有任何问题,欢迎提出,我会尽力改正
117123

118124
## Star History
119125

0 commit comments

Comments
 (0)