2021-10-23 16:47:14 +02:00
<!--
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.
-->
2021-03-21 05:17:45 +01:00
# Apache Guacamole for YunoHost
2021-03-19 04:09:26 +01:00
2021-03-21 05:17:45 +01:00
[![Integration level ](https://dash.yunohost.org/integration/guacamole.svg )](https://dash.yunohost.org/appci/app/guacamole) ![](https://ci-apps.yunohost.org/ci/badges/guacamole.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/guacamole.maintain.svg)
2021-10-23 16:47:14 +02:00
[![Install Apache Guacamole with YunoHost ](https://install-app.yunohost.org/install-with-yunohost.svg )](https://install-app.yunohost.org/?app=guacamole)
2021-03-19 04:09:26 +01:00
*[Lire ce readme en français.](./README_fr.md)*
2021-10-23 16:47:14 +02:00
> *This package allows you to install Apache Guacamole quickly and simply on a YunoHost server.
2021-03-19 04:09:26 +01:00
If you don't have YunoHost, please consult [the guide ](https://yunohost.org/#/install ) to learn how to install it.*
## Overview
2021-10-23 16:47:14 +02:00
Clientless remote desktop gateway. It supports standard protocols like VNC, RDP, and SSH.
2021-03-19 04:09:26 +01:00
2021-11-14 17:52:08 +01:00
**Shipped version:** 1.3.0~ynh6
2021-03-19 04:09:26 +01:00
2021-10-23 16:47:14 +02:00
## Screenshots
2021-03-19 04:09:26 +01:00
2021-10-23 16:47:14 +02:00
![](./doc/screenshots/screenshot1.jpg)
2021-03-19 04:09:26 +01:00
2021-10-23 16:47:14 +02:00
## Disclaimers / important information
2021-03-19 04:09:26 +01:00
2021-10-23 16:47:14 +02:00
## Configuration
2021-03-19 04:09:26 +01:00
2021-10-23 16:47:14 +02:00
The user that is configured as admin during install will have access to admin settings in the settings menu of the app (under the user menu). Configuration files are in `/opt/yunohost/guacamole/etc/guacamole` (for the first install).
2021-03-19 04:09:26 +01:00
2021-10-23 16:47:14 +02:00
## Documentation and resources
2021-03-19 04:09:26 +01:00
2021-10-23 16:47:14 +02:00
* Official app website: https://guacamole.apache.org/
* Official admin documentation: https://guacamole.apache.org/doc/gug/
* Upstream app code repository: https://github.com/search?utf8=%E2%9C%93& q=repo%3Aapache%2Fguacamole-server+repo%3Aapache%2Fguacamole-client+repo%3Aapache%2Fguacamole-website& type=Repositories& ref=searchresults
* YunoHost documentation for this app: https://yunohost.org/app_guacamole
* Report a bug: https://github.com/YunoHost-Apps/guacamole_ynh/issues
2021-03-19 04:09:26 +01:00
## Developer info
2021-03-21 05:17:45 +01:00
Please send your pull request to the [testing branch ](https://github.com/YunoHost-Apps/guacamole_ynh/tree/testing ).
2021-03-19 04:09:26 +01:00
To try the testing branch, please proceed like that.
```
2021-03-21 05:17:45 +01:00
sudo yunohost app install https://github.com/YunoHost-Apps/guacamole_ynh/tree/testing --debug
2021-03-19 04:09:26 +01:00
or
2021-03-21 05:17:45 +01:00
sudo yunohost app upgrade guacamole -u https://github.com/YunoHost-Apps/guacamole_ynh/tree/testing --debug
2021-03-19 04:09:26 +01:00
```
2021-10-23 16:47:14 +02:00
**More info regarding app packaging:** https://yunohost.org/packaging_apps