proot-me/proot
1
0
Fork 0
mirror of https://github.com/proot-me/proot.git synced 2024-11-23 12:26:18 +00:00
Code Issues Actions Releases Activity
chroot, mount --bind, and binfmt_misc without privilege/setup for Linux
1,269 Commits 9 Branches 77 Tags 5 MiB
C 88.4%
Shell 8.3%
Makefile 2.3%
Python 0.4%
SWIG 0.3%
Other 0.3%
master
Go to file
Josselin Poiret 5f780cba57 Add clone3.
2023-06-03 17:35:14 -05:00
.github/workflows Enable SonarCloud (#347) 2023-04-15 20:25:00 -04:00
contrib Add CARE utility scripts 2019-04-18 19:11:18 -04:00
doc docs: fix ubuntu rootfs link 2023-06-03 17:11:11 -05:00
lib Pin lib/uthash at v2.3.0 2023-04-22 17:09:28 -04:00
src Add clone3. 2023-06-03 17:35:14 -05:00
test Fix test-25069c12 and test-25069c13 for new kernels. 2023-05-13 01:31:16 -05: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
.gitmodules Add uthash submodule 2023-04-22 17:09:28 -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 PRoot release v5.4.0 2023-05-13 02:08:11 -05: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 Add link to usage survey 2023-01-27 09:38:38 -05:00
sonar-project.properties Enable SonarCloud (#347) 2023-04-15 20:25:00 -04:00

README.rst 

PRoot
=====

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

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

**Please take the PRoot Usage Survey for 2023!**

.. image:: https://img.shields.io/badge/survey-2023-green?style=flat-square
   :target: https://www.surveymonkey.com/r/7GVXS7W
   
--

.. 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.5371409-blue?style=flat-square
   :target: https://doi.org/10.5281/zenodo.5371409

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>`_