diff doc/xmlrpc.txt @ 4936:eeb9572b0508

doc: Update XML-RPC documentation with example that points to demo
author anatoly techtonik <techtonik@gmail.com>
date Thu, 02 Oct 2014 21:26:37 +0300
parents f47c35727b3e
children 47cc50617e19
line wrap: on
line diff
--- a/doc/xmlrpc.txt	Thu Oct 02 16:57:28 2014 +0300
+++ b/doc/xmlrpc.txt	Thu Oct 02 21:26:37 2014 +0300
@@ -7,12 +7,19 @@
 
 Introduction
 ------------
-Version 1.4 of Roundup includes an XML-RPC frontend. Some installations find
-that roundup-admins requirement of local access to the tracker instance
-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. 
+Version 1.4 of Roundup includes an XML-RPC frontend for remote access. The
+XML-RPC interface allows a limited subset of commands similar to those found in
+local `roundup-admin` tool.
+
+By default XML-RPC is accessible from ``/xmlrpc`` endpoint:
 
-There are two ways to access the xmlrpc interface:
+    http://username:password@localhost:8000/xmlrpc
+
+For demo tracker the URL would be:
+
+    http://localhost:8917/demo/xmlrpc
+
+There are two ways to run the XML-RPC interface:
 
   stand alone roundup-xmlrpc-server
 
@@ -34,9 +41,7 @@
 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'.
+XML-RPC service is available from the roundup HTTP server.
 
 security consideration
 ======================
@@ -103,7 +108,7 @@
 ::
 
         >>> import xmlrpclib
-        >>> roundup_server = xmlrpclib.ServerProxy('http://username:password@localhost:8000/xmlrpc', allow_none=True)
+        >>> roundup_server = xmlrpclib.ServerProxy('http://admin:admin@localhost:8917/demo/xmlrpc', allow_none=True)
         >>> roundup_server.schema()
         {'user': [['username', '<roundup.hyperdb.String>'], ...], 'issue': [...]}
         >>> roundup_server.list('user')
@@ -129,10 +134,3 @@
         []
         >>> 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.

Roundup Issue Tracker: http://roundup-tracker.org/