Skip to content

Commit 3de5f2e

Browse files
committed
Merge pull request docker-library#10 from htgoebel/install-guide
Updates to the Installation guide.
2 parents 3ce7f96 + fbb637e commit 3de5f2e

File tree

1 file changed

+50
-29
lines changed

1 file changed

+50
-29
lines changed

docs/installation.rst

Lines changed: 50 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -4,57 +4,78 @@ Installation
44
Installing Dependencies
55
^^^^^^^^^^^^^^^^^^^^^^^^
66

7-
DebOps requires a dependency that is not installed by Ansible. Install
8-
``netaddr`` however you see fit::
7+
DebOps requires a dependency that is not already installed by Ansible.
8+
Install ``netaddr`` however you see fit:
99

10-
$ apt-get install python-netaddr
11-
$ yum install python-netaddr
10+
$ apt-get install python-pip python-netaddr
11+
$ yum install python-pip python-netaddr
1212
$ pip install netaddr
13-
$ easy_install netaddr
1413

1514

1615

1716
Installing the DebOps scripts
1817
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1918

20-
Download and install the scripts. As long as there is no release with
21-
a officially declared version number we suggest cloning the git
22-
repository. This makes it easy to update later::
19+
The easiest way to install DebOps is::
2320

24-
$ git clone https://github.com/debops/debops
25-
$ cd debops
21+
$ sudo pip install debops
22+
$ debops-update
2623

27-
If you dont have Ansible installed, the bootstrap-ansible.sh can do it
28-
for you::
24+
If you don't have Ansible installed, the script
25+
``bootstrap-ansible.sh`` can do it for you::
2926
3027
$ ./misc/scripts/bootstrap-ansible.sh v1.8.2
3128

32-
This installs version 1.8.2. Without version pin, the newest will be installed.
29+
This installs version 1.8.2. Without version pin, the newest version
30+
will be installed.
3331

34-
Choose, who you want DebOps to be installed:
3532

36-
* System-wide into /usr/local::
33+
Other commonly used choices on how to install DebOps:
3734

38-
sudo make install
35+
* Install the scripts into your own ``~/bin``::
3936

40-
* System-wide into /opt/debops:
41-
This would allow passing ownership of
42-
the installation to some DebOps-operator. Mind to include
43-
``/opt/debops/bin`` into your ``PATH``.
37+
$ pip install --user debops
38+
$ debops-update
4439

45-
::
40+
For more installation options please have a look at the `pip User Guide
41+
<https://pip.pypa.io/en/latest/user_guide.html>`_.
4642

47-
sudo make install PREFIX=/opt/debops
48-
sudo chown -R debops:debops /opt/debops
4943

50-
* Scripts into /usr/bin, playbooks and roles into $HOME: This has the
51-
advantage that every user can have her own set of roles and
52-
playbooks.
44+
Installing the current development version
45+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5346

54-
::
47+
If you want to install the current development version of DebOps,
48+
choose one off::
49+
50+
$ sudo pip install https://github.com/debops/debops/archive/master.zip
51+
52+
53+
If you want to help working on DebOps, it's best to check out the
54+
scripts from github::
55+
56+
$ git clone https://github.com/debops/debops ~/my-projects/debops
57+
$ cd ~/my-projects/debops
58+
59+
You can still install the scripts so you can use them easily, e.g.::
60+
61+
$ pip install --user ~/my-projects/debops
62+
$ debops-update
63+
64+
65+
Updating the DebOps scripts
66+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
67+
68+
For updating the DebOps scripts run (assuming you used `sudo` when
69+
installing)::
70+
71+
$ sudo pip install -U --no-deps debops
72+
73+
74+
If you installed the development version of DebOps and want to update
75+
it, simply use::
76+
77+
$ sudo pip install -U --no https://github.com/debops/debops/archive/master.zip
5578

56-
sudo make install-scripts
57-
debops-update
5879

5980
..
6081
Local Variables:

0 commit comments

Comments
 (0)