salt/doc/topics/quickstart.rst
2013-04-09 15:53:02 -06:00

49 lines
1.1 KiB
ReStructuredText

===================
salt-api Quickstart
===================
:program:`salt-api` manages :term:`netapi modules` which are modules that
(usually) bind to a port and start a service. Each netapi module will have
specific requirements for third-party libraries and configuration (which goes
in the master config file). Read the documentation for each netapi module to
determine what is needed.
For example, the :py:mod:`rest_cherrypy <saltapi.netapi.rest_cherrypy.app>`
netapi module requires that CherryPy be installed and that a ``rest_cherrypy``
section be added to the master config that specifies which port to listen on.
Installation
============
PyPI
----
https://pypi.python.org/pypi/salt-api
::
pip install salt-api
RHEL, Fedora, CentOS
--------------------
RPMs are available in the Fedora repositories and EPEL::
yum install salt-api
Ubuntu
------
PPA packages available for Ubuntu on LaunchPad::
sudo add-apt-repository ppa:saltstack/salt
sudo apt-get update
sudo apt-get install salt-api
openSUSE, SLES
--------------
RPMs are available via the OBS::
zypper install salt-api