diff options
Diffstat (limited to 'doc/README.mdwn')
| -rw-r--r-- | doc/README.mdwn | 23 |
1 files changed, 8 insertions, 15 deletions
diff --git a/doc/README.mdwn b/doc/README.mdwn index a0742f78..29e5fbb7 100644 --- a/doc/README.mdwn +++ b/doc/README.mdwn @@ -35,7 +35,7 @@ see [configuration for the Haskell newbie](https://propellor.branchable.com/hask ## quick start -1. Get propellor installed +1. Get propellor installed on your laptop. `cabal install propellor` or `apt-get install propellor` @@ -44,25 +44,18 @@ see [configuration for the Haskell newbie](https://propellor.branchable.com/hask 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. Push the git repository to a central server (github or your own): - `cd ~/.propellor/; git remote add origin ssh://git.example.com/propellor.git; git push -u origin master` -6. Edit `~/.propellor/config.hs`, and add a host you want to manage. +5. 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` -8. Now you have a simple propellor deployment, but it doesn't do +6. Pick a host and run: `propellor --spin $HOST` +7. Now you have a simple propellor deployment, but it doesn't do much to the host yet, besides installing propellor. So, edit `~/.propellor/config.hs` to configure the host (maybe - start with a few simple properties), and re-run step 7. + start with a few simple properties), and re-run step 6. Repeat until happy and move on to the next host. :) -9. To move beyond manually running `propellor --spin` against hosts - when you change their properties, add a property to your hosts - like: `Cron.runPropellor "30 * * * *"` - - Now they'll automatically update every 30 minutes, and you can - `git commit -S` and `git push` changes that affect any number of - hosts. -10. Write some neat new properties and send patches! +8. Optionally, set up a [centralized git repository](https://propellor.branchable.com/centralized_git_repository/) + so multiple hosts can be updated with a simple `git commit -S; git push` +9. Write some neat new properties and send patches! ## debugging |