summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYoni Rabkin <yoni@rabkins.net>2020-11-16 18:17:19 -0500
committerYoni Rabkin <yoni@rabkins.net>2020-11-16 18:17:19 -0500
commitf586e7dbdcc87f4086d54d755da7126f55dbb5af (patch)
treeb0bdec80624a49ed982035971af6af3602a1af67
parenta5d763421c819fbbc174215d25862b739fae3ee8 (diff)
* doc/rt-liber.texinfo: update manualauth-source
-rw-r--r--doc/rt-liber.texinfo25
-rw-r--r--rt-liber.info58
2 files changed, 58 insertions, 25 deletions
diff --git a/doc/rt-liber.texinfo b/doc/rt-liber.texinfo
index b8cb1f5..0436425 100644
--- a/doc/rt-liber.texinfo
+++ b/doc/rt-liber.texinfo
@@ -140,6 +140,25 @@ Tell rt-liberation where to find the RT server's REST interface:
(setq rt-liber-rest-url "rt.example.org")
@end lisp
+In order to authenticate with the RT server instance you need to
+provide credentials. rt-liberation looks for these in the variables
+@var{rt-liber-rest-username} and @var{rt-liber-rest-password}. You can
+set these directly:
+
+@lisp
+(setq rt-liber-rest-username "someuser"
+ rt-liber-rest-password "somepassword")
+@end lisp
+
+You can also leave these values unset (@code{nil}), in which case
+rt-liberation will look for the credentials in a Netrc file via the
+auth-source library (see: @xref{Top,,, auth, Emacs auth-source}),
+under the machine name "rt-liberation":
+
+@example
+machine rt-liberation login someuser password somepassword
+@end example
+
rt-liberation can issue a command to ``take'' a ticket (that is,
assign it to yourself). For this the variable @var{rt-liber-username}
must be set:
@@ -148,9 +167,9 @@ must be set:
(setq rt-liber-username "someuser")
@end lisp
-rt-liberation can also launch a Web browser to visit a ticket. For
-that to work the base URL needs to be set in
-@var{rt-liber-base-url}. For example:
+rt-liberation can launch a Web browser to visit a ticket. For that to
+work the base URL needs to be set in @var{rt-liber-base-url}. For
+example:
(setq rt-liber-base-url "https://rt.foo.org/")
diff --git a/rt-liber.info b/rt-liber.info
index f712b66..d227b86 100644
--- a/rt-liber.info
+++ b/rt-liber.info
@@ -116,14 +116,28 @@ file, or similar.
(setq rt-liber-rest-url "rt.example.org")
+ In order to authenticate with the RT server instance you need to
+provide credentials. rt-liberation looks for these in the variables
+RT-LIBER-REST-USERNAME and RT-LIBER-REST-PASSWORD. You can set these
+directly:
+
+ (setq rt-liber-rest-username "someuser"
+ rt-liber-rest-password "somepassword")
+
+ You can also leave these values unset ('nil'), in which case
+rt-liberation will look for the credentials in a Netrc file via the
+auth-source library (see: *Note (auth)Top::), under the machine name
+"rt-liberation":
+
+ machine rt-liberation login someuser password somepassword
+
rt-liberation can issue a command to "take" a ticket (that is, assign
it to yourself). For this the variable RT-LIBER-USERNAME must be set:
(setq rt-liber-username "someuser")
- rt-liberation can also launch a Web browser to visit a ticket. For
-that to work the base URL needs to be set in RT-LIBER-BASE-URL. For
-example:
+ rt-liberation can launch a Web browser to visit a ticket. For that
+to work the base URL needs to be set in RT-LIBER-BASE-URL. For example:
(setq rt-liber-base-url "https://rt.foo.org/")
@@ -2019,24 +2033,24 @@ Tag Table:
Node: Top680
Node: Introduction2956
Node: Installation3563
-Node: Queries4542
-Node: Query Compiler5104
-Node: Query Language5745
-Node: Ticket Browser8184
-Node: Ticket Browser Display10656
-Node: Ticket Browser Sorting12647
-Node: Ticket Browser Filtering14597
-Node: Multiple Ticket Browsers16140
-Node: Ticket Viewer17309
-Node: Gnus Integration19481
-Node: Tracking Updates21769
-Node: Batch Operations22846
-Node: Local Storage24026
-Node: Copying25104
-Node: The GNU FDL62653
-Node: Concept Index85045
-Node: Function Index86626
-Node: Variable Index89976
-Node: Keybinding Index90352
+Node: Queries5135
+Node: Query Compiler5697
+Node: Query Language6338
+Node: Ticket Browser8777
+Node: Ticket Browser Display11249
+Node: Ticket Browser Sorting13240
+Node: Ticket Browser Filtering15190
+Node: Multiple Ticket Browsers16733
+Node: Ticket Viewer17902
+Node: Gnus Integration20074
+Node: Tracking Updates22362
+Node: Batch Operations23439
+Node: Local Storage24619
+Node: Copying25697
+Node: The GNU FDL63246
+Node: Concept Index85638
+Node: Function Index87219
+Node: Variable Index90569
+Node: Keybinding Index90945

End Tag Table