guacamole_ynh/README.md

<!--
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.
-->

# Guacamole for YunoHost

[![Integration level](https://dash.yunohost.org/integration/guacamole.svg)](https://dash.yunohost.org/appci/app/guacamole) ![Working status](https://ci-apps.yunohost.org/ci/badges/guacamole.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/guacamole.maintain.svg)

[![Install Guacamole with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=guacamole)

*[Lire ce readme en français.](./README_fr.md)*

> *This package allows you to install Guacamole 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

Clientless remote desktop gateway. It supports standard protocols like VNC, RDP, and SSH

**Shipped version:** 1.5.2~ynh2

## Screenshots

![Screenshot of Guacamole](./doc/screenshots/screenshot1.jpg)

## Disclaimers / important information

## Configuration

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).

## Documentation and resources

* 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 Store: <https://apps.yunohost.org/app/guacamole>
* Report a bug: <https://github.com/YunoHost-Apps/guacamole_ynh/issues>

## Developer info

Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/guacamole_ynh/tree/testing).

To try the testing branch, please proceed like that.

``` bash
sudo yunohost app install https://github.com/YunoHost-Apps/guacamole_ynh/tree/testing --debug
or
sudo yunohost app upgrade guacamole -u https://github.com/YunoHost-Apps/guacamole_ynh/tree/testing --debug
```

**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
Auto-update README 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.`
			`-->`

App name (#31) Use shorter name 2022-06-06 14:27:51 +02:00			`# Guacamole for YunoHost`
Initial commit 2021-03-19 04:09:26 +01:00
Auto-update README 2023-05-02 13:39:41 +02:00			`[![Integration level](https://dash.yunohost.org/integration/guacamole.svg)](https://dash.yunohost.org/appci/app/guacamole) ![Working status](https://ci-apps.yunohost.org/ci/badges/guacamole.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/guacamole.maintain.svg)`

App name (#31) Use shorter name 2022-06-06 14:27:51 +02:00			`[![Install Guacamole with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=guacamole)`
Initial commit 2021-03-19 04:09:26 +01:00
			`[Lire ce readme en français.](./README_fr.md)`

App name (#31) Use shorter name 2022-06-06 14:27:51 +02:00			`> *This package allows you to install Guacamole quickly and simply on a YunoHost server.`
Initial commit 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`

Auto-update README 2023-01-06 23:04:35 +01:00			`Clientless remote desktop gateway. It supports standard protocols like VNC, RDP, and SSH`
Initial commit 2021-03-19 04:09:26 +01:00
Auto-update README 2023-06-05 14:22:40 +02:00			`Shipped version: 1.5.2~ynh2`
Initial commit 2021-03-19 04:09:26 +01:00
Auto-update README 2021-10-23 16:47:14 +02:00			`## Screenshots`
Initial commit 2021-03-19 04:09:26 +01:00
App name (#31) Use shorter name 2022-06-06 14:27:51 +02:00			`![Screenshot of Guacamole](./doc/screenshots/screenshot1.jpg)`
Initial commit 2021-03-19 04:09:26 +01:00
Auto-update README 2021-10-23 16:47:14 +02:00			`## Disclaimers / important information`
Initial commit 2021-03-19 04:09:26 +01:00
Auto-update README 2021-10-23 16:47:14 +02:00			`## Configuration`
Initial commit 2021-03-19 04:09:26 +01:00
Auto-update README 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).
Initial commit 2021-03-19 04:09:26 +01:00
Auto-update README 2021-10-23 16:47:14 +02:00			`## Documentation and resources`
Initial commit 2021-03-19 04:09:26 +01:00
Auto-update README 2022-06-06 13:50:09 +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>`
Auto-update README 2023-10-31 15:14:20 +01:00			`* YunoHost Store: <https://apps.yunohost.org/app/guacamole>`
Auto-update README 2022-06-06 13:50:09 +02:00			`* Report a bug: <https://github.com/YunoHost-Apps/guacamole_ynh/issues>`
Initial commit 2021-03-19 04:09:26 +01:00
			`## Developer info`

Initial commit for Guacamole 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).`
Initial commit 2021-03-19 04:09:26 +01:00
			`To try the testing branch, please proceed like that.`
Auto-update README 2022-06-06 13:50:09 +02:00
			``` bash
Initial commit for Guacamole 2021-03-21 05:17:45 +01:00			`sudo yunohost app install https://github.com/YunoHost-Apps/guacamole_ynh/tree/testing --debug`
Initial commit 2021-03-19 04:09:26 +01:00			`or`
Initial commit for Guacamole 2021-03-21 05:17:45 +01:00			`sudo yunohost app upgrade guacamole -u https://github.com/YunoHost-Apps/guacamole_ynh/tree/testing --debug`
Initial commit 2021-03-19 04:09:26 +01:00			```
Auto-update README 2021-10-23 16:47:14 +02:00
Auto-update README 2022-06-06 13:50:09 +02:00			`More info regarding app packaging: <https://yunohost.org/packaging_apps>`