Skip to content

Commit 43204a4

Browse files
committed
doc: Update XML-RPC documentation with example that points to demo
1 parent 5bab9d1 commit 43204a4

File tree

1 file changed

+14
-16
lines changed

1 file changed

+14
-16
lines changed

doc/xmlrpc.txt

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,19 @@ XML-RPC access to Roundup
77

88
Introduction
99
------------
10-
Version 1.4 of Roundup includes an XML-RPC frontend. Some installations find
11-
that roundup-admins requirement of local access to the tracker instance
12-
limiting. The XML-RPC frontend provides the ability to execute a limited subset
13-
of commands similar to those found in roundup-admin from remote machines.
10+
Version 1.4 of Roundup includes an XML-RPC frontend for remote access. The
11+
XML-RPC interface allows a limited subset of commands similar to those found in
12+
local `roundup-admin` tool.
1413

15-
There are two ways to access the xmlrpc interface:
14+
By default XML-RPC is accessible from ``/xmlrpc`` endpoint:
15+
16+
http://username:password@localhost:8000/xmlrpc
17+
18+
For demo tracker the URL would be:
19+
20+
http://localhost:8917/demo/xmlrpc
21+
22+
There are two ways to run the XML-RPC interface:
1623

1724
stand alone roundup-xmlrpc-server
1825

@@ -34,9 +41,7 @@ The default port is ``8000``. An alternative port can be specified with the
3441
accessing via roundup server
3542
----------------------------
3643
In addition to running a stand alone server described above, the
37-
xmlrpc service is available from the roundup HTTP server. Access it by
38-
sending text/xml data to the URL for the roundup tracker with the last
39-
component of the url set to 'xmlrpc'.
44+
XML-RPC service is available from the roundup HTTP server.
4045

4146
security consideration
4247
======================
@@ -103,7 +108,7 @@ sample python client
103108
::
104109

105110
>>> import xmlrpclib
106-
>>> roundup_server = xmlrpclib.ServerProxy('http://username:password@localhost:8000/xmlrpc', allow_none=True)
111+
>>> roundup_server = xmlrpclib.ServerProxy('http://admin:admin@localhost:8917/demo/xmlrpc', allow_none=True)
107112
>>> roundup_server.schema()
108113
{'user': [['username', '<roundup.hyperdb.String>'], ...], 'issue': [...]}
109114
>>> roundup_server.list('user')
@@ -129,10 +134,3 @@ sample python client
129134
[]
130135
>>> roundup_server.lookup('user','admin')
131136
'1'
132-
133-
If you are accessing the interface via the roundup HTTP server, a url
134-
similar to:
135-
136-
http://username:password@localhost:8000/tracker/xmlrpc
137-
138-
should be used.

0 commit comments

Comments
 (0)