# Conty
[](https://github.com/Kron4ek/Conty/actions/workflows/conty.yml) [](https://github.com/Kron4ek/Conty/actions/workflows/utils.yml)
This is an easy to use compressed unprivileged Linux container packed into a single executable that works on most Linux distros. It is designed to be as simple and user-friendly as possible. You can use it to run any applications, including games (Vulkan and OpenGL).
## Features
* A single executable - download (or create) and run, nothing else is required. And it's portable, you can put it anywhere (even on a usb stick).
* Works on most Linux distros, even very old ones and even without glibc (such as Alpine or Void or Gentoo with musl).
* Works on Steam Deck.
* Root rights are **not required**.
* Compressed (with squashfs or dwarfs), so it takes a lot less disk space than uncompressed containers and can provide faster filesystem access in some cases.
* Contains many packages and libraries, it can run almost everything, and you don't need to install anything on your main (host) system. **You can even run 32-bit applications on pure 64-bit systems**.
* Based on Arch Linux, contains modern software (including fresh videodrivers).
* Almost completely seamless experience. All applications that you run with Conty read and store their configs in your $HOME directory as if you weren't using the container at all.
* No performance overhead. Since it's just a container, there is virtually no performance overhead, all applications will run at full speed. Regarding memory usage, Conty uses a bit more memory due to compression and because applications from the container can't share libraries with your system apps.
* Supports Xorg, Wayland and XWayland.
* Supports filesystem and X11 sandboxing (thanks to bubblewrap and xephyr).
* Supports Chaotic-AUR and ALHP repositories. AUR is also supported.
In its default release, it includes, among others, these apps: `Wine-Proton, Steam, Lutris, PlayOnLinux, GameHub, Minigalaxy, Legendary, Bottles, PrismLauncher, MangoHud, Gamescope, RetroArch, Sunshine, OBS Studio, OpenJDK, Firefox`. The full list can be read in the [latest release's pkg_list.txt](https://github.com/Kron4ek/Conty/releases/latest/download/pkg_list.txt).
If these applications are not enough, you can install additional applications or run external binaries from, for example, your home directory.
## Navigate
Expand
* [Getting Started](#getting-started)
+ [Download](#download)
+ [Requirements](#requirements)
* [Usage](#usage)
+ [GUI](#gui)
+ [CLI](#cli)
* [Managing](#managing)
+ [Install Conty](#install-conty)
+ [How to update](#how-to-update)
* [How to create your own Conty executables](#how-to-create-your-own-conty-executables)
+ [Manual](#manual)
+ [Automated (GitHub Actions)](#automated-github-actions)
* [Useful Tips](#useful-tips)
+ [Sandbox](#sandbox)
+ [About Wine](#about-wine)
* [Known issues](#known-issues)
* [Main used projects](#main-used-projects)
Table of contents generated with markdown-toc
File manager
It has a builtin file manager (pcmanfm):
```
$ ./conty.sh pcmanfm
```
You can also install your own file manager if you want to, but note that file manager will browse the root inside of Conty except for directories that are mounted from the user's root. `/home` is mounted by Conty to allow access to the user's home files.
Checking hardware acceleration
To check if hardware acceleration (OpenGL and Vulkan) works, you can use these tools:
```
$ ./conty.sh glxinfo -B
$ ./conty.sh glxgears
$ ./conty.sh vulkaninfo
$ ./conty.sh vkcube
```
Using Conty as build environment
You can even use Conty for compilation:
```
$ ./conty.sh gcc src.c
$ ./conty.sh git clone https://something.git
$ cd something && ./conty.sh ./configure
$ ./conty.sh make
```
Listing binaries inside Conty
There are many more integrated programs. You can list all of them with:
```
$ ./conty.sh ls /usr/bin
$ ./conty.sh ls /opt
```
Executing user's binaries
It is also possible to run binaries from your storage. For example, if you want to run an application that resides on your HOME, run something like:
```
$ ./conty.sh /home/username/SomeApplication/binaryfile
```
Note that you cannot run AppImage from Conty (this includes AppImage installed from AUR through Conty's package manager) except for extracting the AppImage's content, after which you may use the manually extracted content.
Help Content
```
Usage: conty.sh [COMMAND] [ARGUMENTS]
Arguments:
-e Extract the image
-h Display this text
-H Display bubblewrap help
-g Run the Conty's graphical interface
-l Show a list of all installed packages
-d Export desktop files from Conty into the application menu of
your desktop environment.
Note that not all applications have desktop files, and also that
desktop files are tied to the current location of Conty, so if
you move or rename it, you will need to re-export them.
To remove the exported files, use this argument again.
-m Mount/unmount the image
The image will be mounted if it's not, unmounted otherwise.
Mount point can be changed with the BASE_DIR env variable
(the default is /tmp).
-o Show the image offset
-u Update all packages inside the container
This requires a rebuild of the image, which may take quite
a lot of time, depending on your hardware and internet speed.
Additional disk space (about 6x the size of the current file)
is needed during the update process.
-v Display version of this script
-V Display version of the image
Arguments that don't match any of the above will be passed directly to
bubblewrap, so all bubblewrap arguments are supported as well.
Environment variables:
BASE_DIR Sets a custom directory where Conty will extract its
builtin utilities and mount the image.
The default is /tmp.
DISABLE_NET Disables network access.
DISABLE_X11 Disables access to X server.
Note: Even with this variable enabled applications
can still access your X server if it doesn't use
XAUTHORITY and listens to the abstract socket. This
can be solved by enabling XAUTHORITY, disabling the
abstract socket or by disabling network access.
HOME_DIR Sets the home directory to a custom location.
For example: HOME_DIR="/home/user/custom_home"
Note: If this variable is set the home directory
inside the container will still appear as /home/user,
even though the custom directory is used.
QUIET_MODE Disables all non-error Conty messages.
Doesn't affect the output of applications.
SANDBOX Enables a sandbox.
To control which files and directories are available
inside the container, you can use the --bind and
--ro-bind launch arguments.
(See bubblewrap help for more info).
SANDBOX_LEVEL Controls the strictness of the sandbox.
Available levels:
1: Isolates all user files.
2: Additionally disables dbus and hides all
running processes.
3: Additionally disables network access and
isolates X11 server with Xephyr.
The default is 1.
USE_OVERLAYFS Mounts a writable unionfs-fuse filesystem on top
of the read-only squashfs/dwarfs image, allowing to
modify files inside it.
Overlays are stored in ~/.local/share/Conty. If you
want to undo any changes, delete the entire
directory from there.
NVIDIA_HANDLER Fixes issues with graphical applications on Nvidia
GPUs with the proprietary driver. Enable this only
if you are using an Nvidia GPU, the proprietary
driver and encountering issues running graphical
applications. At least 2 GB of free disk space is
required. This function is enabled by default.
USE_SYS_UTILS Tells the script to use squashfuse/dwarfs and bwrap
installed on the system instead of the builtin ones.
XEPHYR_SIZE Sets the size of the Xephyr window. The default is
800x600.
CUSTOM_MNT Sets a custom mount point for the Conty. This allows
Conty to be used with already mounted filesystems.
Conty will not mount its image on this mount point,
but it will use files that are already present
there.
Additional notes:
System directories/files will not be available inside the container if
you set the SANDBOX variable but don't bind (mount) any items or set
HOME_DIR. A fake temporary home directory will be used instead.
If the executed script is a symlink with a different name, said name
will be used as the command name.
For instance, if the script is a symlink with the name "wine" it will
automatically run wine during launch.
Running Conty without any arguments from a graphical interface (for
example, from a file manager) will automatically launch the Conty's
graphical interface.
Besides updating all packages, you can also install and remove packages
using the same -u argument. To install packages add them as additional
arguments, to remove add a minus sign (-) before their names.
To install: conty.sh -u pkgname1 pkgname2 pkgname3 ...
To remove: conty.sh -u -pkgname1 -pkgname2 -pkgname3 ...
In this case Conty will update all packages and additionally install
and/or remove specified packages.
If you are using an Nvidia GPU, please read the following:
https://github.com/Kron4ek/Conty#known-issues
```
Checking and adding PATH
To check if you have the directory inside your `PATH`, first create the folder, and then use `echo $PATH`. If your distribution does not include the directory, you can add it by adding `export PATH=$PATH:$HOME/.local/bin` somewhere inside the `~/.bashrc` file.
Example
Conty is located in `$HOME/.local/bin/conty.sh`. Then, you ran the following command:
```
$ HOME_DIR=$HOME/Documents/Conty conty.sh --bind $HOME/.steam $HOME/.steam
```
Firefox (and other apps) will be exported to `~/.local/share/applications/Conty` as `firefox-conty.desktop`, it will show up in your menu as `Firefox (Conty)`, and the `Exec=` line inside the exported file will be changed from `env UBUNTU_MENUPROXY=0 /usr/lib/firefox/firefox` to `env HOME_DIR="/home/$USER/Documents/Conty" "/home/$USER/.local/bin/conty.sh" --bind /home/$USER/.steam /home/$USER/.steam env UBUNTU_MENUPROXY=0 /usr/lib/firefox/firefox`.
Illustration
Example
Example 1
```
$ SANDBOX=1 ./conty.sh firefox
```
Example 2
```
$ export SANDBOX=1
$ export SANDBOX_LEVEL=2
$ ./conty.sh --bind ~/.steam ~/.steam --bind ~/.local/share/Steam ~/.local/share/Steam steam
```
Example 3:
```
$ mkdir "/home/username/custom_home_dir"
$ export DISABLE_NET=1
$ export SANDBOX=1
$ export HOME_DIR="/home/username/custom_home_dir"
$ ./conty.sh lutris
```