Flare简介
flare是一个轻量、快速、美观的个人导航页面,适用于 HomeLab 或其他注重私密的场景。其无任何数据库依赖,应用数据完全开放透明,100% 属于用户自己。
官方地址
GitHub地址:https://github.com/soulteary/docker-flare
Docker hub地址:https://hub.docker.com/r/soulteary/flare
Fare安装
请注意,如需公网访问,请使用第二种方法安装。未设置密码将会产生安全风险!!!!!
Docker安装
docker run --rm -it -p 5005:5005 -v `pwd`/app:/app soulteary/flare
安装完成后直接打开浏览器访问http:127.0.0.1:5005
即可使用
Docker-compose安装
内网无密码使用
version: '3.6'
services:
flare:
image: soulteary/flare:latest
restart: always
# 默认无需添加任何参数,如有特殊需求
# 可阅读文档 https://github.com/soulteary/docker-flare/blob/main/docs/advanced-startup.md
command: flare
# 启用账号登陆模式
# command: flare --nologin=0
# environment:
# 如需开启用户登陆模式,需要先设置 `nologin` 启动参数为 `0`
# 如开启 `nologin`,未设置 FLARE_USER,则默认用户为 `flare`
# - FLARE_USER=flare
# 指定你自己的账号密码,如未设置 `FLARE_USER`,则会默认生成密码并展示在应用启动日志中
# - FLARE_PASS=your_password
# 是否开启“使用向导”,访问 `/guide`
# - FLARE_GUIDE=1
ports:
- 5005:5005
volumes:
#自定义数据文件保存位置
- ./app:/app
公网访问,添加账号密码
version: '3.6'
services:
flare:
image: soulteary/flare:latest
restart: always
# 默认无需添加任何参数,如有特殊需求
# 可阅读文档 https://github.com/soulteary/docker-flare/blob/main/docs/advanced-startup.md
command: flare --disable_login=0 --visibility=private
environment:
# 开启登陆
- FLARE_DISABLE_LOGIN=0
# 设置登陆账号
- FLARE_USER=flare
# 指定你自己的账号密码,如未设置 `FLARE_USER`,则会默认生成密码并展示在应用启动日志中
- FLARE_PASS=your_password
ports:
# 根据自己需求设置端口,如需调整访问端口为 8080,
# 可参考修改为 `- 8080:5005`
- 5005:5005
volumes:
#自定义数据文件保存位置
- ./app:/app
使用向导
官方自带了程序使用向导,会在第一次安装玩成之后打开,之后如需访问向导,可以直接在网址后输入/guide
即可再次访问
环境变量
环境变量 | 值 | 解释 |
---|---|---|
FLARE_PORT | 5505 | 修改程序监听端口 |
FLARE_USER | 例如:user | 配置登陆模式下的账号名称 |
FLARE_PASS" | 例如:password | 配置置登陆模式下的密码 |
FLARE_GUIDE | 0或者1 | 启用或禁用程序向导 |
FLARE_OFFLINE | 0或者1 | 启用离线模式 |
FLARE_EDITOR | 0或者1 | 启用在线编辑器功能 |
FLARE_VISIBILITY | 0或者1 | 首页是否需要登陆可见 |
FLARE_DISABLE_LOGIN | 0或者1 | 禁用登陆模式 |
FLARE_MINI_REQUEST | 0或者1,默认关闭 | 启用服务端请求合并功能 |
FLARE_DEPRECATED_NOTICE | 0或者1 | 启用程序废弃功能提示 |
命令行参数
警告:命令行参数优先级比环境变量更高
-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 显示帮助
功能说明
以下说明来自作者github主页
合并资源请求
这个参数的作用是“合并页面请求资源,减少页面资源请求总数量”,在一些书签数据量极大的场景下,可以大幅提升页面渲染性能。
小伙伴可以根据自己的情况按需开启,此参数默认关闭。
启用方法,在 flare 启动参数后添加 -m=1
或者设置环境变量 FLARE_MINI_REQUEST=1
免登陆模式:nologin
当这个参数关闭之后,用户需要在登陆之后,才能够对设置页面的内容进行调整,适合 Flare 在公网环境中使用的小伙伴。
此参数默认开启,方便在 HomeLab 或本地使用的小伙伴,减少不必要的操作。
禁用方法,在 flare 启动参数后添加 --nologin=0
离线模式:offline
当这个参数开启之后,flare 所有依赖公网的功能将被停用。
目前 flare 仅会调用 issue#4 中提到的 https://wis.qq.com/weather/common
接口获取天气数据,和 IPIP 的地理位置接口获取地理信息,开启此参数后,天气将无法获取。
此参数默认关闭,开启方法,在 flare 启动参数后添加:--offline=1
指定端口:port
这个参数用于自定义服务端口,使用 docker-flare
的小伙伴可以忽略。