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.

Self-host Karrot Backend

v17.4.1

Coordination API backend for community groups and activities

ReleaseOpen Source
Updated5 months ago
Setup difficultyModerate
Port
8000 (Backend app server (LISTEN_PORT; healthcheck at /api/healthcheck/))
Requires
PostgreSQL, Redis
Docker
codeberg.org/karrot/karrot-backend
Install with Docker Compose

What is Karrot Backend?

karrot-backend is the Django API server behind Karrot, a free and open-source coordination tool for grassroots groups that organise face-to-face activities such as food pickups, meetings and community events. It powers independent groups with their own rules, activities that members sign up for by slot, places, offers to share, per-activity chats, trust-based editing rights and membership voting, plus email and web push notifications. As the server side of the project it ships self-generated API docs at /docs/, an instance-admin settings API and UI, background workers run from the same image, and a plugin mechanism with documented backend and frontend plugin APIs; optional integrations cover OpenStreetMap, LiveKit video calling, Sentry, InfluxDB statistics, a Discourse forum feed and Postal or SMTP email. Self-hosting is well documented: the recommended route is Co-op Cloud with abra, a plain Docker Compose example is published, and an expert "without docker" Python/Django deployment exists; it needs PostgreSQL and Redis. Frontend and backend must run the same tagged version, mismatched versions are not supported, and instances do not yet federate with each other.

Karrot Backend alternatives

Should you self-host Karrot Backend?

Karrot Backend scores 61/100 on selfhost.directory (how scoring works) and ranks #9 of 32 in Collaboration.

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.

Its closest alternative on selfhost.directory is penpot (84/100, 62 379 stars). It scores higher overall, so compare the two before you pick. See Karrot Backend vs penpot side by side.

Features

  • Activity scheduling with slots
  • Background workers
  • Email and push notifications
  • Group and per-activity chats
  • Group statistics exportOptional, configured via InfluxDB settings.
  • Incoming email repliesRequires a Postal mail server.
  • Independent groups
  • Instance admin settings UI and API
  • Multi-language
  • Plugin System
  • REST API
  • Sharing offers
  • Trust-based group management
  • Video callingDisabled by default; needs LiveKit configuration and per-group enablement.

How to install Karrot Backend

Install Karrot Backend with Docker Compose

docker and docker compose tooling

Good for trying out Karrot or as a base for your own setup; no secret handling, backups, geoip or TLS certificates included.

How to configure Karrot Backend

  • ADMIN_EMAILS
  • FRONTEND_DIR
  • MODEdev
  • BASE_URLhttp://localhost:8000
  • SECRET_KEY

More in Collaboration

Rate this project

Click to rate — no account needed.

0 comments

Posting as guest
Loading comments…