Mercurial > p > roundup > code
comparison doc/xmlrpc.txt @ 4939:47cc50617e19
doc/xmlrpc: Fix headers
| author | anatoly techtonik <techtonik@gmail.com> |
|---|---|
| date | Sun, 05 Oct 2014 15:27:34 +0300 |
| parents | eeb9572b0508 |
| children | ade4bbc2716d |
comparison
equal
deleted
inserted
replaced
| 4938:27f592f3d696 | 4939:47cc50617e19 |
|---|---|
| 17 | 17 |
| 18 For demo tracker the URL would be: | 18 For demo tracker the URL would be: |
| 19 | 19 |
| 20 http://localhost:8917/demo/xmlrpc | 20 http://localhost:8917/demo/xmlrpc |
| 21 | 21 |
| 22 Enabling XML-RPC server | |
| 23 ----------------------- | |
| 22 There are two ways to run the XML-RPC interface: | 24 There are two ways to run the XML-RPC interface: |
| 23 | 25 |
| 24 stand alone roundup-xmlrpc-server | 26 stand alone roundup-xmlrpc-server |
| 25 | 27 |
| 26 access via the roundup server | 28 through roundup itself |
| 27 | 29 |
| 28 | |
| 29 stand alone roundup-xmlrpc-server | 30 stand alone roundup-xmlrpc-server |
| 30 --------------------------------- | 31 --------------------------------- |
| 31 The Roundup XML-RPC standalone server must be started before remote clients can access the | 32 The Roundup XML-RPC standalone server must be started before remote clients can access the |
| 32 tracker via XML-RPC. ``roundup-xmlrpc-server`` is installed in the scripts | 33 tracker via XML-RPC. ``roundup-xmlrpc-server`` is installed in the scripts |
| 33 directory alongside ``roundup-server`` and roundup-admin``. When invoked, the | 34 directory alongside ``roundup-server`` and roundup-admin``. When invoked, the |
| 36 roundup-xmlrpc-server -i ``/path/to/tracker`` | 37 roundup-xmlrpc-server -i ``/path/to/tracker`` |
| 37 | 38 |
| 38 The default port is ``8000``. An alternative port can be specified with the | 39 The default port is ``8000``. An alternative port can be specified with the |
| 39 ``--port`` switch. | 40 ``--port`` switch. |
| 40 | 41 |
| 41 accessing via roundup server | 42 through roundup |
| 42 ---------------------------- | 43 --------------- |
| 43 In addition to running a stand alone server described above, the | 44 In addition to running a stand alone server described above, the |
| 44 XML-RPC service is available from the roundup HTTP server. | 45 XML-RPC service is available from the roundup HTTP server. |
| 45 | 46 |
| 46 security consideration | 47 security consideration |
| 47 ====================== | 48 ---------------------- |
| 48 Note that the current ``roundup-xmlrpc-server`` implementation does not | 49 Note that the current ``roundup-xmlrpc-server`` implementation does not |
| 49 support SSL. This means that usernames and passwords will be passed in | 50 support SSL. This means that usernames and passwords will be passed in |
| 50 cleartext unless the server is being proxied behind another server (such as | 51 cleartext unless the server is being proxied behind another server (such as |
| 51 Apache or lighttpd) that provide SSL. | 52 Apache or lighttpd) that provide SSL. |
| 52 | 53 |
| 53 client API | 54 |
| 55 Client API | |
| 54 ---------- | 56 ---------- |
| 55 The server currently implements four methods. Each method requires that the | 57 The server currently implements four methods. Each method requires that the |
| 56 user provide a username and password in the HTTP authorization header in order | 58 user provide a username and password in the HTTP authorization header in order |
| 57 to authenticate the request against the tracker. | 59 to authenticate the request against the tracker. |
| 58 | 60 |