proot

Go to file

Lucas Ramage a70023ab3d Delete roadmap.rst		2021-10-01 13:36:37 -04:00
contrib	Add CARE utility scripts	2019-04-18 19:11:18 -04:00
doc	Delete roadmap.rst	2021-10-01 13:36:37 -04:00
src	A few fixes for the python extension (#285 )	2021-10-01 13:22:37 -04:00
test	Make sure not to fake too old an kernel release (#281 )	2021-10-01 10:54:43 -04:00
util	Add Dockerfiles for testing (#228 )	2020-06-09 11:37:40 -04:00
.dockerignore	Add Dockerfiles for testing (#228 )	2020-06-09 11:37:40 -04:00
.gitignore	Add Dockerfiles for testing (#228 )	2020-06-09 11:37:40 -04:00
.gitlab-ci.yml	Disable failing pipeline notifications (#221 )	2020-04-16 11:01:13 -04:00
.mailmap	Create .mailmap	2019-03-11 08:45:36 -04:00
AUTHORS	Prepare documentation for release	2020-04-14 19:12:16 +00:00
CHANGELOG.rst	Prepare for release	2021-09-01 22:04:39 -04:00
COPYING	Add a copy of PRoot's license.	2011-11-07 08:37:28 +01:00
HACKING.rst	Add contributing guide	2019-04-06 13:30:54 +00:00
ISSUE_TEMPLATE	Add contributing guide	2019-04-06 13:30:54 +00:00
README.rst	Remove Travis CI (#270 )	2021-09-14 12:57:21 -04:00

README.rst

PRoot
=====

*chroot, mount --bind, and binfmt_misc without privilege/setup for Linux*

Build status
============

.. image:: https://img.shields.io/gitlab/pipeline/proot/proot.svg?label=gitlab-ci&style=flat-square
   :target: https://gitlab.com/proot/proot/pipelines

.. image:: https://img.shields.io/badge/scan--build-latest-yellow.svg?style=flat-square
   :target: https://proot.gitlab.io/proot/reports/scan-build

.. image:: https://img.shields.io/badge/lcov-latest-6688D4.svg?style=flat-square
   :target: https://proot.gitlab.io/proot/reports/lcov

.. image:: https://img.shields.io/cii/summary/2444.svg?label=cii-best-practices&style=flat-square
   :target: https://bestpractices.coreinfrastructure.org/projects/2444

.. image:: https://img.shields.io/badge/DOI-10.5281%2Fzenodo.3751971-blue?style=flat-square
   :target: https://doi.org/10.5281/zenodo.3751971

Compiling
=========

The following commands can be used to compile PRoot and CARE::

    make -C src loader.elf loader-m32.elf build.h # first build the config and loader
    make -C src proot care # then compile PRoot and CARE
    make -C test # run test suite

|asciicast|

.. |asciicast| image:: https://asciinema.org/a/315367.svg
   :target: https://asciinema.org/a/315367

Dependencies
============

- `libarchive <https://libarchive.org>`_
- `libtalloc <https://talloc.samba.org>`_
- `uthash <https://troydhanson.github.io/uthash>`_ (only required for building CARE)

Manuals
=======

- `PRoot <https://github.com/proot-me/proot/blob/master/doc/proot/manual.rst#proot>`_

- `CARE <https://github.com/proot-me/proot/blob/master/doc/care/manual.rst#care>`_

Support
=======

- `Mailing List <mailto:proot_me@googlegroups.com>`_
- `Forum <https://groups.google.com/forum/?fromgroups#!forum/proot_me>`_
- `Chat <https://gitter.im/proot-me/devs>`_

License
=======

SPDX-License-Identifier: `GPL-2.0-or-later <COPYING>`_