Skip to content

Latest commit

 

History

History
91 lines (62 loc) · 3.94 KB

advanced-startup.md

File metadata and controls

91 lines (62 loc) · 3.94 KB
Raw

自定义启动参数

程序目前的启动参数，可以从环境变量或从命令行参数中解析获得。

默认推荐使用一种方案进行参数配置，如果你有特殊需求，需要混合使用。

请注意，命令行参数拥有更高的优先级，会覆盖环境变量中的参数。

环境变量

修改程序监听端口          "FLARE_PORT"
配置登陆模式下的账号      "FLARE_USER"
配置登陆模式下的密码      "FLARE_PASS"
启用或禁用程序向导        "FLARE_GUIDE"
启用程序废弃功能提示      "FLARE_DEPRECATED_NOTICE"
启用服务端请求合并功能     "FLARE_MINI_REQUEST"
禁用登陆模式             "FLARE_DISABLE_LOGIN"
启用离线模式             "FLARE_OFFLINE"
启用在线编辑器功能        "FLARE_EDITOR"
首页是否需要登陆可见      "FLARE_VISIBILITY"

环境变量使用示例： FLARE_OFFLINE=0 或 FLARE_OFFLINE=false

完全的环境变量列表，可以参考这里。

命令行参数

docker run --rm -it -p 5005:5005 soulteary/flare:0.5.1 flare
找不到配置文件config，创建默认配置。
[22:49:49.562] INFO: Flare - 🏂 Challenge all bookmarking apps and websites directories, Aim to Be a best performance monster.
[11:23:23.622] INFO: 程序信息： {"GOGS/ARCH":"linux/arm64","commit":"4D2A2143715A30FC1646DE067847322A8C6F91BF","date":"2024-01-06T03:24:10Z","version":"0.5.1"}
[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")
  -m, --mini_request        使用请求最小化模式
  -o, --offline             启用离线模式
  -l, --disable_login       禁用账号登陆 (default true)
  -n, --enable_notice       启用废弃日志警告 (default true)
  -e, --enable_editor       启用编辑器 (default true)
  -c, --disable_csp         禁用CSP
  -v, --version             显示应用版本号
  -h, --help                显示帮助

功能说明

合并资源请求

  • 环境变量：FLARE_MINI_REQUEST
  • 命令行：mini_request / m

这个参数的作用是“合并页面请求资源，减少页面资源请求总数量”，在一些书签数据量极大的场景下，可以大幅提升页面渲染性能。

小伙伴可以根据自己的情况按需开启，此参数默认关闭。

启用方法，在 flare 启动参数后添加 -m=1 或者设置环境变量 FLARE_MINI_REQUEST=1

免登陆模式：disable_login

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

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

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

离线模式：offline

当这个参数开启之后，flare 所有依赖公网的功能将被停用。

目前 flare 仅会调用 issue#4 中提到的 https://wis.qq.com/weather/common 接口获取天气数据，和 IPIP 的地理位置接口获取地理信息，开启此参数后，天气将无法获取。

此参数默认关闭，开启方法，在 flare 启动参数后添加：--offline=1

指定端口：port

这个参数用于自定义服务端口，使用 docker-flare 的小伙伴可以忽略。