mirror of
https://github.com/YunoHost-Apps/rocketchat_ynh.git
synced 2024-09-03 20:16:25 +02:00
62 lines
2.7 KiB
Markdown
62 lines
2.7 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.
|
|
-->
|
|
|
|
# Rocket.Chat for YunoHost
|
|
|
|
[![Integration level](https://dash.yunohost.org/integration/rocketchat.svg)](https://ci-apps.yunohost.org/ci/apps/rocketchat/) ![Working status](https://ci-apps.yunohost.org/ci/badges/rocketchat.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/rocketchat.maintain.svg)
|
|
|
|
[![Install Rocket.Chat with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=rocketchat)
|
|
|
|
*[Read this README in other languages.](./ALL_README.md)*
|
|
|
|
> *This package allows you to install Rocket.Chat 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
|
|
|
|
Rocket.Chat is an open-source fully customizable communications platform developed in JavaScript for organizations with high standards of data protection.
|
|
|
|
### Features
|
|
|
|
- End to End Encryption
|
|
- Multifactor Authentication
|
|
- Customizable User Permission
|
|
- Mobile Apps for [iOS](https://apps.apple.com/app/rocket-chat/id1148741252) and [Android](https://play.google.com/store/apps/details?id=chat.rocket.android)
|
|
- Desktop Apps for [macOS](https://apps.apple.com/br/app/rocket-chat/id1086818840), [Linux](https://snapcraft.io/rocketchat-desktop) and [Windows](https://releases.rocket.chat/desktop/latest/download)
|
|
|
|
**Shipped version:** 6.10.1~ynh1
|
|
|
|
**Demo:** <https://cloud.rocket.chat/trial>
|
|
|
|
## Screenshots
|
|
|
|
![Screenshot of Rocket.Chat](./doc/screenshots/screenshot.jpg)
|
|
|
|
## :red_circle: Antifeatures
|
|
|
|
- **Not totally free upstream**: The packaged app is under an overall free license, but with clauses that may restrict its use.
|
|
|
|
## Documentation and resources
|
|
|
|
- Official app website: <https://rocket.chat/>
|
|
- Official user documentation: <https://docs.rocket.chat/guides/user-guides>
|
|
- Official admin documentation: <https://docs.rocket.chat/>
|
|
- Upstream app code repository: <https://github.com/RocketChat/Rocket.Chat>
|
|
- YunoHost Store: <https://apps.yunohost.org/app/rocketchat>
|
|
- Report a bug: <https://github.com/YunoHost-Apps/rocketchat_ynh/issues>
|
|
|
|
## Developer info
|
|
|
|
Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/rocketchat_ynh/tree/testing).
|
|
|
|
To try the `testing` branch, please proceed like that:
|
|
|
|
```bash
|
|
sudo yunohost app install https://github.com/YunoHost-Apps/rocketchat_ynh/tree/testing --debug
|
|
or
|
|
sudo yunohost app upgrade rocketchat -u https://github.com/YunoHost-Apps/rocketchat_ynh/tree/testing --debug
|
|
```
|
|
|
|
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|