Skip to content

Commit

Permalink
docs: update 0.5.0
Browse files Browse the repository at this point in the history
  • Loading branch information
soulteary committed Jan 5, 2024
1 parent 04cc359 commit 366abc7
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 9 deletions.
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

## 目录

* [0.5.0](#050---2024-01-05)
* [0.4.3](#043---2023-12-07)
* [0.4.2](#042---2023-12-06)
* [0.4.1](#041---2023-05-07)
Expand All @@ -23,6 +24,14 @@
* [0.2.0](#020---2022-01-30)
* [0.1.0](#010---2022-01-27)

# 0.5.0 - 2024-01-05

- [优化] 使用 Go 新版日志工具替换三方日志库,性能提升。
- [修正] 修正一个 HTML Tag 笔误。( 感谢 @LightAPIs 同学 #37
- [修正] 修正华为手机访问时的样式问题。( 感谢 @LightAPIs 同学 #38
- [修正] 修正一个潜在的程序隐患,让程序运行更加稳定。
- [优化] 完善程序解析参数时的测试覆盖率。

# 0.4.3 - 2023-12-07

- [修正] 修正因为 Golang 版本更新,导致的模版解析出现的展示异常。
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ cd docker-flare
docker pull soulteary/flare
docker run --rm -it -p 5005:5005 -v `pwd`/app:/app soulteary/flare
# 也可以追求明确,使用固定版本
docker pull soulteary/flare:0.4.3
docker run --rm -it -p 5005:5005 -v `pwd`/app:/app soulteary/flare:0.4.3
docker pull soulteary/flare:0.5.0
docker run --rm -it -p 5005:5005 -v `pwd`/app:/app soulteary/flare:0.5.0
```

如果你习惯使用 docker-compose,只需要执行:
Expand Down
23 changes: 16 additions & 7 deletions docs/advanced-startup.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,20 @@
## 命令行参数

```
docker run --rm -it -p 5005:5005 soulteary/flare:0.4.3 flare -h
docker run --rm -it -p 5005:5005 soulteary/flare:0.5.0 flare
找不到配置文件config,创建默认配置。
Flare v0.4.3-0ACDB1AC2E46F39CEBBEB70921A8234465FA9837 linux/arm64 BuildDate=2023-12-07T13:08:58Z
支持命令:
[22:49:49.562] INFO: Flare - 🏂 Challenge all bookmarking apps and websites directories, Aim to Be a best performance monster.
[22:49:49.562] INFO: 程序信息: {"GOGS/ARCH":"linux/arm64","commit":"939551F662C12D0067C6952CC7DC036FA713A506","date":"2024-01-05T13:59:30Z","version":"0.5.0"}
[22:49:49.562] INFO: 程序服务端口 {"port":5005}
[22:49:49.562] INFO: 页面请求合并 {"mini_request":false}
[22:49:49.562] INFO: 启用离线模式 {"offline":false}
[22:49:49.562] INFO: 已禁用登陆模式,用户可直接调整应用设置。
[22:49:49.563] INFO: 在线编辑模块启用,可以访问 /editor 来进行数据编辑。
[22:49:49.563] INFO: 向导模块启用,可以访问 /guide 来获取程序使用帮助。
[22:49:49.563] INFO: 程序已启动完毕 🚀
支持命令:
-p, --port int 指定监听端口 (default 5005)
-g, --guide 启用应用向导 (default true)
-s, --visibility string 调整网站整体可见性 (default "DEFAULT")
Expand All @@ -61,13 +69,14 @@ Flare v0.4.3-0ACDB1AC2E46F39CEBBEB70921A8234465FA9837 linux/arm64 BuildDate=2023
小伙伴可以根据自己的情况按需开启,此参数默认关闭。

启用方法,在 flare 启动参数后添加 `-m=1` 或者设置环境变量 `FLARE_MINI_REQUEST=1`
### 免登陆模式:`nologin`

### 免登陆模式:`disable_login`

当这个参数关闭之后,用户需要在登陆之后,才能够对设置页面的内容进行调整,适合 Flare 在公网环境中使用的小伙伴。

此参数默认开启,方便在 HomeLab 或本地使用的小伙伴,减少不必要的操作。

禁用方法,在 flare 启动参数后添加 `--nologin=0`
禁用方法,在 flare 启动参数后添加 `--disable_login=0`

### 离线模式:`offline`

Expand Down

0 comments on commit 366abc7

Please sign in to comment.