Ansible Role: customize-gnome

Build status for this role:

This role customizes the GNOME desktop. It installs fonts and GNOME extensions from packages or zip files, copies files like desktop backgrounds and GNOME shell tweaks to a host, and modifies user settings. Settings can be supplied in dconf or GSettings format.

Requirements

The community.general collection, as specified in requirements.yml. Install the requirements using

ansible-galaxy install -r requirements.yml

Furthermore, the community.general.dconf module requires the Python psutil module. This module will be installed automatically.

Role Variables

All variables specific for this role start with gnome_. Available variables are listed below:

gnome_user: The user whose settings will be modified. Example:

gnome_user: root

If no gnome_user is specified, it will use the ansible_user_id variable (the user under which Ansible connects to the node).

gnome_packages: A list of packages that will be installed. Example:

gnome_packages:
  - fonts-roboto

gnome_fonts: A list of fonts that will be downloaded from a remote source, unzipped and installed into the local fonts directory. Each list item consists of an url, name, and (glob) list of fonts in that zip file to install (fonts). Example:

gnome_fonts:
  - url: https://github.com/adobe-fonts/source-code-pro/archive/2.030R-ro/1.050R-it.zip
    name: SourceCodePro
    fonts: "source-code-pro-2.030R-ro-1.050R-it/OTF/*.otf"

gnome_files: A list of files, specifying the source (src) and destination (dest) that will be copied from the host to the guest. Example:

gnome_files:
  - src: gtk.css
    dest: /home/{{ gnome_user }}/.config/gtk-3.0/gtk.css

gnome_extensions: A list of GNOME shell extensions that will be installed (downloaded from a remote source and unzipped to the users' local extensions).

The properties url and/or name of each item are loaded dynamically from the web when id is present.

gnome_extensions:
  - id: 545

If the property enable is present and set to a truthy value (e.g. yes), the extension will be enabled automatically after the installation. Example:

gnome_extensions:
  - id: 1112
    enable: yes

Instead of specifying the ID, you can also enforce the url and name keys. Example:

gnome_extensions:
  - url:
    "https://extensions.gnome.org/download-extension/hidetopbar@mathieu.bidon.ca.shell-extension.zip?version_tag=6450"
    name: "hidetopbar@mathieu.bidon.ca"

Note that a predefined name and/or url value will not be overridden by specifying the id.

gnome_gsettings: A list of gsettings entries that will be set for the gnome_user, using gsettings. Each list item consists of a schema, key and value entry. Note that values should be contained within single quotes AND double quotes, due to Ansible's quoting settings for shell commands. Example:

gnome_gsettings:
  - schema: org.gnome.desktop.interface
    key: monospace-font-name
    value: '"Source Code Pro Medium 16"'

gnome_dconf: A list of dconf entries that will be set for the gnome_user, using dconf. Each list item consists of a key and value entry. Example:

gnome_dconf:
  - key: /org/gnome/desktop/background/show-desktop-icons
    value: "false"

gtk_version: The version string of GTK. This is used to create a GTK configuration directory, if it doesn't exist already. Example:

gtk_version: "gtk-3.0"

Dependencies

None.

Example Playbook

- hosts: all
  become: yes
  become_method: sudo
  roles:
    - role: petermosmans.customize-gnome
  vars:
    gnome_dconf:
      - key: /org/gnome/desktop/background/show-desktop-icons
        value: "false"
    gnome_extensions:
      - url: https://extensions.gnome.org/download-extension/hidetopbar@mathieu.bidon.ca.shell-extension.zip?version_tag=6450
        name: hidetopbar@mathieu.bidon.ca
      - id: 15
      - id: 1160
        url: https://example.com/gnome-extension/1160.zip
      - id: 1236
        name: CustomNamedExtension
      - id: 1267
        name: CustomNamedExtension2
        url: https://example.com/gnome-extension/1267.zip
      - id: 1112
        enable: yes
    gnome_files:
      - src: gtk.css
        dest: "/home/{{ gnome_user }}/.config/{{ gtk_version }}/gtk.css"
    gnome_fonts:
      - url: https://github.com/adobe-fonts/source-code-pro/archive/2.030R-ro/1.050R-it.zip
        name: SourceCodePro
        fonts: "source-code-pro-2.030R-ro-1.050R-it/OTF/*.otf"
    gnome_gsettings:
      - schema: org.gnome.desktop.interface
        key: monospace-font-name
        value: '"Source Code Pro Medium 16"'
      - schema: org.gnome.shell.extensions.dash-to-panel
        schemadir: ~/.local/share/gnome-shell/extensions/dash-to-panel@jderose9.github.com/schemas
        key: panel-position
        value: TOP
    gnome_packages:
      - fonts-roboto
    gnome_user: peter
    gtk_version: 3.0

This example will install the global fonts Roboto, Source Code Pro, the GNOME shell extension hidetopbar, and modifies several settings for the user root.

License

GPLv3

Author Information

Initially created by Peter Mosmans. Contributions by many others: see https://github.com/PeterMosmans/ansible-role-customize-gnome/graphs/contributors