cookbook 'codenamephp_gui', '~> 2.1.0'
The codenamephp_gui cookbook has been deprecated
Author provided reason for deprecation:
The codenamephp_gui cookbook has been deprecated and is no longer being maintained by its authors. Use of the codenamephp_gui cookbook is no longer recommended.
codenamephp_gui (6) Versions 2.1.0 Follow0
Cookbook to install linux guis like cinammon or gnome
cookbook 'codenamephp_gui', '~> 2.1.0', :supermarket
knife supermarket install codenamephp_gui
knife supermarket download codenamephp_gui
Chef Cookbook Gui
Cookbook to install linux guis like cinnamon, gnome, ...
The default cookbook is a No-Op. To install a gui, add the respective cookbook to your runlist.
Requirements
Supported Platforms
- Debian Stretch
Suported GUIs
- cinnamon
- xfce4
- gnome
Chef
- Chef 13.0+
Cookbook Depdendencies
- apt
Usage
Add the cookbook to your Berksfile:
cookbook 'codenamephp_gui'
Add the gui cookbook to your runlist, e.g. in a role:
{ "name": "default", "chef_type": "role", "json_class": "Chef::Role", "run_list": [ "recipe[codenamephp_gui::cinnamon]" ] }
Note that the default recipe is a No-Op, so you need to add the gui you want
Recipes
Each recipe just uses the respective resource without any arguments. They are meant to use as a shortcut in a runlist or via chef manage gui. If you need some
additional properties use the resources in a wrapper cookbook.
Resources
Cinnamon
The codenamephp_gui_cinnamon
resource installs or uninstalls the cinnamon gui.
Actions
-
:install
: Installs the gui using apt and starts and enables the lightdm display manager -
:uninstall
: Uninstalls the lightdm display manager
Properties
-
package_name
: The name of the apt package to use for install, defaults to 'cinnamon-core' -
lightdm
: Boolean to enable or disable the lightdm handling, defaults to true
Examples
# Minmal parameters codenamephp_gui_cinnamon 'install cinnamon gui' # Custom package name and disabled lightdm codenamephp_gui_cinnamon 'install cinnamon gui' do package_name 'cinnamon' lightdm false end # Uninstall codenamephp_gui_cinnamon 'install cinnamon gui' do action :uninstall end
XFCE4
The codenamephp_gui_xfce
resource installs or uninstalls the xfce4 gui.
Actions
-
:install
: Installs the gui using apt and starts and enables the lightdm display manager -
:uninstall
: Uninstalls the lightdm display manager
Properties
-
package_name
: The name of the apt package to use for install, defaults to 'xfce4-core' -
lightdm
: Boolean to enable or disable the lightdm handling, defaults to true
Examples
# Minmal parameters codenamephp_gui_xfce4 'install xfce4 gui' # Custom package name and disabled lightdm codenamephp_gui_xfce4 'install xfce4 gui' do package_name 'xfce4' lightdm false end # Uninstall codenamephp_gui_xfce4 'install xfce4 gui' do action :uninstall end
Gnome
The codenamephp_gui_xfce
resource installs or uninstalls the gnome gui.
Actions
-
:install
: Installs the gui using apt -
:uninstall
: Uninstalls the gui using apt
Properties
-
package_name
: The name of the apt package to use for install, defaults to 'gnome-core'
Examples
# Minmal parameters codenamephp_gui_gnome 'install gnome gui' # Custom package name codenamephp_gui_gnome 'install gnome gui' do package_name 'gnome' end # Uninstall codenamephp_gui_gnome 'install gnome gui' do action :uninstall end
Gnome Gsettings
Resource to set gsettings configurations. There are constants in CodenamePHP::Gui::Helper::Gnome::GSettings
that can be used for known schemas and keys
Actions
-
:set
: Sets the configuration
Properties
-
schema
: The schema the configuration is located in, e.g. 'org.gnome.desktop.session' -
key
: The key within the schema to be set, e.g. 'idle-delay' -
value
: The value to set, e.g. '0' -
users
: The users to set the settings for as array of usernames
Examples
# Minimal parameters codenamephp_gui_gnome_gsettings 'Set display idle delay' do schema CodenamePHP::Gui::Helper::Gnome::GSettings::SCHEMA_DESKTOP_SESSION key CodenamePHP::Gui::Helper::Gnome::GSettings::KEY_DESKTOP_SESSION_IDLE_DELAY value '0' users ['test'] end
Gnome Keyboard Shortcuts
The codenamephp_gui_gnome_keyboard_shortcuts
resource adds custom shortcuts for the gnome desktop. This is done by getting the custom shortcuts using gsettings
and then adding the new shortcut and adds back all shortcuts. If a shortcut with the same name already exists it is replaced by the new one
Actions
-
set
: Sets a new or replaces an existing shortcut
Properties
-
shortcut_name
: The name of the shortcut to set, defaults to the resource name -
command
: The command the shortcut should execute -
binding
: The keys the shortcut consists of, also see theCodenamePHP::Gui::Helper::Gnome::GSettings::Keys::*
constants -
users
: The users to set the shortcuts for as array of usernames
Examples
codenamephp_gui_gnome_keyboard_shortcut 'Terminal' do command 'gnome-terminal --maximize' binding "#{CodenamePHP::Gui::Helper::Gnome::GSettings::Keys::SUPER}#{CodenamePHP::Gui::Helper::Gnome::GSettings::Keys::ALT}t" users ['test'] end
Dependent cookbooks
This cookbook has no specified dependencies.
Contingent cookbooks
Collaborator Number Metric
2.1.0 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.0 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
Cookstyle Metric
2.1.0 failed this metric
Chef/Deprecations/ResourceWithoutUnifiedTrue: Set `unified_mode true` in Chef Infra Client 15.3+ custom resources to ensure they work correctly in Chef Infra Client 18 (April 2022) when Unified Mode becomes the default. (https://docs.chef.io/workstation/cookstyle/chef_deprecations_resourcewithoutunifiedtrue): codenamephp_gui/resources/cinnamon.rb: 1
Chef/Deprecations/ResourceWithoutUnifiedTrue: Set `unified_mode true` in Chef Infra Client 15.3+ custom resources to ensure they work correctly in Chef Infra Client 18 (April 2022) when Unified Mode becomes the default. (https://docs.chef.io/workstation/cookstyle/chef_deprecations_resourcewithoutunifiedtrue): codenamephp_gui/resources/gnome.rb: 1
Chef/Deprecations/ResourceWithoutUnifiedTrue: Set `unified_mode true` in Chef Infra Client 15.3+ custom resources to ensure they work correctly in Chef Infra Client 18 (April 2022) when Unified Mode becomes the default. (https://docs.chef.io/workstation/cookstyle/chef_deprecations_resourcewithoutunifiedtrue): codenamephp_gui/resources/gnome_gsettings.rb: 1
Chef/Deprecations/ResourceWithoutUnifiedTrue: Set `unified_mode true` in Chef Infra Client 15.3+ custom resources to ensure they work correctly in Chef Infra Client 18 (April 2022) when Unified Mode becomes the default. (https://docs.chef.io/workstation/cookstyle/chef_deprecations_resourcewithoutunifiedtrue): codenamephp_gui/resources/gnome_keyboard_shortcut.rb: 1
Chef/Deprecations/ResourceWithoutUnifiedTrue: Set `unified_mode true` in Chef Infra Client 15.3+ custom resources to ensure they work correctly in Chef Infra Client 18 (April 2022) when Unified Mode becomes the default. (https://docs.chef.io/workstation/cookstyle/chef_deprecations_resourcewithoutunifiedtrue): codenamephp_gui/resources/xfce4.rb: 1
Run with Cookstyle Version 7.32.1 with cops Chef/Deprecations,Chef/Correctness,Chef/Sharing,Chef/RedundantCode,Chef/Modernize,Chef/Security,InSpec/Deprecations
No Binaries Metric
2.1.0 passed this metric
Testing File Metric
2.1.0 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.0 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.0 failed this metric
2.1.0 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
Cookstyle Metric
2.1.0 failed this metric
Chef/Deprecations/ResourceWithoutUnifiedTrue: Set `unified_mode true` in Chef Infra Client 15.3+ custom resources to ensure they work correctly in Chef Infra Client 18 (April 2022) when Unified Mode becomes the default. (https://docs.chef.io/workstation/cookstyle/chef_deprecations_resourcewithoutunifiedtrue): codenamephp_gui/resources/cinnamon.rb: 1
Chef/Deprecations/ResourceWithoutUnifiedTrue: Set `unified_mode true` in Chef Infra Client 15.3+ custom resources to ensure they work correctly in Chef Infra Client 18 (April 2022) when Unified Mode becomes the default. (https://docs.chef.io/workstation/cookstyle/chef_deprecations_resourcewithoutunifiedtrue): codenamephp_gui/resources/gnome.rb: 1
Chef/Deprecations/ResourceWithoutUnifiedTrue: Set `unified_mode true` in Chef Infra Client 15.3+ custom resources to ensure they work correctly in Chef Infra Client 18 (April 2022) when Unified Mode becomes the default. (https://docs.chef.io/workstation/cookstyle/chef_deprecations_resourcewithoutunifiedtrue): codenamephp_gui/resources/gnome_gsettings.rb: 1
Chef/Deprecations/ResourceWithoutUnifiedTrue: Set `unified_mode true` in Chef Infra Client 15.3+ custom resources to ensure they work correctly in Chef Infra Client 18 (April 2022) when Unified Mode becomes the default. (https://docs.chef.io/workstation/cookstyle/chef_deprecations_resourcewithoutunifiedtrue): codenamephp_gui/resources/gnome_keyboard_shortcut.rb: 1
Chef/Deprecations/ResourceWithoutUnifiedTrue: Set `unified_mode true` in Chef Infra Client 15.3+ custom resources to ensure they work correctly in Chef Infra Client 18 (April 2022) when Unified Mode becomes the default. (https://docs.chef.io/workstation/cookstyle/chef_deprecations_resourcewithoutunifiedtrue): codenamephp_gui/resources/xfce4.rb: 1
Run with Cookstyle Version 7.32.1 with cops Chef/Deprecations,Chef/Correctness,Chef/Sharing,Chef/RedundantCode,Chef/Modernize,Chef/Security,InSpec/Deprecations
No Binaries Metric
2.1.0 passed this metric
Testing File Metric
2.1.0 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.0 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.0 failed this metric
Chef/Deprecations/ResourceWithoutUnifiedTrue: Set `unified_mode true` in Chef Infra Client 15.3+ custom resources to ensure they work correctly in Chef Infra Client 18 (April 2022) when Unified Mode becomes the default. (https://docs.chef.io/workstation/cookstyle/chef_deprecations_resourcewithoutunifiedtrue): codenamephp_gui/resources/gnome.rb: 1
Chef/Deprecations/ResourceWithoutUnifiedTrue: Set `unified_mode true` in Chef Infra Client 15.3+ custom resources to ensure they work correctly in Chef Infra Client 18 (April 2022) when Unified Mode becomes the default. (https://docs.chef.io/workstation/cookstyle/chef_deprecations_resourcewithoutunifiedtrue): codenamephp_gui/resources/gnome_gsettings.rb: 1
Chef/Deprecations/ResourceWithoutUnifiedTrue: Set `unified_mode true` in Chef Infra Client 15.3+ custom resources to ensure they work correctly in Chef Infra Client 18 (April 2022) when Unified Mode becomes the default. (https://docs.chef.io/workstation/cookstyle/chef_deprecations_resourcewithoutunifiedtrue): codenamephp_gui/resources/gnome_keyboard_shortcut.rb: 1
Chef/Deprecations/ResourceWithoutUnifiedTrue: Set `unified_mode true` in Chef Infra Client 15.3+ custom resources to ensure they work correctly in Chef Infra Client 18 (April 2022) when Unified Mode becomes the default. (https://docs.chef.io/workstation/cookstyle/chef_deprecations_resourcewithoutunifiedtrue): codenamephp_gui/resources/xfce4.rb: 1
Run with Cookstyle Version 7.32.1 with cops Chef/Deprecations,Chef/Correctness,Chef/Sharing,Chef/RedundantCode,Chef/Modernize,Chef/Security,InSpec/Deprecations
2.1.0 passed this metric
Testing File Metric
2.1.0 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.0 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.0 failed this metric
2.1.0 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