separate user and system services

- simpler script
- added user service
- fix crontab (every hour instead of every minutes...)

Author: remileduc

README.md

@@ -58,22 +58,23 @@ Systemd mount this folder in RAM by default. If you are lucky, you don't have an
 		Sys. de fichiers Type     Taille Utilisé Dispo Uti% Monté sur
 		udev             devtmpfs    16G       0   16G   0% /dev
 		tmpfs            tmpfs      3,2G    9,6M  3,2G   1% /run
-		/dev/nvme0n1p6   ext4       183G    5,2G  168G   3% /
+		/dev/nvme0n1p6   ext4       183G    5,4G  168G   4% /
 		tmpfs            tmpfs       16G       0   16G   0% /dev/shm
 		tmpfs            tmpfs      5,0M    4,0K  5,0M   1% /run/lock
 		tmpfs            tmpfs       16G       0   16G   0% /sys/fs/cgroup
-		tmpfs            tmpfs       16G    109M   16G   1% /var/cache
-		tmpfs            tmpfs       16G    120K   16G   1% /tmp
-		tmpfs            tmpfs       16G     35M   16G   1% /var/log
+		tmpfs            tmpfs       16G     44K   16G   1% /tmp
+		tmpfs            tmpfs       16G    127M   16G   1% /var/cache
+		tmpfs            tmpfs       16G     38M   16G   1% /var/log
 		/dev/nvme0n1p5   ext4       233M     24M  193M  11% /boot
 		/dev/nvme0n1p2   vfat        95M     25M   71M  27% /boot/efi
 		/dev/nvme0n1p7   ext4       262G     47G  202G  19% /home
-		tmpfs            tmpfs       16G    406M   16G   3% /home/xinouch/.cache
-		/dev/nvme0n1p4   fuseblk    500G     42G  458G   9% /mnt/w10
+		tmpfs            tmpfs       16G     58M   16G   1% /home/xinouch/.mozilla
+		tmpfs            tmpfs       16G    434M   16G   3% /home/xinouch/.cache
+		/dev/nvme0n1p4   fuseblk    500G     93G  407G  19% /mnt/w10
 		/dev/sda2        fuseblk    924G    287G  637G  32% /mnt/data
-		/dev/sda3        ext4       7,9G    584M  6,9G   8% /mnt/persistent
+		/dev/sda3        ext4       7,9G    691M  6,8G  10% /mnt/persistent
 		tmpfs            tmpfs      3,2G       0  3,2G   0% /run/user/114
-		tmpfs            tmpfs      3,2G     16K  3,2G   1% /run/user/1000
+		tmpfs            tmpfs      3,2G     12K  3,2G   1% /run/user/1000
 ```
 
 All the lines with a `tmpfs` filesystem are mounted on the RAM. So, if you have the line
@@ -102,7 +103,9 @@ Reboot and voilà!
 Cache in ramdisk
 ================
 
-You have 2 cache folders: the system one in `/var/cache` and the user one in `/home/$USER/.cache`. We will also take care of the logs in `/var/log`. If you don't want it, check the last subsection of this section.
+You have 2 cache folders: the system one in `/var/cache` and the user one in `/home/$USER/.cache`. We will also take care of the logs in `/var/log` along with the firefox session folder. If you don't want it, check the last subsection of this section.
+
+We need to distinguish 2 types of folders here: the system folders and the user folders. The user folders will be mounted later in the boot, while the system folders will be mounted as soon as possible. For me, it takes 1 minute to load user data.
 
 Change files for your config
 ----------------------------
@@ -132,23 +135,29 @@ now you can simply
 	$ mv home-xinouch-.cache.mount home-{USER}-.cache.mount
 ```
 
-### copycache.service ###
+### home-xinouch-.mozilla.mount ###
+
+Same as in the previous section.
+
+### userramdisk.service ###
 
-In the section [Unit], change the key `RequiresMountsFor` for the last element:
+In the section [Unit], change the key `RequiresMountsFor`:
 
 ```
-	RequiresMountsFor=/var/cache /var/log /home/{USER}/.cache
+	RequiresMountsFor=/home/{USER}/.cache /home/{USER}/.mozilla
 ```
 
 ### ramdisk_cache.sh ###
 
-You need to change all the `persistent` and `user` config variables at the top of the file:
+You need to change the `ramdisks` variable with your paths:
 
 ```bash
-	cacheUser="/home/xinouch/.cache"
-	persistent="/mnt/persistent/system"
-	persistentLog="/mnt/persistent/log"
-	persistentUser="/mnt/persistent/home"
+	declare -A ramdisks=(
+		["cache"]="/var/cache /mnt/persistent/system"
+		["log"]="/var/log /mnt/persistent/log"
+		["usercache"]="/home/xinouch/.cache /mnt/persistent/home"
+		["firefoxsession"]="/home/xinouch/.mozilla /mnt/persistent/firefox"
+	)
 ```
 
 Here, we assume that everything will be saved into a partition mounted in `/mnt/persistent`. You can save it in your home if you want, though you shouldn't store root data in your home... Anyway, be sure that the filesystem for the persistency is NOT `NTFS` but a Linux thing like `ext4`, or you will destroy the permissions... It is also recommended to mount it with the following permissions, as it should be just a backup: `defaults,nodev,noexec,nosuid,noatime,nodiratime`.
@@ -161,15 +170,17 @@ Now that everything is correctly configured, we need to install everything in th
 ```
 	# cp ramdisk_cache.sh /usr/local/sbin/
 	# chmod u+x /usr/local/sbin/ramdisk_cache.sh
-	# cp copycache.service /etc/systemd/system/
-	# cp var-cache.mount var-log.mount home-{USER}-.cache.mount /usr/share/systemd/
+	# cp systemramdisk.service /etc/systemd/system/
+	# cp userramdisk.service /etc/systemd/system/
+	# cp var-cache.mount var-log.mount home-{USER}-.cache.mount home-{USER}-.mozilla.mount /usr/share/systemd/
 
 	# ln -s /usr/share/systemd/var-cache.mount /etc/systemd/system/var-cache.mount
 	# ln -s /usr/share/systemd/var-log.mount /etc/systemd/system/var-log.mount
 	# ln -s /usr/share/systemd/home-{USER}-.cache.mount /etc/systemd/system/home-{USER}-.cache.mount
+	# ln -s /usr/share/systemd/home-{USER}-.mozilla.mount /etc/systemd/system/home-{USER}-.mozilla.mount
 
 	# systemctl daemon-reload
-	# systemctl enable var-cache.mount var-log.mount home-{USER}-.cache.mount copycache.service
+	# systemctl enable var-cache.mount var-log.mount home-{USER}-.cache.mount home-{USER}-.mozilla.mount systemramdisk.service userramdisk.service
 ```
 
 Before rebooting, we need to save the cache (and check everything works :p), so run `ramdisk_cache.sh` as root and check that your persistent folders are filled with the correct data.
@@ -178,7 +189,7 @@ We also need to setup a `cron` so the script is run every X minutes (here every
 
 ```
 	# crontab -e
-		* */1 * * * /usr/local/sbin/ramdisk_cache.sh
+		0 * * * * /usr/local/sbin/ramdisk_cache.sh cache log usercache firefoxsession
 ```
 
 Get rid of `/var/log`
@@ -196,14 +207,14 @@ Get rid of `/var/log`
 
 At the install step, don't copy, link or enable the file `var-log.mount`.
 
-### Change the service copycache ###
+### Change the service systemramdisk ###
 
-In the section `Unit` of `copycache.service`, change the keys `Before` and `RequiresMountsFor`. If you already installed it, do the changes to the file `/etc/systemd/system/copycache.service`:
+In the section `Unit` of `systemramdisk.service`, change the keys `Before` and `RequiresMountsFor`. If you already installed it, do the changes to the file `/etc/systemd/system/systemramdisk.service`:
 
 ```
 	Before=sysinit.target shutdown.target
 	...
-	RequiresMountsFor=/var/cache /home/{USER}/.cache
+	RequiresMountsFor=/var/cache
 ```
 
 ### Change the script ###
@@ -212,6 +223,11 @@ Remove everything related to logs. If you already did the install, change the fi
 
 Finish by executing `systemctl daemon-reload` as root.
 
+Change the user ramdisks
+------------------------
+
+In the same way, edit the files corresponding to the user ramdisks if you don't want it.
+
 License
 =======
 

home-xinouch-.mozilla.mount

@@ -0,0 +1,35 @@
+#    Debian-Systemd-Ramdisk (DSR) is a config repo used to create a ramdisk with systemd.
+#    Copyright (C) 2017  Rémi Ducceschi (remileduc) <remi.ducceschi@gmail.com>
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+# systemd unit file that mounts the user's cache folder
+[Unit]
+Description=User Firefox session Directory
+Documentation=man:hier(7)
+Documentation=http://www.freedesktop.org/wiki/Software/systemd/APIFileSystems
+ConditionPathIsSymbolicLink=!/home/xinouch/.mozilla
+DefaultDependencies=no
+Conflicts=umount.target
+Before=local-fs.target umount.target
+After=swap.target
+
+[Mount]
+What=tmpfs
+Where=/home/xinouch/.mozilla
+Type=tmpfs
+Options=mode=1777,strictatime,nosuid,nodev
+
+[Install]
+WantedBy=local-fs.target

ramdisk_cache.sh

@@ -20,44 +20,47 @@
 
 set -efu
 
-cache="/var/cache"
-log="/var/log"
-cacheUser="/home/xinouch/.cache"
-persistent="/mnt/persistent/system"
-persistentLog="/mnt/persistent/log"
-persistentUser="/mnt/persistent/home"
+# we create a dictionnary whose values are strings with space separated paths.
+# the first path is the mounted ramdisk, the second path is the save folder.
+
+declare -A ramdisks=(
+#	["test"]="mounted persistent" # mkdir mounted persistent; touch persistent/test
+	["cache"]="/var/cache /mnt/persistent/system"
+	["log"]="/var/log /mnt/persistent/log"
+	["usercache"]="/home/xinouch/.cache /mnt/persistent/home"
+	["firefoxsession"]="/home/xinouch/.mozilla /mnt/persistent/firefox"
+)
 lockfile=".cache.lock"
 logfile="/tmp/ramdisk_cache.log"
 
-# first we copy system cache
-# if the lockfile exists in cache, we save the cache in persistent
-if [ -e "$cache"/"$lockfile" ]; then
-	rsync -aqu --delete --exclude "$lockfile" "$cache/" "$persistent/"
-	echo "$(date -Iseconds) - system cache saved to persistent" >> "$logfile"
-else # we put persistent cache in ramdisk
-	rsync -aq "$persistent/" "$cache/"
-	touch "$cache"/"$lockfile"
-	echo "$(date -Iseconds) - system cache loaded from persistent" >> "$logfile"
-fi
-
-# second we copy system log
-# if the lockfile exists in cache, we save the cache in persistent
-if [ -e "$log"/"$lockfile" ]; then
-	rsync -aqu --delete --exclude "$lockfile" "$log/" "$persistentLog/"
-	echo "$(date -Iseconds) - logs saved to persistent" >> "$logfile"
-else # we put persistent cache in ramdisk
-	rsync -aq "$persistentLog/" "$log/"
-	touch "$log"/"$lockfile"
-	echo "$(date -Iseconds) - logs loaded from persistent" >> "$logfile"
-fi
-
-# then we copy user cache
-# if the lockfile exists in cache, we save the cache in persistent
-if [ -e "$cacheUser"/"$lockfile" ]; then
-	rsync -aqu --delete --exclude "$lockfile" "$cacheUser/" "$persistentUser/"
-	echo "$(date -Iseconds) - user cache saved to persistent" >> "$logfile"
-else # we put persistent cache in ramdisk
-	rsync -aq "$persistentUser/" "$cacheUser/"
-	touch "$cacheUser"/"$lockfile"
-	echo "$(date -Iseconds) - user cache loaded from persistent" >> "$logfile"
-fi
+function manageRamdisk { # mounted, persistent
+	mounted="$1"
+	persistent="$2"
+
+	# if the lockfile exists in mounted, we save the content in persistent
+	if [ -e "$mounted"/"$lockfile" ]; then
+		rsync -aqu --delete --exclude "$lockfile" "$mounted/" "$persistent/"
+		echo "$(date -Iseconds) - $mounted saved to persistent" >> "$logfile"
+	else # we put persistent content in ramdisk
+		rsync -aq "$persistent/" "$mounted/"
+		touch "$mounted"/"$lockfile"
+		echo "$(date -Iseconds) - $mounted loaded from persistent" >> "$logfile"
+	fi
+}
+
+for ramdisk in $@; do
+	mounted="$(echo ${ramdisks[$ramdisk]} | cut -sd ' ' -f 1)"
+	persistent="$(echo ${ramdisks[$ramdisk]} | cut -sd ' ' -f 2)"
+
+	# if wrong parameter, we terminate
+	if [ -z "$mounted" ] || [ -z "$persistent" ]; then
+		echo "'$ramdisk' is not valid." >> "$logfile"
+		echo "'$ramdisk' is not valid. Use one of these:"
+		for r in "${!ramdisks[@]}"; do
+			echo -e "\t$r"
+		done
+		exit 1
+	fi
+
+	manageRamdisk "$mounted" "$persistent"
+done

copycache.service systemramdisk.servicecopycache.service renamed to systemramdisk.service

@@ -16,18 +16,18 @@
 
 # systemd service unit file that calls the script to load / save persistent data
 [Unit]
-Description=Copy or Save cache folders
+Description=Copy or Save SYSTEM cache folders
 DefaultDependencies=no
 Before=rsyslog.service syslog.target systemd-journald.service sysinit.target shutdown.target
 After=local-fs.target
 Conflicts=shutdown.target
-RequiresMountsFor=/var/cache /var/log /home/xinouch/.cache
+RequiresMountsFor=/var/cache /var/log
 IgnoreOnIsolate=yes
 
 [Service]
 Type=oneshot
-ExecStart=/usr/local/sbin/ramdisk_cache.sh
-ExecStop=/usr/local/sbin/ramdisk_cache.sh
+ExecStart=/usr/local/sbin/ramdisk_cache.sh cache log
+ExecStop=/usr/local/sbin/ramdisk_cache.sh cache log
 RemainAfterExit=yes
 
 [Install]

userramdisk.service

@@ -0,0 +1,35 @@
+#    Debian-Systemd-Ramdisk (DSR) is a config repo used to create a ramdisk with systemd.
+#    Copyright (C) 2017  Rémi Ducceschi (remileduc) <remi.ducceschi@gmail.com>
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+# systemd service unit file that calls the script to load / save persistent data
+[Unit]
+Description=Copy or Save USER cache folders
+DefaultDependencies=no
+# This may need to be changed: sysinit.target may not be the best requirement
+Before=sysinit.target shutdown.target
+After=local-fs.target
+Conflicts=shutdown.target
+RequiresMountsFor=/home/xinouch/.cache /home/xinouch/.mozilla
+IgnoreOnIsolate=yes
+
+[Service]
+Type=oneshot
+ExecStart=/usr/local/sbin/ramdisk_cache.sh usercache firefoxsession
+ExecStop=/usr/local/sbin/ramdisk_cache.sh usercache firefoxsession
+RemainAfterExit=yes
+
+[Install]
+WantedBy=multi-user.target