From 53dfb30af324408c34fc7f664a05992e186ca4e9 Mon Sep 17 00:00:00 2001
From: tv <tv@krebsco.de>
Date: Fri, 29 Nov 2019 13:41:39 +0100
Subject: README: talk about the target attribute

---
 README.md | 33 ++++++++++++++++++++++++++++++++-
 1 file changed, 32 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 889da7b..1191a2f 100644
--- a/README.md
+++ b/README.md
@@ -15,7 +15,7 @@ krops is a lightweigt toolkit to deploy NixOS systems, remotely or locally.
 
 Create a file named `krops.nix` (name doesn't matter) with following content:
 
-```
+```nix
 let
   krops = (import <nixpkgs> {}).fetchgit {
     url = https://cgit.krebsco.de/krops/;
@@ -56,6 +56,37 @@ and run `$(nix-build --no-out-link krops.nix)` to deploy the target machine.
 Under the hood, this will make the sources available on the target machine
 below `/var/src`, and execute `nixos-rebuild switch -I /var/src`.
 
+## Deployment Target Attribute
+
+The `target` attribute to `writeDeploy` can either be a string or an attribute
+set, specifying where to make the sources available, as well as where to run
+the deployment.
+
+If specified as string, the format could be described as:
+```
+[[USER]@]HOST[:PORT][/SOME/PATH]
+```
+
+Portions in square brakets are optional.
+
+If the `USER` is the empty string, as in e.g. `@somehost`, then the username
+will be obtained by SSH from its configuration files.
+
+If the `target` attribute is an attribute set, then it has to define the attributes
+`host`, `path`, `port`, `sudo`, and `user`.  This allows to deploy to targets
+that don't allow sshing in as root, but allow (preferably passwordless) sudo:
+
+```nix
+pkgs.krops.writeDeploy "deploy" {
+  source = /* ... */;
+  target = lib.mkTarget "user@host/path" // {
+    sudo = true;
+  };
+}
+```
+
+For more details about the `target` attribute, please check the `mkTarget`
+function in lib/default.nix.
 
 ## Source Types
 
-- 
cgit v1.2.3