commit 81db09b7dbf2d3db76f23906165ed46deaf6ed8e · ryan.freumh.org/eilean-nix

+36
README.md
···

       1
       1
       +
       

     

       2
       2
       +
       # Eilean

     

       3
       3
       +
       

     

       4
       4
       +
       Create your own digital island powered by Nix.

     

       5
       5
       +
       

     

       6
       6
       +
       Self hosting is hard.

     

       7
       7
       +
       There's a lot of complexity to manage.

     

       8
       8
       +
       

     

       9
       9
       +
       While NixOS enables reproducible deployments of many services, they still require much manual configuration.

     

       10
       10
       +
       Adding domain names, DNS records, user accounts, databases, HTTP proxies, SMTP servers all add additional complexity.

     

       11
       11
       +
       

     

       12
       12
       +
       Eilean aims to be a personal or community 'island in a box' that requires minimal configuration.

     

       13
       13
       +
       It can achieve this by sharing configration between many NixOS modules (each for an individuial service).

     

       14
       14
       +
       

     

       15
       15
       +
       ### Usage

     

       16
       16
       +
       

     

       17
       17
       +
       Some familiarity with Nix is required. 

     

       18
       18
       +
       

     

       19
       19
       +
       TODO...

     

       20
       20
       +
       

     

       21
       21
       +
       ##### Networking

     

       22
       22
       +
       

     

       23
       23
       +
       Requires a public IPv4 and IPv6 address.

     

       24
       24
       +
       

     

       25
       25
       +
       ##### DNS

     

       26
       26
       +
       

     

       27
       27
       +
       Hosting DNS allows necessary records to be specified decleratively and enabled when the module that required then is.

     

       28
       28
       +
       You will need to point your domain's NS record to your IP address with your registar using a glue record.

     

       29
       29
       +
       

     

       30
       30
       +
       ##### Email

     

       31
       31
       +
       

     

       32
       32
       +
       Hosting email allows for an easy, and cheap, SMTP server for services that require it.

     

       33
       33
       +
       Recieving EMail shouldn't pose an issues.

     

       34
       34
       +
       Sending email to users on your own domain shouldn't pose any issues, if for example users are signing up to services like Mastodon using an EMail account on the same Eilean.

     

       35
       35
       +
       Sending mail will require TCP port 25 to be unblocked by your network provider, and your IP address to not be blacklisted (e.g. check [here](https://mxtoolbox.com/blacklists.aspx)).

     

       36
       36
       +