From 6aeb6621c600cc4484386dd26f1e5f3282e220e3 Mon Sep 17 00:00:00 2001 From: ptrcnull Date: Wed, 19 Jan 2022 00:56:57 +0100 Subject: [PATCH] docs: Add more information about the tool and some instructions --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 32ddfb8..22a5712 100644 --- a/README.md +++ b/README.md @@ -2,4 +2,19 @@ > docker but simpler -Usage: `miniroot -root "/opt/something" -workdir "/usr/src/app" -init "/usr/loacal/bin/npm start"` +In contrast to Docker, miniroot **does not**: +- have a concept of images and layers +- isolate networks +- handle volumes or bind mounts +- have a central daemon + +It's just a simple tool that utilises namespaces to run applications in a semi-isolated environment. + +### Usage + +- get rootfs (you can use `docker export container_name > export.tar` for that) +- extract it somewhere +- run miniroot; example: +``` +miniroot -root "/opt/something" -workdir "/usr/src/app" -init "/usr/local/bin/npm start" +```