README.md

   1 time-slider for Linux
   2 =====================
   3
   4 This is a port (if one can call it that) of the Opensolaris/Illimos
   5 time-slider package to Linux. The porting effort so far was concentrated
   6 mainly on removing Solaris-isms and fixing minor annoyances. More work
   7 might be done in the future
   8
   9
  10 Installation
  11 ============
  12
  13 The Makefile provides an install target that can be used to install
  14 the package. For RPM based distributions a .spec file is included in
  15 the rpm/ subdirectory.
  16
  17 "rpm" and "srpm" Makefile targets exist that will attempt to build
  18 a noarch RPM and/or a SRPM based on that spec file. This might fail
  19 if the user running the command has messed with their RPM environment
  20 (by using ~/.rpmmacros, for example). Moving that file out of the way
  21 temporarily should fix the issues.
  22
  23 The .spec file has been tested on Fedora 20 (as the whole package has),
  24 running ZFS on Linux version 0.6.2 and later.
  25
  26
  27 Running
  28 =======
  29
  30 Python 2 is needed to run this package. Python 3 is not supported.
  31
  32 A systemd time-sliderd.service file is included in the installation.
  33 It is not enabled by default.
  34
  35 No SysV init file is provided, but should not be too complicated to
  36 create.
  37
  38 The main binary is /usr/libexec/time-sliderd. By default this will daemonize
  39 itself, but a --foreground parameter has been added that will keep the
  40 program attached to the starting terminal.
  41
  42
  43 Configuration
  44 =============
  45
  46 Like under Solaris the main way of specifying datasets to be snapshotted
  47 is using the "com.sun:auto-snapshot" property. This will enable the
  48 default "frequent", "hourly", "daily", "weekly" and "monthly" snapshots.
  49 The respective "com.sun:auto-snapshot:<frequency>" properties are
  50 understood as well.
  51
  52
  53 SMF
  54 ===
  55
  56 Further configuration of the time-sliderd service and the snapshots could
  57 be done unter Solaris by using SMF properties of the respective services.
  58
  59 As Linux does not share this concept a config file located at
  60 /etc/time-slider/time-sliderd.conf can be used to set configuration options.
  61
  62 To see a config file dump of the default options run "/usr/libexec/time-sliderd
  63 --configdump" which will print the config to stdout.
  64
  65 No restart is necessary after changes to the config file, the new values
  66 will be picked up immediately.
  67
  68
  69 Known issues
  70 ============
  71
  72 Plugins are currently not working and are completely disabled. Also no
  73 integration with Gnome or other Desktop Environments exists.