navystack/focalboard

navystack/focalboard - Docker镜像文档

---

https://github.com/Navystack/focalboard-ns/actions/workflows/docker-image.yml/badge.svg](https://github.com/Navystack/focalboard-ns/actions/workflows/docker-image.yml)

---

镜像概述

navystack/focalboard是一个非官方的Focalboard跨平台Docker镜像。Focalboard是一款开源、自托管的项目管理工具，类似于Trello、Asana或Notion，支持看板、表格、日历和画廊等多种视图，帮助团队高效协作和项目跟踪。

该镜像提供了多种配置选项，包括不同的Web服务器集成，适合各种部署场景，并针对性能和易用性进行了优化。

核心功能和特性

• 多架构支持：同时支持amd64和arm64(aarch64)架构
• 多阶段构建：采用多阶段构建工艺，显著减小镜像体积
• Web服务器集成：
  • 包含Nginx和OpenResty两种Web服务器选项
  • 预配置Gzip和Brotli压缩
  • 内置WebSocket支持，确保实时功能正常工作
  • PageSpeed模块待命，可根据需要启用
• 性能优化：
  • 智能压缩策略：1024字节以下文件不压缩
  • 避免无意义的图像重新压缩
• 灵活的数据库支持：
  • 默认配置为SQLite
  • 支持MySQL/MariaDB和PostgreSQL（需额外配置）
• 自动更新：
  • Nginx使用Mainline版本
  • Openresty使用Upstream版本
  • Focalboard版本跟随官方Git仓库更新

支持的标签和架构

重要提示：使用latest标签时，如果在前端部署反向代理，必须配置WebSocket相关设置。推荐使用nginx标签以简化部署。

使用场景和适用范围

1. 个人项目管理：单用户部署，用于管理个人任务和项目
2. 团队协作：小型团队的任务跟踪和项目管理
3. 开发团队：敏捷开发中的Scrum看板和任务分配
4. 教育机构：学生项目管理和作业跟踪
5. 企业环境：部门级项目管理和团队协作

快速开始

使用Docker Run

Nginx版本（推荐）

bash
docker run -d \
  --name focalboard \
  -p 80:80 \
  -v ./data:/opt/focalboard/data \
  navystack/focalboard:nginx

基础版本

bash
docker run -d \
  --name focalboard \
  -p 9000:9000 \
  -v ./data:/opt/focalboard/data \
  navystack/focalboard:latest

使用Docker Compose

1. 克隆仓库

bash
git clone https://github.com/NavyStack/focalboard-ns.git
cd focalboard-ns

2. 修改docker-compose.yml文件（以MySQL为例）

yaml
version: '3'

services:
  focalboard-db:
    image: mysql:latest
    container_name: focalboard-db
    environment:
      MYSQL_USER: focalboard
      MYSQL_PASSWORD: powerpassword
      MYSQL_DATABASE: focalboard
      MYSQL_ROOT_PASSWORD: powerpassword
    volumes:
      - focalboard-db:/var/lib/mysql
    restart: unless-stopped

  focalboard:
    image: navystack/focalboard:nginx
    container_name: focalboard
    ports:
      - "80:80"
    depends_on:
      - focalboard-db
    volumes:
      - ./config.json:/opt/focalboard/config.json
      - focalboard-data:/opt/focalboard/data
    restart: unless-stopped

volumes:
  focalboard-db:
  focalboard-data:

3. 根据docker-compose配置修改config.json

json
{
  "serverRoot": "http://localhost",
  "port": 8000,
  "dbtype": "mysql",
  "dbconfig": "focalboard:powerpassword@tcp(focalboard-db:3306)/focalboard",
  "useSSL": false,
  "webpath": "./pack",
  "filespath": "./data/files",
  "telemetry": true,
  "prometheusaddress": ":9092",
  "session_expire_time": 2592000,
  "session_refresh_time": 18000,
  "localOnly": false,
  "enableLocalMode": true,
  "localModeSocketLocation": "/var/tmp/focalboard_local.socket",
  "enablePublicSharedBoards": true
}

4. 启动服务

bash
docker compose up -d

详细配置说明

环境变量

目前该镜像主要通过配置文件进行设置，未来计划支持更多环境变量动态配置。

配置文件

配置文件config.json是Focalboard的主要配置方式，关键配置项说明：

数据库设置

MySQL/MariaDB配置

json
{
  "dbtype": "mysql",
  "dbconfig": "用户名:密码@tcp(数据库地址:3306)/数据库名?charset=utf8mb4&parseTime=True&loc=Local"
}

PostgreSQL配置

json
{
  "dbtype": "postgres",
  "dbconfig": "host=数据库地址 port=5432 user=用户名 password=密码 dbname=数据库名 sslmode=disable"
}

SQLite配置（默认）

json
{
  "dbtype": "sqlite3",
  "dbconfig": "./focalboard.db"
}

高级配置

Nginx配置

如果需要自定义Nginx配置，可以通过挂载配置文件的方式实现：

bash
docker run -d \
  --name focalboard \
  -p 80:80 \
  -v ./nginx.conf:/etc/nginx/conf.d/default.conf \
  -v ./data:/opt/focalboard/data \
  navystack/focalboard:nginx

默认Nginx配置已包含：

• Gzip和Brotli压缩
• WebSocket支持
• 静态文件缓存
• PageSpeed模块（默认未启用）

性能优化

1. 启用PageSpeed模块：修改Nginx配置，取消PageSpeed相关配置的注释
2. 调整压缩策略：根据需求修改Nginx的压缩阈值和类型
3. 数据库优化：对于MySQL/PostgreSQL，根据使用情况调整数据库参数

常见问题

如何支持中文输入？

确保数据库使用UTF-8编码（如MySQL的utf8mb4字符集），默认配置已支持中文。

如何升级到新版本？

1. 拉取最新镜像：docker pull navystack/focalboard:nginx
2. 停止并删除当前容器：docker stop focalboard && docker rm focalboard
3. 使用相同的命令重新启动容器

如何备份数据？

1. SQLite：备份数据目录中的focalboard.db文件
2. MySQL/MariaDB：使用mysqldump命令备份数据库
3. PostgreSQL：使用pg_dump命令备份数据库

相关资源

• https://github.com/NavyStack/focalboard-ns/
• https://hub.docker.com/r/navystack/focalboard/
• 官方Focalboard文档

待办事项

• 支持Docker环境变量动态配置
• 添加Traefik配置示例

许可证

本项目贡献部分采用MIT许可证授权 SPDX-License-Identifier: MIT OR GNU AGPLv3

与所有Docker镜像一样，本镜像可能包含其他适用不同许可证的软件（例如基础发行版中的Bash等包含的软件）。使用预构建镜像时，确保遵守镜像中包含的所有软件的相关许可证是用户的责任。

所有商标均为其各自所有者的财产，除非另有说明，否则本文档中提及的任何商标均不暗示与商标所有者或其他公司有任何关联、赞助或关联关系。