summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJoey Hess2014-05-14 19:47:17 -0400
committerJoey Hess2014-05-14 19:47:17 -0400
commit39217c55690de5641a9fe4ef2236d6127ebbcbb3 (patch)
tree31284fd462e2d02cf9bf0b8077c0e8dd34181988 /doc
parenteb6e6fe11290971b37a18d9a78f6d9b78228c06f (diff)
parent7115d1ec162b4059b3e8e8f84bd8d5898c1db025 (diff)
Merge branch 'joeyconfig'
Diffstat (limited to 'doc')
-rw-r--r--doc/README.mdwn10
-rw-r--r--doc/todo/docker_todo_list.mdwn5
2 files changed, 6 insertions, 9 deletions
diff --git a/doc/README.mdwn b/doc/README.mdwn
index d809a760..71b265f5 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](http://propellor.branchable.com/security/) way.
+[secure](http://propellor.branchable.com/security/) 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](https://propellor.branchable.com/hask
`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`
diff --git a/doc/todo/docker_todo_list.mdwn b/doc/todo/docker_todo_list.mdwn
index 9cb9e4da..65762cff 100644
--- a/doc/todo/docker_todo_list.mdwn
+++ b/doc/todo/docker_todo_list.mdwn
@@ -6,8 +6,3 @@
need ntp installed for a good date source.
* Docking a container in a host should add to the host any cnames that
are assigned to the container.
-* It seems that provisionContainer sometimes hangs when the container
- is already running. This seems likely to be a problem with the simpleSh
- socket hack. (I think this was an uncaught exception crashing the
- simpleSh server thread, and if so, it's fixed. Waiting some weeks to see,
- as this bug rarely occurred..)