Files
appstore/apps/firefly/README.md
T

42 lines
1.4 KiB
Markdown

# 萤火虫
## 应用简介
一款简单、易架设的 WireGuard 服务端软件。
英文说明:A simple and easy to install WireGuard server software.
## 部署说明
- 本应用使用 Docker Compose 在 1Panel 中部署。
- 应用分类:工具。
- 支持架构:amd64。
- 可选版本:`latest``4.4`
- 安装后按应用表单中的端口访问 Web UI、SSH 或对应服务。
## 端口
| 变量 | 说明 | 默认值 | 必填 |
| --- | --- | --- | --- |
| PANEL_APP_PORT_HTTP | 端口 | 40215 | 是 |
## 数据持久化
- `./data:/firefly/conf`
升级或迁移前,请在 1Panel 中备份上述数据目录。
## 配置项
| 变量 | 说明 | 默认值 | 必填 |
| --- | --- | --- | --- |
| FIREFLY_PASSWORD | 网页密码 | password | 是 |
| TIME_ZONE | 时区 | Asia/Shanghai | 是 |
| FIREFLY_AUTO_SSL | 是否启用自动获取 SSL 证书 (开启则需要将端口设置为 443) | false | 是 |
| FIREFLY_DEVICE | WireGuard 出入流量网卡名称 | - | 否 |
## 使用说明
- 安装完成后,在 1Panel 应用页面查看运行状态、端口和日志。
- 首次启用前,请按安装表单填写域名、账号、密码、Token、数据目录等参数。
- 如需对外开放访问,请同步检查防火墙、安全组和反向代理配置。
## 参考资料
- 官网: <https://fahi.uusec.com>
- 文档: <https://github.com/Safe3/firefly/blob/main/README.md>
- 源码: <https://github.com/Safe3/firefly>