Skip to content

Commit 8d33d1e

Browse files
committed
feat: update README to reflect changes in config.yaml file and remove environment variable section
1 parent 28962f9 commit 8d33d1e

File tree

1 file changed

+18
-31
lines changed

1 file changed

+18
-31
lines changed

README.md

Lines changed: 18 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -16,24 +16,24 @@
1616
- **动态加载**:支持动态加载分类和图片,提升用户体验。
1717
- **认证功能**:通过密码保护访问,未认证用户需登录。
1818
- **分页支持**:分类和图片支持分页加载。
19-
- **自定义配置**通过环境变量自定义站点配置
19+
- **自定义配置**通过编辑config.yaml文件自定义站点配置
2020
- **第三方登录**:Linux do
2121

22-
## 环境变量配置
22+
## 配置config.yaml文件
2323

24-
以下环境变量可用于自定义站点配置
24+
自定义站点配置
2525

26-
- `SITE_DIR`:图片目录路径(默认值:`./images`)。
27-
- `SITE_SECURE`:是否开启密码访问,默认关闭为 `false`
28-
- `SITE_PASSWORD`:访问密码(默认值:空)。
29-
- `SITE_PORT`:服务端口(默认值:`8008`)。
30-
- `SITE_TITLE`:站点标题(默认值:`在线图集`)。
31-
- `SITE_ICON`:站点图标 URL(默认值:`https://i.obai.cc/favicon.ico`)。
32-
- `SITE_DYNAMIC`:是否启用动态加载(默认值:`false`不启用)。
33-
- `SITE_Address`:站点地址,接入Linux do 登录必须设置(默认值 `http://localhost:8008`
34-
- `SITE_LINUXDO`:设置是否接入Linux do 登录,设置 `true` 开启(默认值为 `false`
35-
- `SITE_CLIENT_ID`:Linux do 客户端ID , https://connect.linux.do 中获取
36-
- `SITE_CLIENT_SECRET`:Linux do 客户端密钥
26+
- `image_dir`:图片目录路径(默认值:`./images`)。
27+
- `secure`:是否开启密码访问,默认关闭为 `false`
28+
- `password`:访问密码(默认值:空)。
29+
- `port`:服务端口(默认值:`8008`)。
30+
- `title`:站点标题(默认值:`在线图集`)。
31+
- `icon`:站点图标 URL(默认值:`https://i.051214.xyz/favicon.ico`)。
32+
- `dynamic`:是否启用动态加载(默认值:`true`启用)。
33+
- `web_adderss`:站点地址,接入Linux do 登录必须设置(默认值 `http://localhost:8008`
34+
- `linuxdo_enable`:设置是否接入Linux do 登录,设置 `true` 开启(默认值为 `false`
35+
- `linuxdo_client_id`:Linux do 客户端ID , https://connect.linux.do 中获取
36+
- `linuxdo_client_secret`:Linux do 客户端密钥
3737

3838
## 启动项目
3939

@@ -51,31 +51,18 @@ docker run -p 8008:8008 -v /images:/app/images --restart always -e SITE_TITLE=
5151
services:
5252
plist:
5353
image: 'kukudebai/plist:latest'
54-
environment:
55-
# - SITE_DIR=./images
56-
# - SITE_PORT=8008
57-
# - SITE_TITLE=站点标题
58-
# - SITE_ICON=https://i.obai.cc/favicon.ico
59-
# - SITE_DYNAMIC=false
60-
# - SITE_LINUXDO=false
61-
# - SITE_Address=http://localhost:8008
62-
# - SITE_CLIENT_ID=
63-
# - SITE_CLIENT_SECRET=
64-
# - SITE_SECURE=false
65-
# - SITE_PASSWORD=
6654
restart: always
6755
volumes:
68-
- '/images:/app/images'
56+
- './images:/app/images'
57+
- './conf:/app/conf'
6958
ports:
7059
- '8008:8008'
7160
```
7261
7362
### 二进制运行
7463
7564
1. 从Release下载系统对应版本
76-
2. 设置环境变量
77-
- [https://cn.bing.com/search?q=windows+%E8%AE%BE%E7%BD%AE%E7%8E%AF%E5%A2%83%E5%8F%98%E9%87%8F](https://cn.bing.com/search?q=windows+%E8%AE%BE%E7%BD%AE%E7%8E%AF%E5%A2%83%E5%8F%98%E9%87%8F)
78-
- [https://cn.bing.com/search?q=Linux+%E8%AE%BE%E7%BD%AE%E7%8E%AF%E5%A2%83%E5%8F%98%E9%87%8F](https://cn.bing.com/search?q=Linux+%E8%AE%BE%E7%BD%AE%E7%8E%AF%E5%A2%83%E5%8F%98%E9%87%8F)
65+
2. 配置config.yaml文件
7966
3. 直接运行即可,注册为后台服务请查阅相关文档
8067
- [https://cn.bing.com/search?q=%E5%B0%86%E7%A8%8B%E5%BA%8F%E8%BF%9B%E7%A8%8B%E6%B3%A8%E5%86%8C%E4%B8%BALinux%E7%B3%BB%E7%BB%9F%E6%9C%8D%E5%8A%A1](https://cn.bing.com/search?q=%E5%B0%86%E7%A8%8B%E5%BA%8F%E8%BF%9B%E7%A8%8B%E6%B3%A8%E5%86%8C%E4%B8%BALinux%E7%B3%BB%E7%BB%9F%E6%9C%8D%E5%8A%A1)
8168
- [https://cn.bing.com/search?q=%E5%B0%86%E7%A8%8B%E5%BA%8F%E8%BF%9B%E7%A8%8B%E6%B3%A8%E5%86%8C%E4%B8%BAwindows%E6%9C%8D%E5%8A%A1](https://cn.bing.com/search?q=%E5%B0%86%E7%A8%8B%E5%BA%8F%E8%BF%9B%E7%A8%8B%E6%B3%A8%E5%86%8C%E4%B8%BAwindows%E6%9C%8D%E5%8A%A1)
@@ -86,7 +73,7 @@ services:
8673
2. 将项目克隆到本地并进入项目目录。
8774
3. 使用以下命令运行项目:
8875
```sh
89-
go run main.go
76+
go run .
9077
```
9178

9279
## 路由说明

0 commit comments

Comments
 (0)