liaf/readme.md
# Liaf
**Liaf** (Linux In A Folder) is a collection of scripts for creating self-contained Alpine Linux chroots and sandboxes.
**Dependencies:** Bubblewrap and the `chroot` binary.
## Usage
Build a sandbox or chroot(chroot require root privileges) :
liaf -t <sandbox|chroot> -o <project-name> [options]
Run a sandbox or chroot:
liaf -r <environment-name> [-e <executable>]
## Docs
You can find a little docs here [Liaf docs](https://www.freemedialab.org/code/liaf/docs/index.html).
## Build a custom chroot/sandbox whith "other folder scripts"
To create a custom chroot or sandbox, use the following scripts.
| Script | Description |
|---|---|
| `liaf-make-chroot` (from root) | Creates a complete Alpine Linux chroot. |
| `liaf-make-chroot-openrc` (from root) | Creates a complete Alpine Linux chroot with OpenRC. |
| `liaf-make-chroot-openrc-bg` (from root) | Starts OpenRC in the background. Unmount the chroot with `./umount.sh` when finished. |
| `liaf-make-sandbox` | Creates a complete Alpine Linux unpriviliged sandbox using Bubblewrap. |
## Custom options
To customize the runtime options, edit `./run.sh` .