mhzawadi/flame

Flame

镜像概述和主要用途

Flame是一款自托管的服务器起始页，其设计深受https://github.com/jeroenpardon/sui%E5%90%AF%E5%8F%91%E3%80%82%E5%AE%83%E9%9D%9E%E5%B8%B8%E6%98%93%E4%BA%8E%E8%AE%BE%E7%BD%AE%E5%92%8C%E4%BD%BF%E7%94%A8%EF%BC%8C%E9%80%9A%E8%BF%87%E5%86%85%E7%BD%AE%E7%BC%96%E8%BE%91%E5%99%A8%EF%BC%8C%E6%97%A0%E9%9C%80%E6%96%87%E4%BB%B6%E7%BC%96%E8%BE%91%E5%8D%B3%E5%8F%AF%E5%BF%AB%E9%80%9F%E6%90%AD%E5%BB%BA%E4%B8%AA%E4%BA%BA%E5%BA%94%E7%94%A8%E4%B8%AD%E5%BF%83%EF%BC%8C%E5%B8%AE%E5%8A%A9%E7%94%A8%E6%88%B7%E9%9B%86%E4%B8%AD%E7%AE%A1%E7%90%86%E6%9C%8D%E5%8A%A1%E5%99%A8%E4%B8%8A%E7%9A%84%E5%BA%94%E7%94%A8%E5%92%8C%E4%B9%A6%E7%AD%BE%E3%80%82

核心功能和特性

• 📝 直接通过内置GUI编辑器创建、更新、删除应用和书签
• 📌 将常用项目固定到主页，方便快速访问
• 🔍 集成搜索栏，支持本地过滤、11种网络搜索提供商及自定义搜索
• 🔑 认证系统，保护设置、应用和书签安全
• 🔨 丰富的界面自定义选项，包括自定义CSS支持和15种内置颜色主题
• ☀️ 天气小部件，显示当前温度、云量和动态天气状态
• 🐳 Docker集成，可根据容器标签自动识别并添加应用

使用场景和适用范围

适用于自托管服务器用户，需要集中管理多个应用和书签的个人或团队，以及希望自定义服务器起始页界面的用户。尤其适合家庭服务器、个人云服务器用户，帮助提升日常操作效率。

详细使用方法和配置说明

安装

Docker安装（推荐）

https://hub.docker.com/r/pawelmalak/flame

sh
# 拉取镜像
docker pull pawelmalak/flame

# ARM架构（如树莓派）
docker pull pawelmalak/flame:multiarch

# 拉取特定版本
docker pull pawelmalak/flame:2.0.0

部署

sh
# 运行容器
docker run -p 5005:5005 -v /path/to/data:/app/data -e PASSWORD=flame_password flame

构建镜像

sh
# 仅构建amd64架构镜像
docker build -t flame -f .docker/Dockerfile .

# 构建多架构镜像（amd64、armv7、arm64）
# 2GB内存限制下可能构建失败，建议增加内存
docker buildx build \
  --platform linux/arm/v7,linux/arm64,linux/amd64 \
  -f .docker/Dockerfile.multiarch \
  -t flame:multiarch .

Docker-Compose配置

yaml
version: '2.1'
services:
  flame:
    image: pawelmalak/flame:latest
    container_name: flame
    volumes:
      - <host_dir>:/app/data  # 替换为本地数据目录
      - /var/run/docker.sock:/var/run/docker.sock  # 可选，Docker集成功能所需
    ports:
      - 5005:5005
    environment:
      - PASSWORD=flame_password  # 设置访问密码
    restart: unless-stopped

Skaffold部署

sh
# 使用skaffold
skaffold dev

无Docker安装

请参考wiki：https://github.com/pawelmalak/flame/wiki/Installation-without-docker

使用说明

认证

访问https://github.com/pawelmalak/flame/wiki/Authentication%E4%BA%86%E8%A7%A3%E6%9B%B4%E5%A4%9A%E8%AE%A4%E8%AF%81%E7%9B%B8%E5%85%B3%E4%BF%A1%E6%81%AF%E3%80%82

搜索栏

搜索功能

默认搜索设置为搜索所有应用和书签。若要使用特定搜索引擎，需在搜索查询前添加前缀。例如，使用Google搜索"what is docker"，需输入：/g what is docker。

支持的搜索引擎列表、快捷方式及更多搜索功能详情，请访问https://github.com/pawelmalak/flame/wiki/Search-bar%E3%80%82

天气模块设置

1. 从Weather API获取API密钥。

   免费计划每月允许100万次调用，Flame每月调用不超过3000次。

2. 获取位置的经纬度，可通过latlong.net获取。
3. 输入并保存数据，天气小部件将更新并显示在主页上。

Docker集成

要使用Docker集成，每个容器需添加以下标签：

yml
labels:
  - flame.type=application  # "app"也适用
  - flame.name=我的容器
  - flame.url=https://example.com
  - flame.icon=icon-name  # 可选，默认为"docker"
  # - flame.icon=custom 可在应用中上传自定义图标

需在设置 > Docker中启用"使用Docker API"选项。

也可在同一标签中设置多个应用，用;分隔：

yml
labels:
  - flame.type=application
  - flame.name=第一个应用;第二个应用
  - flame.url=https://example1.com;https://example2.com
  - flame.icon=icon-name1;icon-name2

若要使用远程Docker主机，请在主机上执行以下步骤：

• 打开文件/lib/systemd/system/docker.service，搜索ExecStart并编辑：

text
ExecStart=/usr/bin/dockerd -H tcp://0.0.0.0:${PORT} -H unix:///var/run/docker.sock

上述命令将Docker引擎绑定到Unix套接字和指定TCP端口。"0.0.0.0"表示接受所有IP地址的连接。

• 重启守护进程和Docker服务：

shell
sudo systemctl daemon-reload
sudo service docker restart

• 测试是否正常工作：

shell
curl http://${IP}:${PORT}/version

Kubernetes集成

要使用Kubernetes集成，每个Ingress需添加以下注解：

yml
metadata:
  annotations:
  - flame.pawelmalak/type=application  # "app"也适用
  - flame.pawelmalak/name=我的容器
  - flame.pawelmalak/url=https://example.com
  - flame.pawelmalak/icon=icon-name  # 可选，默认为"kubernetes"

需在设置 > Docker中启用"使用Kubernetes Ingress API"选项。

导入HTML书签（实验性）

• 要求
  • python3
  • pip包：Pillow、beautifulsoup4
• 运行脚本前备份db.sqlite！
• 已知问题：生成的图标有时不正确

bash
pip3 install Pillow beautifulsoup4

cd flame/.dev
python3 bookmarks_importer.py --bookmarks <bookmarks.html路径> --data <Flame数据文件夹路径>

自定义CSS和主题

请参考项目wiki：https://github.com/pawelmalak/flame/wiki/Custom-CSS%E5%92%8Chttps://github.com/pawelmalak/flame/wiki/Custom-theme-with-CSS%E3%80%82