colin/greetd
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

readme: Simplify now we have manpages

Browse Source
This commit is contained in:
Kenny Levinsen
2020-03-28 01:02:24 +01:00
parent 4b89180cfe
commit 7ed3f878a3
2 changed files with 24 additions and 137 deletions
Download Patch File Download Diff File Expand all files Collapse all files

159
README.md
View File

@@ -1,155 +1,42 @@
# greetd # greetd
Generic display manager, capable of anything from text-based login to shell (replacing agetty), to graphical login to a Wayland compositor (replacing GDM/lightdm/...). greetd is a minimal and flexible login manager daemon that makes no assumptions about what you want to launch.
Use [gtkgreet](https://git.sr.ht/~kennylevinsen/gtkgreet) to launch [sway](https://github.com/swaywm/sway) if you want a fully graphical session, or use `agreety` to launch a shell if you want a drop-in replacement for `agetty(8)` and `login(1)`.
If you can run it from your shell in a TTY, greetd can start it. If it can be taught to speak a simple JSON-based IPC protocol, then it can be a greeter.
## List of known greetd greeters ## List of known greetd greeters
- agreety - The simple, text-based greeter. - agreety - The simple, text-based greeter living in this repo is a simple example.
- gtkgreet - Simple GTK based greeter (xdg-shell or wlr-layer-shell, to be used with something like `cage`) - gtkgreet - The flagship graphical, GTK based greeter (xdg-shell or wlr-layer-shell, to be used with something like `cage`)
- dlm - Dumb Login Manager (using fbdev) - dlm - Dumb Login Manager (using fbdev)
- wlgreet - Wayland greeter (using wlr-layer-shell, to be used with something like `sway`) - wlgreet - Wayland greeter (using wlr-layer-shell, to be used with something like `sway`)
## Overview ----
greetd is a daemon which:
1. Launches a configured greeter of your choice.
2. Listens on a socket for a login message.
3. If the credentials are valid, terminates the greeter (if it didn't do so itself) and starts the requested session application.
4. When the session application terminates, the greeter is started once again.
All the greeter of choice needs to do is to be able to write a message to a socket. It could be anything from a simple terminal application to a fully-fledged desktop environment in which one of the applications present a user prompt. Of course, the same goes for the session the user logs into.
The greeter runs as a configured user, which is supposed to be one with no interesting privileges except for what the greeter itself needs to run.
## Included in the box:
### Binaries
- greetd, the daemon itself
- agreety, a simple agetty greeter clone.
- greet_proto, a protocol library in Rust. Don't worry if you don't use Rust, the protocol is very simple.
### Configuration files
- greeter.pam, a PAM service file that should be put as `/etc/pam.d/greeter`
- config.toml, a configuration file example
- greetd.service, a systemd service file example.
## Installation ## Installation
- `cp greeter.pam /etc/pam.d/greeter` ### From packages
- `cp greetd.service /etc/systemd/system/greetd.service`
- `mkdir /etc/greetd`
- `cp config.toml /etc/greetd/config.toml`
- Look in the configuration file `/etc/greetd/config.toml` and edit as appropriate.
- Start the greetd service.
## Dumb standalone demo greetd and a few greeters are available in AUR for Arch Linux.
(Requires the pam service installed) ### Manually from source
1. `sudo greetd --vt next --greeter "agreety" --greeter-user $LOGNAME` ```sh
2. Answer the questions (username, password, command), and `agreety` will be replaced by the command you typed if your login is successful. See the `agreety` and `greetd` help texts for more info # Compile greetd and agreety.
cargo build --release
# Protocol # Put things into place
sudo cp target/release/{greetd,agreety} /usr/local/bin/
sudo cp greetd.service /etc/systemd/system/greetd.service
mkdir /etc/greetd
cp config.toml /etc/greetd/config.toml
See `greet_proto` for detailed protocol information. # Look in the configuration file `/etc/greetd/config.toml` and edit as appropriate.
systemctl enable --now greetd
## Format
```
+--------------------+---------+
| payload_length u32 | payload |
+--------------------+---------+
``` ```
`payload_length` is native endianness, payload is JSON. ## How do I write my own greeter?
Requests and responses are encoded the same. All you need to do is an application that can speak the greetd IPC protocol, which is documented in `greetd-ipc(7)`. See gtkgreet or agreety for inspiration.
## Requests
### CreateSession
Create a new session for the given user. This may result in authentication questions.
```
{
"type": "create_session",
"username": "user"
}
```
### PostAuthMessageResponse
Answer an authentication question.
```
{
"type": "post_auth_message_response",
"response": "password"
}
```
### StartSession
Start a fully authenticated session.
```
{
"type": "start_session",
"cmd": ["sway"],
"env": [
"XDG_SESSION_TYPE=wayland",
"XDG_SESSION_DESKTOP=sway"
]
}
```
### CancelSession
Cancel a session being configured.
```
{
"type": "cancel_session"
}
```
## Response
### Success
The action was successful.
```
{
"type": "success",
}
```
### Error
The action failed.
```
{
"type": "error",
"error_type": "loginError",
"description": "..."
}
```
### AuthMessage
The action resulted in authentication questions.
```
{
"type": "auth_message",
"message": "Password:",
"message_type": "secret"
}
```

2
man/agreety-1.scd
View File

@@ -23,7 +23,7 @@ agreety - A text-based greeter for greetd
# DESCRIPTION # DESCRIPTION
agreety is the very simple text-based greeter, with an appearance similar to agreety is a very simple text-based greeter, with an appearance similar to
*agetty*(8) and *login*(1). It is bundled with *greetd*(1). *agetty*(8) and *login*(1). It is bundled with *greetd*(1).
To use agreety, configure it as your greeter in your greetd config file. To use agreety, configure it as your greeter in your greetd config file.