cookbook 'plexconnect', '~> 2.1.4'
plexconnect (3) Versions 2.1.4 Follow0
Installs PlexConnect.
cookbook 'plexconnect', '~> 2.1.4', :supermarket
knife supermarket install plexconnect
knife supermarket download plexconnect
plexconnect Cookbook
Installs plexconnect and its required dependencies.
Requirements
python
Python is required. It is set up as a dependency of this cookbook so it will be handled automatically.
git
The code is being synced from github. Git is required for checking out the code.
Attributes
plexconnect::default
<table>
<tr>
<th>Key</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr>
<td><tt>['plexconnect']['user']</tt></td>
<td>String</td>
<td>User which plexconnect will be ran as</td>
<td>plexconnect</td>
</tr>
<tr>
<td><tt>['plexconnect']['group']</tt></td>
<td>String</td>
<td>Group which owns the plexconnect installation</td>
<td>plexconnect</td>
</tr>
<tr>
<td><tt>['plexconnect']['install_dir']</tt></td>
<td>String</td>
<td>Directory where plexconnect will be installed</td>
<td>/srv/apps/plexconnect</td>
</tr>
<tr>
<td><tt>['plexconnect']['log_dir']</tt></td>
<td>String</td>
<td>Log directory</td>
<td>/var/log/plexconnect</td>
</tr>
<tr>
<td><tt>['plexconnect']['git_url']</tt></td>
<td>String</td>
<td>Git repository which will be checked out</td>
<td>https://github.com/RuudBurger/CouchPotatoServer.git</td>
</tr>
<tr>
<td><tt>['plexconnect']['git_ref']</tt></td>
<td>String</td>
<td>Git branch or tag which will be checked out</td>
<td>v0.5</td>
</tr>
<tr>
<td><tt>['plexconnect']['certificate']</tt></td>
<td>String</td>
<td>SSL certificate</td>
<td>''</td>
</tr>
<tr>
<td><tt>['plexconnect']['key']</tt></td>
<td>String</td>
<td>Private key for the SSL certificate</td>
<td>''</td>
</tr>
<tr>
<td><tt>['plexconnect']['settings']</tt></td>
<td>Hash</td>
<td>Configuration options. Feel free to create a pull request for more custom options.</td>
<td>
<ul>
<li><tt>certfile</tt></li>
<li><tt>ip_pms</tt></li>
<li><tt>logpath</tt></li>
<li><tt>hosttointercept</tt></li>
<li><tt>port_dnsserver</tt></li>
<li><tt>port_pms</tt></li>
<li><tt>port_ssl</tt></li>
<li><tt>port_webserver</tt></li>
</ul>
</td>
</tr>
<tr>
<td><tt>['plexconnect']['atv_settings']</tt></td>
<td>Hash</td>
<td>Configuration options for PlexConnect on the Apple TV. Feel free to create a pull request for more custom options.</td>
<td>
<ul>
<li><tt>apple_tv_id</tt></li>
<li><tt>myplex_user</tt></li>
<li><tt>myplex_auth</tt></li>
<li><tt>subtitlesize</tt></li>
<li><tt>subtitlerenderer</tt></li>
<li><tt>transcodequality</tt></li>
</ul>
</td>
</tr>
</table>
plexconnect::fanart
<table>
<tr>
<th>Key</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr>
<td><tt>['plexconnect']['fanart']['packages']</tt></td>
<td>Array</td>
<td>all required packages to build Pillow</td>
<td><tt>/usr/local/bin/plexconnect</tt></td>
</tr>
</table>
Usage
plexconnect::default
It installs plexconnect by checking it out from source.
plexconnect::init
It sets up an init script and configures rc.d to make plexconnect automatically launch on boot.
plexconnect::fanart
It installs Pillow using the python pip provider. This is required for fanart to show up in PlexConnect.
Contributing
- Fork the repository on Github
- Create a named feature branch (like
add_component_x
) - Write your change
- Write tests for your change (if applicable)
- Run the tests, ensuring they all pass
- Submit a Pull Request using Github
Dependent cookbooks
git >= 0.0.0 |
iptables >= 0.0.0 |
python >= 0.0.0 |
Contingent cookbooks
There are no cookbooks that are contingent upon this one.
plexconnect cookbook CHANGELOG
This file is used to list changes made in each version of the plexconnect cookbook.
2.1.4
- Adds the iptables cookbook to the dependencies
2.1.3
- Allows DNS server to be disabled
- Makes plexmediaserver requirement optional in init file
2.1.2
- Moves user and group to default attributes
2.1.1
- Fixes not_if condition for rc.d block in init recipe
2.1.0
- Updates ATVSettings and installation version to v0.5
- Adds fanart recipe which installs Pillow
2.0.0
- Separates system and Apple TV settings
- Adds some more options to atv_settings
1.0.0
- Initial release of the plexconnect cookbook
Collaborator Number Metric
2.1.4 failed this metric
Failure: Cookbook has 0 collaborators. A cookbook must have at least 2 collaborators to pass this metric.
Contributing File Metric
2.1.4 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file
Foodcritic Metric
2.1.4 failed this metric
FC064: Ensure issues_url is set in metadata: plexconnect/metadata.rb:1
FC065: Ensure source_url is set in metadata: plexconnect/metadata.rb:1
FC066: Ensure chef_version is set in metadata: plexconnect/metadata.rb:1
Run with Foodcritic Version 16.3.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any
No Binaries Metric
2.1.4 passed this metric
Testing File Metric
2.1.4 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
2.1.4 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
2.1.4 failed this metric
2.1.4 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file
Foodcritic Metric
2.1.4 failed this metric
FC064: Ensure issues_url is set in metadata: plexconnect/metadata.rb:1
FC065: Ensure source_url is set in metadata: plexconnect/metadata.rb:1
FC066: Ensure chef_version is set in metadata: plexconnect/metadata.rb:1
Run with Foodcritic Version 16.3.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any
No Binaries Metric
2.1.4 passed this metric
Testing File Metric
2.1.4 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
2.1.4 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
2.1.4 failed this metric
FC065: Ensure source_url is set in metadata: plexconnect/metadata.rb:1
FC066: Ensure chef_version is set in metadata: plexconnect/metadata.rb:1
Run with Foodcritic Version 16.3.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any
2.1.4 passed this metric
Testing File Metric
2.1.4 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
2.1.4 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
2.1.4 failed this metric
2.1.4 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number