TimeVault

Differences between revisions 1 and 47 (spanning 46 versions)
⇤ ← Revision 1 as of 2007-06-21 15:29:29 →
Size: 4409
Editor: 216
Comment: Initial port of docs.html to Wiki
← Revision 47 as of 2007-07-18 17:49:48 → ⇥
Size: 8783
Editor: host87-127-117-202
Comment:
Deletions are marked like this. Additions are marked like this.
Line 5: Line 5:
 * '''Contributors''': JaneWeideman, MatthiasKlose  * '''Contributors''': KieranHogg
Line 7: Line 7:
Line 14: Line 15:
Quick Start
Line 16: Line 16:
After installing the .deb file, there are two steps required to complete installation: == Screenshots ==
Line 18: Line 18:
 * You must select a backup directory from System->Administration->Manage Snapshots.
 * You have to log out of and back into GNOME to have the Previous Versions option appear in file properties in Nautilus. Alternately, you can restart Nautilus from the command line: 'nautilus -q'.		 Here: TimeVault/ScreenShots
Line 23: Line 22:
A snapshot is a copy of a directory at a certain point in time. Snapshots don't use space for the files that haven't changed but instead simply increment the link count for them. On Linux, when a file is deleted, the link count is decremented, but it isn't actually removed until the link count hits zero. ===== Note: =====
The following applies to TimeVault versions below 0.4.0. TimeVault has changed significantly since then, so the documentation will have to be rewritten accordingly.
Line 25: Line 25:
Only files are hard-linked this way. Directories have to be recreated for technical reasons (since a hard-link is actually the file it points to, you would find yourself in a completely different path if directories were hard-linked). ===== Pre 0.4.0 Documentation: =====
(Working to bring this up to pace)
After installing the .deb file, there are two steps required to complete installation:

 * You must configure TimeVault, the backend will start automatically but the notifier needs to be started: To get the notifier app to start in your systray whenever you log in you can add it to your startup programs in System>Preferences>Sessions in the tab Startup Programs you should have an option to add a program click that, name it TimeVault and put:{{{
'/usr/bin/timevault-notifier'}}}
in the command box, you can put whatever you like in the comments box. After you have done this if you log out and back in again you should magically have the TimeVault notifier app sitting in your systray. Right click on it and go to preferences to configure TimeVault as you wish.
Line 27: Line 34:

To configure TimeVault, go to the System->Administration menu and select 'Manage Snapshots'.
Line 45: Line 50:
=== Management ===
ToDo		 A snapshot is a copy of a directory at a certain point in time. Snapshots don't use space for the files that haven't changed but instead simply increment the link count for them. On Linux, when a file is deleted, the link count is decremented, but it isn't actually removed until the link count hits zero.
Line 48: Line 52:
== Snapshot Backend == Only files are hard-linked this way. Directories have to be recreated for technical reasons (since a hard-link is actually the file it points to, you would find yourself in a completely different path if directories were hard-linked).
Line 50: Line 54:
The snapshot backend initially utilized was rsnapshot. While rsnapshot is an excellent enterprise-level piece of software, it has significant complexity that would make configuration by a casual or beginning user uncomfortable (as it might someone one who is unaccustomed to rsync command-line parameters and cron files). The plethora of features available in rsnapshot and other snapshot software would also remain unused in such a simple interface, and additional layers of software would have to be built on top of rsnapshot (or any of the other many snapshot solutions available - see below). == TimeVault Development ==
Line 52: Line 56:
So the approach taken in TimeVault is to implement the snapshot mechanism from scratch (as explained in this seminal paper by Mike Rubel). ["TimeVault/Restructure"] (you should check this page for development information)

Alpha versions are available at https://launchpad.net/timevault/+download . Once feature-adding is stopped, it will enter Beta stage after some respectable period of use by Alpha-testers.

Discuss icon and look-and-feel issues in ["TimeVault/Branding"].

Post ideas and wishlist/feature-requests in ["TimeVault/Ideas"].

Ports to Non-Ubuntu systems or a WM other than GNOME are discussed in ["TimeVault/Ports"].

== Change Log ==
=== Version 0.6.7 ===
 * Automatic reconnect to server (if restarted) from status icon
 * Changed debug message system to allow for varying degrees or verbosity (use --verbose multiple times for more debug information)
 * Added metadata saving system (this one is a pretty big change), so that file changes from apps like Beagle and Tracker (who ultimately churn through hundreds of MB a day) are not saved.
 * Added metadata caching dictionary so it needs to be queried only once for changed files per session. Dictionary auto-trims after 32K entries.
 * Added better information printout in Nautilus' property pages
 * Added Snapshot Browser handling for metadata (checkbox to hide metadata and show real changes only)
 * Fallback mechanism for determining if a file is text in the absence of a mime-type (e.g. extensionless files).
 * Diff viewer in Snapshot Browser

=== Version 0.6.8 ===
 * Snapshot picker improvements - filter by dir or file, or by right-clicking on row
 * Improved use of SQLite API (i.e. rewrite all queries so parameters are escaped by DB engine) - avoids SQL injection through crafting malformed filenames

=== Version 0.6.9 ===
 * Internal versioning - not for release

=== Version 0.6.10 ===
 * Relatively seemless configuration reload: Reload configuration when changed without restarting Nautilus, Notifier, or server
 * More config options: Enable/disable nautilus integration from TimeVault Prefs dialog.
 * Pending Snapshots Browser: When notifier is clicked, list pending snapshots (abort snapshot functionality not yet implemented)
 * Change visualization of different snaptypes in picker so that the total height is still logarithmic(base 1.5), but the ratio is linearly proportional - this makes it easier to see what's happening
 * Pending files are resumed if the server restarts
 * Gracefully add metafile/baselines to snapshotter queue (v. <0.6.10 would do so more aggressively, thereby causing unacceptably long lags when initiating a metadata sigs for newly added paths)
 * Fixed a bug where files with carriage returns in them (yes - believe it or not they exist) can be backed
 * Efficiency improvements.

=== Version 0.6.11 ===
 * Fixed Baseline generation bug where you could not generate them from the Prefs screen
 * Added a Take Baseline button in Prefs->Include
 * Added a Real and Meta filters in Snapshot Browser

=== Version 0.6.12 ===
 * Compatibility changes for Python 2.4 on Gentoo

=== Version 0.6.13 ===
 * Take Baseline button properly connected in Prefs->Include

=== Version 0.6.14 ===
 * Small bug fixes

=== Version 0.7.0 ===
 * Alpha Version for bug testers (new point release - no compatibility with saved snapshots from 0.6 branches). If someone really needs a 0.6 => 0.7 importer written, please let me know.
 * Revision of underlying layers (Config, Daemon)
 * Efficiency improvements
 * Live update on Upcoming Snapshots browser
 * Paths restructured to allow hiding of snapshots taken by others
 * Some parts are bound to be broken

== FAQ ==
Check ["TimeVault/FrequentlyAskedQuestions"] to see if your question has been answered.

If not, please add it to the list of questions. Another place to look is on the forum post for [http://ubuntuforums.org/showthread.php?t=474973 TimeVault] or on [https://launchpad.net/TimeVault Launchpad]
Line 63: Line 130:
== Contributors ==
==== Testing and Bug Triage ====
 * KieranHogg
 * ThomasWolfe2
 * TomVetterlein

==== Logo Design ====
 * DavidEvans

==== Documentation ====
 * ThomasWolfe2
 * TomVetterlein

== Volunteers ==
If you are interesting in helping out, please volunteer here under the appropriate category or create one that suites you.

==== Testing and Bug Triage ====

==== Graphics ====

==== Documentation ====


== Meetings ==

 * Here are the notes from our IRC meetings: ["TimeVault/MeetingNotes"]
Line 65: Line 159:
 * Make a ToDo list  * KDE-port: I've done the GUI for KDE port, the code obviously needs a fair few changes but it's on the back boiler for a few weeks. -- KieranHogg

Overview

TimeVault is a simple front-end for making snapshots of a set of directories. Snapshots are a copy of a directory structure or file at a certain point in time. Restore functionality is integrated into Nautilus - previous versions of a file or directory that has a snapshot can be accessed by examining the properties and selecting the 'Previous Versions' tab.

Snapshots are protected from accidental deletion or modification since they are read-only by default. The super-user can delete intermediate snapshots to save space, but files and directories that existed before or after the deletion will still be accessible.

Screenshots

Here: TimeVault/ScreenShots

What is a Snapshot

Note:

The following applies to TimeVault versions below 0.4.0. TimeVault has changed significantly since then, so the documentation will have to be rewritten accordingly.

Pre 0.4.0 Documentation:

(Working to bring this up to pace) After installing the .deb file, there are two steps required to complete installation:

  • You must configure TimeVault, the backend will start automatically but the notifier needs to be started: To get the notifier app to start in your systray whenever you log in you can add it to your startup programs in System>Preferences>Sessions in the tab Startup Programs you should have an option to add a program click that, name it TimeVault and put:

    '/usr/bin/timevault-notifier'

in the command box, you can put whatever you like in the comments box. After you have done this if you log out and back in again you should magically have the TimeVault notifier app sitting in your systray. Right click on it and go to preferences to configure TimeVault as you wish.

Configuration

There are four tabs: General, Include, Exclude, and Management. General

  • Enable Automated Snapshots: By default, TimeVault will not automatically take snapshots of your system. Checking this box will tell it to automatically take daily snapshots.

  • Allow users readonly access to snapshots: If this box is not checked, only the superuser (root, or a sudoer) can access the snapshots. If it is, then users will be able to browse snapshots according to their rights. So a user that does not have access to a directory or file will not have access to the snapshot of the directory or file. Note that only read access is granted - snapshots cannot be changed except by the root user (in the Management tab)
  • Snapshot Root Directory: Where to store the snapshots. Ideally, you should pick a directory that is mounted onto another physical drive from the data you are backing up. This is so that, in the case of a hard-disk failure, the backups will remain intact (unless the drive containing the backups fails, in which case the current version of the data remains).

Include

Backup paths are listed here. Every directory that you want to be snapshotted should be added to this list.

Exclude

Paths or patterns to exclude from the snapshots should be listed here

A snapshot is a copy of a directory at a certain point in time. Snapshots don't use space for the files that haven't changed but instead simply increment the link count for them. On Linux, when a file is deleted, the link count is decremented, but it isn't actually removed until the link count hits zero.

Only files are hard-linked this way. Directories have to be recreated for technical reasons (since a hard-link is actually the file it points to, you would find yourself in a completely different path if directories were hard-linked).

TimeVault Development

["TimeVault/Restructure"] (you should check this page for development information)

Alpha versions are available at https://launchpad.net/timevault/+download . Once feature-adding is stopped, it will enter Beta stage after some respectable period of use by Alpha-testers.

Discuss icon and look-and-feel issues in ["TimeVault/Branding"].

Post ideas and wishlist/feature-requests in ["TimeVault/Ideas"].

Ports to Non-Ubuntu systems or a WM other than GNOME are discussed in ["TimeVault/Ports"].

Change Log

Version 0.6.7

  • Automatic reconnect to server (if restarted) from status icon
  • Changed debug message system to allow for varying degrees or verbosity (use --verbose multiple times for more debug information)
  • Added metadata saving system (this one is a pretty big change), so that file changes from apps like Beagle and Tracker (who ultimately churn through hundreds of MB a day) are not saved.
  • Added metadata caching dictionary so it needs to be queried only once for changed files per session. Dictionary auto-trims after 32K entries.
  • Added better information printout in Nautilus' property pages
  • Added Snapshot Browser handling for metadata (checkbox to hide metadata and show real changes only)
  • Fallback mechanism for determining if a file is text in the absence of a mime-type (e.g. extensionless files).
  • Diff viewer in Snapshot Browser

Version 0.6.8

  • Snapshot picker improvements - filter by dir or file, or by right-clicking on row
  • Improved use of SQLite API (i.e. rewrite all queries so parameters are escaped by DB engine) - avoids SQL injection through crafting malformed filenames

Version 0.6.9

  • Internal versioning - not for release

Version 0.6.10

  • Relatively seemless configuration reload: Reload configuration when changed without restarting Nautilus, Notifier, or server

  • More config options: Enable/disable nautilus integration from TimeVault Prefs dialog.

  • Pending Snapshots Browser: When notifier is clicked, list pending snapshots (abort snapshot functionality not yet implemented)
  • Change visualization of different snaptypes in picker so that the total height is still logarithmic(base 1.5), but the ratio is linearly proportional - this makes it easier to see what's happening
  • Pending files are resumed if the server restarts

  • Gracefully add metafile/baselines to snapshotter queue (v. <0.6.10 would do so more aggressively, thereby causing unacceptably long lags when initiating a metadata sigs for newly added paths)

  • Fixed a bug where files with carriage returns in them (yes - believe it or not they exist) can be backed
  • Efficiency improvements.

Version 0.6.11

  • Fixed Baseline generation bug where you could not generate them from the Prefs screen

  • Added a Take Baseline button in Prefs->Include

  • Added a Real and Meta filters in Snapshot Browser

Version 0.6.12

  • Compatibility changes for Python 2.4 on Gentoo

Version 0.6.13

  • Take Baseline button properly connected in Prefs->Include

Version 0.6.14

  • Small bug fixes

Version 0.7.0

  • Alpha Version for bug testers (new point release - no compatibility with saved snapshots from 0.6 branches). If someone really needs a 0.6 => 0.7 importer written, please let me know.

  • Revision of underlying layers (Config, Daemon)
  • Efficiency improvements
  • Live update on Upcoming Snapshots browser
  • Paths restructured to allow hiding of snapshots taken by others
  • Some parts are bound to be broken

FAQ

Check ["TimeVault/FrequentlyAskedQuestions"] to see if your question has been answered.

If not, please add it to the list of questions. Another place to look is on the forum post for [http://ubuntuforums.org/showthread.php?t=474973 TimeVault] or on [https://launchpad.net/TimeVault Launchpad]

Other snapshot solutions include:

  • dirvish
  • glastree
  • pdumpfs
  • rsnapshot

Contributors

Testing and Bug Triage

Logo Design

Documentation

Volunteers

If you are interesting in helping out, please volunteer here under the appropriate category or create one that suites you.

Testing and Bug Triage

Graphics

Documentation

Meetings

ToDo

  • KDE-port: I've done the GUI for KDE port, the code obviously needs a fair few changes but it's on the back boiler for a few weeks. -- KieranHogg

CategorySpec

TimeVault (last edited 2011-08-28 18:08:15 by 105)