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

# Wetty for YunoHost

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

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

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

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

Terminal over HTTP and HTTPS. WeTTy is an alternative to ajaxterm and anyterm but much better than them because WeTTy uses xterm.js which is a full fledged implementation of terminal emulation written entirely in JavaScript. WeTTy uses websockets rather then Ajax and hence better response time.


**Shipped version:** 2.5.0~ynh3

## Screenshots

![Screenshot of Wetty](./doc/screenshots/terminal.png)

## Disclaimers / important information

### Configuration

There is few configuration in Wetty:
* Startup config (listen port, URL path, SSH host) is contained in the systemd service file
* User interface configuration is done through the web GUI itself.


* Is LDAP and HTTP authentication supported? **No**
  * You need to manually log in.
  * You can log in as a specific user using `https://<host>/wetty/ssh/<username>`

* You can specify at install if Wetty should be visible by users not logged into YunoHost.

* You can't use ssh key authentication.

## Documentation and resources

* Official app website: <https://github.com/butlerx/wetty/>
* YunoHost documentation for this app: <https://yunohost.org/app_wetty>
* Report a bug: <https://github.com/YunoHost-Apps/wetty_ynh/issues>

## Developer info

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

To try the testing branch, please proceed like that.

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

**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
Update readmes from script. 2021-05-20 11:24:38 +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.`
			`-->`

Start updating READMEs 2020-06-30 18:14:20 +02:00			`# Wetty for YunoHost`
[enh] Update readme Squelette de readme, pour éviter des readme sans infos. 2017-02-03 21:12:24 +01:00
Auto-update README 2023-01-23 10:49:52 +01:00			`[![Integration level](https://dash.yunohost.org/integration/wetty.svg)](https://dash.yunohost.org/appci/app/wetty) ![Working status](https://ci-apps.yunohost.org/ci/badges/wetty.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/wetty.maintain.svg)`
Auto-update README 2023-06-09 22:20:21 +02:00
Fix linter warnings 2021-01-14 09:51:30 +01:00			`[![Install Wetty with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=wetty)`
[enh] Update readme Squelette de readme, pour éviter des readme sans infos. 2017-02-03 21:12:24 +01:00
README.md translation in French 2019-01-28 00:21:25 +01:00			`[Lire ce readme en français.](./README_fr.md)`

Upgrade to v.2.0.2 2020-10-13 08:47:33 +02:00			`> *This package allows you to install Wetty quickly and simply on a YunoHost server.`
example_ynh readme reworked 2020-01-28 06:30:10 +01:00			`If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*`
Initial commit 2014-10-20 18:55:53 +02:00
Add comments and upgrade some stuff 2018-06-28 22:05:35 +02:00			`## Overview`

Auto-update README 2021-09-04 10:36:00 +02:00			`Terminal over HTTP and HTTPS. WeTTy is an alternative to ajaxterm and anyterm but much better than them because WeTTy uses xterm.js which is a full fledged implementation of terminal emulation written entirely in JavaScript. WeTTy uses websockets rather then Ajax and hence better response time.`
Update readmes from script. 2021-05-20 11:24:38 +02:00
Add comments and upgrade some stuff 2018-06-28 22:05:35 +02:00
Auto-update README 2023-06-09 22:20:42 +02:00			`Shipped version: 2.5.0~ynh3`
Auto-update README 2022-08-11 15:49:15 +02:00
Auto-update README 2021-09-04 10:33:35 +02:00			`## Screenshots`

Auto-update README 2022-05-28 10:34:38 +02:00			`![Screenshot of Wetty](./doc/screenshots/terminal.png)`
Auto-update README 2021-09-04 10:33:35 +02:00
Update readmes from script. 2021-05-20 11:24:38 +02:00			`## Disclaimers / important information`

			`### Configuration`
Add comments and upgrade some stuff 2018-06-28 22:05:35 +02:00
Upgrade to v.2.0.2 2020-10-13 08:47:33 +02:00			`There is few configuration in Wetty:`
Small typos 2020-10-13 09:08:33 +02:00			`* Startup config (listen port, URL path, SSH host) is contained in the systemd service file`
			`* User interface configuration is done through the web GUI itself.`
Add comments and upgrade some stuff 2018-06-28 22:05:35 +02:00

Auto-update README 2021-09-04 10:36:00 +02:00			`* Is LDAP and HTTP authentication supported? No`
Update readmes from script. 2021-05-20 11:24:38 +02:00			`* You need to manually log in.`
			* You can log in as a specific user using `https://<host>/wetty/ssh/<username>`
Fix permissions on installed files. Try to fix "unknown command -p". 2021-01-25 16:35:20 +01:00
Auto-update README 2021-09-04 10:36:00 +02:00			`* You can specify at install if Wetty should be visible by users not logged into YunoHost.`
Add comments and upgrade some stuff 2018-06-28 22:05:35 +02:00
Start updating READMEs 2020-06-30 18:14:20 +02:00			`* You can't use ssh key authentication.`
[enh] Update readme Squelette de readme, pour éviter des readme sans infos. 2017-02-03 21:12:24 +01:00
Update readmes from script. 2021-05-20 11:24:38 +02:00			`## Documentation and resources`
Add comments and upgrade some stuff 2018-06-28 22:05:35 +02:00
Auto-update README 2023-06-09 22:20:42 +02:00			`* Official app website: <https://github.com/butlerx/wetty/>`
Auto-update README 2022-05-28 10:34:38 +02:00			`* YunoHost documentation for this app: <https://yunohost.org/app_wetty>`
			`* Report a bug: <https://github.com/YunoHost-Apps/wetty_ynh/issues>`
Add comments and upgrade some stuff 2018-06-28 22:05:35 +02:00
Upgrade to v.2.0.2 2020-10-13 08:47:33 +02:00			`## Developer info`
Add comments and upgrade some stuff 2018-06-28 22:05:35 +02:00
Start updating READMEs 2020-06-30 18:14:20 +02:00			`Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/wetty_ynh/tree/testing).`
[enh] Update readme Squelette de readme, pour éviter des readme sans infos. 2017-02-03 21:12:24 +01:00
Add comments and upgrade some stuff 2018-06-28 22:05:35 +02:00			`To try the testing branch, please proceed like that.`
Auto-update README 2022-05-28 10:34:38 +02:00
			``` bash
Start updating READMEs 2020-06-30 18:14:20 +02:00			`sudo yunohost app install https://github.com/YunoHost-Apps/wetty_ynh/tree/testing --debug`
Add comments and upgrade some stuff 2018-06-28 22:05:35 +02:00			`or`
Start updating READMEs 2020-06-30 18:14:20 +02:00			`sudo yunohost app upgrade wetty -u https://github.com/YunoHost-Apps/wetty_ynh/tree/testing --debug`
Add comments and upgrade some stuff 2018-06-28 22:05:35 +02:00			```
Update readmes from script. 2021-05-20 11:24:38 +02:00
Auto-update README 2022-05-28 10:34:38 +02:00			`More info regarding app packaging: <https://yunohost.org/packaging_apps>`