cadey
/
propellor
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

wording

This commit is contained in:
Joey Hess 2014-11-18 21:26:26 -04:00
parent e273946c22
commit b00d027a08
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/README.mdwn
View File

@ -35,25 +35,25 @@ see [configuration for the Haskell newbie](https://propellor.branchable.com/hask
## quick start ## quick start
1. Get propellor installed on your laptop. 1. Get propellor installed on your development machine (ie, laptop).
`cabal install propellor` `cabal install propellor`
or or
`apt-get install propellor` `apt-get install propellor`
2. Run propellor for the first time. It will set up a `~/.propellor/` git 2. Run `propellor` for the first time. It will set up a `~/.propellor/` git
repository for you. repository for you.
3. If you don't have a gpg private key already, generate one: `gpg --gen-key` 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 4. Run: `propellor --add-key $KEYID`, which will make propellor trust
your gpg key, and will sign your `~/.propellor` repository using it. your gpg key, and will sign your `~/.propellor` repository using it.
5. 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. You can start by not adding any properties, or only a few.
6. Pick a host and run: `propellor --spin $HOST` 6. Run: `propellor --spin $HOST`
7. Now you have a simple propellor deployment, but it doesn't do 7. Now you have a simple propellor deployment, but it doesn't do
much to the host yet, besides installing propellor. much to the host yet, besides installing propellor.
So, edit `~/.propellor/config.hs` to configure the host (maybe So, edit `~/.propellor/config.hs` to configure the host, add some
start with a few simple properties), and re-run step 6. properties to it, and re-run step 6.
Repeat until happy and move on to the next host. :) Repeat until happy and move on to the next host. :)
8. Optionally, set up a [centralized git repository](https://propellor.branchable.com/centralized_git_repository/) 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` so that multiple hosts can be updated with a simple `git commit -S; git push`
9. Write some neat new properties and send patches! 9. Write some neat new properties and send patches!
## debugging ## debugging