1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/wetty_ynh.git synced 2024-09-03 18:16:29 +02:00
wetty_ynh/README.md

66 lines
2.4 KiB
Markdown
Raw Normal View History

2020-06-30 18:14:20 +02:00
# Wetty for YunoHost
2020-10-13 08:47:33 +02:00
[![Integration level](https://dash.yunohost.org/integration/wetty.svg)](https://dash.yunohost.org/appci/app/wetty) ![](https://ci-apps.yunohost.org/ci/badges/wetty.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/wetty.maintain.svg)
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)
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
2020-10-13 09:08:33 +02:00
Terminal in browser over HTTP/HTTPS. (Ajaxterm/Anyterm alternative, but much better)
2018-06-28 22:05:35 +02:00
2020-10-13 08:47:33 +02:00
**Shipped version:** 2.0.2
2018-06-28 22:05:35 +02:00
## Screenshots
2020-10-13 08:50:24 +02:00
![](https://raw.githubusercontent.com/butlerx/wetty/v2.0.2/docs/terminal.png)
2018-06-28 22:05:35 +02:00
## Configuration
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
## Documentation
2020-06-30 18:14:20 +02:00
* Official documentation: https://github.com/butlerx/wetty/tree/master/docs
2018-08-08 23:04:20 +02:00
* YunoHost documentation: If specific documentation is needed, feel free to contribute.
2018-06-28 22:05:35 +02:00
## YunoHost specific features
2020-01-28 06:30:10 +01:00
#### Multi-user support
2018-06-28 22:05:35 +02:00
2020-06-30 18:14:20 +02:00
Multi-user doesn't really mean anything. You can log as any *system* user that allows local SSH login.
2020-10-13 08:47:33 +02:00
You can specify at install if users should log into YunoHost first to be able to access Wetty, or if visitors can access it too.
2018-06-28 22:05:35 +02:00
#### Supported architectures
2020-06-30 18:14:20 +02:00
* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/wetty%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/wetty/)
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/wetty%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/wetty/)
2018-06-28 22:05:35 +02:00
## Limitations
2020-06-30 18:14:20 +02:00
* You can't use ssh key authentication.
2018-06-28 22:05:35 +02:00
## Links
2020-06-30 18:14:20 +02:00
* Report a bug: https://github.com/YunoHost-Apps/wetty_ynh/issues
* Upstream app repository: https://github.com/butlerx/wetty
2018-06-28 22:05:35 +02:00
* YunoHost website: https://yunohost.org/
---
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).
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
```