Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/apognu/tuigreet
Graphical console greeter for greetd
https://github.com/apognu/tuigreet
greetd linux login wayland xorg
Last synced: 3 months ago
JSON representation
Graphical console greeter for greetd
- Host: GitHub
- URL: https://github.com/apognu/tuigreet
- Owner: apognu
- License: gpl-3.0
- Created: 2020-06-27T09:40:12.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-01-04T06:49:58.000Z (5 months ago)
- Last Synced: 2024-01-16T19:35:05.701Z (5 months ago)
- Topics: greetd, linux, login, wayland, xorg
- Language: Rust
- Homepage:
- Size: 453 KB
- Stars: 661
- Watchers: 13
- Forks: 38
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Lists
- awesome-stars - apognu/tuigreet - Graphical console greeter for greetd (Rust)
- awesome-stars - apognu/tuigreet - Graphical console greeter for greetd (Rust)
- stars - apognu/tuigreet
- awesome-hyprland - tuigreet
README
# tuigreet
Graphical console greeter for [greetd](https://git.sr.ht/~kennylevinsen/greetd).
```
Usage: tuigreet [OPTIONS]
Options:
-h, --help show this usage information
-v, --version print version information
-c, --cmd COMMAND command to run
-s, --sessions DIRS colon-separated list of Wayland session paths
--session-wrapper 'CMD [ARGS]...'
wrapper command to initialize the non-X11 session
-x, --xsessions DIRS
colon-separated list of X11 session paths
--xsession-wrapper 'CMD [ARGS]...'
wrapper command to initialize X server and launch X11
sessions (default: startx /usr/bin/env)
--no-xsession-wrapper
do not wrap commands for X11 sessions
-w, --width WIDTH width of the main prompt (default: 80)
-i, --issue show the host's issue file
-g, --greeting GREETING
show custom text above login prompt
-t, --time display the current date and time
--time-format FORMAT
custom strftime format for displaying date and time
-r, --remember remember last logged-in username
--remember-session
remember last selected session
--remember-user-session
remember last selected session for each user
--user-menu allow graphical selection of users from a menu
--user-menu-min-uid UID
minimum UID to display in the user selection menu
--user-menu-max-uid UID
maximum UID to display in the user selection menu
--asterisks display asterisks when a secret is typed
--asterisks-char CHAR
character to be used to redact secrets (default: *)
--window-padding PADDING
padding inside the terminal area (default: 0)
--container-padding PADDING
padding inside the main prompt container (default: 1)
--prompt-padding PADDING
padding between prompt rows (default: 1)
--power-shutdown 'CMD [ARGS]...'
command to run to shut down the system
--power-reboot 'CMD [ARGS]...'
command to run to reboot the system
--power-no-setsid
do not prefix power commands with setsid
```
## Usage
The default configuration tends to be as minimal as possible, visually speaking, only showing the authentication prompts and some minor information in the status bar. You may print your system's `/etc/issue` at the top of the prompt with `--issue` and the current date and time with `--time` (and possibly customize it with `--time-format`). You may include a custom one-line greeting message instead of `/etc/issue` with `--greeting`.
The initial prompt container will be 80 column wide. You may change this with `--width` in case you need more space (for example, to account for large PAM challenge messages). Please refer to usage information (`--help`) for more customization options. Various padding settings are available through the `*-padding` options.
You can instruct `tuigreet` to remember the last username that successfully opened a session with the `--remember` option (that way, the username field will be pre-filled). Similarly, the command and session configuration can be retained between runs with the `--remember-session` option (when using this, the `--cmd` value is overridden by manual selections). You can also remember the selected session per user with the `--remember-user-session` flag. In this case, the selected session will only be saved on successful authentication.
You may change the command that will be executed after opening a session by hitting `F2` and amending the command. Alternatively, you can list the system-declared sessions (or custom ones) by hitting `F3`. Power options are available through `F12`.
## Install
### From source
Building from source requires an installation of Rust's `stable` toolchain, including `cargo`.
```
$ git clone https://github.com/apognu/tuigreet && cd tuigreet
$ cargo build --release
# mv target/release/tuigreet /usr/local/bin/tuigreet
```
Cache directory must be created for `--remember*` features to work. The directory must be owned by the user running the greeter.
```
# mkdir /var/cache/tuigreet
# chown greeter:greeter /var/cache/tuigreet
# chmod 0755 /var/cache/tuigreet
```
### From Arch Linux
On ArchLinux, `tuigreet` is available from the [extra](https://archlinux.org/packages/extra/x86_64/greetd-tuigreet/) repo and is installable through pacman:
```
$ pacman -S greetd-tuigreet
```
Two more distributions are available from the [AUR](https://aur.archlinux.org/packages?O=0&K=tuigreet): `greetd-tuigreet-bin` is the precompiled release for the latest tagged release of `tuigreet` and `greetd-tuigreet-git` is a rolling release always following the `master` branch of this repository.
Those can be installed via your preferred AUR helper.
### From Gentoo
On Gentoo, `tuigreet` is available as a package `gui-apps/tuigreet`:
```
$ emerge --ask --verbose gui-apps/tuigreet
```
### From NixOS
On NixOS `greetd` and `tuigreet` both available via `` main repository.
Please refer to the snippet below for the minimal `tuigreet` configuration:
```nix
{ pkgs, ... }:
{
services.greetd = {
enable = true;
settings = {
default_session = {
command = "${pkgs.greetd.tuigreet}/bin/tuigreet --time --cmd sway";
user = "greeter";
};
};
};
}
```
[More details](https://search.nixos.org/options?channel=unstable&show=services.greetd.settings&from=0&size=50&sort=relevance&query=greetd)
### Pre-built binaries
Pre-built binaries of `tuigreet` for several architectures can be found in the [releases](https://github.com/apognu/tuigreet/releases) section of this repository. The [tip prerelease](https://github.com/apognu/tuigreet/releases/tag/tip) is continuously built and kept in sync with the `master` branch.
## Configuration
Edit `/etc/greetd/config.toml` and set the `command` setting to use `tuigreet`:
```
[terminal]
vt = 1
[default_session]
command = "tuigreet --cmd sway"
user = "greeter"
```
Please refer to [greetd's wiki](https://man.sr.ht/~kennylevinsen/greetd/) for more information on setting up `greetd`.
### Sessions
The available sessions are fetched from `desktop` files in `/usr/share/xsessions` and `/usr/share/wayland-sessions`. If you want to provide custom directories, you can set the `--sessions` arguments with a colon-separated list of directories for `tuigreet` to fetch session definitions some other place.
#### Desktop environments
`greetd` only accepts environment-less commands to be used to start a session. Therefore, if your desktop environment requires either arguments or environment variables, you will need to create a wrapper script and refer to it in an appropriate desktop file.
For example, to run X11 Gnome, you may need to start it through `startx` and configure your `~/.xinitrc` (or an external `xinitrc` with a wrapper script):
```
exec gnome-session
```
To run Wayland Gnome, you would need to create a wrapper script akin to the following:
```
XDG_SESSION_TYPE=wayland dbus-run-session gnome-session
```
Then refer to your wrapper script in a custom desktop file (in a directory declared with the `-s/--sessions` option):
```
Name=Wayland Gnome
Exec=/path/to/my/wrapper.sh
```
#### Common wrappers
Two options allows you to automatically wrap run commands around sessions started from desktop files, depending on whether they come `/usr/share/wayland-sessions` or `/usr/share/xsessions`: `--sessions-wrapper` and `--xsessions-wrapper`. With this, you can prepend another command on front of the sessions you run to set up the required environment to run these kinds of sessions.
By default, unless you change it, all X11 sessions (those picked up from `/usr/share/xsessions`) are prepended with `startx /usr/bin/env`, so the X11 server is started properly.
### Power management
Two power actions are possible from `tuigreet`, shutting down (through `shutdown -h now`) and rebooting (with `shutdown -r now`) the machine. This requires that those commands be executable by regular users, which is not the case on some distros.
To alleviate this, there are two options that can be used to customize the commands that are run: `--power-shutdown` and `--power-reboot`. The provided commands must be non-interactive, meaning they will not be able to print anything or prompt for anything. If you need to use `sudo` or `doas`, they will need to be configured to run passwordless for those specific commands.
An example for `/etc/greetd/config.toml`:
```
[default_session]
command = "tuigreet --power-shutdown 'sudo systemctl poweroff'"
```
Note that, by default, all commands are prefixed with `setsid` to completely detach the command from our TTY. If you would prefer to run the commands as is, or if `setsid` does not exist on your system, you can use `--power-no-setsid`.
### User menu
Optionally, a user can be selected from a menu instead of typing out their name, with the `--user-menu` option, this will present all users returned by NSS at the time `tuigreet` was run, with a UID within the acceptable range. The values for the minimum and maximum UIDs are selected as follows, for each value:
* A user-provided value, through `--user-menu-min-uid` or `--user-menu-max-uid`;
* **Or**, the available values for `UID_MIN` or `UID_MAX` from `/etc/login.defs`;
* **Or**, hardcoded `1000` for minimum UID and `60000` for maximum UID.