This generator provides a simple and fast mechanism to configure swap on /dev/zram*
devices.
The main use case is create swap devices, but devices with a file system can be created too, see below.
A default config file may be located in /usr. This generator checks the following locations:
/run/systemd/zram-generator.conf
/etc/systemd/zram-generator.conf
/usr/local/lib/systemd/zram-generator.conf
/usr/lib/systemd/zram-generator.conf
… and the first file found in that list wins.
In addition, "drop-ins" will be loaded from .conf
files in
/etc/systemd/zram-generator.conf.d/
,
/usr/lib/systemd/zram-generator.conf.d/
, etc.
The main configuration file is read before any of the drop-ins and has the lowest precedence; entries in the drop-in files override entries in the main configuration file.
See systemd.unit(5) for a detailed description of this logic.
See zram-generator.conf.example
for a list of available settings.
Create /etc/systemd/zram-generator.conf
:
# /etc/systemd/zram-generator.conf
[zram0]
zram-fraction = 0.5
A zram device will be created for each section. No actual
configuration is necessary (the default of zram-fraction=0.5
will be
used unless overriden), but the configuration file with at least one
section must exist.
# /etc/systemd/zram-generator.conf
[zram1]
mount-point = /var/tmp
This will set up a /dev/zram1 with ext2 and generate a mount unit for /var/tmp.
The second purpose of this program is to serve as an example of a systemd generator in rust. Details are still being figured out.
It is recommended to use an existing package:
- Fedora:
sudo dnf install zram-generator-defaults
(orsudo dnf install zram-generator
to install without the default configuration) - Debian: packages provided by nabijaczleweli, see https://debian.nabijaczleweli.xyz/README.
- Arch: AUR packages https://aur.archlinux.org/packages/zram-generator/ (or https://aur.archlinux.org/packages/zram-generator-git/ for the latest git commit)
To install directly from sources, execute make install
:
zram-generator
binary is installed in the systemd system generator directory (usually/usr/lib/systemd/system-generators/
)zram-generator(8)
andzram-generator.conf(5)
manpages are installed into/usr/share/man/manN/
, this requiresronn
.units/systemd-zram-setup@.service
is copied into the systemd system unit directory (usually/usr/lib/systemd/system/
)zram-generator.conf.example
is copied into/usr/share/doc/zram-generator/
You need though create your own config file at one of the locations listed above.
The tests require either the zram
module to be loaded, or root to run modprobe zram
.
Set the ZRAM_GENERATOR_ROOT
environment variable to use that
instead of /
as root.
The "{generator}" template in units/systemd-zram-setup@.service.d/binary-location.conf
can be substituted for a non-standard location of the binary for testing.
Written by Zbigniew Jędrzejewski-Szmek zbyszek@in.waw.pl, Igor Raits i.gnatenko.brain@gmail.com, наб nabijaczleweli@gmail.com, and others. See https://github.com/systemd/zram-generator/graphs/contributors for the full list.