path: root/doc/README.mdwn
diff options
authorJoey Hess2014-05-11 13:32:37 -0300
committerJoey Hess2014-05-11 13:32:37 -0300
commitffce1f80ae3c492fe768666a00df396448ad6368 (patch)
tree606bd38c0f1f80c621d0f23c6ad72d659a986095 /doc/README.mdwn
parent2146c8b594b93489656def353ab01a5affd8c932 (diff)
improved initial setup
Configure git to use the gpg key in --add-key, otherwise commit -S will look for a key matching the configured email and if it doesn't find one, will fail.
Diffstat (limited to 'doc/README.mdwn')
1 files changed, 6 insertions, 4 deletions
diff --git a/doc/README.mdwn b/doc/README.mdwn
index 3e6d3650..51b1e4dc 100644
--- a/doc/README.mdwn
+++ b/doc/README.mdwn
@@ -6,7 +6,8 @@ are satisfied.
Propellor is configured via a git repository, which typically lives
in `~/.propellor/` on your development machine. Propellor clones the
repository to each host it manages, in a
-[secure]( way.
+[secure]( way. The git repository
+contains the full source code to Propellor, along with its config file.
Properties are defined using Haskell. Edit `~/.propellor/config.hs`
to get started. There is fairly complete
@@ -40,11 +41,12 @@ see [configuration for the Haskell newbie](
`apt-get install propellor`
2. Run propellor for the first time. It will set up a `~/.propellor/` git
repository for you.
-3. `cd ~/.propellor/`; use git to push the repository to a central
+3. If you don't have a gpg private key already, generate one: `gpg --gen-key`
+4. Run: `propellor --add-key $KEYID`, which will make propellor trust
+ your gpg key, and will sign your `~/.propellor` repository using it.
+5. `cd ~/.propellor/`; use git to push the repository to a central
server (github, or your own git server). Configure that central
server as the origin remote of the repository.
-4. If you don't have a gpg private key, generate one: `gpg --gen-key`
-5. Run: `propellor --add-key $KEYID`
6. Edit `~/.propellor/config.hs`, and add a host you want to manage.
You can start by not adding any properties, or only a few.
7. Pick a host and run: `propellor --spin $HOST`