Skip to content

🚀 使用 Docker Compose 部署 WizNote(为知笔记)

🚀 使用 Docker Compose 部署 WizNote(为知笔记)

下面是一份简洁明了、新手友好的 Docker Compose 部署 WizNote 的教程,助你快速搭建私有笔记服务。

📦 项目简介

WizNote(为知笔记) 是一款专注于工作笔记和团队协作的云笔记软件。其核心特点如下:

特点类别 具体说明
核心功能 支持多种笔记形式:文本、图片、文档、清单、录音等。支持笔记分享与团队协作。
部署与存储 提供官方 Docker 镜像 wiznote/wizserver,支持私有化部署。数据可保存在自己的服务器上。
客户端支持 提供网页版,并支持 Windows、macOS、Linux 等多平台客户端。

自建优势 * 数据私有化:所有笔记数据掌握在自己手中。 * 团队协作:支持创建团队和群组,方便团队内部知识共享与管理。 * 定制化:可以配合Docker灵活部署。

📋 部署前准备

  1. 环境要求

    • 确保服务器已安装 DockerDocker Compose
    • WizNote 对内存有一定要求,建议服务器内存不小于 2GB
  2. 资源检查

    • 端口:确认宿主机上的 3003 端口(或您计划使用的其他端口)未被占用。
    • 磁盘空间:确保部署目录有足够的空间存储笔记数据。
    • 权限:确保当前用户对部署目录有读写权限。

⚙️ 配置 Docker Compose

1.创建项目目录 创建一个目录(如 wiznote)用于存放所有相关文件,并进入该目录。

    mkdir wiznote && cd wiznote

2.创建 docker-compose.yml 文件 将用户提供的配置内容保存到新创建的 docker-compose.yml 文件中。

#version: '3'
services:
  wiznote:
    image: wiznote/wizserver:latest  # Wiznote 官方服务器镜像(最新版)
    container_name: wiznote  # 容器名称,便于管理(如查看日志、重启)
    restart: always  # 容器退出后自动重启,保障服务稳定(如服务器重启后自动恢复)
    environment:
      - SEARCH=true  # 启用全文搜索功能(必须保留,否则无法搜索笔记)
    volumes:
      # 核心挂载:本地 ./storage 目录 ↔ 容器 /wiz/storage 目录
      # 所有笔记、配置、数据库均存储在此目录,删除会丢失数据!
      - ./storage/:/wiz/storage
      # - /etc/localtime:/etc/localtime # 可选:同步宿主机时间,取消注释即可启用
      # 以下为拆分挂载(进阶需求,新手可忽略,保持整体挂载即可)
      #- ./storage/resources:/wiz/storage/store/files/resources
      #- ./storage/docs:/wiz/storage/store/files/docs
      #- ./storage/logs:/wiz/storage/logs

      #- ./storage/wizserver-temp:/wiz/storage/wizserver-temp
      #- ./storage/wiz-abstract:/wiz/storage/wiz-abstract

      #- ./storage/config:/wiz/storage/config
      #- ./storage/data_root:/wiz/storage/data_root
      #- ./storage/db:/wiz/storage/db
      #- ./storage/index:/wiz/storage/index
      #- ./storage/wiz-gather-dev:/wiz/storage/wiz-gather-dev
      #直接备份吧 不差一块硬盘的功耗

      #- /etc/localtime:/etc/localtime
    ports:
      - "3003:80"  # 端口映射:主机 3003 → 容器 80(Web 访问端口)
    privileged: true  # 特权模式:确保容器有足够权限读写存储目录(避免权限报错,新手必保留)
    #network_mode: 'host'  # 主机网络模式(默认注释,无需启用,端口映射更灵活)
# 无需额外配置网络,使用 Docker 默认桥接网络
#networks:
  #wiznote:
#默认管理员账号:admin@wiz.cn,密码:123456


3.关键配置说明 * 镜像wiznote/wizserver:latest 是 WizNote 的官方 Docker 镜像。 * 数据持久化volumes 部分将容器内的 /wiz/storage 目录挂载到宿主机的 ./storage 目录,防止容器重启后笔记数据丢失。这是最重要的配置之一。 * 搜索功能:环境变量 SEARCH=true 启用了笔记的全文搜索功能。 * 端口映射"3003:80" 表示将宿主机的 3003 端口映射到 WizNote 容器的 80 端口。您可以根据需要修改宿主机端口,例如 "8080:80"。 * 时间同步:取消注释 - /etc/localtime:/etc/localtime 可以同步容器与宿主机的时间,确保笔记时间戳准确。 * 特权模式privileged: true 赋予容器特权。在某些环境下,这可能有助于解决权限问题。

🚀 启动与验证

  1. 启动服务docker-compose.yml 文件所在目录下,执行以下命令来后台启动服务: bash docker-compose up -d

  2. 检查服务状态 使用以下命令查看容器是否正常运行: bash docker-compose ps 如果状态(State)栏显示为 Up,则表明容器已成功启动。

  3. 查看日志 如果容器启动异常,或想了解启动状态,可以通过日志来排查问题: bash docker-compose logs wiznote WizNote 首次启动时需要进行初始化,可能需要稍等片刻。

  4. 访问服务 在浏览器中输入 http://你的服务器IP:3003。如果看到 WizNote 的登录界面,说明服务已成功部署。

🔧 基础配置与使用

  1. 初始登录

    • 在浏览器中访问 http://你的服务器IP:3003
    • 使用默认管理员账号 admin@wiz.cn 和密码 123456 进行登录。
    • 安全提示:登录后,请务必在"系统管理"中修改默认管理员密码。
  2. 创建个人笔记

    • 登录后,点击左上角"新建笔记",即可开始创建笔记。
    • WizNote 支持多种笔记格式,包括普通文本、Markdown等。
  3. 配置团队协作(可选)

    • 点击左侧导航栏的加号,可以"创建团队"。
    • 按照指引输入团队信息,并可以通过链接或二维码邀请成员加入。
  4. 客户端配置

    • 您可以在官网下载 Windows、macOS、Linux 等平台的桌面客户端或移动端 APP。
    • 在客户端登录时,服务器地址填写 http://你的服务器IP:3003 即可连接到自己部署的 WizNote 服务。

🔧 基础配置与使用2

Wiznote 核心操作围绕 “创建笔记→管理知识库→多端同步”,新手可按以下步骤快速上手:

1. 步骤 1:修改默认管理员密码(安全必备)

  1. 登录后点击右上角 “管理员” 头像 → 选择 “个人设置”;
  2. 在 “密码修改” 栏:
    • 输入原密码 123456
    • 输入新密码(建议含字母 + 数字 + 符号,如 Wiznote@2024!);
    • 确认新密码,点击 “保存”;
  3. 下次登录需使用新密码,旧密码失效。

2. 步骤 2:创建第一篇笔记

1.左侧 “我的笔记” 右键 → 选择 “新建笔记”; 2.输入笔记标题(如 “我的第一篇知识库笔记”); 3.在编辑区输入内容(支持 Markdown 语法,如标题、列表、图片插入):

    # 知识库入门
    ## 1. 笔记用途
    - 记录技术文档
    - 存储项目需求
    - 整理学习笔记

    ## 2. 同步方式
    连接桌面客户端,自动同步私有服务器数据。

4.内容会实时保存(无需手动点击 “保存”),左侧目录会显示新创建的笔记。

3. 步骤 3:多端同步(以桌面客户端为例)

  1. 下载 Wiznote 桌面客户端(官方下载页);
  2. 安装后打开客户端,点击 “登录”→ 选择 “私有服务器”;
  3. 输入服务器地址 http://服务器IP:3003、管理员账号和新密码;
  4. 点击 “登录”,客户端会自动同步服务器上的笔记(新增 / 修改的笔记会双向同步)。

4. 步骤 4:管理知识库(可选)

  • 创建目录:左侧右键 “我的笔记”→“新建目录”,用于分类存储笔记(如 “技术文档”“生活记录”);
  • 分享笔记:选中笔记右键 “分享”,可生成分享链接(仅团队协作场景使用,个人使用可忽略);
  • 导入 / 导出:顶部菜单 “文件”→“导入”(导入本地 Markdown/TXT 文件)、“导出”(备份笔记为 PDF/Markdown)。

🔄 维护与管理

1.更新服务 当有新版本发布时,可以按以下步骤更新:

    # 进入 docker-compose.yml 所在目录
    cd /path/to/your/wiznote
    # 拉取最新的 WizNote 镜像
    docker-compose pull
    # 重新创建并启动容器
    docker-compose up -d
    # 清理无用的旧镜像
    docker image prune

2.数据备份 * WizNote 的所有笔记数据、配置和数据库都保存在宿主机挂载的 ./storage 目录中。 * 定期备份整个 ./storage 目录即可备份所有笔记数据。在进行版本升级或重要操作前,也建议备份此目录。

3.服务卸载 如需卸载 WizNote,在项目目录下执行:

    docker-compose down

如果希望彻底删除所有数据(包括笔记数据),在上述命令后移除 ./storage 目录即可。

🐛 常见问题排查

问题现象 可能原因与解决方案
容器启动失败 1. 检查 docker-compose.yml 文件语法是否正确(如缩进)。
2. 执行 docker-compose logs wiznote 查看具体错误日志。
无法访问网页 (http://IP:3003) 1. 确认服务器防火墙/安全组是否开放了 3003 端口。
2. 检查 docker-compose ps 确认容器状态是否为 Up
3. 首次启动初始化可能需要时间,请稍等并刷新页面。
忘记管理员密码 1. 若未修改过,默认账号密码为 admin@wiz.cn / 123456
2. 若已修改且遗忘,可能需要通过备份数据或联系官方支持等方式解决。
客户端无法同步 1. 检查客户端设置的服务器地址是否正确,应为你部署的服务器地址和端口。
2. 确认服务器网络是否畅通,客户端能否正常访问服务器端口。
3. 可尝试检查并切换客户端的同步传输协议(HTTP/HTTPS)。
搜索功能不工作 1. 确保 docker-compose.yml 中设置了 SEARCH=true 环境变量。
2. 检查容器日志,查看是否有搜索服务相关的错误。

希望这份教程能帮助你顺利搭建属于自己的 WizNote 笔记服务!如果在部署和使用过程中遇到更多问题,WizNote 的官方文档和用户社区是寻求帮助的好去处。


🐛 常见问题排查2

1. 登录失败(提示 “账号或密码错误”)

  • 原因 1:输入的账号 / 密码与修改后的不一致(或未修改默认密码)。解决

    1.确认账号为 admin@wiz.cn(默认账号未修改); 2.若忘记新密码,需重置(删除 ./storage/config 目录,重启容器恢复默认密码 123456,但会丢失部分配置):

        rm -rf ./storage/config
        docker compose restart
  • 原因 2:服务未完全启动(刚启动容器时,数据库初始化需要时间)。解决:等待 1-2 分钟,刷新登录页面重试。

2. 搜索功能无法使用(无结果或报错)

  • 原因 1:未启用 SEARCH=true(环境变量配置缺失)。解决:编辑 docker-compose.yml,确保 environment 中包含 - SEARCH=true,重启容器:docker compose restart

  • 原因 2:搜索索引损坏(./storage/index 目录异常)。解决:删除索引目录,重启容器重建索引:

    rm -rf ./storage/index
    docker compose restart

3. 桌面客户端无法连接服务器

  • 原因 1:服务器 IP 或端口错误(客户端配置与部署不一致)。解决

    1. 确认客户端 “私有服务器地址” 为 http://服务器IP:3003(端口与部署时一致);
    2. 检查客户端与服务器网络互通(局域网 ping 服务器 IP,公网确认端口已开放)。
    3. 原因 2:防火墙或安全组未开放 3003 端口。解决:重新开放端口(Linux:sudo ufw allow 3003/tcp,云服务器同步安全组规则)。

4. 笔记无法保存(提示 “权限不足”)

  • 原因./storage 目录权限不足,容器无法写入数据。

    解决:重新赋予权限,重启容器:

    sudo chmod -R 777 ./storage
    docker compose restart

通过以上步骤,新手可成功部署 Wiznote 私有服务器,实现笔记的自主管理与多端同步。Wiznote 适合注重数据隐私的个人或小型团队,后续可探索团队协作、插件扩展等进阶功能,具体参考 Wiznote 官方文档