summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorMicah Anderson <micah@riseup.net>2010-12-07 13:39:54 -0500
committerMicah Anderson <micah@riseup.net>2010-12-07 13:39:54 -0500
commit7e1a187f243d64073f660ba8928896e7a1d81db3 (patch)
treedf7566c4eae988a0e867c6ba04c45e47154c9dbd /README
parente15283b781f35779a75415725cd315104879aa67 (diff)
README update: clarify the site-apt preferences options
The README described a few things that were not true relating to the apt/preferences file. First of all it said you could ship a 'file', but preferences.pp very clearly uses the 'content => $custom_preferences' parameter, which will not take file sources, only templates. Secondly, it seemed to imply that you could just drop the custom preferences into your site-apt and it would work. But you actually need to set the $custom_preferences to indicate the content source. Lastly, it said that you could specify a host-specific file in the site-apt module, but there is no facility for this (nor can you use files). Perhaps this is where this module is going eventually, once we have a preferences.d possibility? Until then, it makes more sense to have it reflect the current situation.
Diffstat (limited to 'README')
-rw-r--r--README12
1 files changed, 3 insertions, 9 deletions
diff --git a/README b/README
index 8118d3c..97a398b 100644
--- a/README
+++ b/README
@@ -75,15 +75,9 @@ installation will not accidentally pull in packages from those suites
unless you explicitly specify the version number. This file will be
complemented with all of the preferences_snippet calls (see below).
-If the default preferences template doesn't suit your needs, you can
-create a file named 'preferences' in a site-apt module's files
-directory. You can also create a host-specific file:
-
- site-apt
- - files/
- - server.domain.com/
- - preferences
- preferences
+If the default preferences template doesn't suit your needs, you can create a
+template located in your site-apt module, and set $custom_preferences with the
+location (eg. $custom_preferences = "puppet:///modules/site-apt/preferences")
Setting this variable to false before including this class will force the
apt/preferences file to be absent: