getferdi/ferdi-server

Ferdi-server-docker

镜像概述和主要用途

https://github.com/getferdi/ferdi 是 https://github.com/meetfranz/franz 的硬分叉，增加了许多出色功能并移除了不必要的功能。Ferdi-server 是用于Ferdi客户端的Franz服务器非官方替代品。

本镜像为 https://github.com/getferdi/server 的Docker化版本，运行在Alpine Linux和Node.js（v10.16.3）环境中。

为什么使用自定义Ferdi-server？

自定义Ferdi-server能让您体验Ferdi客户端的全部潜力，允许使用所有高级功能（如工作区和自定义URL配方）并添加自己的配方。

核心功能和特性

• 用户注册和登录
• 服务创建、下载、列出和移除
• 工作区支持
• 功能正常的服务商店
• 用户仪表板
• 密码恢复
• 数据导出/导入到其他Ferdi-server
• 配方更新

使用场景和适用范围

适用于希望使用Ferdi客户端全部功能的用户，尤其是需要自定义服务配方、管理工作区、实现数据本地化存储的个人或团队。适合在家庭网络或私有服务器中部署，通过反向代理对外提供服务。

安装与设置

以下是帮助您创建容器的示例代码片段。

Docker镜像可直接运行（使用默认SQLite数据库），也可通过修改环境变量使用外部数据库（如MySQL、MariaDB、Postgres等）。设置容器后，需使用NGINX等Web服务器创建反向代理，以便从家庭网络外部访问Ferdi-server。

现有用户请注意：Ferdi-server和Ferdi-server Docker镜像的最新更新对默认SQLite数据库名称、位置以及容器内部端口进行了更改。新的容器端口为3333。如果希望保留现有SQLite数据库，需添加DATA_DIR变量并将其设置为/app/database（以匹配现有数据卷），同时将DB_DATABASE变量更改为development（以匹配现有数据库）。详情请参见迁移部分的参数说明。

Docker

拉取Docker镜像：

bash
docker pull docker.xuanyuan.run/getferdi/ferdi-server

使用正确参数创建Docker容器：

bash
docker create \
  --name=ferdi-server \
  -e NODE_ENV=development \
  -e EXTERNAL_DOMAIN=<ferdi-server域名> \
  -e DB_CONNECTION=<数据库类型> \
  -e DB_HOST=<数据库主机> \
  -e DB_PORT=<数据库端口> \
  -e DB_USER=<数据库用户> \
  -e DB_PASSWORD=<数据库密码> \
  -e DB_DATABASE=<数据库名称> \
  -e DB_SSL=false \
  -e MAIL_CONNECTION=smtp \
  -e SMTP_HOST=<SMTP邮件服务器> \
  -e SMTP_PORT=<SMTP端口> \
  -e MAIL_SSL=true/false \
  -e MAIL_USERNAME=<邮件用户名> \
  -e MAIL_PASSWORD=<邮件密码> \
  -e MAIL_SENDER=<发件人邮箱地址> \
  -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 <主机端口>:3333 \
  -v <数据路径>:/data \
  -v <配方路径>:/app/recipes \
  --restart unless-stopped \
  getferdi/ferdi-server

Docker Compose

如果您对默认环境变量满意，可使用提供的示例 https://github.com/getferdi/server/tree/master/docker/docker-compose.yml%E3%80%82%E8%AF%A5%E6%96%87%E4%BB%B6%E5%B0%86%E4%BB%8EDocker Hub拉取最新镜像，或使用本地构建的镜像（可通过本地构建部分的说明构建）。

启动应用：docker-compose -f docker/docker-compose.yml up -d。服务器将在 http://localhost:3333/ 地址启动。

配置

容器镜像通过运行时传递的参数进行配置（如上所示）。以下是默认参数的说明，更多信息请参见https://docs.docker.com/get-started/overview/%E3%80%82

如果未向容器传递任何环境参数，其值将从 /config/config.txt 文件获取。
警告：config.txt 的使用已弃用。请确保在运行时向容器传递正确的环境变量。

启用CONNECT_WITH_FRANZ选项后，Ferdi-server可以：

• 显示完整的Franz配方库而非仅自定义配方
• 导入Franz账户

支持的数据库和驱动

要使用默认SQLite3以外的数据库，请在ENV配置中输入以下驱动代码。

支持的邮件连接（高级）

要使用默认SMTP以外的邮件发送方式，请在ENV配置中输入正确信息，并相应调整docker run、create或compose命令。

从现有Ferdi-server迁移

如果您是使用内置SQlite数据库的现有Ferdi-server用户，应包含以下变量：

如果您是使用外部数据库或内置SQlite数据库不同变量的现有Ferdi-server用户，应相应更新参数。例如，使用外部MariaDB或MySQL数据库时，您的独特参数可能如下：

无论哪种情况，请确保向新Ferdi-server容器传递正确的变量，以保持对现有数据库的访问。

NGINX配置块

要通过子域名从家庭网络外部访问Ferdi-server，请使用以下服务器块：

nginx
# Ferdi-server
server {
  listen 443 ssl http2;
  server_name ferdi.my.website;

  # 所有SSL相关配置移至ssl.conf
  include /config/nginx/ssl.conf;

  location / {
    proxy_pass http://<Ferdi-IP>:3333;
    proxy_set_header  X-Real-IP  $remote_addr;
    proxy_set_header  X-Forwarded-For  $proxy_add_x_forwarded_for;
    proxy_set_header  Host  $host;
    proxy_set_header  X-Forwarded-Proto  $scheme;
  }
}

导入Franz账户

Ferdi-server允许导入完整的Franz账户，包括所有设置。

要导入Franz账户，请在浏览器中打开http://[您的FERDI-SERVER]/import，使用Franz账户详情登录。Ferdi-server将创建具有相同凭据的新用户，并复制您的Franz设置、服务和工作区。

传输用户数据

请参考 https://github.com/getferdi/ferdi/wiki/Transferring-data-between-servers

创建和使用自定义配方

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

有关创建配方的文档，请访问https://github.com/meetfranz/plugins/blob/master/docs/integration.md%E3%80%82

要将配方添加到Ferdi-server，请在浏览器中打开http://[您的FERDI-SERVER]/new。您可以定义以下设置：

• Author：创建配方的作者
• Name：新服务的名称，可包含空格和unicode字符
• Service ID：配方的唯一ID，不含空格或特殊字符（例如google-drive）
• Link to PNG/SVG image：1024x1024 PNG图像和SVG的直接链接，用作商店中的徽标。使用GitHub上传的文件时，请使用jsDelivr，因为raw.githubusercontent文件无法加载
• Recipe files：使用https://github.com/meetfranz/plugins/blob/master/docs/integration.md%E5%88%9B%E5%BB%BA%E7%9A%84%E9%85%8D%E6%96%B9%E6%96%87%E4%BB%B6%E3%80%82**%E8%AF%B7%E5%8B%BF**%E9%A2%84%E5%85%88%E6%89%93%E5%8C%85%E6%96%87%E4%BB%B6 - 上传原始文件（可拖放多个文件）。Ferdi-server将自动打包并以正确格式存储配方。也请勿拖放或选择整个文件夹，选择单个文件。

列出自定义配方

在Ferdi中搜索ferdi:custom将列出所有自定义配方。

支持信息

• 容器运行时的Shell访问：docker exec -it ferdi-server /bin/bash
• 实时监控容器日志：docker logs -f ferdi-server

更新信息

以下是更新容器以获取最新版本Ferdi-server的说明：

通过Docker Run/Create

• 更新镜像：docker pull docker.xuanyuan.run/getferdi/ferdi-server
• 停止运行中的容器：docker stop ferdi-server
• 删除容器：docker rm ferdi-server
• 使用上述相同的docker create参数重新创建新容器（如果正确映射到主机文件夹，您的/config文件夹和ENV设置将被保留）
• 启动新容器：docker start ferdi-server

通过Docker Compose

• 更新所有镜像：docker-compose -f docker/docker-compose.yml pull
  • 或更新单个镜像：docker-compose -f docker/docker-compose.yml pull ferdi-server
• 让Compose按需更新所有容器：docker-compose -f docker/docker-compose.yml up -d
  • 或更新单个容器：docker-compose -f docker/docker-compose.yml up -d ferdi-server

本地构建

如果要本地构建此镜像，请从https://github.com/getferdi/server/tree/master/%E7%9A%84%E6%A0%B9%E7%9B%AE%E5%BD%95%E8%BF%90%E8%A1%8C%E4%BB%A5%E4%B8%8B%E5%91%BD%E4%BB%A4%EF%BC%9A

bash
docker build \
  --no-cache \
  --pull \
  -t getferdi/ferdi-server:latest .

许可证

Ferdi-server-docker和Ferdi-server采用MIT许可证。