manpages

web-greeter(1)

web-greeter(1) General Commands Manual web-greeter(1)

NAME

web-greeter

SYNOPSIS

LightDM greeter that uses chromium for theming via HTML/JavaScript.

DESCRIPTION

web-greeter is a LightDM greeter that uses chromium for theming. Themes can be written using a combination of HTML and Javascript.

OPTIONS

-h, --help
Shows the help
-v, --version
Print program version
--debug
Forces the greeter to run in debug mode
--normal
Forces the greeter to run in normal mode
--list
Shows the available themes
--theme THEME
Sets the theme to use

THEME JAVASCRIPT API

Please note that all properties and functions which are marked as "deprecated" are only available for backwards compatibility and will be removed in a future version of web-greeter. Theme authors should not use any deprecated properties or functions in new works and should update any existing works which make use of deprecated properties and/or functions to ensure continued proper functionality.

See full documentation on https://jezerm.github.io/web-greeter/

The following signals are available to connect javascript functions when a LightDM or web-greeter signal occurs:

lightdm.authentication_complete

Gets emitted when the greeter has completed authentication.

lightdm.autologin_timer_expired

Gets emitted when the automatic login timer has expired.

lightdm.show_message

Gets emitted when the greeter should show a message to the user. This signal emits a message: string and a type: number.

lightdm.show_prompt

Gets emitted when the greeter should show a prompt to the user. This signal emits a message: string and a type: number.

The following functions are available for the greeter to call to execute actions within LightDM:

lightdm.authenticate(username)

Specifies the username of the user we'd like to start authenticating as. Note that if you call lightdm.authenticate with no argument, LightDM (via PAM) will issue a show_prompt() call to ask for the username.

lightdm.authenticate_as_guest()

Authenticates as the guest user.

lightdm.cancel_authentication()

Cancels the authentication of any user currently in the process of authenticating.

lightdm.cancel_autologin()

Cancels the authentication of the autologin user.

lightdm.start_session(session)

Once LightDM has successfully authenticated the user, start the user's session by calling this function. "session" is the authenticated user's session. If no session is passed, start the authenticated user with the system default session.

lightdm.respond(text)

When LightDM has prompted for input, provide the response to LightDM.

lightdm.set_language(lang)

Will set the language for the current LightDM session.

lightdm.shutdown()

Shuts down the system, if the greeter has the authority to do so. Check if greeter can shutdown with lightdm.can_shutdown

lightdm.restart()

Restarts the system, if the greeter has the authority to do so. Check if greeter can restart with lightdm.can_restart

lightdm.suspend()

Suspends the system, if the greeter has the authority to do so. Check if greeter can suspend with lightdm.can_suspend

lightdm.hibernate()

Hibernates the system, if the greeter has the authority to do so. Check if greeter can hibernate with lightdm.can_hibernate

Variables available within the greeter are:

lightdm.authentication_user: string

The username of the authentication user being authenticated or null if no authentication is in progress.

lightdm.autologin_guest: boolean

Indicates the guest user should be used for autologin.

lightdm.autologin_timeout: number

The number of seconds to wait before automatically logging in.

lightdm.autologin_user: string

The name of the user account that should be logged into automatically after timed login delay has passed.

lightdm.can_hibernate: boolean

Whether or not the system can be made to hibernate by the greeter.

lightdm.can_restart: boolean

Whether or not the system can be restarted by the greeter.

lightdm.can_shutdown: boolean

Whether or not the system can be shutdown by the greeter.

lightdm.can_suspend: boolean

Whether or not the system can be suspended by the greeter.

lightdm.default_session: string

The name of the default session (as configured in lightdm.conf).

lightdm.has_guest_account: boolean

A guest account is available for login.

lightdm.hide_users_hint: boolean

The whole list of users should not be displayed.

lightdm.hostname: string

The hostname of the system.

lightdm.is_authenticated: boolean

Indicates if the user has successfully authenticated.

lightdm.in_authentication: boolean

Indicates if lightdm is currently in the authentication phase.

lightdm.language: LightDM.Language | null

The currently selected language.

lightdm.languages: LightDM.Languages[]

The languages that are available on the system.

lightdm.layout: LightDM.Layout

The currently active layout for the selected user.

lightdm.layouts: LightDM.Layout[]

The keyboard layouts that are available on the system.

lightdm.select_guest_hint: boolean

The guest user should be selected by default for login.

lightdm.select_user_hint: string

The username that should be selected by default for login.

lightdm.sessions: LightDM.Session[]

The sessions that are available on the system.

lightdm.users: LightDM.User[]

The users that are able to log in. Returns an Array of LightDMUser objects.

The theme_utils object has some utility functions associated with it which are intended to make a theme author's work easier.

theme_utils.dirlist(path)

Returns an array of strings of filenames present at "path", or Null if the path does not exist.

theme_utils.bind_this(context)

Binds this to class, context, for all of the class's methods.

theme_utils.get_current_localized_time()

Get the current time in a localized format. Language is auto-detected by default, but can be set manually in the greeter config file.
theme_utils.get_current_localized_date()
Get the current date in a localized format. Language is auto-detected by default, but can be set manually in the greeter config file.

Please see the LightDM API documentation for the complete list of calls available. The web-greeter implements all of the LightDM API.

CONFIGURATION

/etc/lightdm/web-greeter.yml

Configuration file.

FILES

/usr/share/web-greeter/themes

Directory where themes should be stored.

EXAMPLES

Please see the "dracula", "gruvbox" and "simple" themes that are shipped with web-greeter.

Command Line
web-greeter --theme simple --debug
web-greeter --normal

SEE ALSO

http://people.ubuntu.com/~robert-ancell/lightdm/reference/

https://lazka.github.io/pgi-docs/#LightDM-1

https://jezerm.github.io/web-greeter/

https://github.com/JezerM/web-greeter

AUTHOR

The legacy lightdm-webkit-greeter was written by Robert Ancell <robert.ancell@canonical.com>. It was ported to webkit2 by the Antergos Developers <dev@antergos.com>. Also includes code improvements contributed by Scott Balneaves <sbalneav@ltsp.org>. Forked and mantained by JezerM <amyuki4@gmail.com>.

2022.2.10