Repository files navigation

A wrapper script for the zram kernel module with interactive and init support

(C) Martin Väth (martin at mvath.de).Many thanks to all people in theAUTHORS file for contributing.The license of this package is the GNU Public License GPL-2.SPDX-License-Identifier: GPL-2.0-only

This is a small helper script to setup a zram device as swap or as a ramdisk.Also azsh completion file andopenrc andsystemd init-scriptsare provided.

Ifzramctl (from>=util-linux-2.26) is available,this is used by default.Currently, this is not a dependency: a manual method is provided as a fallback.The latter might be removed in a future release of this script.

If you want to use one of the options-K-M-2-Z to pass generic args,you needpush.sh (v2.0 or newer) in your$PATH, seehttps://github.com/vaeth/push/

To install this script, just copy the content ofsbin into root's$PATH.To obtain support forzsh completion, copy the content ofzsh tozsh's$fpath.Foropenrc support, the content of openrc should go into/etc.Forsystemd support, the content ofsystemd/system should go into asystemd unit directory (pkg-config --variable=systemdsystemunitdir systemd,usually/lib/systemd/system or/usr/lib/systemd/system) and be modifiedand enabled withsystemctl enable ... for the desired setting.(Or install locally, e.g. directly into/etc/systemd/system).For systemd and optionally also for openrc the content ofmodprobe.dshould go into/lib/modprobe.d or/etc/modprobe.d and be modifiedappropriately.

To useLZ4 compression with zram your kernel needs to be compiled witha corresponding options. Depending on your kernel version this might be

• CONFIG_ZRAM_LZ4_COMPRESS=y (for older kernels)
• CONFIG_CRYPTO_LZ4=y (for recent kernels)

To install this script, you should use:

make install # for installation to /usr/localmake PREFIX=/usr install  # /usr instead of /usr/local

There is an ebuild in the main gentoo tree (usually an older version)and in the mv overlay (current version).

Azram-init package is available.

To install on Arch based distribution: installzram-init from AUR

Once installed, configure:

sudo cp /usr/lib/systemd/system/zram* /etc/systemd/system/

• Lets make your configuration tweaks in

    /etc/modprobe.d/zram.conf  /etc/systemd/system/zram_swap.service  /etc/systemd/system/zram_tmp.service  /etc/systemd/system/zram_var_tmp.service

• start

    sudo systemctl start zram_swap.service  sudo systemctl start zram_tmp.service  sudo systemctl start zram_var_tmp.service

• and finaly enable

    sudo systemctl enable zram_swap.service  sudo systemctl enable zram_tmp.service  sudo systemctl enable zram_var_tmp.service

Optional remove any swap references in/etc/fstab