Skip to content

Latest commit

 

History

History
70 lines (51 loc) · 2.94 KB

README.md

File metadata and controls

70 lines (51 loc) · 2.94 KB
Raw

ContainerBox

What is it?

A tool on top of LXD to easily create and use containers with full graphical capability (a display manager and a desktop environment)

Why?

The main idea is to have the usability from virtualization tools like VirtualBox but without the overhead of running inside a VM. Unprivilleged LXC containers allow for near 0 overhead while still maintaining reasonnable isolation.

How does it work?

The host managed resources are exposed to the container when the latter is not able to manage them (ex: starting a display server). Security is kept in mind so everything that needs to run on the host is isolated as much as possible (ex: nested Xorg server run as unprivilleged user) .

Usage

  • Install
  • Install lxd and xephyr (and xpra if you want) on your host
  • Run install.sh
  • Create a container
  • ContainerBox create -n NAME_OF_CONTAINER(required) -t DISTRO_TO_USE (ubuntu debian fedora -- default: fedora) -d DESKTOP_ENVIRONMENT(KDE GNOME XFCE MATE -- default: XFCE) --x yes|no (experimental xpra support -- default:no)
  • Start a container
  • ContainerBox start -n NAME -m DISPLAY_METHOD (xephyr xpra xorg[rootless Xorg] -- default: xephyr) -f yes|no (fullscreen ?) --c no|DISPLAY_NUMBER (share clipboard)
  • GPU accelerated app in container
  • ContainerBox runapp NAME "command arg1 arg2 ... argN" secure(default)|nested|insecure [WIDTHxHEIGHT]
  • NOTE: 'secure' requires to be running inside a wayland environment and 'nested' having kwin_wayland and XWayland installed
  • Configure a container
  • ContainerBox config network|system|shared_folder|sound NAME_OF_CONTAINER(required) [ OPTIONS ]
  • Take Snapshot of a container
  • ContainerBox snapshot NAME_OF_CONTAINER(required) create|restore|save_state|restore_state|export|import|list [OPTIONS]
  • Show Usage
  • ContainerBox create|config|runapp|snapshot help

NOTES

  • GNOME Can only work if the display has OpenGL. Possible options are: xorg, xspice, xpra

  • For security reasons, Xorg backend starts a Xorg server as the currently logged user (be sure to add this user to video and input groups). It also opens the first available tty, which requires root privileges, and thus the user must also be a sudoer.

SCREENSHOTS

LightDM ContainerBox XFCE Debian ContainerBox

TODO List (in order of priority)

  • Improve install script (create .deb and .rpm packages ?)
  • Write user documentation
  • Create a nice GUI on top of the CLI (WIP)
  • Install from an ISO image (maybe use QEMU to perform the install the lxd-p2c)
  • Your suggestions (as long as it can be done through LXD/LXC)

AUTHOR:

Alexandre Dey

DISCLAIMER

This is still experimental use at your own risk (no real reason for it to break anything, but still)