christinloehner/fedisuite repository overview

⁠FediSuite

FediSuite is a self-hosted app for managing Fediverse accounts with Docker Compose.

Project website: https://www.fedisuite.com⁠

This repository is for operators who want to run FediSuite themselves. You do not need to build anything locally. You only need Docker, Docker Compose, and a .env file with your settings.

⁠What Users Should Use

FediSuite currently has several important public URLs with different purposes.

• Project website / landing page: https://www.fedisuite.com⁠
• Self-hosting repository: https://forge.chrislo.de/FediSuite/FediSuite-Self-Hosting⁠
• Source code, bug reports and contributions: https://forge.chrislo.de/FediSuite/FediSuite-Docker-Image⁠
• Published Docker image for self-hosters: https://hub.docker.com/r/christinloehner/fedisuite⁠

In short:

• If you want to learn about FediSuite, start at the website.
• If you want to self-host FediSuite, use the FediSuite-Self-Hosting repository with the deployment files.
• If you want to report bugs or work on the application itself, use this repository.
• If you want the ready-to-run container image, use Docker Hub.

⁠ATTENTION

We’re using a slightly special versioning philosophy:

We use a 3-part version format, like: 1.20.13

• The first number is the major version and represents really big changes.
• The second number is for new features and important bug fixes.
• The third number represents bleeding-edge versions.

The last number gets bumped for test releases. Once all tests are successful, the second number is increased — which basically means it’s a production release.

So keep this in mind: for a production setup, you should only update when the second number changes.

⁠Bug Reporting and Contribution

If you find a bug or if you want to contribute, please either file a bug report or read the CONTRIBUTING.md here:

---> https://forge.chrislo.de/FediSuite/FediSuite-Docker-Image⁠

⁠Quick Start

git clone https://forge.chrislo.de/FediSuite/FediSuite-Self-Hosting.git FediSuite
cd FediSuite
cp .env.example .env

Edit .env and set at least these values:

• FEDISUITE_IMAGE
• APP_URL
• JWT_SECRET
• DATABASE_URL
• POSTGRES_DB
• POSTGRES_USER
• POSTGRES_PASSWORD
• ADMIN_EMAIL
• ADMIN_PASSWORD
• SMTP_HOST
• SMTP_PORT
• SMTP_USER
• SMTP_PASS
• SMTP_FROM

Then start FediSuite:

docker compose up -d

Open APP_URL in your browser after the containers are healthy.

⁠What The Compose Stack Starts

The default setup starts:

• db: PostgreSQL database
• app: frontend and API
• worker1: background jobs
• worker2: background jobs

The workers handle scheduled posts, refresh jobs, idle reminders, and tips generation.

⁠Default Image Tag

The default .env.example uses:

• christinloehner/fedisuite:latest

If you want to pin a specific release, replace latest with the tag you want to run.

⁠Important Notes

• ADMIN_EMAIL and ADMIN_PASSWORD are required on the first start. The initial admin user is created from these values.
• SMTP is required. FediSuite sends emails for registration, password reset, and historical import related flows.
• If you want to prevent new user sign-ups, set ENABLE_USER_REGISTRATION=false. The initial admin user is still created on first start.

⁠Important Variables

Required:

• FEDISUITE_IMAGE
• DATABASE_URL
• JWT_SECRET
• APP_URL
• ADMIN_EMAIL
• ADMIN_PASSWORD
• SMTP_HOST
• SMTP_PORT
• SMTP_USER
• SMTP_PASS
• SMTP_FROM
• POSTGRES_DB
• POSTGRES_USER
• POSTGRES_PASSWORD

Optional:

• APP_NAME
• PUBLIC_SITE_URL
• OUTBOUND_HTTP_USER_AGENT
• ENABLE_USER_REGISTRATION

⁠Traefik

If you use Traefik, you can either uncomment the example labels in docker-compose.yml or use docker-compose.traefik.example.yml as a reference.

⁠Update

To update to newer image tags:

docker compose pull
docker compose up -d

⁠Verify

To check that your configuration is valid before starting:

cp .env.example .env
docker compose config

⁠Links

• Project website: https://www.fedisuite.com⁠
• Codeberg repository: https://forge.chrislo.de/FediSuite⁠
• License: https://forge.chrislo.de/FediSuite/FediSuite-Docker-Image/raw/branch/main/LICENSE⁠