matthiasluedtke/iconserver

besticon Docker镜像文档

镜像概述和主要用途

本镜像为 https://github.com/mat/besticon 项目的Docker封装。besticon是一个开源的网站图标(favicon)服务，用于从指定URL提取、处理和提供网站图标。该镜像提供了便捷的部署方式，可快速搭建用于获取和管理网站图标的服务。

核心功能和特性

• 从目标URL自动提取网站图标(favicon)
• 支持多种图标格式（ICO、PNG、SVG等常见格式）
• 提供HTTP API接口，便于外部应用集成
• 内置缓存机制，优化重复请求性能
• 轻量级设计，资源占用低，部署简单

使用场景和适用范围

• 网站开发中需要展示外部网站图标的场景
• 构建图标聚合服务或书签管理工具
• 开发需要批量获取网站图标的应用
• 个人或企业内部需要快速部署图标服务的场景

使用方法和配置说明

基本部署

通过以下命令快速启动服务：

bash
docker run -d -p 8080:8080 --name besticon mat/besticon

• 参数说明：
  • -d：后台运行容器
  • -p 8080:8080：端口映射（主机端口:容器端口，默认使用8080）
  • --name besticon：指定容器名称
  • mat/besticon：镜像名称

访问服务

服务启动后，可通过以下方式访问：

• Web界面：访问 http://localhost:8080 查看服务状态和使用示例
• API调用：通过 http://localhost:8080/icon?url=<目标URL> 获取指定网站图标，例如：

  http://localhost:8080/icon?url=github.com
  

高级配置

自定义端口

如需使用非默认端口（8080），可通过环境变量 PORT 指定：

bash
docker run -d -p 3000:3000 -e PORT=3000 --name besticon mat/besticon

数据持久化

通过挂载卷实现缓存数据持久化：

bash
docker run -d -p 8080:8080 -v ./besticon-cache:/app/cache --name besticon mat/besticon

• -v ./besticon-cache:/app/cache：将主机当前目录下的 besticon-cache 文件夹挂载到容器内的缓存目录

容器管理

• 停止服务：docker stop besticon
• 重启服务：docker restart besticon
• 查看日志：docker logs besticon
• 删除容器：docker rm -f besticon