summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJoey Hess2014-11-23 14:41:09 -0400
committerJoey Hess2014-11-23 14:41:09 -0400
commitac41f8b07b45b1855b1c10665757691a56b08353 (patch)
treed446f81a4068ca594abd881c2b055ad2f8662a12 /doc
parent1b34f23414b574105ddfdf36fbeb86aa115a0e2e (diff)
parent3c952a0de9d228eafe6e208007be7d2e018d68b8 (diff)
Merge branch 'joeyconfig'
Diffstat (limited to 'doc')
-rw-r--r--doc/usage.mdwn22
1 files changed, 18 insertions, 4 deletions
diff --git a/doc/usage.mdwn b/doc/usage.mdwn
index 42797049..6646ab14 100644
--- a/doc/usage.mdwn
+++ b/doc/usage.mdwn
@@ -20,11 +20,18 @@ action as needed to satisfy the configured properties of the local host.
# OPTIONS
-* --spin hostname
+* --spin targethost [--via relayhost]
- Causes propellor to automatically install itself on the specified host,
- or if it's already installed there, push any updates. Propellor is then
- run on the host, to satisfy its configured properties.
+ Causes propellor to automatically install itself on the specified target
+ host, or if it's already installed there, push any updates. Propellor is
+ then run on the target host, to satisfy its configured properties.
+
+ When run with --via, propellor sshes to the relay host and runs
+ `propellor --spin hostname` from there. This can be useful when
+ propellor is installing itself, since most of the data transfer
+ is done between relay host and target host. Note that propellor
+ uses ssh agent forwarding to make this work, and the relay host
+ sees any privdata belonging to the target host.
* --add-key keyid
@@ -52,6 +59,13 @@ action as needed to satisfy the configured properties of the local host.
Opens $EDITOR on the privdata value.
+* hostname
+
+ When run with a hostname and no other options, propellor will
+ provision the local host with the configuration of that hostname.
+ This is useful when the local host doesn't yet have its hostname set
+ correctly.
+
# ENVIRONMENT
Set `PROPELLOR_DEBUG=1` to make propellor output each command it runs and