Update README
Goes for all branches
This commit is contained in:
37
README.md
37
README.md
@@ -1,3 +1,38 @@
|
|||||||
# PyJail
|
# PyJail
|
||||||
|
|
||||||
Jailing tool for Python
|
PyJail is a jailing tool for Python
|
||||||
|
It allows you to jail Python programs in a closed off filesystem
|
||||||
|
|
||||||
|
## How to install
|
||||||
|
|
||||||
|
Installing PyJail is really simple! Just run `python3 ./install.py` in the directory
|
||||||
|
where the files are stored!
|
||||||
|
|
||||||
|
## Compatibility
|
||||||
|
|
||||||
|
As of now we're still working on a custom Python interpreter to make all programs
|
||||||
|
fully jailing compatible, sadly enough it's quite hard work.
|
||||||
|
So as of now it is compatible with all Python programs, **but** only some will be
|
||||||
|
properly confined.
|
||||||
|
|
||||||
|
## POSIX compatibility
|
||||||
|
|
||||||
|
We're also providing a (sort-of) POSIX compatible mode. This allows Python programs
|
||||||
|
made for Linux to also run natively on Windows. This is more meant for Windows
|
||||||
|
versions that don't feature WSL (Windows 7/8/8.1) but still need to run some
|
||||||
|
Linux only scripts.
|
||||||
|
|
||||||
|
### The 4 branches
|
||||||
|
|
||||||
|
Which branch works best for you?
|
||||||
|
Well, that's pretty simple. We have 4 branches (`main`, `next`, `edge` and `no-posix`).
|
||||||
|
If you want the most stable experience, then the `main` branch is for you.
|
||||||
|
If you want the lastest features, but also a more stable experience (compared to `edge`),
|
||||||
|
then the `next` branch is for you
|
||||||
|
If you want the bleeding-edge and don't care about stability, then `edge` is for you.
|
||||||
|
If you only need simple jailing and no POSIX compatibility, then `no-posix` is for you.
|
||||||
|
|
||||||
|
### Issues
|
||||||
|
|
||||||
|
Please report issues [over here](https://git.novacow.ch/Nova/PyJail/issues/)
|
||||||
|
And please check if your issue isn't a duplicate before reporting.
|
||||||
|
Reference in New Issue
Block a user