← Back to branch summary

~jocave/checkbox/hybrid-amd-gpu-mods

« back to all changes in this revision

Viewing changes to plainbox/docs/install.rst

  • Committer: Zygmunt Krynicki
  • Date: 2013-05-17 13:54:25 UTC
  • mto: This revision was merged to the branch mainline in revision 2130.
  • Revision ID: zygmunt.krynicki@canonical.com-20130517135425-cxcenxx5t0qrtbxd
checkbox-ng: add CheckBoxNG sub-project

CheckBoxNG (or lowercase as checkbox-ng, pypi:checkbox-ng) is a clean
implementation of CheckBox on top of PlainBox. It provides a new
executable, 'checkbox' that has some of the same commands that were
previously implemented in the plainbox package.

In particular CheckBoxNG comes with the 'checkbox sru' command
(the same one as in plainbox). Later on this sub-command will be removed
from plainbox.

CheckBoxNG depends on plainbox >= 0.3

Signed-off-by: Zygmunt Krynicki <zygmunt.krynicki@canonical.com>

Show diffs side-by-side

added added

removed removed

Lines of Context:
plainbox/docs/install.rst
1
 
Installation
2
 
============
3
 
 
4
 
Debian Jessie and Ubuntu 14.04
5
 
------------------------------
6
 
 
7
 
You can install :term:`Plainbox` straight from the archive:
8
 
 
9
 
.. code-block:: bash
10
 
 
11
 
    $ sudo apt-get install plainbox
12
 
 
13
 
Ubuntu (Development PPA)
14
 
------------------------
15
 
 
16
 
Plainbox can be installed from a :abbr:`PPA (Personal Package Archive)` on
17
 
Ubuntu Precise (12.04) or newer.
18
 
 
19
 
.. code-block:: bash
20
 
 
21
 
    $ sudo add-apt-repository ppa:checkbox-dev/ppa && sudo apt-get update && sudo apt-get install plainbox
22
 
 
23
 
From python package index
24
 
-------------------------
25
 
 
26
 
Plainbox can be installed from :abbr:`pypi (python package index)`. Keep in
27
 
mind that you will need python3 version of ``pip``:
28
 
 
29
 
.. code-block:: bash
30
 
 
31
 
    $ pip3 install plainbox
32
 
 
33
 
We recommend using virtualenv or installing with the ``--user`` option.
34
 
 
35
 
From a .snap (for Ubuntu Snappy)
36
 
--------------------------------
37
 
 
38
 
You can build a local version of plainbox.snap and install it on any snappy
39
 
device (it is architecture independent for now, it doesn't bundle python
40
 
itself). You will have to have access to the checkbox source repository for
41
 
this.
42
 
 
43
 
.. code-block:: bash
44
 
 
45
 
    $ bzr branch lp:checkbox
46
 
    $ cd checkbox/plainbox/
47
 
    $ make
48
 
 
49
 
This will give you a new .snap file in the ``dist/`` directory. You can install
50
 
that snappy on a physical or virtual machine running snappy with the
51
 
``snappy-remote`` tool. Note that you will have to have the latest version of
52
 
the tool only available in the snappy PPA at this time. Refer to `snappy
53
 
umentation <https://developer.ubuntu.com/en/snappy/start/>`_ for details.
54
 
 
55
 
If you followed snappy documentation to run an amd64 image in kvm you can try
56
 
this code snippet to get started. Note that you can pass the use ``-snapshot``
57
 
option to kvm to make all the disk changes temporary. This will let you make
58
 
destructive changes inside the image without having to re-create the original
59
 
image each time.
60
 
 
61
 
.. code-block:: bash
62
 
 
63
 
    wget http://releases.ubuntu.com/15.04/ubuntu-15.04-snappy-amd64-generic.img.xz
64
 
    unxz ubuntu-15.04-snappy-amd64-generic.img.xz
65
 
    kvm -snapshot -m 512 -redir :8090::80 -redir :8022::22 ubuntu-15.04-snappy-amd64-generic.img
66
 
    snappy-remote --url=ssh://localhost:8022 install plainbox_0.22.dev0_all.snap
67
 
 
68
 
The password for the ``ubuntu`` user is ``ubuntu``. After installing you can
69
 
log in (or use the KVM window) and invoke the ``plainbox.plainbox`` executable
70
 
directly.