Skip to content

部署指南

Folia 有两种主要运行方式:

  • Web 版:适合浏览器、自托管和多端访问
  • 桌面版:适合本地完整体验

Web 版部署

前置条件

你至少需要准备两类外部依赖:

  1. 网易云 API 服务
  2. AI 接口配置

网易云 API 的部署来源

Folia 当前依赖的后端项目是:

按其官方文档,常见部署方式包括:

  • 直接运行 Node 服务:pnpm i 后执行 node app.js
  • 使用 npx @neteaseapireborn/api@latest
  • 将该 API 项目单独部署到 Vercel

官方文档还说明:

  • 默认端口是 3000
  • 默认 host 是 localhost
  • Vercel 版接口在部分请求中可能需要额外传 realIP

一键部署到 Vercel

可以直接使用:

Deploy with Vercel

部署后补齐环境变量,变量表见 配置说明

部署到 Cloudflare

项目仓库已经包含 Cloudflare 所需的基础入口:

  • wrangler.jsonc
  • worker/index.ts
  • dist/ 作为静态资源目录

典型流程:

bash
npm install
npm run build
npx wrangler login
npx wrangler deploy

当前 wrangler.jsonc 配置会:

  • ./worker/index.ts 作为 Worker 入口
  • ./dist 作为静态资源目录
  • /api/* 请求优先交给 Worker 处理

部署到 Cloudflare 时,同样需要配置和 Vercel 一致的环境变量,见 配置说明

本地开发

推荐使用 vercel dev,它会模拟 Vercel 的运行环境,从而支持 api/ 目录下的AI主题接口功能:

bash
npm install
cp .env.example .env.local
vercel dev

建议先在 Vercel 配置好环境变量,接入你的仓库CI/CD流水线,然后:

bash
vercel env pull .env.local

这样就能保证本地开发环境和线上环境的一致性,避免一些环境变量导致的调试问题,也更方便做版本控制。

桌面版开发

启动 Electron 开发环境

bash
npm install
npm run dev:electron

这会同时启动:

  • Vite 前端开发服务器
  • Electron 主进程

用构建产物运行桌面版

bash
npm run dev:electron:dist

打包桌面版

bash
npm run build:electron

当前构建配置覆盖:

  • Windows nsis
  • macOS dmg
  • Linux tar.gz / deb / rpm

运行时注意事项

网易云 API

桌面版会在本地启动内嵌的 Netease API 服务;Web 版则需要你自己提供一个可访问的 API 地址。

Linux 图形兼容

桌面版在 Linux 下包含若干图形兼容分支,可通过不同脚本使用更保守的渲染模式:

bash
npm run dev:electron:dist:swiftshader
npm run dev:electron:dist:software

如果你要排查 Wayland / Vulkan / 驱动兼容问题,这两个脚本会很有帮助。

Released under AGPL-3.0