linuxserver/joplin

linuxserver/joplin

镜像概述和主要用途

Joplin 是一款免费开源的笔记和待办事项应用，支持管理大量笔记并组织到笔记本中。本镜像由 LinuxServer.io 团队提供，将 Joplin 应用打包为 Docker 容器，便于快速部署和使用。

核心功能和特性

LinuxServer.io 容器特性

• 定期及时的应用更新
• 简化的用户权限映射（PGID、PUID）
• 基于 s6 overlay 的自定义基础镜像
• 每周基础 OS 更新，通过跨生态系统共享通用层减少存储空间占用、 downtime 和带宽消耗
• 定期安全更新

Joplin 应用特性

• 支持大量笔记组织为笔记本结构
• 免费开源，跨平台同步能力
• 富文本编辑和 Markdown 支持
• 待办事项管理功能
• 数据本地存储，保护隐私

支持的架构

本镜像通过 Docker manifest 实现多平台支持。拉取 lscr.io/linuxserver/joplin:latest 会自动获取适合您架构的镜像，也可通过标签指定特定架构：

使用场景和适用范围

• 个人笔记管理：适合需要本地存储和组织大量笔记的个人用户
• 小型团队协作：在可信局域网环境中共享笔记（需配合适当安全措施）
• 自托管需求：希望完全控制数据存储位置，不依赖第三方服务的用户
• 开发/测试环境：快速部署独立的笔记应用实例

应用设置

访问地址

应用可通过以下地址访问：

• [***]

严格反向代理配置

本镜像默认使用自签名证书，因此协议为 https。若使用验证证书的反向代理，需为容器禁用证书检查。

注意：现代 GUI 桌面应用可能与最新 Docker 系统调用限制存在兼容性问题。在使用旧内核或 libseccomp 版本的主机上，可添加 --security-opt seccomp=unconfined 参数允许这些系统调用。

安全注意事项

[!WARNING] 本容器提供对主机系统的特权访问。除非已正确配置安全措施，否则请勿将其暴露到互联网。

• HTTPS 要求：完整功能需要 HTTPS 支持。现代浏览器特性（如用于音视频的 WebCodecs）在不安全的 HTTP 连接下无法工作。
• 认证机制：默认无认证。可选的 CUSTOM_USER 和 PASSWORD 环境变量可启用 HTTP 基本认证，仅适用于可信局域网环境。互联网暴露时，强烈建议使用反向代理（如 https://github.com/linuxserver/docker-swag%EF%BC%89%E9%85%8D%E5%90%88 robust 认证机制。
• 权限风险：Web 界面包含带无密码 sudo 访问的终端。任何能访问 GUI 的用户可获取容器内 root 权限、安装任意软件并探测本地网络。
• Seccomp 配置：在老旧硬件或过时 Linux 发行版等特定环境中，可能需要停用标准 seccomp 配置文件以运行容器化桌面软件，可通过 --security-opt seccomp=unconfined 参数实现。仅在绝对必要时使用此选项，因其会禁用 Docker 的关键安全层，增加容器逃逸风险。

Selkies-based GUI容器通用选项

本容器基于 https://github.com/linuxserver/docker-baseimage-selkies%EF%BC%8C%E6%8F%90%E4%BE%9B%E4%BB%A5%E4%B8%8B%E7%8E%AF%E5%A2%83%E5%8F%98%E9%87%8F%E5%92%8C%E8%BF%90%E8%A1%8C%E9%85%8D%E7%BD%AE%E4%BB%A5%E8%87%AA%E5%AE%9A%E4%B9%89%E5%8A%9F%E8%83%BD%EF%BC%9A

可选环境变量

可选运行配置

国际化支持

要以其他语言启动桌面会话，设置 LC_ALL 环境变量，例如：

• -e LC_ALL=zh_CN.UTF-8 - 中文
• -e LC_ALL=ja_JP.UTF-8 - 日语
• -e LC_ALL=ko_KR.UTF-8 - 韩语
• -e LC_ALL=ar_AE.UTF-8 - 阿拉伯语
• -e LC_ALL=ru_RU.UTF-8 - 俄语
• -e LC_ALL=es_MX.UTF-8 - 西班牙语（拉丁美洲）
• -e LC_ALL=de_DE.UTF-8 - 德语
• -e LC_ALL=fr_FR.UTF-8 - 法语
• -e LC_ALL=nl_NL.UTF-8 - 荷兰语
• -e LC_ALL=it_IT.UTF-8 - 意大利语

GPU加速配置

DRI3 GPU加速

对于需要加速的应用或游戏，可将渲染设备挂载到容器，供应用使用：

bash
--device /dev/dri:/dev/dri

此功能仅支持开源 GPU 驱动：

可通过 DRINODE 环境变量指定特定 GPU。DRI3 在 aarch64 架构上，若容器内安装了适用于芯片组的正确驱动，也可工作。

Nvidia GPU支持

注意：基于 Alpine 的镜像不支持 Nvidia 功能。

通过 Zink 可实现 Nvidia GPU 的 OpenGL 支持。当兼容的 Nvidia GPU 被传递到容器时，还会自动用于硬件加速视频流编码（使用 x264enc 全帧配置文件），显著降低 CPU 负载。

使用以下运行时标志启用 Nvidia 支持：

对于 Docker Compose，需先在主机上将 Nvidia 运行时配置为默认：

bash
sudo nvidia-ctk runtime configure --runtime=docker --set-as-default
sudo systemctl restart docker

然后在 compose.yaml 中为服务分配 GPU：

yaml
services:
  joplin:
    image: lscr.io/linuxserver/joplin:latest
    deploy:
      resources:
        reservations:
          devices:
            - driver: nvidia
              count: 1
              capabilities: [compute,video,graphics,utility]

应用管理

容器内安装应用有两种方法：PRoot Apps（推荐用于持久化）和 Native Apps。

PRoot Apps（持久化）

通过 apt-get install 等方式原生安装的软件包在容器重建后不会保留。要跨容器更新保留应用及其设置，推荐使用 https://github.com/linuxserver/proot-apps%EF%BC%8C%E8%BF%99%E4%BA%9B%E6%98%AF%E5%AE%89%E8%A3%85%E5%88%B0%E7%94%A8%E6%88%B7%E6%8C%81%E4%B9%85%E5%8C%96 $HOME 目录的便携应用。

在容器内通过命令行安装应用：

bash
proot-apps install filezilla

支持的应用列表见 https://github.com/linuxserver/proot-apps?tab=readme-ov-file#supported-apps%E3%80%82

Native Apps（非持久化）

可使用 https://github.com/linuxserver/docker-mods/tree/universal-package-install mod 从系统原生仓库安装软件包。此方法会增加容器启动时间且不持久。在 compose.yaml 中添加：

yaml
environment:
  - DOCKER_MODS=linuxserver/mods:universal-package-install
  - INSTALL_PACKAGES=libfuse2|git|gdb

部署方法

Docker Compose（推荐）

yaml
---
services:
  joplin:
    image: lscr.io/linuxserver/joplin:latest
    container_name: joplin
    environment:
      - PUID=1000        # 用户ID，使用 `id your_user` 查看
      - PGID=1000        # 组ID，使用 `id your_user` 查看
      - TZ=Etc/UTC       # 时区，参考 https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List
    volumes:
      - /path/to/config:/config  # 容器内用户主目录，存储程序设置和文件
    ports:
      - 3000:3000        # Joplin桌面GUI HTTP端口（需代理）
      - 3001:3001        # Joplin桌面GUI HTTPS端口
    shm_size: "1gb"      # Electron应用正常运行所需
    restart: unless-stopped

Docker Run

bash
docker run -d \
  --name=joplin \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -p 3000:3000 \
  -p 3001:3001 \
  -v /path/to/config:/config \
  --shm-size="1gb" \
  --restart unless-stopped \
  lscr.io/linuxserver/joplin:latest

参数说明

容器通过运行时参数配置，格式为 <外部>:<内部>。

环境变量（Docker Secrets）

可通过特殊前缀 FILE__ 从文件设置任何环境变量。例如：

bash
-e FILE__MYVAR=/run/secrets/mysecretvariable

将根据 /run/secrets/mysecretvariable 文件内容设置 MYVAR 环境变量。

Umask设置

所有镜像支持通过可选的 -e UMASK=022 设置覆盖容器内服务的默认 umask。注意 umask 不是 chmod，它基于其值减去权限而非添加。详情请参考 umask 说明。

用户/组标识符（PUID/PGID）

使用卷（-v 标志）时，主机 OS 和容器之间可能出现权限问题。通过指定用户 PUID 和组 PGID 可避免此问题。确保主机上的卷目录由指定用户拥有，权限问题将迎刃而解。

使用 id your_user 命令查看您的 PUID 和 PGID：

bash
id your_user

示例输出：

text
uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)

Docker Mods

https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=joplin&query=%24.mods%5B%27joplin%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml]([] "查看此容器可用的mods") https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml]([] "查看通用mods")

我们发布了多种 https://github.com/linuxserver/docker-mods 以启用容器的附加功能。上方动态徽章链接了此镜像可用的 Mods 列表以及可应用于任何 LinuxServer.io 镜像的通用 Mods。

支持信息

• 容器运行时的 Shell 访问：

  bash
  docker exec -it joplin /bin/bash
  

• 实时监控容器日志：

  bash
  docker logs -f joplin
  

• 容器版本号：

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

• 镜像版本号：

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

更新方法

大多数镜像为静态、版本化的，需更新镜像并重建容器以更新内部应用。除特殊说明外，不建议或支持在容器内更新应用。

通过Docker Compose更新

• 更新镜像：

  • 所有镜像：

    bash
    docker-compose pull
    

  • 单个镜像：

    bash
    docker-compose pull joplin
    

• 更新容器：

  • 所有容器：

    bash
    docker-compose up -d
    

  • 单个容器：

    bash
    docker-compose up -d joplin
    

• 清理旧镜像：

  bash
  docker image prune
  

通过Docker Run更新

• 更新镜像：

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

• 停止运行中的容器：

  bash
  docker stop joplin
  

• 删除容器：

  bash
  docker rm joplin
  

• 使用相同参数重建容器（若正确映射主机文件夹，/config 文件夹和设置将保留）

• 清理旧镜像：

  bash
  docker image prune
  

[!TIP] 推荐使用 [Diun](