selfhost.directory

The index of self-hostable projects — ranked, categorized and served with live updates.
Own your data and stop giving it to big tech.

GitHub
ferdium-server logo

Self-host ferdium-server

v2.0.14

Self-hosted backend for Ferdium messaging aggregator

ReleaseOpen SourceMIT
Updated9 hours ago
LanguageTypescript
Setup difficultyModerate
Stars
302
Port
3333 (HTTP API server)
Docker
ferdium/ferdium-server
Install with Docker Compose
ferdium-server screenshot 1ferdium-server screenshot 2ferdium-server screenshot 3ferdium-server screenshot 4ferdium-server screenshot 5ferdium-server screenshot 6ferdium-server screenshot 7ferdium-server screenshot 8ferdium-server screenshot 9ferdium-server screenshot 10

What is ferdium-server?

Ferdium-server is the backend component for Ferdium, a community-driven messaging aggregator that combines multiple web services into one application. The server handles user registration and authentication, workspace management, service/recipe storage, and data import/export. It can run with a built-in SQLite database or connect to external MySQL, MariaDB, or PostgreSQL databases. The server is deployed via Docker (image: ferdium/ferdium-server) or manually with Node.js. It exposes a REST API on port 3333 that the Ferdium desktop/mobile clients connect to. Key features include user dashboards, custom recipe creation, Franz/Ferdi account import, and workspace support. The project is licensed under MIT and actively maintained by the Ferdium organization.

Should you self-host ferdium-server?

ferdium-server scores 49/100 on selfhost.directory (how scoring works) and ranks #29 of 33 in Communication. It has 302 GitHub stars.

There was no stable release in the past 12 months, so check the repository's recent activity before you rely on it.

Setup is moderate: expect some configuration beyond a single command. An official Docker image is available. It is MIT-licensed and written mostly in Typescript.

Its closest alternative on selfhost.directory is Jitsi Meet (79/100, 30 159 stars). It scores higher overall, so compare the two before you pick. See ferdium-server vs Jitsi Meet side by side.

Features

  • Custom recipe creation
  • Data Export/Import
  • Franz/Ferdi account import
  • Multiple database support
  • Password Recovery
  • Recipe updates
  • Service/recipe management
  • Service store
  • SMTP email notifications
  • User dashboard
  • User registration and login
  • Workspace support

ferdium-server README

How to install ferdium-server

Install ferdium-server with Docker Compose

docker-compose -f docker/docker-compose.yml up -d

Uses default SQLite database; modify docker-compose.yml for external databases

How to configure ferdium-server

  • APP_KEYThese are needed if running outside of Docker

    These are needed if running outside of Docker

  • APP_URLlocalhost
  • CACHE_VIEWSfalseThese have defaults hard-coded, but are being overridden

    These have defaults hard-coded, but are being overridden

  • CONNECT_WITH_FRANZfalse
  • DATA_DIRdata
  • DB_BUSY_TIMEOUT5000
  • DB_CONNECTIONsqlite
  • DB_DATABASEferdium
  • DB_HOST127.0.0.1
  • DB_PASSWORD
  • DB_PORT3306
  • DB_SQLITE_JOURNAL_MODEWALSQLite durability/concurrency notes: - WAL improves concurrent reads/writes for the default SQLite deployment. - FULL is the safer default for production durability. - NORMAL reduces fsync pressure, but may lose the last committed transactions on sudden power loss or kernel crash.

    SQLite durability/concurrency notes: - WAL improves concurrent reads/writes for the default SQLite deployment. - FULL is the safer default for production durability. - NORMAL reduces fsync pressure, but may lose the last committed transactions on sudden power loss or kernel crash.

  • DB_SQLITE_SYNCHRONOUSFULL
  • DB_SSLfalse
  • DB_USERroot
  • HOST127.0.0.1
  • IS_CREATION_ENABLEDtrue
  • IS_DASHBOARD_ENABLEDtrue
  • IS_REGISTRATION_ENABLEDtrue
  • MAIL_CONNECTIONsmtp
  • MAIL_PASSWORD
  • MAIL_SENDERnoreply@ferdium.org
  • MAIL_SSLfalse
  • MAIL_USERNAMEusername
  • NODE_ENVdevelopment
  • PORT3333
  • SMTP_HOST127.0.0.1
  • SMTP_PORT2525

ferdium-server releases & version history

FAQ

How do I create custom recipes?

Visit http://[YOUR FERDIUM-SERVER]/new in your browser to define the recipe author, name, service ID, logo image URL, and upload recipe files. The server packages and stores them automatically.

How do I import my Franz/Ferdi account?

Open http://[YOUR FERDIUM-SERVER]/import in your browser and log in with your Franz/Ferdi credentials. The server will create a new user and copy your settings, services, and workspaces.

Why use a custom Ferdium server?

A custom server lets you manage all user data yourself and add your own recipes to the repository, instead of relying on the official instance at api.ferdium.org.

More in Application Management

Rate this project

Click to rate — no account needed.

0 comments

Posting as guest
Loading comments…