Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/JezerM/web-greeter
A modern, visually appealing greeter for LightDM.
https://github.com/JezerM/web-greeter
lightdm lightdm-greeter lightdm-web-greeter nody-greeter web-greeter
Last synced: about 1 month ago
JSON representation
A modern, visually appealing greeter for LightDM.
- Host: GitHub
- URL: https://github.com/JezerM/web-greeter
- Owner: JezerM
- License: gpl-3.0
- Created: 2021-06-17T05:28:34.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-07-26T14:31:25.000Z (5 months ago)
- Last Synced: 2024-08-03T09:04:41.232Z (5 months ago)
- Topics: lightdm, lightdm-greeter, lightdm-web-greeter, nody-greeter, web-greeter
- Language: Python
- Homepage: https://web-greeter-page.vercel.app
- Size: 16.6 MB
- Stars: 207
- Watchers: 8
- Forks: 11
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Changelog: NEWS.md
- Funding: .github/FUNDING.yml
- License: COPYING
Awesome Lists containing this project
- awesome-linux-ricing - Web Greeter
README
Web Greeter
A LightDM greeter made with PyQt5
A modern, visually appealing greeter for LightDM, that allows to create web based themes with HTML,
CSS and JavaScript.
This is a fork of the [Antergos web-greeter](https://github.com/Antergos/web-greeter) that tries to
fix and improve this project for a modern and current use. Due to this, some API changes are
needed, which implies that current themes would need to do changes to work correctly.
Also, check out [nody-greeter][nody-greeter], a greeter made in **Node.js** with **Electron**!
(Actually, faster than Web Greeter)
## [See Live Demo][live_demo]
Gruvbox and Dracula themes!
## Features
- Create themes with HTML, CSS and JavaScript!
- Should work everywhere.
- JavaScript error handling, allowing to load the default theme.
- Themes could be simple, or very complex.
- Battery and brightness control.
- Tab completion for zsh and bash.
## Available distro packages
### Arch
- AUR: https://aur.archlinux.org/packages/web-greeter/
```sh
yay -S web-greeter
```
### Ubuntu/Debian
Download from the [latest release](https://github.com/JezerM/web-greeter/releases/latest) and
install with apt.
```sh
apt install ./web-greeter-VER-DISTRO.deb
```
## Dependencies
| | arch | ubuntu | fedora | openSUSE | debian |
|--------------------------|----------------------|-------------------------|---------------------|-----------------------|-------------------------|
|**liblightdm-gobject** |lightdm |liblightdm-gobject-1-dev |lightdm-gobject-devel|typelib-1_0-LightDM-1 |liblightdm-gobject-dev |
|**pygobject** |python-gobject |python3-gi |pygobject3 |python3-gobject |python3-gi |
|**pyqt5** |python-pyqt5 |python3-pyqt5 |python3-qt5 |python3-qt5-devel |python3-pyqt5 |
|**pyqt5-webengine** |python-pyqt5-webengine|python3-pyqt5.qtwebengine|python3-qt5-webengine|python3-qtwebengine-qt5|python3-pyqt5.qtwebengine|
|**python-yaml** |python-ruamel-yaml |python3-ruamel.yaml |python3-ruamel-yaml |python3-ruamel.yaml |python3-ruamel.yaml |
|**python-inotify** |python-pyinotify |python3-pyinotify |python3-inotify |python3-pyinotify |python3-pyinotify |
|**qt5-webengine** |qt5-webengine |libqt5webengine5 |qt5-qtwebengine |libqt5-qtwebengine |libqt5webengine5 |
|**gobject-introspection** |gobject-introspection |gobject-introspection |gobject-introspection|gobject-introspection |gobject-introspection |
|**libxcb** |libxcb |libxcb1-dev |libxcb-devel |libxcb |libxcb1-dev |
|**libx11** |libx11 |libx11-dev |libX11-devel |libX11 |libx11-dev |
> Note: web-greeter does not work in Fedora. See #19
### Build dependencies
- rsync
- make
- tsc (`npm i -g typescript`)
- pyrcc5 (Should be installed with above dependencies)
- base-devel (build-essential)
### PIP
- PyGObject
- PyQt5
- PyQtWebEngine
- ruamel.yaml
- pyinotify
PIP dependencies are no longer required as long as common dependencies are satisfied. However, you
can install PIP dependencies with:
```sh
pip install -r requirements.txt
```
> ***NOTE*** If using PIP, be sure to install these dependencies as root. Yet, not recommended.
## Download & Install
```sh
git clone --recursive https://github.com/JezerM/web-greeter.git
cd web-greeter
sudo make install
```
This will build **web-greeter** and package all the files to be installed.
See [latest release][releases].
### Uninstall
Use `sudo make uninstall` to uninstall web-greeter, but preserving web-greeter.yml and themes.
Either, use `sudo make uninstall_all` to remove everything related to web-greeter.
## Theme JavaScript API
[Antergos][Antergos] documentation is no longer available, although it is accesible through
[Web Archive][WebArchive]. Current and updated documentation is available at [web-greeter-page/docs][web-greeter-docs].
You can access the man-pages `man web-greeter` for some documentation and explanation. Also, you can
explore the provided [themes](https://github.com/JezerM/web-greeter-themes/tree/master/themes) for real use cases.
Additionally, you can install the TypeScript types definitions inside your theme with npm:
```sh
npm install nody-greeter-types
```
## Additional features
### Brightness control
`acpi` is the only tool needed to control the brightness, besides a compatible device.
This functionality is based on [acpilight][acpilight] replacement for `xbacklight`.
udev rules are needed to be applied before using it, check [acpilight rules][acpilight_rules].
Then, lightdm will need to be allowed to change backlight values, to do so add lightdm user
to the **video** group: `sudo usermod -a -G video lightdm`
Enable it inside `/etc/lightdm/web-greeter.yml`
### Battery status
`acpi` and `acpi_listen` are the only tools you need (and a battery).
This functionality is based on ["bat" widget][bat_widget] from ["lain" awesome-wm library][lain].
You can enable it inside `/etc/lightdm/web-greeter.yml`
## Debugging
You can run the greeter from within your desktop session if you add the following line to the desktop
file for your session located in `/usr/share/xsessions/`: `X-LightDM-Allow-Greeter=true`.
You have to log out and log back in after adding that line. Then you can run the greeter
from command line.
Themes can be opened with a debug console if you set `debug_mode` as `true`
inside `/etc/lightdm/web-greeter.yml`. Or, you could run the `web-greeter` with
the parameter `--debug`. I recommend to use the last one, as it is easier and handy.
```sh
web-greeter --debug
```
Check `web-greeter --help` for more commands.
> ***Note:*** Do not use `lightdm --test-mode` as it is not supported.
## Troubleshooting
Before setting **web-greeter** as your LightDM Greeter, you should make sure it does work also with LightDM:
- Run **web-greeter** as root with `--no-sandbox` flag ("Unable to determine socket to daemon" and "XLib" related errors are expected)
- Run `lightdm --test-mode`. Although it's not supported, if it does work then it could help to debug lightdm.
### LightDM crashes and tries to recover over and over again
LightDM does this when the greeter crashes, so it could mean **web-greeter** was not installed
correctly, or some dependencies were updated/removed after a distro update.
### Import errors
If you see something like this: `ImportError: libQt5WebEngineCore.so.5: undefined symbol: _ZNSt12out_of_rangeC1EPKc, version Qt_5`, check out this [StackOverflow response](https://stackoverflow.com/a/68811630).
With some PyQt5 import errors like `ModuleNotFoundError: No module named 'PyQt5.QtWebEngineWidgets'`, check out this [GitHub response](https://github.com/spyder-ide/spyder/issues/8952#issuecomment-499418456).
web-greeter related import errors:
- `AttributeError: module 'globals' has no attribute 'greeter'` means some exception happened inside the Browser constructor, maybe related to LightDM or PyQt5.
- `ModuleNotFoundError: No module named 'resources'` could mean `path/to/web-greeter-clone/web-greeter/resources.py` was not compiled with pyrcc5 in the build/install methods.
[antergos]: https://github.com/Antergos "Antergos"
[nody-greeter]: https://github.com/JezerM/nody-greeter "Nody Greeter"
[cx_freeze]: https://github.com/marcelotduarte/cx_Freeze "cx_Freeze"
[acpilight]: https://gitlab.com/wavexx/acpilight/ "acpilight"
[acpilight_rules]: https://gitlab.com/wavexx/acpilight/-/blob/master/90-backlight.rules "udev rules"
[bat_widget]: https://github.com/lcpz/lain/blob/master/widget/bat.lua "Battery widget"
[lain]: https://github.com/lcpz/lain "Lain awesome library"
[WebArchive]: https://web.archive.org/web/20190524032923/https://doclets.io/Antergos/web-greeter/stable "Web Archive"
[web-greeter-docs]: https://web-greeter-page.vercel.app "Documentation"
[live_demo]: https://jezerm.github.io/web-greeter-themes/ "Live Demo"
[releases]: https://github.com/JezerM/web-greeter/releases "Releases"