nixcloud-webservices

This nixpkgs extension, called nixcloud-webservices, focuses on ease of deployment of web-related technologies.

You should continue to read one of these documentations:

• nixcloud.webservices
• nixcloud.reverse-proxy
• nixcloud.email
• nixcloud.TLS
• nixcloud.container

It features the development stack we use at https://nixcloud.io.

Continuous integration at https://hydra.nixcloud.io/project/nixcloud-webservices

Using nixcloud-webservices

Depending on which NixOS version you're on you can get different channels of nixcloud-webservices which are tested against different NixOS releases:

For NixOS 18.03

# nix-channel --add https://hydra.nixcloud.io/channel/custom/nixcloud-webservices/release-18.03/nixcloud-webservices
# nix-channel --update

For NixOS Unstable

# nix-channel --add https://hydra.nixcloud.io/channel/custom/nixcloud-webservices/nixos-unstable/nixcloud-webservices
# nix-channel --update

Adding nixcloud-webservices to your configuration.nix

Simply append <nixcloud-webservices> to your imports list and you're ready to go, for example:

{
  imports = [
    ./hardware-configuration.nix
    <nixcloud-webservices>
  ];
  # ... other options ...
}

You can find nixcloud-webservices specific options in the latest manual.

Get the source

Alternatively if you want to hack on nixcloud-webservices, you can also Git clone it with:

$ git clone https://github.com/nixcloud/nixcloud-webservices

Importing

Option A: Importing modules in your local system

You import modules into your local system by adding the path to your configuration.nix to the imports list. Like this:

{
  imports = [
    ./hardware-configuration.nix
    /path/to/nixcloud-webservices
  ];
  # ... other options ...
}

Option B: Building a (KVM) VM

If you don't want to clutter your local system you can use a VM:

nix-build '<nixpkgs/nixos>' --arg configuration '{ imports = [ ./modules ./config.nix ]; services.mingetty.autologinUser = "root"; }' -A vm

Note: You have to create config.nix manually, it contains basically the lines we put in /etc/nixos/configuration.nix in previous examples.

Note: This is for advanced users who know how VMs on NixOS work.

License

The license can be found in LICENSE.

For inquiries, please contact:

• Joachim Schiele [email protected]
• Paul Seitz [email protected]

Thanks

Many thanks to:

• https://www.internetsociety.org/ (Sponsor)
• ISOC.nl (Sponsor)
• Internet hardening fund (Sponsor)
• profpatsch (Early prototyping)
• aszlig (NixOS module system)
• uwap (Email abstraction)
• clever (Helping with hydra.nixcloud.io)
• brauner (Help with LXC)
• leenaars (Requirements, testing, review)
• seitz
• qknight

Among all who didn't make it into this list! Thanks for helping with writing this!