Commit 5f5045b5 authored by Stavros Sachtouris's avatar Stavros Sachtouris
Browse files

Installation guide

parent 2151584b
......@@ -3,6 +3,7 @@ Installation
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.
* Kamaki repository: `http://code.grnet.gr/git/kamaki <http://code.grnet.gr/git/kamaki>`_
* Synnefo Linux packages: `http://apt.dev.grnet.gr <http://apt.dev.grnet.gr>`_
......@@ -10,11 +11,15 @@ This guide describes the standard installation process for kamaki, with the aspi
Linux and Unix-like enviroments
-------------------------------
.. _installing-from-source-ref:
Installing from source (git repos.)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Setup a virtual enviroment (optional)
"""""""""""""""""""""""""""""""""""""
1. Setup a virtual enviroment (optional)
""""""""""""""""""""""""""""""""""""""""
With virtualenv users can setup kamaki and synnefo services in a sandbox environment.
.. code-block:: console
......@@ -24,8 +29,10 @@ Setup a virtual enviroment (optional)
.. hint:: More about virtualenv: `<http://www.virtualenv.org>`_
Install snf-common from synnefo project (required since v0.6.1)
"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
2. Install snf-common from synnefo project (required since v0.6.0)
""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
Package snf-common is required since kamaki 0.6.0.
.. code-block:: console
......@@ -37,8 +44,8 @@ Install snf-common from synnefo project (required since v0.6.1)
$ cd -
Install kamaki
""""""""""""""
3. Install kamaki
"""""""""""""""""
.. code-block:: console
......@@ -48,11 +55,12 @@ Install kamaki
$ ./setup build install
Install progress and/or ansicolors (optional)
"""""""""""""""""""""""""""""""""""""""""""""
4. Install progress and/or ansicolors (optional)
""""""""""""""""""""""""""""""""""""""""""""""""
|Progress: Allows command-line progress bars in some commands
|Ansicolors: Colors at kamaki output (can switched on and off in `setup <setup.html>`_)
progress: command-line progress bars (in some commands)
ansicolors: color kamaki output (can switched on and off in `setup <setup.html>`_)
.. code-block:: console
......@@ -63,11 +71,54 @@ Install progress and/or ansicolors (optional)
Ubuntu and Debian packages
^^^^^^^^^^^^^^^^^^^^^^^^^^
Mac OS
------
The following steps describe a command-line approach, but any graphic package manager can be used instead.
1. Add the following to apt sources list
""""""""""""""""""""""""""""""""""""""""
* Debian::
deb http://apt.dev.grnet.gr/ sid main
* Ubuntu::
deb http://apt.dev.grnet.gr/ precise main
2. Update
"""""""""
.. code-block:: console
$ sudo apt-get update
.. note:: Safely ignore a signature verification error like the following, if it emerges:
.. 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
3. Install kamaki
"""""""""""""""""
Since version 0.6.0, the package snf-common (available at synnefo apt repository) will be automatically installed as a dependency.
.. code-block:: console
$ sudo apt-get install kamaki
4. Install ansicolors and/or progress (Optional)
""""""""""""""""""""""""""""""""""""""""""""""""
.. code-block:: console
$ sudo apt-get install python-ansicolors
$ sudo apt-get install python-progress
Mac OS X
--------
Kamaki can be installed on Mac OS X systems from source, by following the steps at :ref:`installing-from-source-ref`.
Windows
-------
Installing from source (git repos.)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.
......@@ -622,7 +622,7 @@ Permanent history is implemented as a command group and is common to both the on
Tab completion
^^^^^^^^^^^^^^
Kamaki shell features tab completion for the first level of command terms of the current context. Tab completion pool changes dynamically when the context is switched. Currently, tab completion is not supported when the / detour is used (see :ref:accessing-top-level-commands-ref ).
Kamaki shell features tab completion for the first level of command terms of the current context. Tab completion pool changes dynamically when the context is switched. Currently, tab completion is not supported when the / detour is used (see :ref:`accessing-top-level-commands-ref` ).
OS Shell integration
^^^^^^^^^^^^^^^^^^^^
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment