aboutsummaryrefslogtreecommitdiffstats
path: root/roles/local_homedirs/README.md
diff options
context:
space:
mode:
authorStonewall Jackson <stonewall@sacredheartsc.com>2023-02-13 22:58:12 -0500
committerStonewall Jackson <stonewall@sacredheartsc.com>2023-02-13 22:58:12 -0500
commit9f79e53c5b6dfae5875f0d082679b41ab405ed4c (patch)
tree6ad32722b80c86dfb87e00e8591ac9d457b3598e /roles/local_homedirs/README.md
parent3754ed133313ec8bb80aed680d505f57f18ce25d (diff)
downloadselfhosted-9f79e53c5b6dfae5875f0d082679b41ab405ed4c.tar.gz
selfhosted-9f79e53c5b6dfae5875f0d082679b41ab405ed4c.zip
local_homedirs: add docs
Diffstat (limited to 'roles/local_homedirs/README.md')
-rw-r--r--roles/local_homedirs/README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/roles/local_homedirs/README.md b/roles/local_homedirs/README.md
new file mode 100644
index 0000000..8a42708
--- /dev/null
+++ b/roles/local_homedirs/README.md
@@ -0,0 +1,25 @@
+Local Homedirs
+==============
+
+Description
+-----------
+
+The `local_homedirs` provisions per-user space on the local disk to accomdate
+applications that perform poorly with NFS home directories.
+
+Basically, this role adds some PAM modules and login scripts that cause
+various applications to write to `/usr/local/home/$USER`, rather than
+`/home/$USER`.
+
+This role does not accept any variables.
+
+Usage
+-----
+
+Example playbook:
+
+````yaml
+- hosts: linux_desktops
+ roles:
+ - role: local_homedirs
+````