Commit 60851f970a7d2060e3822916d70053b05e2558ea
1 parent
8639b8c178
more doc
Showing 1 changed file with 6 additions and 0 deletions Inline Diff
docs/personal-configuration.md
| # Personal Configuration | 1 | 1 | # Personal Configuration | |
| 2 | 2 | |||
| One of the design choices of Boxen very early on was that we didn't want to | 3 | 3 | 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". | 4 | 4 | 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 | 5 | 5 | We do so as little as possible in the core, and we don't do it at all for | |
| per-user configurations. | 6 | 6 | per-user configurations. | |
| 7 | 7 | |||
| How? The personal manifest. | 8 | 8 | How? The personal manifest. | |
| 9 | 9 | |||
| Personal manifests live in `modules/people/manifests/<name>.pp`, | 10 | 10 | Personal manifests live in `modules/people/manifests/<name>.pp`, | |
| where `<name>` is your GitHub username. | 11 | 11 | where `<name>` is your GitHub username. | |
| A basic personal manifest might look like so: | 12 | 12 | A basic personal manifest might look like so: | |
| 13 | 13 | |||
| ``` puppet | 14 | 14 | ``` puppet | |
| class people::wfarr { | 15 | 15 | class people::wfarr { | |
| notify { 'hello world': } | 16 | 16 | notify { 'hello world': } | |
| } | 17 | 17 | } | |
| ``` | 18 | 18 | ``` | |
| 19 | 19 | |||
| Now, each time `wfarr` runs Boxen it'll automatically print out "hello world" | 20 | 20 | Now, each time `wfarr` runs Boxen it'll automatically print out "hello world" | |
| somewhere during the run. | 21 | 21 | somewhere during the run. | |
| You can even run `boxen-my-config` to generate a default template for you | 22 | 22 | You can even run `boxen-my-config` to generate a default template for you | |
| and open it up in your editor. | 23 | 23 | and open it up in your editor. | |
| When you're done, you can simply run `boxen` and it'll include your changes | 24 | 24 | When you're done, you can simply run `boxen` and it'll include your changes | |
| in your personal manifest. | 25 | 25 | in your personal manifest. | |
| **You should always keep your manifest committed and pushed to your repository**. | 26 | 26 | **You should always keep your manifest committed and pushed to your repository**. | |
| Otherwise, auto-updates won't work! | 27 | 27 | Otherwise, auto-updates won't work! | |
| 28 | 28 | |||
| 29 | The whole point of these personal manifest are they are _your_ manifest. |