Ferdium 服务器项目使用与部署指南

Ferdium 服务器项目使用与部署指南

ferdium-server The server component that can either be self-hosted or hosted for general purpose - for use with the ferdium thick client. 项目地址: https://gitcode.com/gh_mirrors/fe/ferdium-server

1. 项目介绍

Ferdium 服务器是 Ferdium 客户端的一个配套服务器组件，可以自行托管或用于通用目的。它允许用户自行管理所有注册用户的数据，并添加自己的食谱到仓库中。如果不需要这样做，可以使用官方的服务器实例 api.ferdium.org。

2. 项目快速启动

以下是基于 Docker 的快速启动步骤：

拉取 Docker 镜像

docker pull ferdium/ferdium-server:latest

创建 Docker 容器

docker create \
  --name=ferdium-server \
  -e NODE_ENV=development \
  -e APP_URL=<ferdium-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 \
  ferdium/ferdium-server:latest

启动容器

docker start ferdium-server

3. 应用案例和最佳实践

用户数据迁移

若要将用户数据从一个服务器迁移到另一个服务器，请参考官方文档：https://github.com/getferdi/ferdi/wiki/Transferring-data-between-servers

自定义食谱

Ferdium 服务器允许扩展 Franz/Ferdi 的食谱目录，以添加自定义的 Ferdium 食谱。创建食谱的官方指南可以在这里找到。

4. 典型生态项目

由于 Ferdium 服务器是基于 AdonisJS 框架构建的，因此任何 AdonisJS 支持的插件或中间件都可以作为生态项目的一部分使用。例如，可以使用 AdonisJS 的认证、数据库和缓存等功能来扩展服务器的功能。

以上是关于 Ferdium 服务器项目的使用与部署指南。希望对您的开源项目部署有所帮助。

ferdium-server The server component that can either be self-hosted or hosted for general purpose - for use with the ferdium thick client. 项目地址: https://gitcode.com/gh_mirrors/fe/ferdium-server