1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/ssh_chroot_dir_ynh.git synced 2024-09-03 20:26:26 +02:00
ssh_chroot_dir_ynh/README.md
2023-12-11 10:40:53 +00:00

46 lines
2 KiB
Markdown

<!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
It shall NOT be edited by hand.
-->
# ssh chroot directory for YunoHost
[![Integration level](https://dash.yunohost.org/integration/ssh_chroot_dir.svg)](https://dash.yunohost.org/appci/app/ssh_chroot_dir) ![Working status](https://ci-apps.yunohost.org/ci/badges/ssh_chroot_dir.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/ssh_chroot_dir.maintain.svg)
[![Install ssh chroot directory with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=ssh_chroot_dir)
*[Lire ce readme en français.](./README_fr.md)*
> *This package allows you to install ssh chroot directory quickly and simply on a YunoHost server.
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview
This app provides a directory, accessible via ssh of sftp, to a new user.
A "chroot jail" limits the commands the user can use, so you can rest assured that
they can't access your server's contents outside of the provided directory.
A data size quota is also set on the directory.
**Shipped version:** 1.3~ynh2
## Documentation and resources
* Upstream app code repository: <https://github.com/maniackcrudelis/ssh_chroot>
* YunoHost Store: <https://apps.yunohost.org/app/ssh_chroot_dir>
* Report a bug: <https://github.com/YunoHost-Apps/ssh_chroot_dir_ynh/issues>
## Developer info
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/ssh_chroot_dir_ynh/tree/testing).
To try the testing branch, please proceed like that.
``` bash
sudo yunohost app install https://github.com/YunoHost-Apps/ssh_chroot_dir_ynh/tree/testing --debug
or
sudo yunohost app upgrade ssh_chroot_dir -u https://github.com/YunoHost-Apps/ssh_chroot_dir_ynh/tree/testing --debug
```
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>