abonerib/nix-serve-ng
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

readme: introduce recommended service.nix-serve.package variant (#38)

Browse Source 
It is much more idiomatic to use services.nix-serve.package instead of
an overlay. Also this way, one doesn't has to consume the repository directly.
This commit is contained in:
Philipp Schuster 2024-10-01 15:38:04 +02:00 committed by GitHub
parent d5df363246
commit 578ad85b30
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 66 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

92
README.md
View File

@ -4,41 +4,78 @@
## Quick start ## Quick start
There are two main approaches you can use to upgrade a NixOS system to replace There are three main approaches you can use to configure a NixOS system to replace
the old `nix-serve` with `nix-serve-ng`. the old `nix-serve` with `nix-serve-ng`:
If you specify your desired NixOS system within `flake.nix` then you can do - **A**: Set `services.nix-serve.package = pkgs.nix-serve-ng;` in your NixOS configuration
something like this: - `nix-serve-ng` is [packaged in nixpkgs](https://search.nixos.org/packages) already
- There is no need to consume this repository directly
- **B**: Include `nix-serve-ng.nixosModules.default` in your NixOS configuration
- `nix-serve-ng` refers to this repository being a flake input
- Requires consume this repository / this flake
- Overlays `pkgs.nix-serve` with `pkgs.nix-serve-ng`
- **C**: Like **B** but not requiring a flake
We recommend approach **A**. Only use **B** or **C** if you need a bleeding edge
upstream version of the project.
### Variant A:
_The code snippet below shows a `flake.nix`._
```nix ```nix
{ inputs = { {
nixpkgs.url = github:NixOS/nixpkgs; inputs.nixpkgs.url = "github:NixOS/nixpkgs";
nix-serve-ng.url = github:aristanetworks/nix-serve-ng; outputs = { nixpkgs, ... }: {
};
outputs = { nixpkgs, nix-serve-ng, ... }: {
nixosConfigurations.default = nixpkgs.lib.nixosSystem { nixosConfigurations.default = nixpkgs.lib.nixosSystem {
modules = [ modules = [
nix-serve-ng.nixosModules.default /* ... */
{
{ services.nix-serve.enable = true; services.nix-serve.enable = true;
services.nix-serve.package = pkgs.nix-serve-ng;
… /* ... */
} }
/* ... */
]; ];
system = "x86_64-linux";
}; };
}; };
} }
``` ```
If you don't use `flake.nix` then you can instead define your NixOS module: ### Variant B:
like this:
_The code snippet below shows a `flake.nix`._
```nix ```nix
let {
inputs.nixpkgs.url = "github:NixOS/nixpkgs";
inputs.nix-serve-ng.url = "aristanetworks/nix-serve-ng";
outputs = { nixpkgs, nix-serve-ng, ... }: {
nixosConfigurations.default = nixpkgs.lib.nixosSystem {
modules = [
nix-serve-ng.nixosModules.default
/* ... */
{
services.nix-serve.enable = true;
/* ... */
}
/* ... */
];
};
};
}
```
### Variant C:
_The code snippet below shows a NixOS module file._
```nix
{ config, pkgs, lib, ... }:
let
nix-serve-ng-src = builtins.fetchTarball { nix-serve-ng-src = builtins.fetchTarball {
# Replace the URL and hash with whatever you actually need # Replace the URL and hash with whatever you actually need
url = "https://github.com/aristanetworks/nix-serve-ng/archive/1937593598bb1285b41804f25cd6f9ddd4d5f1cb.tar.gz"; url = "https://github.com/aristanetworks/nix-serve-ng/archive/1937593598bb1285b41804f25cd6f9ddd4d5f1cb.tar.gz";
@ -47,13 +84,16 @@ let
}; };
nix-serve-ng = import nix-serve-ng-src; nix-serve-ng = import nix-serve-ng-src;
in in
{ ... }: { {
imports = [ nix-serve-ng.nixosModules.default ]; /* ... */
imports = [ nix-serve-ng.nixosModules.default ];
…
} config = {
services.nix-serve.enable = true;
};
/* ... */
}
``` ```
## Motivation ## Motivation