aboutsummaryrefslogtreecommitdiffstats
path: root/roles/linux_desktop
diff options
context:
space:
mode:
authorStonewall Jackson <stonewall@sacredheartsc.com>2023-02-13 22:00:41 -0500
committerStonewall Jackson <stonewall@sacredheartsc.com>2023-02-13 22:00:41 -0500
commitcc5f4658d2fe08a2741ce7cadfcef8b7c986318e (patch)
tree2cbf4ad6cc4b14bd4dd7b8863898977d70b6c5ef /roles/linux_desktop
parentee4556fa5ccb87890e4531fd4b9b7f5975447ddb (diff)
downloadselfhosted-cc5f4658d2fe08a2741ce7cadfcef8b7c986318e.tar.gz
selfhosted-cc5f4658d2fe08a2741ce7cadfcef8b7c986318e.zip
linux_desktop: add docs
Diffstat (limited to 'roles/linux_desktop')
-rw-r--r--roles/linux_desktop/README.md41
1 files changed, 41 insertions, 0 deletions
diff --git a/roles/linux_desktop/README.md b/roles/linux_desktop/README.md
new file mode 100644
index 0000000..555c08a
--- /dev/null
+++ b/roles/linux_desktop/README.md
@@ -0,0 +1,41 @@
+Linux Desktop
+=============
+
+Description
+-----------
+
+The `linux_desktop` role performs various setup tasks for Linux workstations,
+including:
+
+ - install and configure GNOME desktop environment
+ - set the default systemd target to `graphical`
+ - configure Flatpak repository and install apps
+
+Lists of Yum and Flatpak applications to be installed can be found in the
+[vars file](vars/main.yml).
+
+Variables
+---------
+
+This role **accepts** the following variables:
+
+Variable | Default | Description
+-------------------------------------------|-----------------------------|------------
+`linux_desktop_access_group` | `role-linux-desktop-access` | FreeIPA group allowed to login to GDM (will be created)
+`linux_desktop_flatpak_update_on_calendar` | `daily` | Systemd [calendar interval](https://www.freedesktop.org/software/systemd/man/systemd.time.html#Calendar%20Events) for updating Flatpak apps
+`linux_desktop_enable_wayland` | yes | Enable Wayland compositor
+`linux_desktop_thumbnail_cache_size` | 4096 | Size of thumbnail cache (MB)
+`linux_desktop_enable_window_buttons` | yes | Enable minimize and maximize buttons
+
+Usage
+-----
+
+Example playbook:
+
+````yaml
+- hosts: linux_desktops
+ roles:
+ - role: linux_desktop
+ vars:
+ linux_desktop_enable_window_buttons: yes
+````