Hass/message-pusher
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 4 Wiki Activity

docs: update README

Browse Source
This commit is contained in:
JustSong
2022-12-08 14:58:17 +08:00
parent 17391d3e7f
commit fad737392f
1 changed files with 4 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+4 -3
View File
@@ -97,7 +97,7 @@ _✨ 搭建专属于你的消息推送服务，支持多种消息推送方式，
你可以通过设置环境变量或者命令行参数进行配置。 你可以通过设置环境变量或者命令行参数进行配置。
等到系统启动后，使用 `root` 用户登录系统并做进一步的配置。 等到系统启动后，使用 `root` 用户登录系统并做进一步的配置，默认密码为 `123456`。
### 环境变量 ### 环境变量
1. `REDIS_CONN_STRING`：设置之后将使用 Redis 作为请求频率限制的存储，而非使用内存存储。 1. `REDIS_CONN_STRING`：设置之后将使用 Redis 作为请求频率限制的存储，而非使用内存存储。
@@ -107,8 +107,9 @@ _✨ 搭建专属于你的消息推送服务，支持多种消息推送方式，
3. `SQL_DSN`：设置之后将使用指定数据库而非 SQLite。 3. `SQL_DSN`：设置之后将使用指定数据库而非 SQLite。
+ 例子：`SQL_DSN=root:123456@tcp(localhost:3306)/message-pusher` + 例子：`SQL_DSN=root:123456@tcp(localhost:3306)/message-pusher`
注意：使用 Docker 部署时，请使用 `-e key=value` 设置环境变量。 注意：使用 Docker 部署时，请使用 `-e key=value` 设置环境变量。
+ 例子：`docker run -e SESSION_SECRET=random_string ...`
例子：`docker run -e SESSION_SECRET=random_string ...`
### 命令行参数 ### 命令行参数
1. `--port <port_number>`: 指定服务器监听的端口号，默认为 `3000`。 1. `--port <port_number>`: 指定服务器监听的端口号，默认为 `3000`。