Self-host your own digital island
1
2# Eilean
3
4<div align="center">
5 <img src="./eilean-donan.jpg" alt="Eilean Donan" width="400"/>
6 <!-- Photo by DAVID ILIFF. License: CC BY-SA 3.0 -->
7</div>
8
9Eilean enables you to host your own digital island where you control your own online infrastructure.
10Through the use of open standards and federated protocols Eilean allows you to interoperate with other providers.
11
12[NixOS](https://nixos.org/) is used to enable reproducible deployments of services such as webservers, mailservers, federated communication servers, Virtual Private Network servers, and more.
13However, such services still require a lot of manual configuration for domain names, DNS records, user accounts, databases, HTTP proxies, TLS certificates, and more.
14
15Eilean aims to be a optioned framework to allow the simple deployment of these services on a single machine, and a library of documentation for common issues in managing runtime state like secrets, databases, and upgrades.
16
17By using Nix, Eilean modules are extensible to other configurations outside this deployment scenario, such as offloading a particularly resource heavy service to a dedicated machine.
18
19For instructions on getting started see [docs/getting_started.md](./docs/getting_started.md).
20
21Contributions for additional services are welcome.
22