Update README.md

This commit is contained in:
Kron4ek 2021-03-26 22:14:38 +05:00 committed by GitHub
parent f0a7155c35
commit 07290c755c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -21,14 +21,14 @@ need to install anything on your host system. You can even run 32-bit applicatio
on pure 64-bit systems.
* Based on Arch Linux, so it contains latest software, including latest
videodrivers.
* Almost completely seamless experience. All applcation that you run
* Almost completely seamless experience. All applcations that you run
with Conty store their configs in your HOME directory as if you wouldn't
use container at all.
* Supports filesystem sandboxing
## Requirements
The only requirements are bash, fuse2 and tar. And your /tmp directory
The only requirements are **bash**, **fuse2** and **tar**. And your /tmp directory
should allow binaries execution (which it does by default on most distros).
Also, your Linux kernel must support unprivileged user namespaces. On some
@ -37,16 +37,14 @@ Linux distros this feature is disabled by default and can be enabled with sysfs:
```
sysctl kernel.unprivileged_userns_clone=1
```
or
```
echo 1 > /proc/sys/kernel/unprivileged_userns_clone
```
## Usage
Either download ready-to-use executable from the releases page or create your
Either download ready-to-use executable from the [**releases**](https://github.com/Kron4ek/Conty/releases) page or create your
own (the instructions are below). Make it executable before run.
```
@ -54,7 +52,7 @@ chmod +x conty.sh
./conty.sh command command_arguments
```
For example, if you want to run some application from your HOME directory run:
For example, if you want to run an application from your HOME directory run:
```
./conty.sh /home/username/App/application_binary
@ -68,7 +66,7 @@ Conty also contains Steam, Lutris, Wine-Staging and much more.
./conty.sh wine app.exe
```
Want to check if your graphics acceleration works? Run glxinfo and glxgears:
Want to check if graphics acceleration works? Run glxinfo and glxgears:
```
./conty.sh glxinfo | grep direct
@ -83,12 +81,12 @@ List all built-in binaries with:
## Sandbox
Conty uses bubblewrap and thus support filesystem sandboxing. By default
Conty uses bubblewrap and thus supports filesystem sandboxing. By default
it's disabled and all directories on your system are available for the container.
You can enable sandboxing with the SANDBOX environment variable. You can allow
access to directories you want with the WHITELIST_DIRS variable. And it's
also possible to disable network with the DISABLE_NET. For example:
You can enable sandboxing with the **SANDBOX** environment variable. You can allow
access to directories you want with the **WHITELIST_DIRS** variable. And it's
also possible to disable network with the **DISABLE_NET**. For example:
```
export DISABLE_NET=1
@ -97,9 +95,9 @@ export WHITELIST_DIRS="/home/username/.cache /opt /home/username/Downloads"
./conty.sh command
```
## How to create your own Conty executable
## How to create your own Conty executables
If you want to create Arch-based container then use the create-arch-bootstrap.sh script. Root rights
If you want to create Arch-based container then use the **create-arch-bootstrap.sh** script. Root rights
are required for this step, because chrooting is used here.
```
@ -111,7 +109,7 @@ the container.
If want to use some other distro then you need to manually obtain it from somewhere.
When distro bootsrap is obtained, use create-conty.sh script to pack
When distro bootsrap is obtained, use the **create-conty.sh** script to pack
everything into a single executable.
```