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.
-->
2020-06-30 18:14:20 +02:00
# Wetty for YunoHost
2017-02-03 21:12:24 +01:00
2021-09-03 16:28:23 +02:00
[](https://dash.yunohost.org/appci/app/wetty)  
2021-01-14 09:51:30 +01:00
[](https://install-app.yunohost.org/?app=wetty)
2017-02-03 21:12:24 +01:00
2019-01-28 00:21:25 +01:00
*[Lire ce readme en français.](./README_fr.md)*
2020-10-13 08:47:33 +02:00
> *This package allows you to install Wetty quickly and simply on a YunoHost server.
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.*
2014-10-20 18:55:53 +02:00
2018-06-28 22:05:35 +02:00
## Overview
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.
2021-05-20 11:24:38 +02:00
2018-06-28 22:05:35 +02:00
2021-09-04 10:33:35 +02:00
**Shipped version:** 2.1.1~ynh1
2018-06-28 22:05:35 +02:00
2021-09-04 10:33:35 +02:00
## Screenshots
2021-05-20 11:24:38 +02:00
## Disclaimers / important information
### Configuration
2018-06-28 22:05:35 +02:00
2020-10-13 08:47:33 +02:00
There is few configuration in Wetty:
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.
2018-06-28 22:05:35 +02:00
2021-09-04 10:36:00 +02:00
* Is LDAP and HTTP authentication supported? **No**
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>`
2021-01-25 16:35:20 +01:00
2021-09-04 10:36:00 +02:00
* You can specify at install if Wetty should be visible by users not logged into YunoHost.
2018-06-28 22:05:35 +02:00
2020-06-30 18:14:20 +02:00
* You can't use ssh key authentication.
2017-02-03 21:12:24 +01:00
2021-05-20 11:24:38 +02:00
## Documentation and resources
2018-06-28 22:05:35 +02:00
2021-05-20 11:24:38 +02:00
* Official app website: https://github.com/butlerx/wetty
* Official admin documentation: https://github.com/butlerx/wetty/tree/main/docs
2021-06-19 13:21:37 +02:00
* Upstream app code repository: https://github.com/butlerx/wetty
2021-05-20 11:24:38 +02:00
* YunoHost documentation for this app: https://yunohost.org/app_wetty
2021-01-25 16:35:20 +01:00
* Report a bug: https://github.com/YunoHost-Apps/wetty_ynh/issues
2018-06-28 22:05:35 +02:00
2020-10-13 08:47:33 +02:00
## Developer info
2018-06-28 22:05:35 +02:00
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 ).
2017-02-03 21:12:24 +01:00
2018-06-28 22:05:35 +02:00
To try the testing branch, please proceed like that.
```
2020-06-30 18:14:20 +02:00
sudo yunohost app install https://github.com/YunoHost-Apps/wetty_ynh/tree/testing --debug
2018-06-28 22:05:35 +02:00
or
2020-06-30 18:14:20 +02:00
sudo yunohost app upgrade wetty -u https://github.com/YunoHost-Apps/wetty_ynh/tree/testing --debug
2018-06-28 22:05:35 +02:00
```
2021-05-20 11:24:38 +02:00
2021-09-03 16:28:23 +02:00
**More info regarding app packaging:** https://yunohost.org/packaging_apps
