Skip to content

Commit 5ec70be

Browse files
authored
Update api.rst
1 parent fa7e3f5 commit 5ec70be

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

docs/api.rst

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,19 @@
33
XML-RPC API Documentation
44
=========================
55

6-
To use the XML-RPC interface, connect to supervisor's HTTP port
6+
7+
8+
9+
10+
To use the XML-RPC interface, first make sure it has been configured
11+
properly by specifying the rpcinterface_factory in your conf file:
12+
13+
.. code-block:: ini
14+
15+
[rpcinterface:supervisor]
16+
supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface
17+
18+
Then you can connect to supervisor's HTTP port
719
with any XML-RPC client library and run commands against it. An
820
example of doing this using Python's ``xmlrpclib`` client library
921
is as follows.

0 commit comments

Comments
 (0)