# Karrot Backend

> Self-hosted, open-source Django API backend for Karrot, the coordination tool for grassroots groups: activity slots, places, chats, offers and voting.

- **Category:** [Collaboration](https://selfhost.directory/collaboration)
- **Source model:** Open source
- **Latest version:** v17.4.1
- **Author:** Karrot
- **Platforms:** Docker, Docker Compose
- **Ports:** 8000 (Backend app server (LISTEN_PORT; healthcheck at /api/healthcheck/))
- **Requires:** Redis, PostgreSQL
- **Tags:** PostgreSQL, Redis, API, Docker, Django, Agpl

## Docker images

- [`codeberg.org/karrot/karrot-backend`](https://codeberg.org/karrot/karrot-backend) — Backend app server (also runs the background worker)

## 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.

## Should you self-host Karrot Backend?

Karrot Backend scores **61/100** on selfhost.directory ([how scoring works](https://selfhost.directory/scoring)) and ranks **#9 of 32** in [Collaboration](https://selfhost.directory/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](https://selfhost.directory/project/penpot) (84/100, 62 421 stars). It scores higher overall, so compare the two before you pick. [See Karrot Backend vs penpot side by side.](https://selfhost.directory/compare/karrot-backend-vs-penpot)

## Features

- Activity scheduling with slots
- Background workers
- Email and push notifications
- Group and per-activity chats
- Group statistics export (◐ partial) — Optional, configured via InfluxDB settings.
- Incoming email replies (◐ partial) — Requires 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 calling (◐ partial) — Disabled by default; needs LiveKit configuration and per-group enablement.

## How to install Karrot Backend

### Install Karrot Backend with Docker Compose

Requirements: docker and docker compose tooling

wget https://docs.karrot.world/self-host/docker-compose.yml

docker compose up -d

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

## Karrot Backend alternatives

- [Agorakit](https://selfhost.directory/project/agorakit): Open-source groupware for collectives: self-hosted groups with a forum, calendar with iCal feeds, file manager, map and email digests. (compare: https://selfhost.directory/compare/agorakit-vs-karrot-backend)
- [QFieldCloud](https://selfhost.directory/project/qfieldcloud): Self-hosted open-source platform for synchronizing geospatial field data between QGIS desktop and QField mobile app with offline support. (compare: https://selfhost.directory/compare/karrot-backend-vs-qfieldcloud)
- [Foodsoft](https://selfhost.directory/project/foodsoft): Open-source web app for food co-ops: manage products, orders, finances, and work shifts — run it yourself with Docker or Rails. (compare: https://selfhost.directory/compare/foodsoft-vs-karrot-backend)
- [kan](https://selfhost.directory/project/kan): An open-source Trello alternative for self-hosted kanban boards: workspaces, labels, comments, activity logs, Trello imports and a REST API, run via Docker Compose. (compare: https://selfhost.directory/compare/kan-vs-karrot-backend)
- [Colanode](https://selfhost.directory/project/colanode): Open-source, local-first chat-and-docs workspace that stands in for Slack and Notion; self-hosted via Docker Compose or Helm with Postgres, Redis and object storage. (compare: https://selfhost.directory/compare/colanode-vs-karrot-backend)
- [open-sparrow](https://selfhost.directory/project/open-sparrow): OpenSparrow is a self-hosted, open-source PHP platform generating CRUD apps, dashboards, calendars from JSON schema on PostgreSQL. Includes RAG, workflows, Kanban, 2FA. (compare: https://selfhost.directory/compare/karrot-backend-vs-open-sparrow)
- [Chatto](https://selfhost.directory/project/chatto): Chatto is an open-source, self-hosted team chat server: one compact binary, no separate database, with rooms, threads, attachments, search, calls and SSO. (compare: https://selfhost.directory/compare/chatto-vs-karrot-backend)
- [quackback](https://selfhost.directory/project/quackback): Quackback is a self-hosted, open-source customer feedback platform with boards, roadmap, changelog, chat, help center, and status page. (compare: https://selfhost.directory/compare/karrot-backend-vs-quackback)

## More in Collaboration

- [Kitsu](https://selfhost.directory/project/kitsu): Self-hosted production tracker for creative studios with task management, asset tracking, scheduling, and review workflows.
- [Klaxon](https://selfhost.directory/project/klaxon): Klaxon is a self-hosted, open-source tool that monitors websites for changes and sends email, Slack, or Discord alerts — built for newsrooms to track newsworthy updates.
- [kodbox](https://selfhost.directory/project/kodbox): kodbox is a self-hosted, open-source PHP file manager and private cloud drive: multi-storage mounting, fine-grained permissions, sharing, and online preview/edit.
- [Kurrier](https://selfhost.directory/project/kurrier): Kurrier is an open-source, self-hosted workspace unifying email, calendars, contacts, and file storage via IMAP/SMTP, CalDAV, CardDAV, and WebDAV/S3 with OIDC/SSO auth.
- [learnhouse](https://selfhost.directory/project/learnhouse): LearnHouse is a self-hosted, open-source LMS with AI-powered courses, real-time collaboration, code execution, and enterprise SSO.
- [Libervia](https://selfhost.directory/project/libervia): Libervia-web is a web-based interface for Libervia, a decentralized and federated communication platform based on XMPP. It provides features such as instant messaging, microblogging, file sharing, photo albums, events, and forums.
- [Live Helper Chat](https://selfhost.directory/project/live-helper-chat): Live Helper Chat - live support for your website. Featuring web and mobile apps, Voice & Video & ScreenShare. Supports Telegram, Twilio (whatsapp), Facebook messenger including building a bot.
- [Loomio](https://selfhost.directory/project/loomio): Open-source self-hosted decision-making tool for groups: discussions, proposals with many voting methods, subgroups, reply-by-email, deployed with Docker Compose.
- [Loot](https://selfhost.directory/project/loot-app): Open-source, self-hosted web app to track community contributions and share their rewards through contributive budgets, with email notices and a read-only API.
- [Lowcoder](https://selfhost.directory/project/lowcoder): Open-source low-code platform for internal tools and customer apps with visual builder, 120+ components, 60+ data sources, and Docker self-hosting.
- [Mailcow](https://selfhost.directory/project/mailcow): Open-source mail server suite providing email hosting with spam filtering, antivirus, webmail, calendar and contacts via Docker Compose installation.
- [mailez](https://selfhost.directory/project/mailez): A self-hosted email platform with SMTP, IMAP, POP3, CardDAV, CalDAV, a React webmail client, and admin console — all deployed via a single Docker Compose command.

## Links

- [Homepage](https://codeberg.org/karrot/karrot-backend)
- [Website](https://docs.karrot.world)
- [Backend source repository](https://codeberg.org/karrot/karrot-backend)
- [Matrix chat](https://matrix.to/#/#karrot:matrix.org)
- [Self-hosting guide](https://docs.karrot.world/self-host/getting-started)
- [Releases](https://codeberg.org/karrot/karrot/releases)
- [Community forum](https://community.karrot.world)
- [Mastodon](https://fosstodon.org/@karrot)

---
Source: https://selfhost.directory/project/karrot-backend