gibby/ferdium-server

Ferdium Server

镜像概述和主要用途

Ferdium Server是一个可自托管的服务器应用，用于支持Ferdium客户端。通过部署自定义服务器，用户可以自主管理所有注册用户的数据，添加自定义应用配方（recipes），而无需依赖官方服务器。如果不需要自主管理数据，也可使用官方服务器实例api.getferdi.com。

核心功能和特性

• ✅ 用户注册与登录
• ✅ 服务的创建、下载、列表展示和删除
• ✅ 工作区支持
• ✅ 功能完善的服务商店
• ✅ 用户仪表板
• ✅ 数据导出/导入至其他Ferdi服务器
• ✅ 密码恢复
• ✅ 配方更新

使用场景和适用范围

适用于需要自主管理Ferdium用户数据和自定义应用配方的个人或组织，尤其适合注重数据隐私、需要定制化服务商店的用户。

详细使用方法和配置说明

部署方式

Docker部署（推荐）

Docker是部署Ferdium Server最简单的方式。默认使用SQLite数据库，也可通过环境变量配置外部数据库（如MySQL、MariaDB、Postgres等）。部署后建议配置NGINX反向代理并添加SSL证书以确保外部访问安全。

注意：旧版config.txt已弃用，环境变量发生变化，包括默认数据库名称和位置、容器内部端口，以及新增DATA_DIR变量。现有用户请参考https://github.com/getferdi/server/blob/master/docker/README.md%E8%BF%9B%E8%A1%8C%E8%BF%81%E7%A7%BB%E3%80%82

1. 拉取Docker镜像

sh
docker pull ghcr.io/gibby/ferdium-server

2. 创建Docker容器（根据需求配置环境变量）

sh
docker create \
--name=ferdi-server \
-e NODE_ENV=development \
-e APP_URL=<ferdi-server-url> \
-e DB_CONNECTION=<database> \
-e DB_HOST=<yourdbhost> \
-e DB_PORT=<yourdbport> \
-e DB_USER=<yourdbuser> \
-e DB_PASSWORD=<yourdbpass> \
-e DB_DATABASE=<yourdbdatabase> \
-e DB_SSL=false \
-e MAIL_CONNECTION=smtp \
-e SMTP_HOST=<smtpmailserver> \
-e SMTP_PORT=<smtpport> \
-e MAIL_SSL=true/false \
-e MAIL_USERNAME=<yourmailusername> \
-e MAIL_PASSWORD=<yourmailpassword> \
-e MAIL_SENDER=<sendemailaddress> \
-e IS_CREATION_ENABLED=true \
-e IS_DASHBOARD_ENABLED=true \
-e IS_REGISTRATION_ENABLED=true \
-e CONNECT_WITH_FRANZ=true \
-e DATA_DIR=data \
-p <port>:3333 \
-v <path to data>:/data \
-v <path to recipes>:/app/recipes \
--restart unless-stopped \
ghcr.io/gibby/ferdium-server

也可使用docker-compose v2，示例配置见https://github.com/getferdi/server/blob/master/docker/docker-compose.yml%E3%80%82

3. （可选）配置NGINX反向代理，参考DigitalOcean教程。

手动部署

1. 克隆包含子模块的仓库
2. 安装AdonisJS CLI
3. 复制.env.example为.env并编辑配置（见下文配置说明）
4. 仅当使用PostgreSQL且数据库托管在GCP、AWS等平台时，设置DB_SSL=true
5. 运行npm install安装依赖
6. 执行数据库迁移：

js
node ace migration:run

7. 启动服务器：

js
npm start

配置说明

Ferdium Server的配置存储在.env文件中，除AdonisJS默认设置外，包含以下自定义配置：

• IS_CREATION_ENABLED（true/false，默认true）：是否允许创建自定义配方
• IS_REGISTRATION_ENABLED（true/false，默认true）：是否允许新用户注册
• IS_DASHBOARD_ENABLED（true/false，默认true）：是否启用用户仪表板
• CONNECT_WITH_FRANZ（true/false，默认true）：是否允许连接Franz服务器，启用后可：
  • 显示完整Franz配方库（而非仅自定义配方）
  • 导入Franz账户

功能使用

导入Franz账户

通过浏览器访问http://[YOUR FERDI-SERVER]/import，使用Franz账户登录，Ferdi Server将创建新用户并复制Franz的设置、服务和工作区。

数据传输

参考https://github.com/getferdi/ferdi/wiki/Transferring-data-between-servers%E3%80%82

创建和使用自定义配方

Ferdium Server允许扩展Franz配方目录，添加自定义Ferdi配方。

配方创建参考https://github.com/meetfranz/plugins/blob/master/docs/integration.md%E3%80%82%E6%B7%BB%E5%8A%A0%E9%85%8D%E6%96%B9%E6%AD%A5%E9%AA%A4%EF%BC%9A

1. 浏览器访问http://[YOUR FERDI-SERVER]/new
2. 配置以下设置：
   • Author：配方作者
   • Name：服务名称（可包含空格和Unicode字符）
   • Service ID：配方唯一ID（不含空格和特殊字符，如google-drive）
   • Link to SVG image：1024x1024 SVG logo的直接链接（推荐使用jsDelivr托管GitHub文件，raw.githubusercontent链接可能无法加载）
   • Recipe files：上传按Franz指南创建的原始配方文件（不要打包，选择单个文件上传）

列出自定义配方

在Ferdium客户端中搜索ferdi:custom即可显示所有自定义配方。