七千二百袋水泥
七千二百袋水泥
Published on 2025-09-21 / 1 Visits

在NAS上搭建Perlite开源平台:Obsidian笔记的完美Web展示与发布方案指南

Perlite是一款专为Obsidian笔记优化的基于Web的Markdown文档查看器,作为Obsidian Publish的开源替代方案,它允许用户将整个Obsidian库或Markdown文件夹直接放置在Web目录中,自动构建可访问的页面。

Perlite的设计目标是提供简洁高效的Markdown内容展示,用户无需复杂配置即可实现笔记的在线发布与共享。

在线演示地址如下:
https://perlite.secure77.de

Image

环境准备与文件下载

首先,访问GitHub项目页面下载Perlite的配置文件:
https://github.com/secure-77/Perlite

Image

下载完成后,创建一个专用文件夹用于解压,建议仅保留“perlite”和“web”两个核心目录。如有需要,可保留docker-compose.yml文件,但建议修改其中默认的80端口以避免冲突。

Image

注意事项:
若启动后无法显示内容,通常是由于文件权限设置问题所致。

Image

推荐通过SSH连接至NAS,使用递归命令调整文件夹权限,以确保Web服务正常读取文件。

Image

使用Docker Compose部署Perlite

通过以下Docker Compose配置可快速部署Perlite服务:

services:  
perlite:  
    image: sec77/perlite:latest  
    container_name: perlite  
    restart: unless-stopped  
    environment:  
      - NOTES_PATH=Demo  
      - HIDE_FOLDERS=docs,private,trash  
      - HIDDEN_FILE_ACCESS=false  
      - LINE_BREAKS=true  
      - ABSOLUTE_PATHS=false  
      - ALLOWED_FILE_LINK_TYPES=pdf,mp4  
      - DISABLE_POP_HOVER=false  
      - SHOW_TOC=true  
      - SHOW_LOCAL_GRAPH=true  
      - HOME_FILE=README  
      - FONT_SIZE=15  
      - HTML_SAFE_MODE=true  
      - TEMP_PATH=/tmp  
      - SITE_TITLE=Demo  
      - SITE_TYPE=article  
      - SITE_URL=  
      - SITE_IMAGE=  
      - SITE_DESC=  
      - SITE_NAME=Perlite  
      - SITE_TWITTER=https://x.com/  
      - SITE_LOGO=perlite.svg  
      - SITE_HOMEPAGE=https://perlite.secure77.de/  
      - SITE_GITHUB=https://github.com/  
    volumes:  
      - ./perlite/Demo:/var/www/perlite/Demo:ro  
  
web:  
    image: nginx:stable  
    container_name: perlite_web  
    restart: unless-stopped  
    ports:  
      - 8080:80  
    volumes:  
      - ./web/config/perlite.conf:/etc/nginx/conf.d/default.conf:ro  
    volumes_from:  
      - perlite        
    depends_on:  
      - perlite

环境变量参数说明:

  • NOTES_PATH: 指定Markdown笔记存储路径,示例中为“Demo”文件夹。
  • HIDE_FOLDERS: 定义需隐藏的文件夹列表,多个名称以逗号分隔,这些内容将不在界面显示。
  • HIDDEN_FILE_ACCESS: 控制是否允许访问隐藏文件,设为false表示禁止访问。
  • LINE_BREAKS: 启用或禁用换行符处理,true代表启用。
  • ABSOLUTE_PATHS: 是否使用绝对路径链接资源,false表示不使用。
  • ALLOWED_FILE_LINK_TYPES: 许可的文件链接类型,例如允许pdf与mp4格式。
  • DISABLE_POP_HOVER: 禁用或启用鼠标悬停预览功能,false代表启用该功能。
  • SHOW_TOC: 控制是否显示文章目录,true为显示。
  • SHOW_LOCAL_GRAPH: 决定是否展示本地知识图谱,true表示展示。
  • HOME_FILE: 设置网站首页文件,例如README.md。
  • FONT_SIZE: 调整显示字体的大小,示例值为15。
  • HTML_SAFE_MODE: 启用HTML安全模式以避免潜在风险,true为启用。
  • TEMP_PATH: 指定临时文件存储路径,例如/tmp。
  • SITE_TITLE: 设置网站标题名称。
  • SITE_TYPE: 定义网站内容类型。
  • SITE_URL: 配置网站的访问地址。
  • SITE_IMAGE: 设置网站的代表性图片。
  • SITE_DESC: 填写网站的描述信息。
  • SITE_NAME: 命名网站的名称。
  • SITE_TWITTER: 添加Twitter社交链接。
  • SITE_LOGO: 指定网站Logo图像文件。
  • SITE_HOMEPAGE: 设置主页跳转链接。
  • SITE_GITHUB: 添加GitHub项目地址。

提示:
由于环境变量较多,建议初次部署时保持默认配置,待熟悉后再按需调整。

平台使用与功能体验

在浏览器中输入http://NAS的IP:8080即可访问Perlite界面。

Image

界面左侧为演示文档区域,用于展示基础功能。

Image

通过修改映射目录中的Markdown文件,可自定义显示内容。

Image

如不熟悉Markdown语法,建议保留示例文档作为参考。

Image

双链笔记功能可直观展示内容关联,构建知识网络。

Image

大纲视图支持文章结构预览与快速导航。

Image

设置选项允许切换主题样式与调整字体大小等参数。

Image

移动端网页经过优化,具有良好的响应式体验。

Image

平台总结与推荐

Perlite作为专为Obsidian设计的Markdown发布工具,在功能和外观方面表现优秀。尽管需部署两个容器且需注意文件权限,但这些并不影响其整体实用性。对于Obsidian用户而言,将其作为笔记展示与同步方案极具价值。

综合推荐指数:⭐⭐⭐⭐(功能全面,值得部署)
使用体验:⭐⭐⭐⭐(界面美观,暂缺中文支持)
部署难度:⭐⭐⭐(中等难度,需基础操作经验)