citadel-core/README.md

<!--
SPDX-FileCopyrightText: 2021 Citadel and contributors

SPDX-License-Identifier: GPL-3.0-or-later
-->

<p align="center">
  <img height="300" src="https://avatars.githubusercontent.com/u/86734767">
  <h1 align="center">🏰 Citadel Core</h1>
</p>


[![Discord Server](https://img.shields.io/badge/Community%20Chat-Discord-%235351FB?style=flat-square)](https://discord.gg/6U3kM2cjdB)
[![Twitter](https://img.shields.io/twitter/follow/runcitadel?style=flat-square)](https://twitter.com/runcitadel)
![License](https://img.shields.io/github/license/runcitadel/core?style=flat-square)

Citadel Core contains simple, minimalistic host system components for running a Citadel server.
It uses docker and docker-compose to orchestrate containers for the core system and apps.

This repository also contains `karen`, a background daemon responsible for communication between Citadel docker containers and the Citadel Core.

Citadel Core is a fully FLOSS project which replaces the previous `compose` and `compose-nonfree` repositories.