Skip to content
This repository was archived by the owner on Oct 16, 2022. It is now read-only.

Commit 620d737

Browse files
committed
Updated README; Added section on supported system types;
1 parent c0c5047 commit 620d737

File tree

3 files changed

+31
-5
lines changed

3 files changed

+31
-5
lines changed

README.md

Lines changed: 31 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Timeshift is similar to applications like [rsnapshot](http://www.rsnapshot.org/)
1818

1919
* Snapshots are saved by default on the system (root) partition in path **/timeshift**. Other linux partitions can also be selected. For best results the snapshots should be saved to an external (non-system) partition.
2020

21-
![](images/settings_location.png)
21+
![](images/settings_location.png)
2222

2323
### Multiple Snapshot Levels
2424

@@ -28,7 +28,7 @@ Timeshift is similar to applications like [rsnapshot](http://www.rsnapshot.org/)
2828

2929
* Boot snapshots provide an additional level of backup and are created every time the system starts. Boot snapshots are deplayed by 10 mins so that system startup is not affected.
3030

31-
![](images/settings_schedule.png)
31+
![](images/settings_schedule.png)
3232

3333
### Rsync & BTRFS Snapshots
3434

@@ -74,6 +74,32 @@ You can selectively include items for backup from the ***Settings*** window. Sel
7474
- Since installing a new linux distribution also formats your root partition you need to save your snapshots on a separate linux partition for this to work.
7575
- It is recommended to include hidden items in home directory by selecting the option "*Include Hidden Items*" from *Settings* > *Users*.
7676

77+
## Supported System Configurations
78+
79+
- **Normal** - OS installed on non-encrypted partitions
80+
81+
- **LUKS Encrypted** - OS installed on LUKS-encrypted partitions
82+
83+
- **LVM2** - OS installed on LVM2 volumes (with or without LUKS)
84+
85+
- **BTRFS** - OS installed on BTRFS volumes (with or without LUKS)
86+
87+
- Only Ubuntu-type layouts with **@** and **@home** subvolumes are supported
88+
89+
90+
- **@** and **@home** subvolumes may be on same or different BTRFS volumes
91+
- **@** may be on BTRFS volume and **/home** may be mounted on non-BTRFS partition
92+
- Other layouts are not supported
93+
94+
- **GRUB2** - Bootloader must be GRUB2. GRUB legacy and other bootloaders are not supported.
95+
96+
- **EFI** - EFI systems are supported. Make sure that ```/boot/efi``` partition is selected for mounting before restoring snapshots (application will do it automatically).
97+
98+
99+
- **Encrypted Home** - For users with encrypted home, files in ```/home/.ecryptfs/$USER``` will be backed-up and restored. The decrypted contents in ```$HOME``` will be excluded. This avoids the security risk of decrypted contents becoming available outside the user's home directory.
100+
- **Encrypted Private Directory** - For users with encrypted *Private* directory, the encrypted files in ```$HOME/.Private```, as well as the decrypted files in ```$HOME/Private```, will be excluded (as it contains user data). Filters added by user to include files from ```$HOME/.Private``` or ```$HOME/Private``` will be ignored.
101+
- **Docker & Containers** - Docker and containerized systems are not supported. Running Timeshift on such systems will have unpredictable results.
102+
77103
## Installation
78104

79105
#### Ubuntu-based Distributions
@@ -84,7 +110,7 @@ Packages are available in the Launchpad PPA for supported Ubuntu releases.
84110
Run the following commands in a terminal window:
85111

86112
```sh
87-
sudo apt-add-repository -y ppa:teejee2008/ppa
113+
sudo add-apt-repository -y ppa:teejee2008/ppa
88114
sudo apt-get update
89115
sudo apt-get install timeshift
90116
```
@@ -149,11 +175,11 @@ This program is free for personal and commercial use and comes with absolutely n
149175

150176
**PayPal** ~ If you find this application useful and wish to say thanks, you can buy me a coffee by making a donation with Paypal.
151177

152-
[![](https://upload.wikimedia.org/wikipedia/commons/b/b5/PayPal.svg)](https://www.paypal.com/cgi-bin/[email protected]&cmd=_xclick&currency_code=USD&amount=10&item_name=Timeshift%20Donation)
178+
[![](images/PayPal.png)](https://www.paypal.com/cgi-bin/[email protected]&cmd=_xclick&currency_code=USD&amount=10&item_name=Timeshift%20Donation)
153179

154180
**Patreon** ~ You can also sign up as a sponsor on [Patreon.com](https://www.patreon.com/teejeetech). As a patron you will get access to beta releases of new applications that I'm working on. You will also get news and updates about new features that are not published elsewhere.
155181

156-
[![](https://2.bp.blogspot.com/-DNeWEUF2INM/WINUBAXAKUI/AAAAAAAAFmw/fTckfRrryy88pLyQGk5lJV0F0ESXeKrXwCLcB/s200/patreon.png)](https://www.patreon.com/bePatron?u=3059450)
182+
[![](images/patreon.png)](https://www.patreon.com/bePatron?u=3059450)
157183

158184
**Bitcoin** ~ You can send bitcoins at this address or by scanning the QR code below:
159185

images/PayPal.png

2.92 KB
Loading

images/patreon.png

5.6 KB
Loading

0 commit comments

Comments
 (0)