Difference between revisions of "Profile-sync-daemon"

From ArchWiki
Jump to: navigation, search
m (Running PSD to Manage Profiles)
(PSD On Other Distros)
(7 intermediate revisions by 6 users not shown)
Line 25: Line 25:
 
*{{AUR|conkeror}}
 
*{{AUR|conkeror}}
 
*[[firefox]] (all flavors including stable, beta, and aurora)
 
*[[firefox]] (all flavors including stable, beta, and aurora)
*[http://www.webupd8.org/2011/05/install-firefox-nightly-from-ubuntu-ppa.html firefox-trunk]
+
*[http://www.webupd8.org/2011/05/install-firefox-nightly-from-ubuntu-ppa.html firefox-trunk]: An Ubuntu-only browser
 
*{{AUR|google-chrome}}
 
*{{AUR|google-chrome}}
*[https://bbs.archlinux.org/viewtopic.php?id=117157 heftig's version of aurora]
+
*[https://bbs.archlinux.org/viewtopic.php?id=117157 heftig's version of aurora]: An Arch Linux only browser
 
*[[midori]]
 
*[[midori]]
 
*[[opera]]
 
*[[opera]]
 
*{{AUR|opera-next}}
 
*{{AUR|opera-next}}
*[[qupzilla]]
+
*Qupzilla
 
+
{{Note|Heftig's version of Aurora is an Arch Linux only browser.}}
+
{{Note|Firefox-trunk is an Ubuntu-only only browser.}}
+
  
 
==Setup and Installation==
 
==Setup and Installation==
{{AUR|Profile-sync-daemon}} is available for download from the [[Arch User Repository|AUR]].  Build it and install like any other package.   
+
{{AUR|profile-sync-daemon}} is available for download from the [[Arch User Repository|AUR]].  Build it and install like any other package.   
  
 
=== Edit /etc/psd.conf ===
 
=== Edit /etc/psd.conf ===
Line 71: Line 68:
 
  # If the following is commented out (default), then all available/supported  
 
  # If the following is commented out (default), then all available/supported  
 
  # browsers will be sync'ed, separated by comma
 
  # browsers will be sync'ed, separated by comma
  BROWSERS="chromium,opera"
+
  BROWSERS="chromium opera"
  
 
== Using PSD ==
 
== Using PSD ==
Line 106: Line 103:
 
Both a systemd service file and a timer are provided and should be used to interact with psd. Both should be invoked together! The role of the timer is update the tmpfs copy/copies back to the disk which it does once per hour. Failure to start the resync timer will result in the profile being sync'ed only on start up and shutdown.
 
Both a systemd service file and a timer are provided and should be used to interact with psd. Both should be invoked together! The role of the timer is update the tmpfs copy/copies back to the disk which it does once per hour. Failure to start the resync timer will result in the profile being sync'ed only on start up and shutdown.
  
  # systemctl [option] psd psd-resync
+
  # systemctl [option] psd.service psd-resync.service
  
 
Available options:
 
Available options:
Line 116: Line 113:
  
 
Start psd and its timer as well as set psd and its timer to start/stop at boot/shutdown ''(highly recommended)'':
 
Start psd and its timer as well as set psd and its timer to start/stop at boot/shutdown ''(highly recommended)'':
  # systemctl enable psd psd-resync
+
  # systemctl enable psd.service psd-resync.service
  # systemctl start psd psd-resync
+
  # systemctl start psd.service psd-resync.service
  
 
Obviously, you must first close your browser before starting the service.
 
Obviously, you must first close your browser before starting the service.
Line 161: Line 158:
  
 
== PSD On Other Distros ==
 
== PSD On Other Distros ==
Psd is a simple bash script and should therefore run on any Linux distro. Below is a list of distros known to package psd, and a link to download their respective packages. As noted above, these are unsupported by the author due to their own, unique init scripts:
+
Psd is a bash script and should therefore run on any Linux distro. Below is a list of distros known to package psd, and a link to download their respective packages.  
  
=== Chakra ===
+
{{Note|Different distros use different init systems. The packages linked below are configured to use the default init system for the given distro.}}
http://chakra-linux.org/ccr/packages.php?ID=5007
+
 
 +
{| class="wikitable" align="center"
 +
|-
 +
! Distro !! Default Init System !! Link to Package
 +
|-
 +
| Arch || Systemd || [https://aur.archlinux.org/packages/profile-sync-daemon AUR].
 +
|-
 +
| Chakra || Systemd || [http://chakra-linux.org/ccr/packages.php?ID=5008 CCR].
 +
|-
 +
| Debian || Upstart ||  Graysky's PPA, See instruction below.
 +
|-
 +
| Exherbo || Systemd || [http://git.exherbo.org/summer/packages/net-www/profile-sync-daemon In official repos].
 +
|-
 +
| Fedora || Systemd || [http://koji.fedoraproject.org/koji/packageinfo?packageID=16307 In official repos].
 +
|-
 +
| Gentoo || OpenRC || [http://packages.gentoo.org/package/www-misc/profile-sync-daemon In official repos].
 +
|-
 +
| Mint || Upstart || Graysky's PPA, See instruction below.
 +
|-
 +
| OpenSUSE || Upstart || Packaged by [http://download.opensuse.org/repositories/home:/Overman79:/Laptop Overman79].
 +
|-
 +
| Ubuntu || Upstart || Graysky's PPA, See instruction below.
 +
|-
 +
| Void || Systemd || In official [https://github.com/xtraeme/xbps-packages/tree/master/srcpkgs/profile-sync-daemon repos].
 +
|}
  
 
=== Debian ===
 
=== Debian ===
Line 175: Line 196:
 
  # apt-get install profile-sync-daemon
 
  # apt-get install profile-sync-daemon
  
=== Exherbo ===
+
=== Mint and Ubuntu ===
http://git.exherbo.org/summer/packages/net-www/profile-sync-daemon
+
 
+
=== Fedora 18 ===
+
http://repo-ck.com/fedora_rpms
+
 
+
=== Gentoo ===
+
http://packages.gentoo.org/package/www-misc/profile-sync-daemon
+
=== Ubuntu ===
+
 
To add the PPA (personal package archive) to your Ubuntu (packages available for Lucid and newer) system, and to install psd:
 
To add the PPA (personal package archive) to your Ubuntu (packages available for Lucid and newer) system, and to install psd:
  

Revision as of 10:32, 20 July 2013

Template:Article summary start Template:Article summary text Template:Article summary heading Template:Article summary wiki Template:Article summary wiki Template:Article summary wiki Template:Article summary wiki Template:Article summary wiki Template:Article summary end

Benefits of Psd

Running this daemon is beneficial for two reasons:

  1. Reduced wear to physical discs
  2. Speed

Since the profile(s), browser cache*, etc. are relocated into tmpfs (RAM disk), the corresponding onslaught of I/O associated with using the browser is also redirected from the physical disc to RAM, thus reducing wear to the physical disc and also greatly improving browser speed and responsiveness. For example, the access time of RAM is on the order of nanoseconds while the access time of physical discs is on the order of milliseconds. This is a difference of six orders of magnitude or 1,000,000 times faster.

Note: Chromium actually keeps its cache directory separately from its browser profile directory. It is not within the scope of profile-sync-daemon to modify this behavior; users are encouraged to refer to the Chromium_Tips_and_Tweaks#Cache_in_tmpfs section of the main Chromium_Tips_and_Tweaks article for several work-arounds.

Supported Browsers

Currently, the following browsers are auto-detected and managed:

Setup and Installation

profile-sync-daemonAUR is available for download from the AUR. Build it and install like any other package.

Edit /etc/psd.conf

Edit the included /etc/psd.conf defining which user(s) will have their profiles managed by psd.

Example:

# List users separated by spaces whose browser(s) profile(s) will get symlinked 
# and sync'ed to tmpfs.
# Do NOT list a user twice!
USERS="facade happy"
Note: At least one user must be defined.

Optionally uncomment the BROWSERS array and populate it with whichever browser(s) are to be sync'ed to tmpfs. If the BROWSERS array stays commented (default) then all supported browser profiles will be sync'ed if they exist.

Example: Let's say that Chromium, Opera and Midori are installed but only Chromium and Opera are to be sync'ed to tmpfs since the user keeps Midori as a backup browser and it is seldom used:

# List browsers separated by spaces to include in the sync. Useful if you do not
# wish to have all possible browser profiles sync'ed.
#
# Possible values:
#   chromium
#   conkeror.mozdev.org
#   firefox
#   firefox-trunk
#   google-chrome
#   heftig-aurora 
#   midori
#   opera
#   opera-next
#   qupzilla
#
# If the following is commented out (default), then all available/supported 
# browsers will be sync'ed, separated by comma
BROWSERS="chromium opera"

Using PSD

Preview Mode (Parse)

The 'parse' option can be called to show users exactly what psd will do based on the /etc/psd.conf entered. Call it like so:

$ profile-sync-daemon parse
 Profile-sync-daemon v5.24

Psd will manage the following per /etc/psd.conf settings:

browser/psname:  chromium/chromium
owner/group:     facade/users
sync target:     /home/facade/.config/chromium
tmpfs dir:       /tmp/facade-chromium
profile size:    81M

browser/psname:  firefox/firefox
owner/group:     facade/users
sync target:     /mnt/data/docs/facade/mozilla/firefox/1Zp9V43q.banking
tmpfs dir:       /tmp/facade-firefox-1Zp9V43q.banking
profile size:    5.9M

browser/psname:  firefox/firefox
owner/group:     facade/users
sync target:     /mnt/data/docs/facade/mozilla/firefox/obg67zqQ.proxy
tmpfs dir:       /tmp/facade-firefox-obg67zqQ.proxy
profile size:    17M

As shown in the output and as stated above, if no specific browser or subset of browsers are defined in the BROWSERS array, psd will sync ALL supported profiles that it finds for the given user(s).

Running PSD to Manage Profiles

Do not call /usr/bin/profile-sync-daemon to sync or to unsync directly. Instead use the provided service files.

Both a systemd service file and a timer are provided and should be used to interact with psd. Both should be invoked together! The role of the timer is update the tmpfs copy/copies back to the disk which it does once per hour. Failure to start the resync timer will result in the profile being sync'ed only on start up and shutdown.

# systemctl [option] psd.service psd-resync.service

Available options:

start  Turn on daemon and timer.
stop  Turn off daemon and timer.
enable  Autostart daemon and timer on boot-up.
disable  Don't autostart daemon and timer on boot-up.


Start psd and its timer as well as set psd and its timer to start/stop at boot/shutdown (highly recommended):

# systemctl enable psd.service psd-resync.service
# systemctl start psd.service psd-resync.service

Obviously, you must first close your browser before starting the service.

Sync at More Frequent Intervals (Optional)

The package provided timer syncs once per hour. Users may optionally redefine this behavior simply be creating their own timer with whatever interval is desired. The example below syncs once every ten minutes:

/etc/systemd/system/my-psd-resync.timer
[Unit]
Description=My own profile resync
After=psd.service
Conflicts=psd-resync.timer

[Timer]
Unit=psd-resync.service
OnUnitActiveSec=10min
Note: The 'Conflicts...' line disables the package-provided timer and allows 'my-psd-resync.timer' to take over and work with psd-resync.service.

See `man systemd.timer` for additional options.

Caveats for Firefox and Heftig's Aurora ONLY

The way psd keeps track of browser profiles and sync targets requires users to have a unique name as the last directory for all profiles in their respective $HOME/.mozilla/<browser>/profiles.ini files. Psd will check when it is called to run for this and refuse if this rule is not satisfied. The following is an example of a BAD profile that will fail the the test. Note that although each full path is unique, they both end in the same name! Again, the user must modify the profiles.ini and the corresponding directory on the filesystem to correct this in order to use Psd.

$ cat ~/.mozilla/firefox/profiles.ini

[General]
StartWithLastProfile=1

[Profile0 for user facade]
Name=normal
IsRelative=0
Path=/mnt/data/docs/facade/mozilla/firefox/myprofile.abc
Default=1

[Profile1 for user happy]
Name=proxy
IsRelative=0
Path=/mnt/data/docs/happy/mozilla/firefox/myprofile.abc

Support

Post in the discussion thread with comments or concerns.

PSD On Other Distros

Psd is a bash script and should therefore run on any Linux distro. Below is a list of distros known to package psd, and a link to download their respective packages.

Note: Different distros use different init systems. The packages linked below are configured to use the default init system for the given distro.
Distro Default Init System Link to Package
Arch Systemd AUR.
Chakra Systemd CCR.
Debian Upstart Graysky's PPA, See instruction below.
Exherbo Systemd In official repos.
Fedora Systemd In official repos.
Gentoo OpenRC In official repos.
Mint Upstart Graysky's PPA, See instruction below.
OpenSUSE Upstart Packaged by Overman79.
Ubuntu Upstart Graysky's PPA, See instruction below.
Void Systemd In official repos.

Debian

To add the PPA (personal package archive) to your Debian (tested on squeeze) system, and to install psd:

# echo "deb http://ppa.launchpad.net/graysky/utils/ubuntu quantal main" > /etc/apt/sources.list.d/graysky.list
# echo "deb-src http://ppa.launchpad.net/graysky/utils/ubuntu quantal main" >> /etc/apt/sources.list.d/graysky.list
# apt-key adv --keyserver keyserver.ubuntu.com --recv-keys FF7F9516
# apt-get update
# apt-get install profile-sync-daemon

Mint and Ubuntu

To add the PPA (personal package archive) to your Ubuntu (packages available for Lucid and newer) system, and to install psd:

$ sudo add-apt-repository ppa:graysky/utils
$ sudo apt-get update
$ sudo apt-get install profile-sync-daemon

External Links Mentioning PSD