https://github.com/vaeth/zram-init
A wrapper script for the zram linux kernel module with zsh and openrc support
https://github.com/vaeth/zram-init
initscript openrc systemd wrapper-script zram
Last synced: 6 months ago
JSON representation
A wrapper script for the zram linux kernel module with zsh and openrc support
- Host: GitHub
- URL: https://github.com/vaeth/zram-init
- Owner: vaeth
- Created: 2012-03-02T10:09:10.000Z (over 13 years ago)
- Default Branch: main
- Last Pushed: 2022-01-13T21:07:04.000Z (over 3 years ago)
- Last Synced: 2024-07-10T00:38:10.576Z (11 months ago)
- Topics: initscript, openrc, systemd, wrapper-script, zram
- Language: Shell
- Homepage: http://www.mathematik.uni-wuerzburg.de/~vaeth/download/index.html#zram-init
- Size: 113 KB
- Stars: 78
- Watchers: 9
- Forks: 26
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: ChangeLog
Awesome Lists containing this project
README
# zram-init
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 the `AUTHORS` 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 a __zsh completion__ file and __openrc__ and __systemd__ init-scripts
are provided.
## General instructions
If `zramctl` (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 need `push.sh` (v2.0 or newer) in your `$PATH`, see
https://github.com/vaeth/push/
To install this script, just copy the content of `sbin` into root's `$PATH`.
To obtain support for __zsh completion__, copy the content of `zsh` to
zsh's `$fpath`.
For __openrc__ support, the content of openrc should go into `/etc`.
For __systemd__ support, the content of `systemd/system` should go into a
systemd unit directory (`pkg-config --variable=systemdsystemunitdir systemd`,
usually `/lib/systemd/system` or `/usr/lib/systemd/system`) and be modified
and enabled with `systemctl enable ...` for the desired setting.
(Or install locally, e.g. directly into `/etc/systemd/system`).
For systemd and optionally also for openrc the content of `modprobe.d`
should go into `/lib/modprobe.d` or `/etc/modprobe.d` and be modified
appropriately.
To use `LZ4` compression with zram your kernel needs to be compiled with
a 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)
## Instructions for specific distributions
### General
To install this script, you should use:
```
make install # for installation to /usr/local
make PREFIX=/usr install # /usr instead of /usr/local
```
### Gentoo based
There is an ebuild in the main gentoo tree (usually an older version)
and in the mv overlay (current version).
### Alpine Linux
A __zram-init__ package is available.
### Arch based
To install on Arch based distribution: install `zram-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`