Mercurial > p > roundup > code

comparison doc/xmlrpc.txt @ 4678:23de24f57566

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
issue2550749 - the xmlrpc interface is invoked on content type and not url path. Sending any text/xml data to roundup results in invoking the xml-rpc interface, but a REST or other interface could also consume xml data and do something different. So require the use of 'http(s)://.../xmlrpc' uri to trigger the xmlrpc interface.
author rouilj
date Sun, 25 Nov 2012 18:24:28 -0500
parents 3f251efd5f48
children 8ee41c7372e7
comparison
equal deleted inserted replaced
4677:3cf77c30697e 4678:23de24f57566
9 Version 1.4 of Roundup includes an XML-RPC frontend. Some installations find 9 Version 1.4 of Roundup includes an XML-RPC frontend. Some installations find
10 that roundup-admins requirement of local access to the tracker instance 10 that roundup-admins requirement of local access to the tracker instance
11 limiting. The XML-RPC frontend provides the ability to execute a limited subset 11 limiting. The XML-RPC frontend provides the ability to execute a limited subset
12 of commands similar to those found in roundup-admin from remote machines. 12 of commands similar to those found in roundup-admin from remote machines.
13 13
14 roundup-xmlrpc-server 14 There are two ways to access the xmlrpc interface:
15
16 stand alone roundup-xmlrpc-server
17
18 access via the roundup server
19
20
21 stand alone roundup-xmlrpc-server
15 --------------------- 22 ---------------------
16 The Roundup XML-RPC server must be started before remote clients can access the 23 The Roundup XML-RPC standalone server must be started before remote clients can access the
17 tracker via XML-RPC. ``roundup-xmlrpc-server`` is installed in the scripts 24 tracker via XML-RPC. ``roundup-xmlrpc-server`` is installed in the scripts
18 directory alongside ``roundup-server`` and roundup-admin``. When invoked, the 25 directory alongside ``roundup-server`` and roundup-admin``. When invoked, the
19 location of the tracker instance must be specified. 26 location of the tracker instance must be specified.
20 27
21 roundup-xmlrpc-server -i ``/path/to/tracker`` 28 roundup-xmlrpc-server -i ``/path/to/tracker``
22 29
23 The default port is ``8000``. An alternative port can be specified with the 30 The default port is ``8000``. An alternative port can be specified with the
24 ``--port`` switch. 31 ``--port`` switch.
32
33 accessing via roundup server
34 ----------------------------
35 In addition to running a stand alone server described above, the
36 xmlrpc service is available from the roundup HTTP server. Access it by
37 sending text/xml data to the URL for the roundup tracker with the last
38 component of the url set to 'xmlrpc'.
25 39
26 security consideration 40 security consideration
27 ====================== 41 ======================
28 Note that the current ``roundup-xmlrpc-server`` implementation does not 42 Note that the current ``roundup-xmlrpc-server`` implementation does not
29 support SSL. This means that usernames and passwords will be passed in 43 support SSL. This means that usernames and passwords will be passed in
106 [] 120 []
107 >>> roundup_server.filter('user',[],{'username':'adm'}) 121 >>> roundup_server.filter('user',[],{'username':'adm'})
108 [] 122 []
109 >>> roundup_server.lookup('user','admin') 123 >>> roundup_server.lookup('user','admin')
110 '1' 124 '1'
125
126 If you are accessing the interface via the roundup HTTP server, a url
127 similar to:
128
129 http://username:password@localhost:8000/tracker/xmlrpc
130
131 should be used.
Roundup Issue Tracker: http://roundup-tracker.org/