Mercurial > p > roundup > code
diff doc/xmlrpc.txt @ 4678:23de24f57566
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 |
line wrap: on
line diff
--- a/doc/xmlrpc.txt Sun Nov 25 18:07:58 2012 -0500 +++ b/doc/xmlrpc.txt Sun Nov 25 18:24:28 2012 -0500 @@ -11,9 +11,16 @@ limiting. The XML-RPC frontend provides the ability to execute a limited subset of commands similar to those found in roundup-admin from remote machines. -roundup-xmlrpc-server +There are two ways to access the xmlrpc interface: + + stand alone roundup-xmlrpc-server + + access via the roundup server + + +stand alone roundup-xmlrpc-server --------------------- -The Roundup XML-RPC server must be started before remote clients can access the +The Roundup XML-RPC standalone server must be started before remote clients can access the tracker via XML-RPC. ``roundup-xmlrpc-server`` is installed in the scripts directory alongside ``roundup-server`` and roundup-admin``. When invoked, the location of the tracker instance must be specified. @@ -23,6 +30,13 @@ The default port is ``8000``. An alternative port can be specified with the ``--port`` switch. +accessing via roundup server +---------------------------- +In addition to running a stand alone server described above, the +xmlrpc service is available from the roundup HTTP server. Access it by +sending text/xml data to the URL for the roundup tracker with the last +component of the url set to 'xmlrpc'. + security consideration ====================== Note that the current ``roundup-xmlrpc-server`` implementation does not @@ -108,3 +122,10 @@ [] >>> roundup_server.lookup('user','admin') '1' + +If you are accessing the interface via the roundup HTTP server, a url +similar to: + + http://username:password@localhost:8000/tracker/xmlrpc + +should be used.