Revision 5f5045b5 docs/installation.rst

b/docs/installation.rst
3 3

  
4 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 5

  
6

  
6 7
* Kamaki repository: `http://code.grnet.gr/git/kamaki <http://code.grnet.gr/git/kamaki>`_
7 8

  
8 9
* Synnefo Linux packages: `http://apt.dev.grnet.gr <http://apt.dev.grnet.gr>`_
......
10 11
Linux and Unix-like enviroments
11 12
-------------------------------
12 13

  
14
.. _installing-from-source-ref:
15

  
13 16
Installing from source (git repos.)
14 17
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
15 18

  
16
Setup a virtual enviroment (optional)
17
"""""""""""""""""""""""""""""""""""""
19
1. Setup a virtual enviroment (optional)
20
""""""""""""""""""""""""""""""""""""""""
21

  
22
With virtualenv users can setup kamaki and synnefo services in a sandbox environment.
18 23

  
19 24
.. code-block:: console
20 25

  
......
24 29

  
25 30
.. hint:: More about virtualenv: `<http://www.virtualenv.org>`_
26 31

  
27
Install snf-common from synnefo project (required since v0.6.1)
28
"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
32
2. Install snf-common from synnefo project (required since v0.6.0)
33
""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
34

  
35
Package snf-common is required since kamaki 0.6.0.
29 36

  
30 37
.. code-block:: console
31 38

  
......
37 44

  
38 45
    $ cd -
39 46

  
40
Install kamaki
41
""""""""""""""
47
3. Install kamaki
48
"""""""""""""""""
42 49

  
43 50
.. code-block:: console
44 51

  
......
48 55

  
49 56
    $ ./setup build install
50 57

  
51
Install progress and/or ansicolors (optional)
52
"""""""""""""""""""""""""""""""""""""""""""""
58
4. Install progress and/or ansicolors (optional)
59
""""""""""""""""""""""""""""""""""""""""""""""""
53 60

  
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>`_)
61
progress: command-line progress bars (in some commands)
62

  
63
ansicolors: color kamaki output (can switched on and off in `setup <setup.html>`_)
56 64

  
57 65
.. code-block:: console
58 66

  
......
63 71
Ubuntu and Debian packages
64 72
^^^^^^^^^^^^^^^^^^^^^^^^^^
65 73

  
66
Mac OS
67
------
74
The following steps describe a command-line approach, but any graphic package manager can be used instead.
75

  
76
1. Add the following to apt sources list
77
""""""""""""""""""""""""""""""""""""""""
78

  
79
* Debian::
80

  
81
    deb http://apt.dev.grnet.gr/ sid main
82

  
83
* Ubuntu::
84

  
85
    deb http://apt.dev.grnet.gr/ precise main
86

  
87
2. Update
88
"""""""""
89

  
90
.. code-block:: console
91

  
92
    $ sudo apt-get update
93

  
94
.. note:: Safely ignore a signature verification error like the following, if it emerges:
95

  
96
    .. warning:: GPG error: http://apt.dev.grnet.gr precise/sid InRelease: The following signatures couldn't be verified because the public key is not available: NO_PUBKEY XXXXXXXX
97

  
98
3. Install kamaki
99
"""""""""""""""""
100

  
101
Since version 0.6.0, the package snf-common (available at synnefo apt repository) will be automatically installed as a dependency.
102

  
103
.. code-block:: console
104

  
105
    $ sudo apt-get install kamaki
106

  
107
4. Install ansicolors and/or progress (Optional)
108
""""""""""""""""""""""""""""""""""""""""""""""""
109

  
110
.. code-block:: console
111

  
112
    $ sudo apt-get install python-ansicolors
113

  
114
    $ sudo apt-get install python-progress
115

  
116
Mac OS X
117
--------
118

  
119
Kamaki can be installed on Mac OS X systems from source, by following the steps at :ref:`installing-from-source-ref`.
68 120

  
69 121
Windows
70 122
-------
71 123

  
72
Installing from source (git repos.)
73
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
124
It has proven possible (and not too tricky) to install kamaki on Windows console using some auxiliary applications, but Windows users are not the target audience for the time being.

Also available in: Unified diff