docs: update tls desc

zaigie · Feb 3, 2024 · 6f7ef67 · 6f7ef67
1 parent 9398740
commit 6f7ef67
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 3 deletions.
diff --git a/README.en.md b/README.en.md
@@ -117,7 +117,7 @@ Please refer to [pst-agent deployment tutorial](./README.agent.en.md)
 
 ```bash
 # Download pst_{version}_{platform}_{arch}.tar.gz and extract to the pst directory
-mkdir -p pst && tar -xzf pst_v0.5.0_linux_amd64.tar.gz -C pst
+mkdir -p pst && tar -xzf pst_v0.5.0_linux_x86_64.tar.gz -C pst
 ```
 
 ##### Configuration
@@ -137,6 +137,9 @@ mkdir -p pst && tar -xzf pst_v0.5.0_linux_amd64.tar.gz -C pst
    web: # web configuration
      password: "" # web management mode password
      port: 8080 # web service port
+     tls: false # Whether to enable TLS
+     cert_path: "" # Cert File Path
+     key_path: "" # Key File Path
    rcon: # RCON configuration
      address: "127.0.0.1:25575" # RCON address
      password: "" # Set AdminPassword
@@ -212,6 +215,9 @@ You can also right-click - "Properties", view the path and file name, and then c
 web: # web configuration
   password: "" # web management mode password
   port: 8080 # web service port
+  tls: false # Whether to enable TLS
+  cert_path: "" # Cert File Path
+  key_path: "" # Key File Path
 rcon: # RCON configuration
   address: "127.0.0.1:25575" # RCON address
   password: "" # Set AdminPassword

diff --git a/README.md b/README.md
@@ -118,7 +118,7 @@ AdminPassword=...,...,RCONEnabled=true,RCONPort=25575
 
 ```bash
 # 下载 pst_{version}_{platform}_{arch}.tar.gz 文件并解压到 pst 目录
-mkdir -p pst && tar -xzf pst_v0.5.0_linux_amd64.tar.gz -C pst
+mkdir -p pst && tar -xzf pst_v0.5.0_linux_x86_64.tar.gz -C pst
 ```
 
 ##### 配置
@@ -138,6 +138,9 @@ mkdir -p pst && tar -xzf pst_v0.5.0_linux_amd64.tar.gz -C pst
    web: # web 相关配置
      password: "" # web 管理模式密码
      port: 8080 # web 服务端口
+     tls: false # 是否开启 TLS
+     cert_path: "" # Cert 文件路径
+     key_path: "" # Key 文件路径
    rcon: # RCON 相关配置
      address: "127.0.0.1:25575" # RCON 地址
      password: "" # 设置的 AdminPassword
@@ -192,7 +195,7 @@ kill $(ps aux | grep 'pst' | awk '{print $2}') | head -n 1
 
 ##### 下载解压
 
-解压 `pst_v0.5.0_windows_x86.zip` 到任意目录（推荐命名文件夹目录名称为 `pst`）
+解压 `pst_v0.5.0_windows_x86_64.zip` 到任意目录（推荐命名文件夹目录名称为 `pst`）
 
 ##### 配置
 
@@ -213,6 +216,9 @@ kill $(ps aux | grep 'pst' | awk '{print $2}') | head -n 1
 web: # web 相关配置
   password: "" # web 管理模式密码
   port: 8080 # web 服务端口
+  tls: false # 是否开启 TLS
+  cert_path: "" # Cert 文件路径
+  key_path: "" # Key 文件路径
 rcon: # RCON 相关配置
   address: "127.0.0.1:25575" # RCON 地址
   password: "" # 设置的 AdminPassword