bc2001c0ac83f481bc729dc180e254b2299486b2
[kamaki] / docs / installation.rst
1 Installation
2 ============
3
4 This guide describes the standard installation process for kamaki, with the aspiration of covering as much cases as possible. Although kamaki was initially targeted to advanced Linux/Unix-like users, it should be quite straightforward to install and have it up and running in most popular platforms.
5
6 * Kamaki repository: `http://code.grnet.gr/git/kamaki <http://code.grnet.gr/git/kamaki>`_
7
8 * Synnefo Linux packages: `http://apt.dev.grnet.gr <http://apt.dev.grnet.gr>`_
9
10 Linux and Unix-like enviroments
11 -------------------------------
12
13 Installing from source (git repos.)
14 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
15
16 Setup a virtual enviroment (optional)
17 """""""""""""""""""""""""""""""""""""
18
19 .. code-block:: console
20
21     $ virtualenv kamaki-env
22
23     $ source kamaki-env/bin/activate
24
25 .. hint:: More about virtualenv: `<http://www.virtualenv.org>`_
26
27 Install snf-common from synnefo project (required since v0.6.1)
28 """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
29
30 .. code-block:: console
31
32     $ git clone http://code.grnet.gr/git/synnefo
33
34     $ cd synnefo/snf-common
35
36     $ ./setup build install
37
38     $ cd -
39
40 Install kamaki
41 """"""""""""""
42
43 .. code-block:: console
44
45     $ git clone http://code.grnet.gr/git/kamaki
46
47     $ cd kamaki
48
49     $ ./setup build install
50
51 Install progress and/or ansicolors (optional)
52 """""""""""""""""""""""""""""""""""""""""""""
53
54 |Progress: Allows command-line progress bars in some commands
55 |Ansicolors: Colors at kamaki output (can switched on and off in `setup <setup.html>`_)
56
57 .. code-block:: console
58
59     $ pip install progress
60
61     $ pip install ansicolors
62
63 Ubuntu and Debian packages
64 ^^^^^^^^^^^^^^^^^^^^^^^^^^
65
66 Mac OS
67 ------
68
69 Windows
70 -------
71
72 Installing from source (git repos.)
73 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^