| 1 |
.. _cedar-preface: |
| 2 |
|
| 3 |
Preface |
| 4 |
======= |
| 5 |
|
| 6 |
.. _cedar-preface-purpose: |
| 7 |
|
| 8 |
Purpose |
| 9 |
------- |
| 10 |
|
| 11 |
This software manual has been written to document version 2 and version 3 of |
| 12 |
Cedar Backup. Version 2 was first released in 2005, and version 3 in 2015. |
| 13 |
|
| 14 |
.. _cedar-preface-audience: |
| 15 |
|
| 16 |
Audience |
| 17 |
-------- |
| 18 |
|
| 19 |
This manual has been written for computer-literate administrators who |
| 20 |
need to use and configure Cedar Backup on their Linux or UNIX-like |
| 21 |
system. The examples in this manual assume the reader is relatively |
| 22 |
comfortable with UNIX and command-line interfaces. |
| 23 |
|
| 24 |
.. _cedar-preface-conventions: |
| 25 |
|
| 26 |
Conventions Used in This Book |
| 27 |
----------------------------- |
| 28 |
|
| 29 |
This section covers the various conventions used in this manual. |
| 30 |
|
| 31 |
Typographic Conventions |
| 32 |
~~~~~~~~~~~~~~~~~~~~~~~ |
| 33 |
|
| 34 |
*Term* |
| 35 |
Used for first use of important terms. |
| 36 |
|
| 37 |
``Command`` |
| 38 |
Used for commands, command output, and switches |
| 39 |
|
| 40 |
*Replaceable* |
| 41 |
Used for replaceable items in code and text |
| 42 |
|
| 43 |
``Filenames`` |
| 44 |
Used for file and directory names |
| 45 |
|
| 46 |
.. _cedar-preface-conventions-typo: |
| 47 |
|
| 48 |
Icons |
| 49 |
~~~~~ |
| 50 |
|
| 51 |
|note| This icon designates a note relating to the surrounding text. |
| 52 |
|
| 53 |
|tip| This icon designates a helpful tip relating to the surrounding text. |
| 54 |
|
| 55 |
|warning| This icon designates a warning relating to the surrounding text. |
| 56 |
|
| 57 |
.. _cedar-preface-organization: |
| 58 |
|
| 59 |
Organization of This Manual |
| 60 |
--------------------------- |
| 61 |
|
| 62 |
:doc:`intro` |
| 63 |
Provides some some general history about Cedar Backup, what needs it |
| 64 |
is intended to meet, how to get support, and how to migrate from |
| 65 |
version 2 to version 3. |
| 66 |
|
| 67 |
:doc:`basic`: |
| 68 |
Discusses the basic concepts of a Cedar Backup infrastructure, and |
| 69 |
specifies terms used throughout the rest of the manual. |
| 70 |
|
| 71 |
:doc:`install` |
| 72 |
Explains how to install Cedar Backup either from the Debian package or from |
| 73 |
the Python package. |
| 74 |
|
| 75 |
:doc:`commandline`: |
| 76 |
Discusses the various Cedar Backup command-line tools, including the |
| 77 |
primary ``cback3`` command. |
| 78 |
|
| 79 |
:doc:`config`: |
| 80 |
Provides detailed information about how to configure Cedar Backup. |
| 81 |
|
| 82 |
:doc:`extensions` |
| 83 |
Describes each of the officially-supported Cedar Backup extensions. |
| 84 |
|
| 85 |
:doc:`extenspec` |
| 86 |
Specifies the Cedar Backup extension architecture interface, through |
| 87 |
which third party developers can write extensions to Cedar Backup. |
| 88 |
|
| 89 |
:doc:`depends` |
| 90 |
Provides some additional information about the packages which Cedar |
| 91 |
Backup relies on, including information about how to find |
| 92 |
documentation and packages on non-Debian systems. |
| 93 |
|
| 94 |
:doc:`recovering` |
| 95 |
Cedar Backup provides no facility for restoring backups, assuming the |
| 96 |
administrator can handle this infrequent task. This appendix provides |
| 97 |
some notes for administrators to work from. |
| 98 |
|
| 99 |
:doc:`securingssh` |
| 100 |
Password-less SSH connections are a necessary evil when remote backup |
| 101 |
processes need to execute without human interaction. This appendix |
| 102 |
describes some ways that you can reduce the risk to your backup pool |
| 103 |
should your master machine be compromised. |
| 104 |
|
| 105 |
*Next*: :doc:`intro` |
| 106 |
|
| 107 |
.. |note| image:: images/note.png |
| 108 |
.. |tip| image:: images/tip.png |
| 109 |
.. |warning| image:: images/warning.png |
| 110 |
|