cdist configuration management Latest manual: Home page:
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

117 lines
2.6 KiB

How to install cdist
Source Host
This is the machine you use to configure the target hosts.
* /bin/sh: A posix like shell (for instance bash, dash, zsh)
* Python >= 3.2
* SSH client
* sphinx (for building html docs and/or the manpages)
Target Hosts
* /bin/sh: A posix like shell (for instance bash, dash, zsh)
* SSH server
Install cdist
You can install cdist either from git or as a python package.
From git
Cloning cdist from git gives you the advantage of having
a version control in place for development of your own stuff
To install cdist, execute the following commands:
.. code-block:: sh
git clone
cd cdist
export PATH=$PATH:$(pwd -P)/bin
Available versions in git
* The active development takes place in the **master** branch
* The released versions can be found in the tags
Other branches may be available for features or bugfixes, but they
may vanish at any point. To select a specific branch use
.. code-block:: sh
# Generic code
git checkout -b <localbranchname> origin/<branchname>
So for instance if you want to use and stay with version 4.1, you can use
.. code-block:: sh
git checkout -b 4.1 origin/4.1
Git mirrors
If the main site is down, you can acquire cdist from one of the following sites:
* git:// `github <>`_
* git:// `sourceforge <>`_
Building and using manpages
If you want to build and use the manpages, run:
.. code-block:: sh
make man
export MANPATH=$MANPATH:$(pwd -P)/docs/dist/man
Or you can move manpages from docs/dist/man directory to some
other directory and add it to MANPATH.
You can also build manpages for types in your ~/.cdist directory:
.. code-block:: sh
make dotman
Built manpages are now in docs/dist/man directory. If you have
some other custom .cdist directory, e.g. /opt/cdist then use:
.. code-block:: sh
DOT_CDIST_PATH=/opt/cdist make dotman
Building and using HTML documentation
If you want to build and use HTML documentation, run:
.. code-block:: sh
make html
Now you can access docs/dist/html/index.html.
Python package
Cdist is available as a python package at
`PyPi <>`_. You can install it using
.. code-block:: sh
pip install cdist