diff --git a/Makefile b/Makefile index 32f0ec5f..367c8570 100644 --- a/Makefile +++ b/Makefile @@ -1,4 +1,4 @@ -VERSION = 6.30 +VERSION = 6.31 PN = profile-sync-daemon PREFIX ?= /usr diff --git a/README.md b/README.md index 43441bd5..b3632bea 100644 --- a/README.md +++ b/README.md @@ -7,23 +7,6 @@ Always backup your browser profile(s) before using psd for the first time. ##Users of eCryptFS User of eCryptFS are encouraged not to use psd unless willing to help troubleshoot suspected browser corruption. See [#158](https://github.com/graysky2/profile-sync-daemon/issues/158). -##NOTE FOR VERSION 6 -My desktop distro (Arch) switched to systemd a while ago and other big ones (Fedora, Debian, Ubuntu) have followed suite. With the release of psd version 6.x I will no longer be supporting alternative init systems such as upstart and openrc. It is too complex for me to maintain and test multiple configurations on non-native init systems for me. - -Also of note for version 6.x is that no longer does psd run in as a system service. It now runs as a user service. -This is much more simple and means that: -* There is no more need for `/etc/psd.conf` and the USERS array therein. -* Different users can have their own config files that THEY own (`~/.psd/psd.conf`). -* Encrypted $HOME should be supported under this model (NOT yet implemented). - -Update instructions from version 5.x: -* Stop psd v5.7x and close your browsers. -* Build the package linked above and install it. -* Run psd to create your `~/.config/psd/psd.conf` and then edit it as you normally would. -* Check it in parse mode `psd p` and if happy with the output, run it via systemd usermode: `systemctl --user start psd` (and optionally enable it). - -Note that if you're using overlayfs mode, your user needs to have sudo right to /usr/bin/psd-overlay-helper or else psd will refuse to run in overlayfs mode. - ##Supported Browsers * Chromium * Conkeror @@ -55,7 +38,7 @@ To build from source, see the included INSTALL text document. ##Installation from Distro Packages ### Officially Packaged -* ![logo](http://gnulinuxvagos.es/public/style_extra/downloads_traffic_images/os_Antergos.png "antergos logo")Antergos: in the official [repos](http://build.antergos.com/browse/main#). +* ![logo](http://gnulinuxvagos.es/public/style_extra/downloads_traffic_images/os_Antergos.png "antergos logo")Antergos: in the official [repos](http://build.antergos.com/package/profile-sync-daemon). * ![logo](http://freedos-32.sourceforge.net/lean/debian_logo.png "debian logo")Debian jesse+: in the official [repos](https://packages.debian.org/unstable/profile-sync-daemon). * ![logo](https://s19.postimg.org/sjwaizg8j/zebrapig_head.png "exherbo logo")Exherbo: in the official [repos](http://git.exherbo.org/summer/packages/net-www/profile-sync-daemon). * ![logo](http://s9.postimg.org/p5f1tscxn/fedora.jpg "fedora logo")Fedora: in the official [repos](http://koji.fedoraproject.org/koji/packageinfo?packageID=16307). @@ -92,3 +75,22 @@ To add the PPA (personal package archive) to your Ubuntu system (packages availa ###Other Distros If you are interested in packaging psd for your favorite distro, please contact me. + +##NOTE FOR VERSION 6 +My desktop distro (Arch) switched to systemd a while ago and other big ones (Fedora, Debian, Ubuntu) have followed suite. With the release of psd version 6.x I will no longer be supporting alternative init systems such as upstart and openrc. It is too complex for me to maintain and test multiple configurations on non-native init systems for me. + +Also of note for version 6.x is that no longer does psd run in as a system service. It now runs as a user service. +This is much more simple and means that: +* There is no more need for `/etc/psd.conf` and the USERS array therein. +* Different users can have their own config files that THEY own (`~/.psd/psd.conf`). +* Encrypted $HOME should be supported under this model (NOT yet implemented). + +Update instructions from version 5.x: +* Stop psd v5.7x and close your browsers. +* Build the package linked above and install it. +* Run psd to create your `~/.config/psd/psd.conf` and then edit it as you normally would. +* Check it in parse mode `psd p` and if happy with the output, run it via systemd usermode: `systemctl --user start psd` (and optionally enable it). + +Note that if you're using overlayfs mode, your user needs to have sudo right to /usr/bin/psd-overlay-helper or else psd will refuse to run in overlayfs mode. + + diff --git a/doc/psd.1 b/doc/psd.1 index 782a3fdc..5e437909 100644 --- a/doc/psd.1 +++ b/doc/psd.1 @@ -1,5 +1,5 @@ .\" Text automatically generated by txt2man -.TH profile-sync-daemon 1 "25 November 2016" "" "" +.TH profile-sync-daemon 1 "26 November 2016" "" "" .SH NAME \fBprofile-sync-daemon \fP- Symlinks and syncs browser profiles to RAM (tmpfs) thus reducing HDD/SSD calls and speeding-up browsers. \fB @@ -22,7 +22,7 @@ Since the profile/profiles, browser cache*, etc. are relocated into tmpfs (RAM d .SH SETUP $XDG_CONFIG_HOME/psd/psd.conf (referred to hereafter as "the config file") contains all user managed settings. .PP -NOTE -- Any edits made to the config file while psd is active will be applied only after the service has been restarted. +NOTE: edits made to the config file while psd is active will be applied only after the service has been restarted. .RS .IP \(bu 3 Optionally enable the use of overlayfs to improve sync speed and to use a smaller memory footprint. Do this in the USE_OVERLAYFS variable. The user will require no password sudo rights to /usr/bin/psd-overlay-helper to use this option and the kernel must support overlayfs version 22 or higher. See the FAQ below for additional details. @@ -32,6 +32,9 @@ Optionally define which browsers are to be managed in the BROWSERS array. If non Optionally disable the use of crash-recovery snapshots (not recommended). Do this in the USE_BACKUPS variable. .IP \(bu 3 Optionally define the number of crash-recovery snapshots to keep. Do this in the BACKUP_LIMIT variable. +.RE +.PP +NOTE: occasionally, updates/changes are made to the default config file (/usr/share/psd/psd.conf) upstream. The user copy ($XDG_CONFIG_HOME/psd/psd.conf) will need to be diffed against it. .SH RUNNING PSD .SS PREVIEW MODE The preview option can be called to show users exactly what psd will do/is doing based on the entries in the config file. It will also provide useful information such as profile size, paths, and if any recovery snapshots have been created. @@ -40,7 +43,7 @@ The preview option can be called to show users exactly what psd will do/is doing .fam C $ psd p - Profile-sync-daemon v6.17 on Arch Linux. + Profile-sync-daemon on Arch Linux. .nf .fam C @@ -83,7 +86,7 @@ The clean mode will delete ALL recovery snapshots that have accumulated. Only ru .fam C $ psd c - Profile-sync-daemon v6.17 on Arch Linux. + Profile-sync-daemon on Arch Linux. Deleting 2 crashrecovery dirs for profile /home/facade/.config/chromium /home/facade/.config/chromium-backup-crashrecovery-20150117_171359 @@ -92,7 +95,7 @@ The clean mode will delete ALL recovery snapshots that have accumulated. Only ru .fam T .fi .SS START AND STOP PSD -With the release of the version 6.x series of psd, the only init system that is officially supported is systemd. Psd ships with a systemd user service to start or stop it (psd.service). Additionally, a provided resync-timer will run an hourly resync from tmpfs back to the disk. The resync-timer is started automatically with psd.service so there is no need to attempt to start the timer. +With the release of the version 6.x series of psd, the only init system that is officially supported is systemd. Psd ships with a systemd user service to start or stop it (psd.service). Additionally, a provided resync-timer will run an hourly resync from tmpfs back to the disk. The resync-timer is started automatically with psd.service so there is no need to start the timer; only start psd.service. .PP .nf .fam C