Debian Codegraph @

docs/manual/install.rst

raw
1 .. _cedar-install:
2
3 Installation
4 ============
5
6 .. _cedar-install-background:
7
8 Background
9 ----------
10
11 There are two different ways to install Cedar Backup. The easiest way is
12 to install the pre-built Debian packages. This method is painless and
13 ensures that all of the correct dependencies are available, etc.
14
15 If you are running a Linux distribution other than Debian or you are running
16 some other platform like FreeBSD or Mac OS X, then you must install the python
17 package. When using the Python package, you need to manage all of the external
18 dependencies yourself.
19
20 Cedar Backup has been developed on a Debian GNU/Linux system and is
21 primarily supported on Debian and other Linux systems. However, since it
22 is written in portable Python 3, it should run without problems on just
23 about any UNIX-like operating system. In particular, full Cedar Backup
24 functionality is known to work on Debian and SuSE Linux systems, and
25 client functionality is also known to work on FreeBSD and Mac OS X
26 systems.
27
28 To run a Cedar Backup client, you really just need a working Python 3
29 installation. To run a Cedar Backup master, you will also need a set of
30 other executables, most of which are related to building and writing
31 CD/DVD images. A full list of dependencies is provided further on in
32 this chapter.
33
34 .. _cedar-install-debian:
35
36 Installing on a Debian System
37 -----------------------------
38
39 The easiest way to install Cedar Backup onto a Debian system is by using
40 a tool such as ``apt-get`` or ``aptitude``.
41
42 Install Cedar Backup using this set of commands:
43
44 ::
45
46 $ apt-get update
47 $ apt-get install cedar-backup3 cedar-backup3-doc
48
49
50 Several of the Cedar Backup dependencies are listed as “recommended” rather
51 than required. If you are installing Cedar Backup on a master machine, you must
52 install some or all of the recommended dependencies, depending on which actions
53 you intend to execute. The stage action normally requires *ssh*, and the store
54 action requires *eject* and either *cdrecord*/*mkisofs* or *dvd+rw-tools*.
55 Clients must also install some sort of SSH server if a remote master will
56 collect backups from them.
57
58 Once the package has been installed, you can proceed to configuration as
59 described in :doc:`config`.
60
61 |note|
62
63 The Debian package-management tools must generally be run as root. It is
64 safe to install Cedar Backup to a non-standard location and run it as a
65 non-root user. However, to do this, you must install the Python package
66 instead of the Debian package.
67
68 .. _cedar-install-python:
69
70 Installing the Python Package
71 -----------------------------
72
73 On platforms other than Debian, Cedar Backup is installed as a Python package.
74 You will have to manage external dependencies on your own.
75
76 The easiest way to install the Python package is using Pip::
77
78 $ pip install cedar-backup3
79
80 There are other ways to install a package, but this is the simplest and is
81 probably the mechanism most people will want to use. If you are an experienced
82 Python user, feel free to use whichever mechanism you prefer on your own
83 system.
84
85 .. _cedar-install-python-deps:
86
87 Installing Dependencies
88 ~~~~~~~~~~~~~~~~~~~~~~~
89
90 Cedar Backup requires a number of external packages in order to function
91 properly. Before installing Cedar Backup, you must make sure that these
92 dependencies are met.
93
94 Cedar Backup is written in Python 3 and requires version 3.8 or greater
95 of the language.
96
97 Additionally, remote client peer nodes must be running an RSH-compatible
98 server, such as the ``ssh`` server, and master nodes must have an
99 RSH-compatible client installed if they need to connect to remote peer
100 machines.
101
102 Master machines also require several other system utilities, most having
103 to do with writing and validating CD/DVD media. On master machines, you
104 must make sure that these utilities are available if you want to to run
105 the store action:
106
107 - ``mkisofs``
108
109 - ``eject``
110
111 - ``mount``
112
113 - ``unmount``
114
115 - ``volname``
116
117 Then, you need this utility if you are writing CD media:
118
119 - ``cdrecord``
120
121 *or* these utilities if you are writing DVD media:
122
123 - ``growisofs``
124
125 All of these utilities are common and are easy to find for almost any
126 UNIX-like operating system.
127
128 |tip|
129
130 Many UNIX-like distributions provide an automatic or semi-automatic way to
131 install packages like the ones Cedar Backup requires (think RPMs for RedHat,
132 Gentoo's Portage system, Homebrew for Mac, or the BSD ports system). If you
133 are not sure how to install these packages on your system, you might want to
134 check out :doc:`depends`. This appendix provides links to “upstream” source
135 packages, plus as much information as I have been able to gather about
136 packages for non-Debian platforms.
137
138 ----------
139
140 *Previous*: :doc:`basic` • *Next*: :doc:`commandline`
141
142 ----------
143
144 .. |note| image:: images/note.png
145 .. |tip| image:: images/tip.png
146 .. |warning| image:: images/warning.png