Files
gitea-pages/admin-guide/puppet/roles/console.rst
2021-05-05 14:24:27 +02:00

83 lines
1.8 KiB
ReStructuredText

``role::console``
=================
A console as used at SLS/SwissFEL/... beamlines. Essentially a workstation with
additional configuration for Epics, mounts, etc.
Parameters
----------
================= ========= ==============
**Name** **Type** **Default**
----------------- --------- --------------
banner_message string See ``common.yaml``
favorites array See ``common.yaml``
keyboard_layouts array See ``common.yaml``
local_homes bool false
mount_root string
mounts array
priv_users array
symlink_root string
users array
================= ========= ==============
``banner_message``
~~~~~~~~~~~~~~~~~~
A message displayed on the login screen.
``favorites``
~~~~~~~~~~~~~
The of applications/locations in the 'Favorites' menu. Entries usually specify
an application's desktop file, eg. 'firefox.desktop'.
``keyboard_layouts``
~~~~~~~~~~~~~~~~~~~~
The list of keyboard layouts available on the login screen.
``local_homes``
~~~~~~~~~~~~~~~
Whether or not to use local homes in ``/home``.
``mount_root``
~~~~~~~~~~~~~~
The directory where the mountpoint for the mounts in `mounts`_ are created.
``mounts``
~~~~~~~~~~
A list of mounts defined through ``mounter::def::NAME`` (see the :doc:`mounter
<../profiles/mounter>`). The mounts must have a mountpoint beneath `mount_root`_
for `symlink_root`_ to work properly.
``priv_users``
~~~~~~~~~~~~~~
A list of users, which will have admin privileges in the UI. They can install
additional software, for example.
``symlink_root``
~~~~~~~~~~~~~~~~
The directory where the symlinks to the mounts in `mounts`_ are created.
``users``
~~~~~~~~~
The list of users/groups, who are allowed to log in. Group names must be
prefixed with ``%``.