Dustin Falgout
8 years ago
4 changed files with 453 additions and 0 deletions
@ -0,0 +1,104 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?> |
||||
<!-- Copyright 2017 Dustin Falgout <dustin@antergos.com> --> |
||||
<component type="desktop"> |
||||
<id>com.antergos.web-greeter</id> |
||||
<metadata_license>CC0-1.0</metadata_license> |
||||
<project_license>GPL-3.0+</project_license> |
||||
<name>Web Greeter</name> |
||||
<summary>A modern, visually appealing greeter for LightDM.</summary> |
||||
<description> |
||||
<p> |
||||
Web Greeter for LightDM utilizes themes built with HTML/CSS/JavaScript for it's login screen. |
||||
</p> |
||||
<p> |
||||
Web Greeter's themes provide modern, visually appealing, and feature-rich |
||||
login screens. It includes two themes by default. There are a growing number of |
||||
3rd-Party themes available online. |
||||
</p> |
||||
</description> |
||||
<screenshots> |
||||
<screenshot height="412" width="800" type="default"> |
||||
<image>https://github.com/Antergos/web-greeter/raw/master/themes/antergos/img/screenshot1.jpg</image> |
||||
<caption>Login screen (default theme)</caption> |
||||
</screenshot> |
||||
<screenshot height="412" width="800"> |
||||
<image>https://github.com/Antergos/web-greeter/raw/master/themes/antergos/img/screenshot2.jpg</image> |
||||
<caption>Login screen background switcher (default theme)</caption> |
||||
</screenshot> |
||||
<screenshot height="412" width="800"> |
||||
<image>https://github.com/Antergos/web-greeter/raw/master/themes/antergos/img/screenshot3.jpg</image> |
||||
<caption>Login screen user selection (default theme)</caption> |
||||
</screenshot> |
||||
</screenshots> |
||||
|
||||
<!-- |
||||
Validate with `appstream-util validate *.appdata.xml` |
||||
--> |
||||
|
||||
<releases> |
||||
<release date="2016-12-26" version="2.2.1"> |
||||
<description> |
||||
<p>This is a maintenance release in the 2.2 series, with the following improvements:</p> |
||||
<ul> |
||||
<li>Increased the timeout for the "theme loaded" check to ensure themes are given enough time to load (when running on less powerful systems). (GH #98)</li> |
||||
<li>Fixed issue where users' custom .face image failed to load. (GH #98)</li> |
||||
</ul> |
||||
</description> |
||||
</release> |
||||
<release date="2016-12-18" version="2.2"> |
||||
<description> |
||||
<p>This is a milestone release with the following improvements:</p> |
||||
<ul> |
||||
<li>The JavaScript API for themes is now fully documented: https://goo.gl/0iPzA4</li> |
||||
<li>New Theme Error Recovery System that will alert the user when errors are detected during JavaScript execution and give them the option to to load a fallback theme.</li> |
||||
<li>New config option: secure_mode (enabled by default). When enabled, only local http requests are allowed in themes. All non-local requests will be blocked.</li> |
||||
<li>It is now possible to override the language and format used by the greeter when displaying the current time. See the greeter config file for details.</li> |
||||
<li>A new utility method for getting the current localized time is available to themes.</li> |
||||
<li>Simple theme now has a fade out exit animation.</li> |
||||
</ul> |
||||
<ul> |
||||
<li>Switched build systems from Autotools to Meson.</li> |
||||
<li>Updated API usage for LightDM 1.19.2+.</li> |
||||
<li>Updated bundled JS & CSS vendor libs to their latest versions.</li> |
||||
<li>Updated translations with latest changes contributed by the Antergos Community on Transifex.</li> |
||||
<li>Default theme: |
||||
<ul> |
||||
<li>Buttons and user list-box items received some minor style enhancements.</li> |
||||
<li>Theme is now compatible with the latest jQuery.</li> |
||||
</ul> |
||||
</li> |
||||
<li>Simple theme: |
||||
<ul> |
||||
<li>Removed deprecated HTML4 tags.</li> |
||||
<li>Improved styles for the input field.</li> |
||||
</ul> |
||||
</li> |
||||
</ul> |
||||
<ul> |
||||
<li>The ugly default X cursor will no longer be shown after the greeter exits.</li> |
||||
<li>Default theme: |
||||
<ul> |
||||
<li>The error messages container will now appear correctly (size and position).</li> |
||||
<li>It is now once again possible to skip straight to password entry by pressing either the spacebar or the enter key.</li> |
||||
</ul> |
||||
</li> |
||||
</ul> |
||||
</description> |
||||
</release> |
||||
</releases> |
||||
<kudos> |
||||
<kudo>ModernToolkit</kudo> |
||||
</kudos> |
||||
<url type="bugtracker">https://github.com/Antergos/web-greeter/issues</url> |
||||
<url type="donation">https://antergos.com/donate</url> |
||||
<url type="help"/> |
||||
<url type="homepage">https://github.com/Antergos/web-greeter</url> |
||||
<url type="translate">https://www.transifex.com/faidoc/antergos/lightdm-webkit2-greeter</url> |
||||
<suggests> |
||||
<id>apps.light-locker</id> |
||||
</suggests> |
||||
<update_contact>dustin_at_antergos.com</update_contact> |
||||
<translation type="gettext">web-greeter</translation> |
||||
<developer_name>Antergos Linux Project</developer_name> |
||||
</component> |
||||
|
||||
@ -0,0 +1,6 @@
|
||||
[Desktop Entry] |
||||
Name=Web Greeter |
||||
Comment=Greeter for LightDM |
||||
Exec=web-greeter |
||||
Type=Application |
||||
X-Ubuntu-Gettext-Domain=web-greeter |
||||
@ -0,0 +1,308 @@
|
||||
.TH "lightdm-webkit2-greeter" "1" "2016.01.10" |
||||
.nh |
||||
.ad l |
||||
.SH "NAME" |
||||
lightdm-webkit2-greeter |
||||
.SH "SYNOPSIS" |
||||
.PP |
||||
LightDM greeter that uses webkit2 for theming via HTML/JavaScript\&. |
||||
.PP |
||||
.SH "DESCRIPTION" |
||||
.PP |
||||
lightdm-webkit2-greeter is a LightDM greeter that uses webkit2 for theming\&. Themes can be written |
||||
using a combination of HTML and Javascript\&. |
||||
.PP |
||||
.SH "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 |
||||
lightdm-webkit2-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\&. |
||||
.PP |
||||
The following functions \fBmust\fR be provided by the greeter theme and callable on the global "window" object\&. |
||||
.PP |
||||
\fBshow_prompt(text, type)\fR |
||||
.RS 4 |
||||
This will be called when LightDM needs to prompt the user for some reason, such |
||||
as asking for a password\&. The "text" parameter will be the text of the |
||||
prompt, and the "type" parameter will either be "text" for a visible prompt, or |
||||
"password" for a prompt that the input should be hidden\&. |
||||
.RE |
||||
.PP |
||||
\fBshow_message(text, type)\fR |
||||
.RS 4 |
||||
This will be called when LightDM needs to display some info for the user\&. |
||||
The "text" parameter will be the text of the |
||||
message, and the "type" parameter will either be "info" for an information |
||||
message, or "error" for an error message that LightDM has encountered\&. |
||||
.RE |
||||
.PP |
||||
\fBauthentication_complete()\fR |
||||
.RS 4 |
||||
This function is called by LightDM when authentication has completed\&. |
||||
.RE |
||||
.PP |
||||
\fBautologin_timer_expired()\fR |
||||
.RS 4 |
||||
This function is called by LightDM when an autologin user's login timer has |
||||
expired\&. The greeter should reset the authentication process\&. |
||||
.RE |
||||
.PP |
||||
The following functions are available for the greeter to call to execute |
||||
actions within LightDM\&. |
||||
.PP |
||||
\fBlightdm\&.authenticate(username)\fR |
||||
.RS 4 |
||||
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\&. The older function |
||||
lightdm\&.start_authentication() has been deprecated\&. |
||||
.RE |
||||
.PP |
||||
\fBlightdm\&.authenticate_as_guest()\fR |
||||
.RS 4 |
||||
Authenticates as the guest user\&. |
||||
.RE |
||||
.PP |
||||
\fBlightdm\&.cancel_authentication()\fR |
||||
.RS 4 |
||||
Cancels the authentication of any user currently in the process of |
||||
authenticating\&. |
||||
.RE |
||||
.PP |
||||
\fBlightdm\&.cancel_autologin()\fR |
||||
.RS 4 |
||||
Cancels the authentication of the autologin user\&. The older function |
||||
lightdm\&.cancel_timed_login() has been deprecated. |
||||
.RE |
||||
.PP |
||||
\fBlightdm\&.get_hint(hint_name)\fR |
||||
.RS 4 |
||||
Returns the value of a named hint provided by LightDM\&. |
||||
.RE |
||||
.PP |
||||
\fBlightdm\&.suspend()\fR |
||||
.RS 4 |
||||
Suspends the system, if the greeter has the authority to do so\&. |
||||
.RE |
||||
.PP |
||||
\fBlightdm\&.hibernate()\fR |
||||
.RS 4 |
||||
Hibernates the system, if the greeter has the authority to do so\&. |
||||
.RE |
||||
.PP |
||||
\fBlightdm\&.start_session_sync(session)\fR |
||||
.RS 4 |
||||
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. The older function lightdm\&.login(user, session) has been |
||||
deprecated\&. |
||||
.RE |
||||
.PP |
||||
\fBlightdm\&.respond(text)\fR |
||||
.RS 4 |
||||
When LightDM has prompted for input, provide the response to LightDM\&. |
||||
The deprecated function was "provide_secret"\&. This is still available for |
||||
backwards compatibility, but authors of greeters should move to using |
||||
lightdm.respond()\&. |
||||
.RE |
||||
.PP |
||||
\fBlightdm\&.restart()\fR |
||||
.RS 4 |
||||
Restarts the system, if the greeter has the authority to do so\&. |
||||
.RE |
||||
.PP |
||||
\fBlightdm\&.set_language(lang)\fR |
||||
.RS 4 |
||||
Will set the language for the current LightDM session\&. |
||||
.RE |
||||
.PP |
||||
\fBlightdm\&.shutdown()\fR |
||||
.RS 4 |
||||
Shuts down the system, if the greeter has the authority to do so\&. |
||||
.RE |
||||
.PP |
||||
Variables available within the greeter are: |
||||
.PP |
||||
\fBlightdm\&.authentication_user\fR |
||||
.RS 4 |
||||
String\&. The username of the authentication user being authenticated or null if no |
||||
authentication is in progress\&. |
||||
.RE |
||||
.PP |
||||
\fBlightdm\&.autologin_guest\fR |
||||
.RS 4 |
||||
Boolean\&. Indicates the guest user should be used for autologin\&. |
||||
.RE |
||||
.PP |
||||
\fBlightdm\&.autologin_timeout\fR |
||||
.RS 4 |
||||
Number\&. The number of seconds to wait before automatically logging in\&. The |
||||
older variable lightdm\&.timed_user_delay has been deprecated\&. |
||||
.RE |
||||
.PP |
||||
\fBlightdm\&.autologin_user\fR |
||||
.RS 4 |
||||
String\&. The name of the user account that should be logged into |
||||
automatically after timed login delay has passed\&. The older variable |
||||
lightdm\&.timed_login_user has been deprecated\&. |
||||
.RE |
||||
.PP |
||||
\fBlightdm\&.can_hibernate\fR |
||||
.RS 4 |
||||
Boolean\&. Whether or not the system can be made to hibernate by the greeter\&. |
||||
.RE |
||||
.PP |
||||
\fBlightdm\&.can_restart\fR |
||||
.RS 4 |
||||
Boolean\&. Whether or not the system can be restarted by the greeter\&. |
||||
.RE |
||||
.PP |
||||
\fBlightdm\&.can_shutdown\fR |
||||
.RS 4 |
||||
Boolean\&. Whether or not the system can be shutdown by the greeter\&. |
||||
.RE |
||||
.PP |
||||
\fBlightdm\&.can_suspend\fR |
||||
.RS 4 |
||||
Boolean\&. Whether or not the system can be suspended by the greeter\&. |
||||
.RE |
||||
.PP |
||||
\fBlightdm\&.default_session\fR |
||||
.RS 4 |
||||
String\&. The name of the default session (as configured in lightdm.conf)\&. |
||||
.RE |
||||
.PP |
||||
\fBlightdm\&.has_guest_account\fR |
||||
.RS 4 |
||||
Boolean\&. A guest account is available for login\&. |
||||
.RE |
||||
.PP |
||||
\fBlightdm\&.hide_users\fR |
||||
.RS 4 |
||||
Boolean\&. The whole list of users should not be displayed\&. |
||||
.RE |
||||
.PP |
||||
\fBlightdm\&.hostname\fR |
||||
.RS 4 |
||||
String\&. The hostname of the system\&. |
||||
.RE |
||||
.PP |
||||
\fBlightdm\&.is_authenticated\fR |
||||
.RS 4 |
||||
Boolean\&. Indicates if the user has successfully authenticated\&. |
||||
.RE |
||||
.PP |
||||
\fBlightdm\&.in_authentication\fR |
||||
.RS 4 |
||||
Boolean\&. Indicates if lightdm is currently in the authentication phase\&. |
||||
.RE |
||||
.PP |
||||
\fBlightdm\&.language\fR |
||||
.RS 4 |
||||
String\&. The currently selected language\&. The older variable name |
||||
lightdm\&.default_language is deprecated\&. |
||||
.RE |
||||
.PP |
||||
\fBlightdm\&.layout\fR |
||||
.RS 4 |
||||
String\&. The name of the currently active keyboard layout\&. To change the |
||||
layout, assign a valid layout name to this variable\&. The older variable name |
||||
lightdm\&.default_layout is deprecated\&. |
||||
.RE |
||||
.PP |
||||
\fBlightdm\&.layouts\fR |
||||
.RS 4 |
||||
Array\&. The keyboard layouts that are available on the system\&. Returns an Array |
||||
of LightDMLayout objects\&. |
||||
.RE |
||||
.PP |
||||
\fBlightdm\&.num_users\fR |
||||
.RS 4 |
||||
Number\&. The number of users able to log in\&. |
||||
.RE |
||||
.PP |
||||
\fBlightdm\&.select_guest\fR |
||||
.RS 4 |
||||
Boolean\&. The guest user should be selected by default for login\&. |
||||
.RE |
||||
.PP |
||||
\fBlightdm\&.select_user\fR |
||||
.RS 4 |
||||
String\&. The username that should be selected by default for login\&. |
||||
.RE |
||||
.PP |
||||
\fBlightdm\&.sessions\fR |
||||
.RS 4 |
||||
Array\&. The sessions that are available on the system\&. Returns an Array of |
||||
LightDMSession objects\&. |
||||
.RE |
||||
.PP |
||||
\fBlightdm\&.users\fR |
||||
.RS 4 |
||||
Array\&. The users that are able to log in\&. Returns an Array of LightDMUser |
||||
objects\&. |
||||
.RE |
||||
.PP |
||||
The following calls can be made to read configuration keys out of the |
||||
lightdm-webkit2-greeter configuration file\&. |
||||
.PP |
||||
config\&.get_str(section, key)\fR |
||||
.RS 4 |
||||
Returns the string value associated with key under the "section" in the configuration file\&. |
||||
.RE |
||||
.PP |
||||
config\&.get_num(section, key)\fR |
||||
.RS 4 |
||||
Returns the numeric value associated with key under the "section" in the configuration file\&. |
||||
.RE |
||||
.PP |
||||
config\&.get_bool(section, key)\fR |
||||
.RS 4 |
||||
Returns the boolean value associated with key under the "section" in the configuration file\&. |
||||
.RE |
||||
.PP |
||||
The greeterutil object has some utility functions associated with it which |
||||
are intended to make a theme author's work easier\&. |
||||
.PP |
||||
greeterutil\&.dirlist(path)\fR |
||||
.RS 4 |
||||
Returns an array of strings of filenames present at "path", or Null if the |
||||
path does not exist\&. |
||||
.RE |
||||
.PP |
||||
greeterutil\&.txt2html(txt)\fR |
||||
.RS 4 |
||||
Returns a simple HTML conversion of the passed text\&. Newlines are replaced |
||||
with <br>, and the characters \&&, <, >, and " are replaced with their HTML |
||||
equivalents\&. |
||||
.RE |
||||
.PP |
||||
Please see the LightDM API documentation for the complete list of calls |
||||
available\&. The lightdm-webkit2-greeter implements all of the LightDM API\&. |
||||
.PP |
||||
.SH "CONFIGURATION" |
||||
.PP |
||||
\fB/etc/lightdm/lightdm-webkit2-greeter\&.conf\fR |
||||
.RS 4 |
||||
Keyfile that contains one key: webkit-theme\&. This should point to which |
||||
theme the greeter should use\&. |
||||
.RE |
||||
.SH "FILES" |
||||
.PP |
||||
\fB/usr/share/lightdm-webkit/themes\fR |
||||
.RS 4 |
||||
Directory where themes should be stored\&. |
||||
.RE |
||||
.SH "EXAMPLES" |
||||
.PP |
||||
Please see the "antergos" and "simple" themes that are shipped with lightdm-webkit2-greeter\&. |
||||
.SH "SEE ALSO" |
||||
.PP |
||||
http://people\&.ubuntu\&.com/~robert-ancell/lightdm/reference/core\&.html |
||||
.SH "AUTHOR" |
||||
.PP |
||||
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>\&. |
||||
@ -0,0 +1,35 @@
|
||||
# |
||||
# [greeter] |
||||
# debug_mode = Greeter theme debug mode. |
||||
# detect_theme_errors = Provide an option to load a fallback theme when theme errors are detected. |
||||
# screensaver_timeout = Blank the screen after this many seconds of inactivity. |
||||
# secure_mode = Don't allow themes to make remote http requests. |
||||
# time_format = A moment.js format string so the greeter can generate localized time for display. |
||||
# time_language = Language to use when displaying the time or "auto" to use the system's language. |
||||
# webkit_theme = Webkit theme to use. |
||||
# |
||||
# NOTE: See moment.js documentation for format string options: http://momentjs.com/docs/#/displaying/format/ |
||||
# |
||||
|
||||
[greeter] |
||||
debug_mode = false |
||||
detect_theme_errors = true |
||||
screensaver_timeout = 300 |
||||
secure_mode = true |
||||
time_format = LT |
||||
time_language = auto |
||||
webkit_theme = antergos |
||||
|
||||
# |
||||
# [branding] |
||||
# background_images = Path to directory that contains background images for use by themes. |
||||
# logo = Path to logo image for use by greeter themes. |
||||
# user_image = Default user image/avatar. This is used by themes for users that have no .face image. |
||||
# |
||||
# NOTE: Paths must be accessible to the lightdm system user account (so they cannot be anywhere in /home) |
||||
# |
||||
|
||||
[branding] |
||||
background_images = /usr/share/backgrounds |
||||
logo = /usr/share/lightdm-webkit/themes/antergos/img/antergos.png |
||||
user_image = /usr/share/lightdm-webkit/themes/antergos/img/antergos-logo-user.png |
||||
Loading…
Reference in new issue