Menu
▾
▴
safekeep-commit
|
From: <di...@us...> - 2007-01-26 20:28:06
|
Revision: 308
http://safekeep.svn.sourceforge.net/safekeep/?rev=308&view=rev
Author: dimi
Date: 2007-01-26 12:28:01 -0800 (Fri, 26 Jan 2007)
Log Message:
-----------
Update documentation
Modified Paths:
--------------
safekeep/trunk/doc/safekeep.txt
Modified: safekeep/trunk/doc/safekeep.txt
===================================================================
--- safekeep/trunk/doc/safekeep.txt 2007-01-26 19:03:51 UTC (rev 307)
+++ safekeep/trunk/doc/safekeep.txt 2007-01-26 20:28:01 UTC (rev 308)
@@ -7,7 +7,7 @@
SYNOPSIS
--------
-'safekeep' [--server] [-q] [-v] [-C file] [-e <email>] [-m <smtp>]
+'safekeep' [--server] [-q] [-v] [-C file] [-e <email>] [-m <smtp>] <clientid>*
'safekeep' --client
@@ -25,7 +25,7 @@
In server mode, SafeKeep parses a set of configurations files which
defines a set of backup clients. For each backup client, SafeKeep
connects to the client host over SSH (using a public key authentification
-system previously set up using `safekeep -k --deploy`), and launches
+system previously set up using `safekeep -keys --deploy`), and launches
`safekeep --client` onto the client host. The client does the real backup
and sends the data over SSH to the SafeKeep server which stores it in
the specified location.
@@ -41,6 +41,11 @@
The SSH key management mode is a helper mode for deploying or verifying
the setup of the SSH authentification keys.
+In both server and keys management mode, you can restrict the operation
+to a specific set of clients by listing the desired client IDs as
+arguments. If no client ID is given, SafeKeep will operate over all known
+clients.
+
Each mode accepts a few options as described below.
OPERATION MODE
@@ -81,7 +86,10 @@
Specifies the configuration file location.
This can be a single file (for a single client configuration)
or a directory containing several configuration files (one per
- backup client)
+ backup client). Can be specified multiple times.
+ If not specified at all, SafeKeep will default to searching
+ `/etc/safekeep.d/` for configuration files.
+ Simply using this default is the recommended usage.
-e, --email=EMAIL::
In addition to writing the session logs
@@ -108,9 +116,10 @@
--deploy::
Deploy the authorization keys on the clients.
-Configuration file
-------------------
+CONFIGURATION
+-------------
+
Each backup client is described by a configuration file in XML format of the
following form:
@@ -119,7 +128,7 @@
<backup id="my.host.com primary backup">
<!-- the client backup host, the user under which the servers will connect,
- the SSH keys used for launching "safekeep -c" and "rdiff-backup" -->
+ the SSH keys used for launching "safekeep --client" and "rdiff-backup" -->
<host
name="localhost" user="guest"
key-ctrl="/home/dimi/.ssh/backup_id_dsa"
@@ -172,11 +181,14 @@
</backup>
------------------------------------------------------------------------
-See Also
+Normally the configuration files are placed in the `/etc/safekeep.d/` directory
+from where they will get picked up automatically by SafeKeep.
+
+SEE ALSO
--------
rdiff-backup(1)
-Author
+AUTHOR
------
Written by Dimi Paun <di...@la...> and Stelian Pop <st...@la...>.
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <di...@us...> - 2007-01-26 21:16:38
|
Revision: 311
http://safekeep.svn.sourceforge.net/safekeep/?rev=311&view=rev
Author: dimi
Date: 2007-01-26 13:16:33 -0800 (Fri, 26 Jan 2007)
Log Message:
-----------
Cleanup the docs a bit
Modified Paths:
--------------
safekeep/trunk/doc/safekeep.txt
Modified: safekeep/trunk/doc/safekeep.txt
===================================================================
--- safekeep/trunk/doc/safekeep.txt 2007-01-26 21:13:27 UTC (rev 310)
+++ safekeep/trunk/doc/safekeep.txt 2007-01-26 21:16:33 UTC (rev 311)
@@ -125,20 +125,20 @@
------------------------------------------------------------------------
<!-- the client backup id -->
-<backup id="my.host.com primary backup">
+<backup id="my_workstation">
<!-- the client backup host, the user under which the servers will connect,
the SSH keys used for launching "safekeep --client" and "rdiff-backup" -->
<host
- name="localhost" user="guest"
- key-ctrl="/home/dimi/.ssh/backup_id_dsa"
- key-data="/home/dimi/.ssh/backup2_id_dsa"
+ name="my_workstation.corp.com" user="root"
+ key-ctrl="/home/jdoe/.ssh/backup_id_dsa"
+ key-data="/home/jdoe/.ssh/backup2_id_dsa"
/>
<!-- location where the backuped data will be stored on the server
and for how long (s=sec, m=min, h=hours, D=days, W=weeks, M=months, or Y=years) -->
<repo
- path="./tmp"
+ path="./data"
retention="10D"
/>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <di...@us...> - 2007-01-26 23:16:45
|
Revision: 316
http://safekeep.svn.sourceforge.net/safekeep/?rev=316&view=rev
Author: dimi
Date: 2007-01-26 15:16:44 -0800 (Fri, 26 Jan 2007)
Log Message:
-----------
Document some more realistic configuration examples.
Modified Paths:
--------------
safekeep/trunk/doc/safekeep.txt
Modified: safekeep/trunk/doc/safekeep.txt
===================================================================
--- safekeep/trunk/doc/safekeep.txt 2007-01-26 22:17:02 UTC (rev 315)
+++ safekeep/trunk/doc/safekeep.txt 2007-01-26 23:16:44 UTC (rev 316)
@@ -116,77 +116,70 @@
--deploy::
Deploy the authorization keys on the clients.
-
CONFIGURATION
-------------
-Each backup client is described by a configuration file in XML format of the
-following form:
-
+Normally the configuration files are placed in the `/etc/safekeep.d/` directory
+from where they will get picked up automatically by SafeKeep. Each backup
+client is described by a configuration file in XML format. The minimum
+configuration file is:
------------------------------------------------------------------------
-<!-- the client backup id -->
-<backup id="my_workstation">
+<backup>
+ <host name="my_workstation" />
+</backup>
+------------------------------------------------------------------------
+This will simply backup all relevant files (excluding temporary files,
+caches, etc) from the client with the address `my_workstation`.
- <!-- the client backup host, the user under which the servers will connect,
- the SSH keys used for launching "safekeep --client" and "rdiff-backup" -->
- <host
- name="my_workstation.corp.com" user="root"
- key-ctrl="/home/jdoe/.ssh/backup_id_dsa"
- key-data="/home/jdoe/.ssh/backup2_id_dsa"
- />
-
- <!-- location where the backuped data will be stored on the server
- and for how long (s=sec, m=min, h=hours, D=days, W=weeks, M=months, or Y=years) -->
- <repo
- path="./data"
- retention="10D"
- />
-
- <!-- settings for database dump and for volume snapshot -->
+A more realistic example:
+------------------------------------------------------------------------
+<backup>
+ <host name="my_workstation" />
+ <repo retention="10D" />
<setup>
-
- <!-- database type ("postgres" or "mysql"), user with backup rights,
- location of the dump file on the client host, and flag to remove
- or not the dump file after the backup is done -->
- <dump
- type="postgres"
- db="dbname"
- user="foobar"
- file="/var/backup/dumps/mydata"
- cleanup="true"
- />
-
- <!-- what volume is to be snapshoted (device location) and the size
- of the snapshot (unallocated space must exist in the volume group) -->
- <snapshot
- device="/path/to/volume"
- size="500M"
- />
-
+ <dump type="postgres" user="postgres" file="/var/lib/pgsql/backups/all_dbs" />
+ <snapshot device="/dev/mapper/VolGroup00-LogVol00" size="500M" />
</setup>
- <!-- data to be backuped -->
<data>
- <!-- each type of tag can be present more than one time -->
- <!-- if a database dump was created, it must be added in this section -->
- <include path="/home"/>
- <exclude path="/home/guest"/>
+ <exclude regexp=".*\.ogg"/>
+ <exclude regexp=".*\.mp3"/>
- <include glob="**/important/"/>
+ <include path="/etc"/>
+
<exclude glob="/home/*/tmp"/>
+ <include path="/home"/>
- <include regexp=".*\.ogg"/>
- <exclude regexp=".*\.mp3"/>
+ <include path="/root"/>
+
+ <include path="/srv"/>
+
+ <exclude path="/var/cache"/>
+ <exclude path="/var/lock"/>
+ <exclude path="/var/run"/>
+ <exclude path="/var/tmp"/>
+ <include path="/var"/>
</data>
</backup>
------------------------------------------------------------------------
+In this case, SafeKeep will dump all databases managed by PostgreSQL,
+snapshot the disk via LVM, and proceed to backup `/etc`, `/home`,
+`/root`, `/srv`, `/var`, while excluding some unneeded files and
+directories. Older data will be retained for 10 days.
-Normally the configuration files are placed in the `/etc/safekeep.d/` directory
-from where they will get picked up automatically by SafeKeep.
+For full reference documentation of the configuration format, see
+safekeep.conf(5).
+CLIENT IDS
+----------
+Normally the client IDs are generated automatically from the configuration
+filenames without the extension. E.g. if a configuration file is named
+`my_workstation.conf`, the client ID becomes `my_workstation`. For more
+information on this topic, see safekeep.conf(5).
+
SEE ALSO
--------
-rdiff-backup(1)
+rdiff-backup(1), safekeep.conf(5)
AUTHOR
------
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <di...@us...> - 2007-01-29 19:13:21
|
Revision: 328
http://safekeep.svn.sourceforge.net/safekeep/?rev=328&view=rev
Author: dimi
Date: 2007-01-29 11:13:19 -0800 (Mon, 29 Jan 2007)
Log Message:
-----------
Fix the example with the latest results
Modified Paths:
--------------
safekeep/trunk/doc/safekeep.txt
Modified: safekeep/trunk/doc/safekeep.txt
===================================================================
--- safekeep/trunk/doc/safekeep.txt 2007-01-29 17:22:11 UTC (rev 327)
+++ safekeep/trunk/doc/safekeep.txt 2007-01-29 19:13:19 UTC (rev 328)
@@ -158,7 +158,12 @@
<exclude path="/var/lock"/>
<exclude path="/var/run"/>
<exclude path="/var/tmp"/>
+ <include path="/var/named/chroot/etc"/>
+ <include path="/var/named/chroot/var/named"/>
+ <exclude path="/var/named/chroot"/>
<include path="/var"/>
+
+ <exclude path="/"/>
</data>
</backup>
------------------------------------------------------------------------
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <di...@us...> - 2007-02-02 00:53:11
|
Revision: 360
http://safekeep.svn.sourceforge.net/safekeep/?rev=360&view=rev
Author: dimi
Date: 2007-02-01 16:53:10 -0800 (Thu, 01 Feb 2007)
Log Message:
-----------
Add documentation about keys deployment
Modified Paths:
--------------
safekeep/trunk/doc/safekeep.txt
Modified: safekeep/trunk/doc/safekeep.txt
===================================================================
--- safekeep/trunk/doc/safekeep.txt 2007-02-02 00:43:23 UTC (rev 359)
+++ safekeep/trunk/doc/safekeep.txt 2007-02-02 00:53:10 UTC (rev 360)
@@ -182,6 +182,22 @@
`my_workstation.conf`, the client ID becomes `my_workstation`. For more
information on this topic, see safekeep.conf(5).
+KEY DEPLOYMENT
+--------------
+The `safekeep(1)` server needs to access the clients in order to conduct
+the backup. To that end, it establishes two ssh(1) pipes: one for control,
+and one for data. To simplify the deployment of the keys, `safekeep(1)`
+has a key deploy mode.
+
+When deploying keys using the built-in key management functionality,
+`safekeep(1)` needs to be invoked as the user under which it will function
+as a server. By default, that user is 'safekeep'. For extra security,
+you can not login into that account, so you have to invoke `safekeep(1)`
+as follows:
+------------------------------------------------------------------------
+ # sudo -H -u safekeep safekeep --keys --deploy
+------------------------------------------------------------------------
+
SEE ALSO
--------
rdiff-backup(1), safekeep.conf(5)
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <di...@us...> - 2007-02-04 05:18:24
|
Revision: 369
http://safekeep.svn.sourceforge.net/safekeep/?rev=369&view=rev
Author: dimi
Date: 2007-02-03 21:18:22 -0800 (Sat, 03 Feb 2007)
Log Message:
-----------
Eduard Malinschi <ed...@la...>
Fix typo.
Modified Paths:
--------------
safekeep/trunk/doc/safekeep.txt
Modified: safekeep/trunk/doc/safekeep.txt
===================================================================
--- safekeep/trunk/doc/safekeep.txt 2007-02-02 21:32:26 UTC (rev 368)
+++ safekeep/trunk/doc/safekeep.txt 2007-02-04 05:18:22 UTC (rev 369)
@@ -25,7 +25,7 @@
In server mode, SafeKeep parses a set of configurations files which
defines a set of backup clients. For each backup client, SafeKeep
connects to the client host over SSH (using a public key authentification
-system previously set up using `safekeep -keys --deploy`), and launches
+system previously set up using `safekeep --keys --deploy`), and launches
`safekeep --client` onto the client host. The client does the real backup
and sends the data over SSH to the SafeKeep server which stores it in
the specified location.
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <di...@us...> - 2007-03-04 17:52:33
|
Revision: 427
http://safekeep.svn.sourceforge.net/safekeep/?rev=427&view=rev
Author: dimi
Date: 2007-03-04 09:52:31 -0800 (Sun, 04 Mar 2007)
Log Message:
-----------
Fix restore docs.
Modified Paths:
--------------
safekeep/trunk/doc/safekeep.txt
Modified: safekeep/trunk/doc/safekeep.txt
===================================================================
--- safekeep/trunk/doc/safekeep.txt 2007-03-04 17:52:06 UTC (rev 426)
+++ safekeep/trunk/doc/safekeep.txt 2007-03-04 17:52:31 UTC (rev 427)
@@ -213,7 +213,7 @@
Once you have determined where the data will be stored (we'll continue
the example above), all you have to do is run `rdiff-backup`:
------------------------------------------------------------------------
- # rdiff-backup /var/lib/safekeep/mybox my-restore-dir
+ # rdiff-backup -r 1s /var/lib/safekeep/mybox my-restore-dir
------------------------------------------------------------------------
You will be able to find more information on the restore procedure in
the `rdiff-backup(1)` man page.
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <di...@us...> - 2007-03-07 16:54:49
|
Revision: 437
http://safekeep.svn.sourceforge.net/safekeep/?rev=437&view=rev
Author: dimi
Date: 2007-03-07 08:54:47 -0800 (Wed, 07 Mar 2007)
Log Message:
-----------
Mention the new conf file
Modified Paths:
--------------
safekeep/trunk/doc/safekeep.txt
Modified: safekeep/trunk/doc/safekeep.txt
===================================================================
--- safekeep/trunk/doc/safekeep.txt 2007-03-07 16:52:20 UTC (rev 436)
+++ safekeep/trunk/doc/safekeep.txt 2007-03-07 16:54:47 UTC (rev 437)
@@ -236,7 +236,7 @@
SEE ALSO
--------
-rdiff-backup(1), safekeep.backup(5)
+rdiff-backup(1), safekeep.conf(5), safekeep.backup(5)
AUTHOR
------
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <di...@us...> - 2007-03-09 00:33:18
|
Revision: 451
http://safekeep.svn.sourceforge.net/safekeep/?rev=451&view=rev
Author: dimi
Date: 2007-03-08 16:33:17 -0800 (Thu, 08 Mar 2007)
Log Message:
-----------
Fix docs
Modified Paths:
--------------
safekeep/trunk/doc/safekeep.txt
Modified: safekeep/trunk/doc/safekeep.txt
===================================================================
--- safekeep/trunk/doc/safekeep.txt 2007-03-08 22:44:20 UTC (rev 450)
+++ safekeep/trunk/doc/safekeep.txt 2007-03-09 00:33:17 UTC (rev 451)
@@ -185,9 +185,9 @@
`safekeep(1)` needs to be invoked as the user under which it will function
as a server. By default, that user is 'safekeep'. For extra security,
you can not login into that account, so you have to invoke `safekeep(1)`
-as follows:
+as 'root':
------------------------------------------------------------------------
- # sudo -H -u safekeep safekeep --keys --deploy
+ [root@yourbox ~] # safekeep --keys --deploy
------------------------------------------------------------------------
RESTORING
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
×
Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.
Thanks for helping keep SourceForge clean.
X