📝 更新README

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,18 @@
+<!--
+如果你不认真勾选下面的内容，我可能会直接关闭你的 Issue。
+提问之前，建议先阅读 https://github.com/ruby-china/How-To-Ask-Questions-The-Smart-Way
+-->
+
+**我确定我已经查看了** (标注`[ ]`为`[x]`)
+
+- [ ] [Halo 使用文档](https://docs.halo.run/)
+- [ ] [Github Wiki 常见问题](https://github.com/ruibaby/halo/wiki/4.-%E5%B8%B8%E8%A7%81%E9%97%AE%E9%A2%98)
+- [ ] [其他 Issues](https://github.com/ruibaby/halo/issues)
+
+----
+
+**我要申请**  (标注`[ ]`为`[x]`)
+
+- [ ] BUG 反馈
+- [ ] 添加新的特性或者功能
+- [ ] 请求技术支持

README.md

@@ -56,7 +56,11 @@ curl https://raw.githubusercontent.com/jwilder/nginx-proxy/master/nginx.tmpl > /
 # 获取 docker-compose.yaml 文件
 yum install -y wget && wget -O docker-compose.yaml https://git.io/fpS8N
 
-# 修改 docker-compose.yaml,修改 VIRTUAL_HOST,LETSENCRYPT_HOST 为自己的域名,修改 LETSENCRYPT_EMAIL 为自己的邮箱。
+# 修改 docker-compose.yaml
+# 1. 修改 VIRTUAL_HOST,LETSENCRYPT_HOST 为自己的域名。
+# 2. 修改 LETSENCRYPT_EMAIL 为自己的邮箱。
+# 3. 修改 DB_USER 数据库用户名，注意：这是自定义的，请不要使用默认的！下面数据库密码同理。
+# 4. 修改 DB_PASSWORD 数据库密码。
 
 # 运行
 docker-compose up -d

docker-compose.yaml

@@ -21,12 +21,12 @@ services:
     ports:
       - 8090:8090
     environment:
-      - VIRTUAL_PORT=8090 #监听的端口
-      - VIRTUAL_HOST=localhost  #监听的地址
-      - LETSENCRYPT_HOST=localhost #证书的域名
-      - LETSENCRYPT_EMAIL=i@example.com #证书所有者的邮箱，快过期时会提醒
-      - DB_USER=admin
-      - DB_PASSWORD=123456
+      - VIRTUAL_PORT=8090
+      - VIRTUAL_HOST=localhost  # 监听的地址（务必修改）
+      - LETSENCRYPT_HOST=localhost # 证书的域名 （务必修改）
+      - LETSENCRYPT_EMAIL=i@example.com # 证书所有者的邮箱，快过期时会提醒（务必修改）
+      - DB_USER=admin # h2数据库用户名，自定义（务必修改）
+      - DB_PASSWORD=123456 # h2数据库密码，自定义（务必修改）
     volumes:
       - ~/halo:/root/halo
 

docs/README-en-US.md

@@ -56,7 +56,11 @@ curl https://raw.githubusercontent.com/jwilder/nginx-proxy/master/nginx.tmpl > /
 # Get the docker-compose.yaml
 yum install -y wget && wget -O docker-compose.yaml https://git.io/fpS8N
 
-# Modify docker-compose.yaml, modify VIRTUAL_HOST, LETSENCRYPT_HOST for your own domain name, and modify LETSENCRYPT_EMAIL to your own mailbox.
+# Modify docker-compose.yaml
+# 1. modify VIRTUAL_HOST, LETSENCRYPT_HOST for your own domain name.
+# 2. modify LETSENCRYPT_EMAIL to your own mailbox.
+# 3. modify DB_USER .
+# 4. modify DB_PASSWORD .
 
 # run
 docker-compose up -d