Skip to content

Commit

Permalink
docs: update version 0.2.6
Browse files Browse the repository at this point in the history
  • Loading branch information
soulteary committed Feb 17, 2022
1 parent 40dfb14 commit fbf0365
Show file tree
Hide file tree
Showing 6 changed files with 37 additions and 15 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,19 @@

## 目录

* [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)
* [0.2.1](#021---2022-02-07)
* [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

Expand Down
20 changes: 17 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
4 changes: 3 additions & 1 deletion docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -15,6 +15,8 @@ services:
# - FLARE_USER=flare
# 指定你自己的账号密码,如未设置 `FLARE_USER`,则会默认生成密码并展示在应用启动日志中
# - FLARE_PASS=your_password
# 是否开启“使用向导”,访问 `/guide`
# - FLARE_GUIDE=1
ports:
- 5005:5005
volumes:
Expand Down
23 changes: 12 additions & 11 deletions docs/application-account.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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 应用已启动 🚀
```
Binary file modified screenshots/docker-image-size.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/flare-guide.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit fbf0365

Please sign in to comment.