[krb5-auth-dialog] README: markdownify
- From: Guido Günther <guidog src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [krb5-auth-dialog] README: markdownify
- Date: Mon, 15 Feb 2021 13:02:45 +0000 (UTC)
commit 4c389965e574fc827a9832df73289b3c3fbebaaf
Author: Guido Günther <agx sigxcpu org>
Date: Mon Feb 15 13:40:35 2021 +0100
README: markdownify
Also update for meson.
README => README.md | 39 ++++++++++++++++++++++++++++++---------
1 file changed, 30 insertions(+), 9 deletions(-)
---
diff --git a/README b/README.md
similarity index 79%
rename from README
rename to README.md
index 65cb103..a7d7769 100644
--- a/README
+++ b/README.md
@@ -1,50 +1,68 @@
-krb5-auth-dialog is a simple dialog that monitors Kerberos tickets, and
-pops up a dialog when they are about to expire. Eventually, we expect
-it to be part of GNOME.
+[krb5-auth-dialog](https://gitlab.gnome.org/GNOME/krb5-auth-dialog/)
+is a simple dialog that monitors Kerberos tickets, and pops up a
+dialog when they are about to expire.
Configuration
=============
Configuration settings are handled via gsettings.
You can set the principal that is used to acquire tickets via:
+
+```sh
gsettings set org.gnome.KrbAuthDialog principal "principal@YOUR.REALM"
+```
You can set the time of the first password prompt via:
+
+```sh
gsettings set org.gnome.KrbAuthDialog prompt-minutes 30
+```
You can set the principals pkinit identifier via:
+
+```sh
gsettings set org.gnome.KrbAuthDialog pk-userid "FILE:/path/to/user.pem,/path/to/user.key"
+```
or if you're using a smartcard:
+
+```sh
gsettings set org.gnome.KrbAuthDialog pk-userid "PKCS11:/usr/lib/opensc/opensc-pkcs11.so"
+```
DBus API
========
You can request a ticket granting ticket via DBus:
+```sh
dbus-send --print-reply --type=method_call \
--dest=org.gnome.KrbAuthDialog \
/org/gnome/KrbAuthDialog \
org.gnome.KrbAuthDialog.acquireTgt \
string:'principal'
+```
If the sent principal doesn't match the one currently in the ticket cache the
request fails. To request a TGT for the "default" principal use string:''.
-See examples/tgt-signals.py for information about sent DBus signals.
-
+See [examples/tgt-signals.py](examples/tgt-signals.py) for information
+about sent DBus signals.
Plugins
=======
Plugins are currently disabled by default. Individual plugins can be enabled via gsettings:
Enable pam and dummy plugions:
-.
+
+```
gsettings set org.gnome.KrbAuthDialog.plugins enabled "['pam', 'dummy']"
+```
To list currently enabled plugins:
-gsettings get org.gnome.KrbAuthDialog.plugins enabled
+```
+gsettings get org.gnome.KrbAuthDialog.plugins enabled
+```
A Note on Translations
======================
@@ -56,7 +74,10 @@ Kerberos gets translated.
If your language doesn't have a translation yet and you want to provide one do a
- cd po; make krb5-auth-dialog.pot
+```
+ meson . _build
+ ninja -C _build krb5-auth-dialog-update-po
+```
-in the unpacked source tree to get a template of translatable strings.
+in the source tree to get a template of translatable strings.
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]