tinyramfs/README.md

81 lines
1.7 KiB
Markdown
Raw Normal View History

2020-04-17 19:44:25 +05:30
Tinyramfs
=========
**Currently tinyramfs is incomplete, don't expect that everything is working**
2020-02-10 02:43:39 +05:30
Features
2020-04-12 01:06:16 +05:30
--------
2020-04-12 01:01:02 +05:30
- No `local`'s, no bashisms, only POSIX shell
- Portable, not distro specific
- Easy to use configuration
- Build time and init time hooks
- LUKS (detached header, key), LVM
2020-07-16 00:53:12 +05:30
- mdev, mdevd, eudev, systemd-udevd
2020-04-12 01:01:02 +05:30
Dependencies
2020-02-10 02:43:39 +05:30
------------
2020-04-12 01:01:02 +05:30
* POSIX utilities
2020-04-12 01:01:02 +05:30
* POSIX shell
2020-04-17 19:44:25 +05:30
* `switch_root`
* `mount`
* `cpio`
2020-07-16 00:53:12 +05:30
* `strip`
2020-04-17 19:44:25 +05:30
- Optional
2020-07-16 00:53:12 +05:30
* `blkid`
- Required for UUID, LABEL, PARTUUID support
2020-07-16 01:56:12 +05:30
* `mdev` OR `mdevd` OR `eudev` OR `systemd-udevd` OR CONFIG_UEVENT_HELPER
2020-04-17 19:44:25 +05:30
- systemd-udevd not tested
2020-04-12 01:01:02 +05:30
* `lvm2`
- Required for LVM support
2020-04-17 19:44:25 +05:30
* `cryptsetup`
- Required for LUKS support
* `kmod` OR `busybox modutils` with [this patch](https://gist.github.com/illiliti/ef9ee781b5c6bf36d9493d99b4a1ffb6) (already included in KISS Linux)
- Not required for monolithic kernel
2020-04-17 19:44:25 +05:30
Notes
-----
* busybox modutils doesn't handle soft dependencies (modules.softdep). You must manually copy them using hooks
* busybox and toybox blkid doesn't support PARTUUID. You must use util-linux blkid for PARTUUID support
2020-04-17 19:44:25 +05:30
Installation
------------
2020-04-17 19:44:25 +05:30
```sh
git clone https://github.com/illiliti/tinyramfs
cd tinyramfs
make install
vi /etc/tinyramfs/config # edit config for your needs
tinyramfs -o /boot/initramfs
# update your bootloader
# reboot...
```
2020-04-12 01:01:02 +05:30
2020-02-10 02:43:39 +05:30
Configuration
2020-04-12 01:06:16 +05:30
-------------
2020-02-10 02:43:39 +05:30
Statically via config
2020-04-17 19:44:25 +05:30
-----------------
See [config](config)
Dynamically via kernel parameters
2020-04-17 19:44:25 +05:30
-----------------------------
TODO finalize and document kernel command-line parameters
Thanks
------
2020-04-12 01:01:02 +05:30
[E5ten](https://github.com/E5ten)
2020-04-17 19:44:25 +05:30
[dylanaraps](https://github.com/dylanaraps)
2020-04-12 01:01:02 +05:30
2020-08-05 03:22:57 +05:30
Donate
------
You can donate if you like this project
2020-04-12 01:01:02 +05:30
2020-08-05 03:22:57 +05:30
BTC: 1BwrcsgtWZeLVvNeEQSg4A28a3yrGN3FpK