hosting/selfhostblocks
1
0
Fork 0
Code Issues Activity
selfhostblocks/README.md
Pierre Penninckx fd06c34032
use correct badge for tests (#332)
2024-10-26 16:22:54 +00:00

9.8 KiB
Raw Permalink Blame History

Self Host Blocks

Modular server management based on NixOS modules and focused on best practices.

Documentation Tests Demo

SHB (Self Host Blocks) is yet another server management tool that is not like the other server management tools.

TOC

Unified Interfaces

SHB's first goal is to provide unified building blocks and by extension configuration interface, for self-hosting.

Compare the configuration for Nextcloud and Forgejo in Self Host Blocks. The following snippets focus on similitudes and assume the relevant blocks are configured off-screen. It also does not show specific options for each service. These are still complete snippets that configure HTTPS, subdomain serving the service, LDAP and SSO integration.

shb.nextcloud = {
  enable = true;
  subdomain = "nextcloud";
  domain = "example.com";

  ssl = config.shb.certs.certs.letsencrypt.${domain};

  apps.ldap = {
    enable = true;
    host = "127.0.0.1";
    port = config.shb.ldap.ldapPort;
    dcdomain = config.shb.ldap.dcdomain;
    adminPasswordFile = config.sops.secrets."nextcloud/ldap_admin_password".path;
  };
  apps.sso = {
    enable = true;
    endpoint = "https://${config.shb.authelia.subdomain}.${config.shb.authelia.domain}";

    secretFile = config.sops.secrets."nextcloud/sso/secret".path;
    secretFileForAuthelia = config.sops.secrets."authelia/nextcloud_sso_secret".path;
  };
};

shb.forgejo = {
  enable = true;
  subdomain = "forgejo";
  domain = "example.com";

  ssl = config.shb.certs.certs.letsencrypt.${domain};

  ldap = {
    enable = true;
    host = "127.0.0.1";
    port = config.shb.ldap.ldapPort;
    dcdomain = config.shb.ldap.dcdomain;
    adminPasswordFile = config.sops.secrets."forgejo/ldap_admin_password".path;
  };

  sso = {
    enable = true;
    endpoint = "https://${config.shb.authelia.subdomain}.${config.shb.authelia.domain}";

    secretFile = config.sops.secrets."forgejo/ssoSecret".path;
    secretFileForAuthelia = config.sops.secrets."forgejo/authelia/ssoSecret".path;
  };
};

As you can see, they are pretty similar!

SHB provides an ever growing list of services that are configured in the same way.

Incremental Adoption

SHB's second goal is to facilitate testing NixOS and slowly switching an existing installation to NixOS.

To achieve this, SHB pioneers contracts which allows you, the final user, to be more in control of which piece go where. This lets you choose, for example, any reverse proxy you want or any database you want, without requiring work from maintainers of the services you want to self host. (See manual for a complete explanation)

Usage

Caution: You should know that although I am using everything in this repo for my personal production server, this is really just a one person effort for now and there are most certainly bugs that I didn't discover yet.

Self Host Blocks is available as a flake. To use it in your project, add the following flake input:

inputs.selfhostblocks.url = "github:ibizaman/selfhostblocks";

More information is provided in the manual, like secrets management.

  • You are new to self hosting and want pre-configured services to deploy easily. Look at the services section.
  • You are a seasoned self-hoster but want to enhance some services you deploy already. Go to the blocks section.
  • You are a user of Self Host Blocks but would like to use your own implementation for a block. Go to the contracts section.

Head over to the matrix channel for any remaining question, or just to say hi :)

More Benefits of SHB

By using Self Host Blocks, you get all the benefits of NixOS which are, for self hosted applications specifically:

  • declarative configuration;
  • atomic configuration rollbacks;
  • real programming language to define configurations;
  • user-defined abstractions (create your own functions or NixOS modules on top of SHB!);
  • integration with the rest of nixpkgs;
  • much fewer "works on my machine" type of issues.

In no particular order, here are some aspects of SHB which I find interesting and differentiates it from other server management projects:

  • SHB intends to be a library, not a framework. You can either go all in and use SHB provided services directly or use just one block in your existing infrastructure.
  • SHB introduces contracts to allow you to swap implementation for each self-hosting need. For example, you should be able to use the reverse proxy you want without modifying any services depending on it.
  • SHB contracts also allows you to use your own custom implementation instead of the provided one, as long as it follows the contract and passes the tests.
  • SHB provides at least one implementation for each contract like backups, SSL certificates, reverse proxy, VPN, etc. Those are called blocks here and are documented in the manual.
  • SHB provides several services out of the box fully using the blocks provided. Those can also be found in the manual.
  • SHB follows nixpkgs unstable branch closely. There is a GitHub action running daily that updates the nixpkgs input in the root flakes.nix, runs the tests and merges a PR with the new input if the tests pass.

Manual

The manual can be found at shb.skarabox.com.

Work is in progress to document everything in the manual but I'm not there yet. For what's not yet documented, unfortunately the source code is the best place to read about them. Here for services and here for blocks.

Roadmap

Currently, the Nextcloud service and SSL block are the most advanced and most documented.

Documenting all services and blocks will be done as I make all blocks and services use the contracts.

Upstreaming changes is also on the roadmap.

Check the issues to see planned works. Feel free to add more!

That being said, I am personally using all the blocks and services in this project, so they do work to some extent.

Available Blocks

Provided Services

Demos

Demos that start and deploy a service on a Virtual Machine on your computer are located under the demo folder. These show the onboarding experience you would get if you deployed one of the services on your own server.

Community

All issues and PRs are welcome. For PRs, if they are substantial changes, please open an issue to discuss the details first. More details in here.

Come hang out in the Matrix channel. :)

One aspect that's close to my heart is I intent to make SHB the lightest layer on top of nixpkgs as possible. I want to upstream as much as possible. I will still take some time to experiment here but when I'm satisfied with how things look, I'll upstream changes.

License

I'm following the Nextcloud license which is AGPLv3. See this article from the FSF that explains what this license adds to the GPL one.