第50章 NodeBB 静态目录配置与安全
静态目录
NodeBB 允许插件配置静态目录,让浏览器可以直接访问其中的文件。这对在插件中提供静态资源非常有用,例如:
某个 NodeBB 插件允许用户根据论坛活跃度获得奖杯,这些奖杯以 PNG 图片的形式展示在用户资料页上。
此时就需要配置一个静态目录,让这些图片可以通过浏览器的 标签直接引用。
安全注意事项
按下文方式配置的静态目录对公众访问没有任何保护。由于不经过身份验证,任何用户(访客、爬虫或其他)都能访问挂载目录中的文件,这意味着这些文件可能被搜索引擎等收录。
请务必不要把私密内容放进静态目录,除非它们受其他认证机制保护(例如通过 nginx 配置 Basic/Digest 认证)。
另一种做法是:不用静态目录,而是通过 static:api.routes 钩子把控制器挂载到路由上,在控制器中做必要的校验,再用 res.sendFile 返回文件。
挂载静态目录
核心中的静态目录
NodeBB 核心本身暴露了两个目录:
/build/public —— 每次执行 ./nodebb build 时都会被清空并重新生成(不要使用) /public —— 包含 NodeBB 使用的各类资源(默认图片、语言文件等) 其中只有 /public/uploads 不受版本控制,建议把自定义资源放在这里。
这两个目录都通过统一前缀 /assets 提供(前者优先于后者)。例如,要加载位于 /public/favicon.ico 的默认网站图标,可以在浏览器中访问 /assets/favicon.ico。
插件中的静态目录
插件可以通过 plugin.json 文件中的 staticDirs 属性定义静态目录。
你可以定义一个对象字面量,以键值对的形式声明目录名及其路径(相对于插件目录)。
插件定义的静态目录都会挂载到 plugins/{YOUR-PLUGIN-ID} 前缀下。
假设以下条件成立:
NodeBB 安装在 /var/www/nodebb,且 可通过 https://example.org 访问,且 插件安装后位于 /var/www/nodebb/node_modules/nodebb-plugin-example
那么可以这样定义静态目录:
``` { ... "staticDirs": { "images": "images" } ... } ```
这段配置会让 NodeBB 把 /var/www/nodebb/node_modules/nodebb-plugin-example/images 挂载到 https://example.org/plugins/nodebb-plugin-example/images,目录中的所有文件都可以直接访问。