linuxserver/obsidian

linuxserver/obsidian Docker镜像文档

镜像概述和主要用途

https://github.com/linuxserver/docker-obsidian 是由LinuxServer.io团队开发的Docker镜像，用于运行Obsidian笔记应用。Obsidian是一款本地优先的笔记应用，支持创建、链接和组织笔记，并提供数百种插件和主题来自定义工作流。用户可离线访问笔记、通过端到端加密安全同步，还能将笔记发布到线上。

LinuxServer.io团队提供的该镜像具有以下特点：

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

核心功能和特性

容器核心特性

• 多架构支持：适配x86-64和arm64v8架构
• 用户权限管理：通过PUID/PGID轻松映射主机用户权限，避免权限问题
• 安全增强：内置安全更新机制，支持HTTPS加密访问
• 灵活配置：丰富的环境变量和运行参数，支持自定义端口、认证、界面标题等
• GPU加速：支持DRI3和Nvidia GPU加速，提升图形渲染性能
• 多语言支持：通过环境变量配置支持多种语言界面

Obsidian应用特性

• 本地优先的笔记管理，数据存储在用户设备上
• 双向链接功能，构建知识图谱
• 支持Markdown格式，丰富的编辑功能
• 可扩展的插件系统和主题市场
• 离线访问能力，无需依赖云端
• 端到端加密同步

使用场景和适用范围

适用场景

• 个人知识管理：用于创建和组织个人笔记、研究资料、学习笔记
• 团队协作：在可信局域网内共享知识库（需配合安全措施）
• 离线工作环境：需要在无网络环境下访问和编辑笔记
• 自定义工作流：通过插件和主题定制个性化笔记体验

适用范围

• 家庭或小型办公环境的本地服务器部署
• 需在多设备间同步但重视数据隐私的用户
• 技术文档撰写者、研究人员、学生等需要高效组织信息的人群

不适用场景

• 直接暴露在公网环境（需配合反向代理和强认证）
• 对实时多人协作有强需求的场景
• 资源受限的设备（如低配置嵌入式设备）

详细使用方法和配置说明

支持的架构

拉取镜像时，直接使用 lscr.io/linuxserver/obsidian: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%E4%B9%8B%E5%90%8E%EF%BC%8C%E5%B9%B6%E9%85%8D%E7%BD%AE%E5%BC%BA%E5%81%A5%E7%9A%84%E8%AE%A4%E8%AF%81%E6%9C%BA%E5%88%B6%E3%80%82
• 终端访问：Web界面包含具有无密码sudo权限的终端。任何有权访问GUI的用户都可在容器内获取root权限、安装任意软件并探测本地网络。
• seccomp配置：某些旧环境可能需要禁用标准seccomp配置文件才能运行容器化桌面软件，可通过 --security-opt seccomp=unconfined 参数实现。仅在绝对必要时使用此选项，因为它会禁用Docker的关键安全层。

环境变量配置

基于Selkies的GUI容器提供以下可选环境变量：

运行参数配置

多语言支持

通过设置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 GPU。

Nvidia GPU支持通过Zink实现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:
  obsidian:
    image: lscr.io/linuxserver/obsidian:latest
    deploy:
      resources:
        reservations:
          devices:
            - driver: nvidia
              count: 1
              capabilities: [compute,video,graphics,utility]

应用管理

容器内安装应用有两种方法：PRoot 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%60$HOME%60%E7%9B%AE%E5%BD%95%E7%9A%84%E4%BE%BF%E6%90%BA%E5%BC%8F%E5%BA%94%E7%94%A8%E3%80%82

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

bash
proot-apps install filezilla

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

原生应用（非持久化）

可使用https://github.com/linuxserver/docker-mods/tree/universal-package-install%E6%A8%A1%E5%9D%97%E4%BB%8E%E7%B3%BB%E7%BB%9F%E5%8E%9F%E7%94%9F%E4%BB%93%E5%BA%93%E5%AE%89%E8%A3%85%E8%BD%AF%E4%BB%B6%E5%8C%85%E3%80%82%E6%AD%A4%E6%96%B9%E6%B3%95%E4%BC%9A%E5%A2%9E%E5%8A%A0%E5%AE%B9%E5%99%A8%E5%90%AF%E5%8A%A8%E6%97%B6%E9%97%B4%EF%BC%8C%E4%B8%94%E4%B8%8D%E6%8C%81%E4%B9%85%E3%80%82%E5%9C%A8%60compose.yaml%60%E4%B8%AD%E6%B7%BB%E5%8A%A0%EF%BC%9A

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

Docker部署方案示例

Docker Compose配置

推荐使用Docker Compose进行部署，创建compose.yaml文件：

yaml
---
services:
  obsidian:
    image: lscr.io/linuxserver/obsidian:latest
    container_name: obsidian
    environment:
      - PUID=1000               # 用户ID，通过id命令获取
      - PGID=1000               # 组ID，通过id命令获取
      - TZ=Etc/UTC              # 时区，如Asia/Shanghai
      - CUSTOM_USER=admin       # 可选，HTTP认证用户名
      - PASSWORD=yourpassword   # 可选，HTTP认证密码
      - LC_ALL=zh_CN.UTF-8      # 可选，设置为中文界面
    volumes:
      - /path/to/config:/config # 配置目录，替换为实际路径
    ports:
      - 3000:3000               # HTTP端口
      - 3001:3001               # HTTPS端口
    shm_size: "1gb"             # electron应用所需的共享内存大小
    # 可选：GPU加速配置
    # devices:
    #   - /dev/dri:/dev/dri
    restart: unless-stopped

启动容器：

bash
docker-compose up -d

Docker Run命令

使用Docker命令直接部署：

bash
docker run -d \
  --name=obsidian \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -e CUSTOM_USER=admin \
  -e PASSWORD=yourpassword \
  -p 3000:3000 \
  -p 3001:3001 \
  -v /path/to/config:/config \
  --shm-size="1gb" \
  # 可选：GPU加速
  # --device /dev/dri:/dev/dri \
  --restart unless-stopped \
  lscr.io/linuxserver/obsidian:latest

参数说明

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

来自文件的环境变量（Docker secrets）

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

bash
-e FILE__MYVAR=/run/secrets/mysecretvariable

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

应用运行的Umask设置

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

用户/组标识符

使用卷（-v标志）时，主机OS和容器之间可能出现权限问题。通过指定用户PUID和组PGID可避免此问题。

确保主机上的任何卷目录都由您指定的相同用户拥有，权限问题将迎刃而解。

此处PUID=1000和PGID=1000，可通过以下命令获取您的用户ID：

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=obsidian&query=%24.mods%5B%27obsidian%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%E4%BB%A5%E5%90%AF%E7%94%A8%E5%AE%B9%E5%99%A8%E5%86%85%E7%9A%84%E9%99%84%E5%8A%A0%E5%8A%9F%E8%83%BD%E3%80%82%E4%B8%8A%E8%BF%B0%E5%8A%A8%E6%80%81%E5%BE%BD%E7%AB%A0%E5%8F%AF%E8%AE%BF%E9%97%AE%E6%AD%A4%E9%95%9C%E5%83%8F%E5%8F%AF%E7%94%A8%E7%9A%84Mods%E5%88%97%E8%A1%A8%E4%BB%A5%E5%8F%8A%E5%8F%AF%E5%BA%94%E7%94%A8%E4%BA%8E%E4%BB%BB%E4%BD%95LinuxServer.io%E9%95%9C%E5%83%8F%E7%9A%84%E9%80%9A%E7%94%A8Mods%E3%80%82

支持信息

• 容器运行时的Shell访问：

  bash
  docker exec -it obsidian /bin/bash
  

• 实时监控容器日志：

  bash
  docker logs -f obsidian
  

• 容器版本号：

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

• 镜像版本号：

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

更新信息

大多数镜像都是