appjail.adoc

=== Container orchestration: Overlord, Director, AppJail and cloud-init

Links: +
link:https://github.com/DtxdF/AppJail[AppJail on GitHub] URL: link:https://github.com/DtxdF/AppJail[] +
link:https://github.com/DtxdF/Director[Director on GitHub] URL: link:https://github.com/DtxdF/Director[] +
link:https://github.com/DtxdF/Overlord[Overlord on GitHub] URL: link:https://github.com/DtxdF/Overlord[] +
link:https://github.com/AppJail-makejails[Makejails] URL: link:https://github.com/AppJail-makejails[]

Contact: Jesús Daniel Colmenares Oviedo <[email protected]>

**AppJail** is an open-source BSD-3 licensed framework entirely written in POSIX shell and C to create isolated, portable and easy to deploy environments using FreeBSD jails that behaves like an application.

**Director** is a tool for running multi-jail environments on link:https://github.com/DtxdF/AppJail[AppJail] using a simple YAML specification.
A Director file is used to define how one or more jails that make up your application are configured.
Once you have a Director file, you can create and start your application with a single command: `appjail-director up`.

**Overlord** is a fast, distributed orchestrator for FreeBSD jails oriented to GitOps.
You define a file with the service intended to run on your cluster and deployment takes seconds to minutes.
This orchestration tool uses link:https://github.com/DtxdF/AppJail[AppJail], link:https://github.com/DtxdF/director[Director] and can even create VMs with link:https://github.com/FreeBSD/vm-bhyve[vm-bhyve], but as its philosophy is "deploy using code" you can create a single file once and deploy many times.
Through a tree chaining system Overlord deploys jails on connected systems sharing their resources almost infinitely.
See the link:https://github.com/DtxdF/Overlord/wiki[wiki] for articles that use Overlord.

**Recently written articles about Overlord**:

* link:https://freebsdfoundation.org/our-work/journal/browser-based-edition/networking-3/overlord-deploy-jails-as-fast-as-you-code/[Overlord: Deploy Jails as Fast as You Code]
* link:https://github.com/DtxdF/overlord/wiki/cloud-init[Deploying virtual machines using cloud-init]
* link:https://github.com/DtxdF/overlord/wiki/ephemeral[Deploying virtual machines with ephemeral jails]
* link:https://github.com/DtxdF/overlord/wiki/gitops[Using GitOps with Overlord]
* link:https://dtxdf.github.io/jellyseerr.html[How to install Jellyfin and Jellyseerr using Overlord]

**Makejails** are simple text files that automate the steps to create a jail, a widely used feature of link:https://github.com/DtxdF/AppJail[AppJail].
Currently, there are many Makejails created and hosted in the link:https://github.com/AppJail-makejails[Centralized Repository], but here are some of the recently written ones:

* link:https://github.com/AppJail-makejails/odoo[Odoo]
* link:https://github.com/AppJail-makejails/writefreely[WriteFreely]
* link:https://github.com/AppJail-makejails/adminer[Adminer]
* link:https://github.com/AppJail-makejails/shiori[Shiori]
* link:https://github.com/AppJail-makejails/healthchecks[Healthchecks]
* link:https://github.com/AppJail-makejails/ntfy[ntfy]

Sponsor: https://www.patreon.com/appjail