Skip to content

Latest commit

 

History

History
78 lines (64 loc) · 3.57 KB

README.md

File metadata and controls

78 lines (64 loc) · 3.57 KB
Raw

sddm_wynn theme

A flexible, configurable, material SDDM theme. Most values are configurable via the theme.conf file.

Screenshots (some functionality not shown)

Screenshot

Features

  • Select user via user picker
  • Select user via typing in username (optional)
  • Display organization logo instead of user icon (optional)
  • Select background image (configuration option)
  • Customizable color scheme (configuration option)
  • Set default session (configuration option)
  • User selects their preferred session via menu
  • Select user's session via request to your API (optional, see below)
  • Display a configurable usage message to the user (optional)

Installation

  1. Install sddm
  2. git clone https://github.com/m-wynn/sddm_wynn-theme.git /usr/share/sddm/themes/sddm_wynn-theme
  3. chmod -R 755 /usr/share/sddm/themes/sddm_wynn-theme
  4. Install qml dependencies (qt5-graphicaleffects and qt5-quickcontrols2)
  5. Put "Current=sddm_wynn-theme" in the [Theme] section of /etc/sddm.conf

Configuration file values

You can create a theme.conf.user file in the theme folder, which will override the defaults.

  • default_background: Path to background image
  • default_session: Session name to default to. This is the sessionname in /usr/share/xsessions/sessionname.desktop (i.e. cinnamon or cinnamon2d, NOT Cinnamon (Software Rendering))
  • font: The name of font family to use in labels and fields
  • accent1: The color of the top bar
  • accent1_text: The color of the top bar text and buttons
  • accent2: The color of other items, like the "LOG IN" button
  • accent2_hover: The color that will be applied on hover to accent2 items
  • am_pm_clock: Whether to use a 12-hour AM/PM clock or a 24-hour clock
  • logo (optional): Path to the image that will be placed in the spot usually filled by a face icon
  • primary_screen_only: Whether or not to display the panel on both screens, or just the primary screen.
  • user_name: fill to have the user type in their own username, or select if you would like to provide a menu of users to choose from
  • session_api (optional): A url which will return the user's preferred desktop environment (yes, this was made with a very specific use-case in mind, see more below)
  • aup (optional): A string that will contain an Acceptable Use Policy for your users. Escape characters such as '\n' will render properly (i.e. as actual newlines). Alternatively, quote the whole thing and put in real newlines.

Session API

The session API value is useful if, for example, you are running a linux lab of many users, and users can choose a desktop environment to be associated with their account. As an example, this could be done via LDAP and an small web API.

The greeter theme will read your session_api value from the configuration file, replace %s with the username, perform an HTTP GET request, and use the body of the result as the session name. Again, the session name should be the sessionname in /usr/share/xsessions/sessionname.desktop (i.e. cinnamon or cinnamon2d, NOT Cinnamon (Software Rendering)). If the API returns N, then it will reset to the default_session configuration value.

For example, if your session_api is http://ldap-api.mylab.com/%s/session/0 and a user types in their name m_wynn into the username box, as soon as they focus away from the username box, the theme will GET http://ldap-api.mylab.com/m_wynn/session/0. If the result is N, the default_session will be used. Otherwise, the body of the response (i.e. "cinnamon") is used as the session name.