generated from meterriblecrew/flake-template
tinydns: Update README
parent
0b1f1bf777
commit
68715163ab
32
README.org
32
README.org
|
@ -1,21 +1,29 @@
|
||||||
#+TITLE: NixOS Modules
|
#+TITLE: NixOS Modules
|
||||||
#+AUTHOR: spacefrogg
|
#+AUTHOR: spacefrogg
|
||||||
#+EMAIL: git@spacefrogg.net
|
#+EMAIL: git@spacefrogg.net
|
||||||
#+options: toc:nil
|
#+startup: showall
|
||||||
|
|
||||||
* Modules
|
* Modules
|
||||||
** tinydns
|
** tinydns
|
||||||
|
A replacement for the upstream tinydns module. This module extends the service
|
||||||
|
in an incompatible way. You instantiate a service by adding an attribute
|
||||||
|
=<ipv4-address>= under =services.tinydns=. This flake comes with an extended
|
||||||
|
=lib= attribute, which you must use in your nixos configuration (e.g. in the
|
||||||
|
call to =nixpkgs#lib.nixosSystem=) to have special functions under =lib.tinydns=
|
||||||
|
available that create tinydns records from functions and arguments. See the
|
||||||
|
module documentation for currently available functions.
|
||||||
|
|
||||||
|
|
||||||
* Development
|
* Development
|
||||||
This comes with a self-contained redo toolchain to help in working with the
|
This comes with a self-contained redo toolchain to help in working with the
|
||||||
flake. It basically deploys any input flake into the =tmp= directory for easier
|
flake. It basically deploys any input flake into the =tmp= directory for easier
|
||||||
access.
|
access.
|
||||||
|
|
||||||
redo targets under =tmp/= come in three kinds:
|
redo targets under =tmp/= come in three kinds:
|
||||||
- =clean= :: will remove all build products under =tmp/=
|
- =clean= :: will remove all build products under =tmp/=
|
||||||
- =<flake>= :: will make sure a store path to =<flake>= exists and puts an
|
- =<flake>= :: will make sure a store path to =<flake>= exists and puts an
|
||||||
indirect root into =tmp/<flake>=.
|
indirect root into =tmp/<flake>=.
|
||||||
- =<flake>.rw= :: will make sure a store path to =<flake>= exists and will
|
- =<flake>.rw= :: will make sure a store path to =<flake>= exists and will copy
|
||||||
copy its contents to =tmp/.<flake>.rw= and will link to it from
|
its contents to =tmp/.<flake>.rw= and will link to it from
|
||||||
=tmp/<flake>.rw=. (Rationale: On Linux, directories cannot denote reliable
|
=tmp/<flake>.rw=. (Rationale: On Linux, directories cannot denote reliable
|
||||||
targets due to their non-trivial relation to modification time.)
|
targets due to their non-trivial relation to modification time.)
|
||||||
|
|
Loading…
Reference in New Issue