my-boxen/docs/personal-configuration.md
Will Farrington 8639b8c178 get doc-wild
2013-02-06 21:24:28 -08:00

29 lines
1 KiB
Markdown

# Personal Configuration
One of the design choices of Boxen very early on was that we didn't want to
dictate down to users "you can do this, but you can't do that".
We do so as little as possible in the core, and we don't do it at all for
per-user configurations.
How? The personal manifest.
Personal manifests live in `modules/people/manifests/<name>.pp`,
where `<name>` is your GitHub username.
A basic personal manifest might look like so:
``` puppet
class people::wfarr {
notify { 'hello world': }
}
```
Now, each time `wfarr` runs Boxen it'll automatically print out "hello world"
somewhere during the run.
You can even run `boxen-my-config` to generate a default template for you
and open it up in your editor.
When you're done, you can simply run `boxen` and it'll include your changes
in your personal manifest.
**You should always keep your manifest committed and pushed to your repository**.
Otherwise, auto-updates won't work!
You can check out the [projects README](../modules/projects/README.md) for further examples.