2023-02-07 20:30:25 +03:00
# SrvOS - NixOS for your server
2022-12-01 19:32:37 +03:00
STATUS: **experimental**
2023-02-07 20:30:25 +03:00
SrvOS is a collection of opinionated and sharable NixOS configurations.
2022-12-01 19:32:37 +03:00
As we learn more about NixOS in various deployments, we end up re-writing the same modules and configs. This is a way for us to speed up and share our setups.
2023-02-07 20:30:25 +03:00
Instead of supporting everything, our goal is to target certain verticals and make the support super smooth there.
2023-02-13 19:17:55 +03:00
## Quick Usage
2022-12-19 17:00:06 +03:00
2023-02-13 19:17:55 +03:00
Add `srvos` to your `flake.nix` to augment your NixOS configuration. For
2023-01-17 01:53:50 +03:00
example to deploy a GitHub Action runner on Hetzner:
2022-12-19 17:00:06 +03:00
```nix
{
inputs = {
srvos.url = "github:numtide/srvos";
};
outputs = { srvos, nixpkgs, ... }: {
nixosConfigurations.myHost = nixpkgs.lib.nixosSystem {
system = "x86_64-linux";
modules = [
srvos.nixosModules.common
2023-01-17 01:53:50 +03:00
srvos.nixosModules.hardware-hetzner-amd
srvos.nixosModules.roles-github-actions-runner
2022-12-19 17:00:06 +03:00
];
2022-12-19 18:13:10 +03:00
};
2022-12-19 17:00:06 +03:00
};
}
```
2023-02-15 12:35:52 +03:00
## Documentation
2022-12-31 18:26:51 +03:00
2023-02-15 12:35:52 +03:00
The [Documentation ](https://numtide.github.io/srvos/ ) website shows more general usage, how to install SrvOS, etc...
2023-01-02 11:22:32 +03:00
2023-02-15 12:35:52 +03:00
To improve the documentation, take a look at the `./docs` folder. You can also run `nix run .#docs.serve` to start a preview server on < http: // localhost:3000 > .
## Contributing
Contributions are always welcome.
2023-01-17 01:53:50 +03:00
## License
[MIT ](LICENSE )
***
This is a [Numtide ](https://numtide.com ) project.
< img src = "https://numtide.com/logo.png" alt = "NumTide Logo" width = "80" >