https://github.com/gryf/py-time-machine
Rsync/hardlinks based python script for backup purposes using local or remote locations
https://github.com/gryf/py-time-machine
Last synced: 2 months ago
JSON representation
Rsync/hardlinks based python script for backup purposes using local or remote locations
- Host: GitHub
- URL: https://github.com/gryf/py-time-machine
- Owner: gryf
- License: gpl-2.0
- Created: 2022-10-24T12:35:10.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-09-15T15:21:22.000Z (over 1 year ago)
- Last Synced: 2025-01-12T19:48:21.665Z (4 months ago)
- Language: Python
- Size: 60.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
py-time-machine
===============
Rsync/hardlinks based python script for backup purposes using local or remote
locations. Inspired by `rsync-time-machine`_.
Features
--------
Same as in `rsync-time-machine`_, but also:
* Python3 support
* Backup to remote host
* Configuration will be read from ``XDG_CONFIG_HOME`` or ``/etc/``
* Using yaml instead of ini style config files
Usage
-----
Place the script on your path, create configuration and save it under
convenient location.
Than, execute it:
.. code:: shell-session
$ py-time-machine.py
or provide configuration file:
.. code:: shell-session
$ py-time-machine.py -c file_with_configuration.yaml
There is an option for redirecting log to a file, by passing its location with
``--log`` parameter:
.. code:: shell-session
$ py-time-machine.py -c file_with_configuration.yaml -l ~/.ptm.log
or, as a root, using global configuration:
.. code:: shell-session
# py-time-machine.py -l /var/log/py-time-machine.log
Configuration
-------------
Sample configuration can be found with this repository with comments. To
configure remote host, it's as simple as:
.. code:: yaml
...
destination: user@hostname_or_ip_address:/path/to/the/backup
...
In this example ``user@`` might be omitted, so that current user would be used.
Please note, that in case of remote destination, absolute path should be used.
If needed, there is also a section, where rsh command might be tweaked, i.e.
for usage different keys and/or ssh options:
.. code:: yaml
...
rsh_command: >-
ssh -i /path/to/ssh-key -o 'StrictHostKeyChecking=no' -o
'UserKnownHostsFile=/dev/null'
...
Using yamls' ``>-`` notation all of the string will be concatenated and **not**
terminated with newline character. Be careful, to not put special characters
like dash or asterisk at the beginning of the broken line, or there will be
issue with config reported.
License
-------
See the LICENSE file for license rights and limitations (GNU GPL v2).
.. _rsync-time-machine: https://github.com/infinet/rsync-time-machine