LinuxServer Planka Docker镜像文档

镜像概述和主要用途

Planka 是一款优雅的开源项目跟踪工具，提供直观的Web界面用于任务管理和项目协作。LinuxServer.io团队提供的Docker镜像简化了Planka的部署流程，支持多架构运行，并包含定期更新、用户权限管理等增强特性，适用于需要自托管项目管理解决方案的团队或个人。

核心功能和特性

LinuxServer.io镜像特性

• 定期应用更新：及时同步上游应用版本
• 灵活用户映射：通过PUID/PGID实现容器内用户与宿主机用户权限对齐
• 自定义基础镜像：集成s6 overlay进程管理系统
• 高效资源利用：每周基础OS更新，跨镜像共享通用层，减少存储空间占用和带宽消耗
• 持续安全加固：定期安全更新和漏洞修复

Planka应用特性

• 直观Web界面：简洁易用的项目跟踪看板
• 多媒体支持：用户头像、项目背景图和附件管理
• 用户权限管理：支持管理员账户和多用户协作
• 数据持久化：配置和媒体文件可通过卷挂载持久化存储

使用场景和适用范围

• 团队项目管理：跟踪任务进度、分配职责、管理项目里程碑
• 个人任务规划：用于个人待办事项管理和时间规划
• 自托管解决方案：适合对数据隐私有要求，需要本地部署项目管理工具的组织
• 开发团队协作：与Git工作流结合，管理开发任务和Bug跟踪

注意：使用前需准备外部PostgreSQL数据库服务。

支持的架构

该镜像通过Docker Manifest支持多平台部署，拉取lscr.io/linuxserver/planka:latest即可自动匹配对应架构，也可通过标签指定具体架构：

应用设置

基本访问

Web界面可通过 [***] 访问，默认端口为1337。

首次运行配置

• 首次启动需设置DEFAULT_前缀的环境变量（管理员账户信息），完成初始配置后建议移除这些变量，避免后续启动时覆盖Web界面中修改的用户设置（如密码、显示名等）。

从***镜像迁移

若从Planka***镜像迁移，需将以下目录复制到新的/config挂载点：

text
/config
├── attachments              # 附件文件
├── project-background-images # 项目背景图片
└── user-avatars             # 用户头像

部署方法

Docker Compose配置（推荐）

yaml
---
services:
  planka:
    image: lscr.io/linuxserver/planka:latest
    container_name: planka
    environment:
      - PUID=1000                # 用户ID（通过`id your_user`获取）
      - PGID=1000                # 组ID（通过`id your_user`获取）
      - TZ=Etc/UTC               # 时区（参考时区数据库列表）
      - BASE_URL=[***]  # 访问Planka的完整URL（含协议）
      - DATABASE_URL=postgresql://user:password@planka-db:5432/planka  # PostgreSQL连接串
      - DEFAULT_ADMIN_EMAIL=***  # 默认管理员***（首次运行后可移除）
      - DEFAULT_ADMIN_USERNAME=demo         # 默认管理员用户名（首次运行后可移除）
      - DEFAULT_ADMIN_PASSWORD=demo         # 默认管理员密码（首次运行后可移除）
      - "DEFAULT_ADMIN_NAME=Demo User"      # 默认管理员显示名（首次运行后可移除）
      - SECRET_KEY=notasecretkey            # 会话加密密钥（建议32-64位字母数字）
      - TRUST_PROXY=0                       # 反向代理信任设置（1=信任上游代理）
    volumes:
      - /path/to/planka/data:/config        # 配置和数据持久化目录
    ports:
      - 1337:1337                 # Web界面端口映射
    restart: unless-stopped       # 重启策略

Docker Run命令

bash
docker run -d \
  --name=planka \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -e BASE_URL=[***] \
  -e DATABASE_URL=postgresql://user:password@planka-db:5432/planka \
  -e DEFAULT_ADMIN_EMAIL=*** \
  -e DEFAULT_ADMIN_USERNAME=demo \
  -e DEFAULT_ADMIN_PASSWORD=demo \
  -e DEFAULT_ADMIN_NAME="Demo User" \
  -e SECRET_KEY=notasecretkey \
  -e TRUST_PROXY=0 \
  -p 1337:1337 \
  -v /path/to/planka/data:/config \
  --restart unless-stopped \
  lscr.io/linuxserver/planka:latest

参数说明

端口映射

环境变量

卷挂载

高级运行参数

高级配置

环境变量文件（Docker Secrets）

支持通过文件注入环境变量，使用FILE__前缀指定文件路径：

bash
-e FILE__SECRET_KEY=/run/secrets/planka_secret_key

容器将从/run/secrets/planka_secret_key文件中读取SECRET_KEY的值。

Umask设置

通过-e UMASK=022覆盖默认umask值，控制文件权限创建规则（umask为权限掩码，非直接权限设置）。

用户/组ID配置

通过PUID和PGID确保容器内用户与宿主机用户权限一致，避免卷挂载时的权限问题。使用id your_user命令获取当前用户的PUID和PGID：

bash
id your_user
# 输出示例：uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)

只读文件系统

支持以只读模式运行容器，需参考LinuxServer只读文档配置必要的临时卷。

非Root用户运行

支持以非root用户运行容器，需参考LinuxServer非Root文档配置用户权限。

Docker Mods

可通过Docker Mods扩展容器功能，相关Mods列表可通过以下链接查看：

• Planka专用Mods
• 通用Mods（适用于所有LinuxServer镜像）

支持信息

容器内Shell访问

bash
docker exec -it planka /bin/bash

实时日志查看

bash
docker logs -f planka

版本查询

• 容器版本：

  bash
  docker inspect -f '{{ index .Config.Labels "build_version" }}' planka
  

• 镜像版本：

  bash
  docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/planka:latest
  

更新方法

Docker Compose更新

1. 更新镜像：

   bash
   # 更新所有镜像
   docker-compose pull
   # 仅更新planka
   docker-compose pull planka
   

2. 重启容器：

   bash
   # 重启所有容器
   docker-compose up -d
   # 仅重启planka
   docker-compose up -d planka
   

3. 清理旧镜像：

   bash
   docker image prune
   

Docker Run更新

1. 拉取最新镜像：

   bash
   docker pull lscr.io/linuxserver/planka:latest
   

2. 停止并删除当前容器：

   bash
   docker stop planka && docker rm planka
   

3. 使用原参数重新创建容器（配置文件通过卷挂载持久化，不会丢失）
4. 清理旧镜像：

   bash
   docker image prune
   

镜像更新通知（Diun）

推荐使用Diun工具监控镜像更新，不建议使用自动更新容器的工具。

本地构建

如需自定义镜像，可通过以下步骤本地构建：

bash
# 克隆仓库
git clone [***]
cd docker-planka

# 构建镜像（默认amd64架构）
docker build \
  --no-cache \
  --pull \
  -t lscr.io/linuxserver/planka:latest .

# 跨架构构建（如在x86_64上构建arm64镜像）
docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset
docker build -f Dockerfile.aarch64 -t lscr.io/linuxserver/planka:arm64v8-latest .

版本历史

• 2025-01-12：基于Alpine 3.21重构
• 2024-09-18：更新默认用户文档说明
• 2024-09-12：首次发布