lsiodev/wikijs

linuxserver/wikijs

镜像概述和主要用途

LinuxServer.io团队提供的wikijs镜像，基于NodeJS构建，是一款现代、轻量级且功能强大的wiki应用。该镜像具备以下特点：

• 定期且及时的应用更新
• 简单的用户映射（PGID、PUID）
• 带有s6覆盖层的自定义基础镜像
• 每周基础OS更新，跨整个LinuxServer.io生态系统共享通用层，以最小化空间占用、停机时间和带宽
• 定期安全更新

核心功能和特性

• 多平台支持：通过Docker manifest实现多架构支持，包括x86-64和arm64v8
• 灵活的数据库配置：支持SQLite（默认）和PostgreSQL数据库
• 数据持久化：配置和数据通过卷挂载实现持久化存储
• 用户权限控制：通过PUID和PGID设置容器内用户权限，避免主机与容器间权限问题
• 时区配置：支持自定义时区设置

支持的架构

该镜像利用Docker manifest实现多平台识别，拉取lscr.io/linuxserver/wikijs:latest即可获取对应架构的正确镜像，也可通过标签拉取特定架构镜像。支持的架构如下：

应用设置

请注意，数据库配置环境变量仅在首次运行时生效，之后需要直接编辑/config/config.yml文件来修改设置。更多信息请参考官方文档。

使用方法和配置说明

docker-compose（推荐）

yaml
---
version: "2.1"
services:
  wikijs:
    image: lscr.io/linuxserver/wikijs:latest
    container_name: wikijs
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
      - DB_TYPE=sqlite #可选
      - DB_HOST= #可选
      - DB_PORT= #可选
      - DB_NAME= #可选
      - DB_USER= #可选
      - DB_PASS= #可选
    volumes:
      - /path/to/config:/config
      - /path/to/data:/data
    ports:
      - 3000:3000
    restart: unless-stopped

docker cli

bash
docker run -d \
  --name=wikijs \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -e DB_TYPE=sqlite `#可选` \
  -e DB_HOST= `#可选` \
  -e DB_PORT= `#可选` \
  -e DB_NAME= `#可选` \
  -e DB_USER= `#可选` \
  -e DB_PASS= `#可选` \
  -p 3000:3000 \
  -v /path/to/config:/config \
  -v /path/to/data:/data \
  --restart unless-stopped \
  lscr.io/linuxserver/wikijs:latest

参数说明

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

环境变量从文件读取（Docker secrets）

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

bash
-e FILE__MYVAR=/run/secrets/mysecretvariable

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

应用运行的Umask设置

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

用户/组标识符

使用卷（-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=wikijs&query=%24.mods%5B%27wikijs%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%AE%9E%E7%8E%B0%E5%AE%B9%E5%99%A8%E5%86%85%E7%9A%84%E9%A2%9D%E5%A4%96%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%E4%BB%A5%E5%8F%8A%E9%80%82%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 wikijs /bin/bash
  

• 实时监控容器日志：

  bash
  docker logs -f wikijs
  

• 容器版本号：

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

• 镜像版本号：

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

更新信息

大多数镜像为静态、版本化，需要更新镜像并重新创建容器以更新内部应用。除部分例外（如nextcloud、plex），不建议或支持在容器内更新应用。

通过Docker Compose更新

• 更新镜像：

  • 所有镜像：

    bash
    docker-compose pull
    

  • 单个镜像：

    bash
    docker-compose pull wikijs
    

• 更新容器：

  • 所有容器：

    bash
    docker-compose up -d
    

  • 单个容器：

    bash
    docker-compose up -d wikijs
    

• 移除旧的悬空镜像：

  bash
  docker image prune
  

通过Docker Run更新

• 更新镜像：

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

• 停止运行中的容器：

  bash
  docker stop wikijs
  

• 删除容器：

  bash
  docker rm wikijs
  

• 使用上述docker run参数重新创建容器（若正确映射到主机文件夹，/config文件夹和设置将被保留）

• 移除旧的悬空镜像：

  bash
  docker image prune
  

通过Watchtower自动更新（仅在忘记原始参数时使用）

• 拉取最新镜像并使用相同环境变量运行：

  bash
  docker run --rm \
    -v /var/run/docker.sock:/var/run/docker.sock \
    containrrr/watchtower \
    --run-once wikijs
  

• 移除旧的悬空镜像：docker image prune

警告：不建议将Watchtower用作现有Docker容器的自动更新解决方案。我们通常不鼓励自动更新，但此工具可用于一次性手动更新忘记原始参数的容器。长期来看，强烈建议使用Docker Compose。

镜像更新通知 - Diun（Docker镜像更新通知器）

提示：推荐使用Diun获取更新通知。不推荐或支持其他自动更新容器的工具。

本地构建

如需为开发或自定义逻辑对镜像进行本地修改：

bash
git clone https://github.com/linuxserver/docker-wikijs.git
cd docker-wikijs
docker build \
  --no-cache \
  --pull \
  -t lscr.io/linuxserver/wikijs:latest .

可使用multiarch/qemu-user-static在x86_64硬件上构建ARM变体：

bash
docker run --rm --privileged multiarch/qemu-user-static:register --reset

注册后，可使用-f Dockerfile.aarch64指定要使用的dockerfile。

版本历史

• 25.08.22：基于Alpine 3.18重建
• 07.07.23：弃用armhf架构，详见公告
• 21.03.23：恢复git和openssh包以支持git存储
• 21.03.23：创建虚拟/etc/os-release以修复系统信息页面
• 10.10.22：基于Alpine 3.16重建，迁移至s6v3
• 23.01.21：基于Alpine 3.13重建
• 01.06.20：基于Alpine 3.12重建
• 28.04.20：添加python依赖（用于部分NPM模块）和git（用于存储模块）
• 14.12.19：初始发布