cookbook 'cups', '= 0.8.0'
cups (11) Versions 0.8.0 Follow2
Installs/Configures cups
cookbook 'cups', '= 0.8.0', :supermarket
knife supermarket install cups
knife supermarket download cups
cups Cookbook
Installs the cups package, if needed, starts the cups service, and configures printers on target systems.
Attributes
cups::default
<table>
<tr>
<th>Key</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr>
<td><tt>['cups']['printers']</tt></td>
<td>array</td>
<td>List of printers to configure on the system. See example in the usage section below.</td>
<td><tt>[]</tt></td>
</tr>
<tr>
<td><tt>['cups']['systemgroups']</tt></td>
<td>string</td>
<td>Defines authorized system-group users in /etc/cups/cupsd.conf file.</td>
<td><tt>sys root</tt></td>
</tr>
<tr>
<td><tt>['cups']['share_printers']</tt></td>
<td>boolean</td>
<td>Should cups share printers?</td>
<td><tt>true</tt></td>
</tr>
<tr>
<td><tt>['cups']['require_encryption']</tt></td>
<td>boolean</td>
<td>Should cups require SSL/TLS for client communication? This requires both <tt>['cups']['cert_file']</tt> and <tt>['cups']['key_file']</tt> to be set.</td>
<td><tt>false</tt></td>
</tr>
<tr>
<td><tt>['cups']['cert_file']</tt></td>
<td>string</td>
<td>The full path to the SSL certificate file to be used by cups. Note: if an intermediate certificate is required by the issuing certificate authority, the intermediate certificate must be appended to the server certificate file as cups does not support separate intermediate and certificate files.</td>
<td><tt>nil</tt></td>
</tr>
<tr>
<td><tt>['cups']['key_file']</tt></td>
<td>string</td>
<td>The full path to the SSL key file to be used by cups.</td>
<td><tt>nil</tt></td>
</tr>
<tr>
<td><tt>['cups']['server_aliases']</tt></td>
<td>array</td>
<td>List of allowed domains for remote administration</td>
<td><tt>[]</tt></td>
</tr>
</table>
cups::airprint
<table>
<tr>
<th>Key</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr>
<td><tt>['cups']['airprint_generate']['git_url']</tt></td>
<td>string</td>
<td>URL to the airprint file generator repo.</td>
<td><tt>https://github.com/tjfontaine/airprint-generate.git</tt></td>
</tr>
<tr>
<td><tt>['cups']['airprint_generate']['git_revision']</tt></td>
<td>string</td>
<td>Git repo tag/version to pull.</td>
<td><tt>master</tt></td>
</tr>
</table>
cups::default_printer
<table>
<tr>
<th>Key</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr>
<td><tt>['cups']['default_printer']</tt></td>
<td>string</td>
<td>Sets the system-wide default printer.</td>
<td><tt>nil</tt></td>
</tr>
</table>
Usage
cups::default
Include cups
in your node's run_list
:
{ "name":"my_node", "run_list": [ "recipe[cups]" ] }
SAMPLE format for printer entries:
json
"cups": {
"printers": [
{
"printer1": {
"uri": "lpd://FQDN",
"desc": "HP LaserJet xx",
"model": "textonly.ppd", #textonly.ppd is set as the default by the recipe.
"location": "Front Office"
}
},
{
"printer2": {
"uri": "lpd://xxx.xxx.xxx.xxx"
}
},
{
"printer3": {
"uri": "lpd://myprinter.mydomain"
}
}
]
}
Data bags
Set the attribute node['cups']['printer_bag']
to the name of your data bag.
Data bag entries use this format:
{
"id": "printer1",
"model": "textonly.ppd",
"uri": "lpd://FQDN",
"location": "Front Office",
"desc": "HP LaserJet xx"
}
cups::airprint
Configures CUPS to advertise printers via AirPrint.
cups::default_printer
Sets the system-wide default printer (via the node['cups']['default_printer']
attribute).
CAUTION -- in its current form, this will completely overwrite the /etc/cups/lpoptions file.
Contributing
- Fork the repository on Github
- Create a named feature branch (like
add_component_x
) - Write you change
- Write tests for your change (if applicable)
- Run the tests, ensuring they all pass
- Submit a Pull Request using Github
License and Authors
Copyright 2015, Biola University
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Dependent cookbooks
git ~> 4.0 |
Contingent cookbooks
There are no cookbooks that are contingent upon this one.
cups CHANGELOG
This file is used to list changes made in each version of the cups cookbook.
0.8.0
- Allow setting the ServerAlias directive (#9)
0.7.0
- Add SSL support to CUPS (#13)
0.6.0
- Support specifying printer config via data_bags
0.5.0
- Debian Jesse/systemd support
- Dropped
reload
service action on all platforms in favor ofrestart
- Dropped
0.4.0
- Airprint support
0.2.1
- Initial commit of new repo
Foodcritic Metric
0.8.0 failed this metric
FC022: Resource condition within loop may not behave as expected: /tmp/cook/c815c57020a2482934fcc4d3/cups/recipes/default.rb:92
0.8.0 failed this metric