Skip to content

docs: add dynamic url description #153

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
LightAPIs wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add dynamic url description #153

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions docs/advanced-startup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,3 +80,30 @@ Flare v0.4.3-0ACDB1AC2E46F39CEBBEB70921A8234465FA9837 linux/arm64 BuildDate=2023
### 指定端口：`port`

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

### 动态链接

> [!TIP]
> Since: v0.4.2 - 2023.12.06

根据环境，进行动态链接的展示和切换。

假设 flare 服务的首页地址为 `https://192.168.0.1:5005/`，以下可用的各参数及其对应解析结果：

| 参数名 | 解析结果 |
| --- | --- |
| `host` | `192.168.0.1:5005` |
| `hostname` | `192.168.0.1` |
| `href` | `https://192.168.0.1:5005/` |
| `origin` | `https://192.168.0.1:5005` |
| `pathname` | `/` |
| `port` | `5005` |
| `protocol` | `https:` |

**示例**

假设某书签网址配置为 `https://{hostname}:8888/test` 时:

- 当 flare 服务的首页地址为 `https://192.168.0.1:5005/`，其显示为 `https://192.168.0.1:8888/test`。
- 当 flare 服务的首页地址为 `https://172.17.0.1:5005/`，其显示为 `https://172.17.0.1:8888/test`。
- 当 flare 服务的首页地址为 `https://link.example.com/`，其显示为 `https://link.example.com:8888/test`。