diff --git a/CHANGELOG.md b/CHANGELOG.md index 1428ce4..b101086 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,7 @@ ## 目录 +* [0.2.6](#026---2022-02-17) * [0.2.5](#025---2022-02-16) * [0.2.4](#024---2022-02-11) * [0.2.3](#023---2022-02-08) @@ -11,7 +12,11 @@ * [0.2.0](#020---2022-01-30) * [0.1.0](#010---2022-01-27) +## 0.2.6 - 2022-02-17 +当前版本新增了一个简单的功能,“使用向导”,相比较阅读文章,十几秒钟的交互引导会更直观一些。 + +- [新增] 用户使用向导,访问 `/guide` 即可使用,如果不需要这个功能,可以在环境变量中配置 `FLARE_GUIDE=0` 来关闭功能。 ## 0.2.5 - 2022-02-16 diff --git a/README.md b/README.md index e3341b5..8a2de2a 100644 --- a/README.md +++ b/README.md @@ -36,21 +36,35 @@ cd docker-flare 启动应用非常简单,如果你习惯使用 Docker,可以执行: ```bash -docker run --rm -it -p 5005:5005 -v `pwd`/app:/app soulteary/flare:0.2.5 +docker run --rm -it -p 5005:5005 -v `pwd`/app:/app soulteary/flare:0.2.6 ``` -如果你习惯使用 docker-compose: +如果你习惯使用 docker-compose,只需要执行: ```bash docker-compose up -d ``` -在命令执行完毕之后,默认访问浏览器的 `5005` 端口,就能看到下面的界面啦: +如果你是 Traefik 用户,可以参考 `docker-compose.traefik.yml` 配置文件来使用。 + +不论是哪一种方式,在命令执行完毕之后,默认情况下,我们访问浏览器的 `5005` 端口,就能看到下面的界面啦: ![Flare Web UI](./screenshots/ui.png) +### 应用使用向导 + +为了方便你的使用,我制作了一个简单的向导程序,在 flare 启动之后,你可以随时访问 `/guide`,获取 flare 基础界面功能的介绍。 + +![Flare Guide](./screenshots/flare-guide.png) + +## 应用性能 + +“快”作为 Flare 对主要优势而言,自然是需要“满分”来加持。 + ![Flare Lighthouse Scores](./screenshots/lighthouse.png) +如果你好奇这是如何实现的,可以阅读这篇文章:[《Flare 制作记录:应用前后端性能优化》](https://soulteary.com/2022/01/19/flare-production-record-application-frontend-and-backend-performance-optimization.html)。 + ## 进阶文档 - [自定义启动参数](./docs/advanced-startup.md) diff --git a/docker-compose.yml b/docker-compose.yml index a23d2b1..d63d158 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -2,7 +2,7 @@ version: '3.6' services: flare: - image: soulteary/flare:0.2.5 + image: soulteary/flare:0.2.6 restart: always # 默认无需添加任何参数,如有特殊需求 # 可阅读文档 https://github.com/soulteary/docker-flare/blob/main/docs/advanced-startup.md @@ -15,6 +15,8 @@ services: # - FLARE_USER=flare # 指定你自己的账号密码,如未设置 `FLARE_USER`,则会默认生成密码并展示在应用启动日志中 # - FLARE_PASS=your_password + # 是否开启“使用向导”,访问 `/guide` + # - FLARE_GUIDE=1 ports: - 5005:5005 volumes: diff --git a/docs/application-account.md b/docs/application-account.md index 562425d..abf3f51 100644 --- a/docs/application-account.md +++ b/docs/application-account.md @@ -13,7 +13,7 @@ version: '3.6' services: flare: - image: soulteary/flare:0.2.5 + image: soulteary/flare:0.2.6 restart: always # 默认无需添加任何参数,如有特殊需求 # 可阅读文档 https://github.com/soulteary/docker-flare/blob/main/docs/advanced-startup.md @@ -34,14 +34,15 @@ services: 当你使用 `docker-compose up -d` 启动应用之后,接着使用 `docker-compose ps`,就可以看到包含密码的日志输出啦: ```bash -docker-flare-flare-1 | 2022/02/16 14:11:14 用户未指定 `FLARE_USER`,使用默认用户名 flare -docker-flare-flare-1 | 2022/02/16 14:11:14 用户未指定 `FLARE_PASS`,自动生成应用密码 7fc0e7cbc1356c93 -docker-flare-flare-1 | 2022/02/16 14:11:14 -docker-flare-flare-1 | 2022/02/16 14:11:14 Flare v0.2.5-DD66850 linux/amd64 BuildDate=2022-02-16T13:36:31+0800 -docker-flare-flare-1 | 2022/02/16 14:11:14 -docker-flare-flare-1 | 2022/02/16 14:11:14 服务端口 5005 -docker-flare-flare-1 | 2022/02/16 14:11:14 合并页面资源请求 false -docker-flare-flare-1 | 2022/02/16 14:11:14 启用应用离线模式 false -docker-flare-flare-1 | 2022/02/16 14:11:14 启用免登陆模式 true -docker-flare-flare-1 | 2022/02/16 14:11:14 应用已启动 🚀 +docker-flare-flare-1 | 2022/02/17 13:35:04 用户未指定 `FLARE_USER`,使用默认用户名 flare +docker-flare-flare-1 | 2022/02/17 13:35:04 用户未指定 `FLARE_PASS`,自动生成应用密码 cd888435ec5678d6 +docker-flare-flare-1 | 2022/02/17 13:35:04 +docker-flare-flare-1 | 2022/02/17 13:35:04 Flare v0.2.6-E7DDC50 linux/amd64 BuildDate=2022-02-17T13:10:50+0800 +docker-flare-flare-1 | 2022/02/17 13:35:04 +docker-flare-flare-1 | 2022/02/17 13:35:04 服务端口 5005 +docker-flare-flare-1 | 2022/02/17 13:35:04 合并页面资源请求 false +docker-flare-flare-1 | 2022/02/17 13:35:04 启用应用离线模式 false +docker-flare-flare-1 | 2022/02/17 13:35:04 启用免登陆模式 true +docker-flare-flare-1 | 2022/02/17 13:35:04 启用教程模块,可以访问 /guide 来获取“使用向导”。 +docker-flare-flare-1 | 2022/02/17 13:35:04 应用已启动 🚀 ``` \ No newline at end of file diff --git a/screenshots/docker-image-size.png b/screenshots/docker-image-size.png index 2fb664a..067db24 100644 Binary files a/screenshots/docker-image-size.png and b/screenshots/docker-image-size.png differ diff --git a/screenshots/flare-guide.png b/screenshots/flare-guide.png new file mode 100644 index 0000000..525b42d Binary files /dev/null and b/screenshots/flare-guide.png differ