mirror of
https://github.com/YunoHost-Apps/wetty_ynh.git
synced 2024-09-03 18:16:29 +02:00
Update readmes from script.
This commit is contained in:
parent
c340f29756
commit
426abdd034
5 changed files with 78 additions and 64 deletions
52
README.md
52
README.md
|
|
@ -1,3 +1,10 @@
|
|||
---
|
||||
|
||||
<!--
|
||||
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
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/wetty)  
|
||||
|
|
@ -9,52 +16,37 @@
|
|||
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
|
||||
|
||||
## Overview
|
||||
Terminal in browser over HTTP/HTTPS. (Ajaxterm/Anyterm alternative, but much better)
|
||||
|
||||
**Shipped version:** 2.0.3
|
||||
Terminal in browser over HTTP/HTTPS. (Ajaxterm/Anyterm alternative)
|
||||
|
||||
## Screenshots
|
||||
**Shipped version:** 2.0.3~ynh5
|
||||
|
||||
|
||||
|
||||
## Configuration
|
||||
|
||||
## 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.
|
||||
|
||||
## Documentation
|
||||
|
||||
* Official documentation: https://github.com/butlerx/wetty/tree/master/docs
|
||||
* YunoHost documentation: If specific documentation is needed, feel free to contribute.
|
||||
|
||||
## YunoHost specific features
|
||||
|
||||
#### Multi-user support
|
||||
|
||||
* Is LDAP and HTTP authentication supported ? **No**
|
||||
* Nevertheless, being connected on Yunohost prevents using `/wetty/ssh/<user>`
|
||||
* You need to manually log in.
|
||||
* You can log in as a specific user using `https://<host>/wetty/ssh/<username>`
|
||||
|
||||
Multi-user doesn't really mean anything. You can log as any *system* user that allows local SSH login.
|
||||
|
||||
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.
|
||||
|
||||
#### Supported architectures
|
||||
|
||||
* x86-64 - [](https://ci-apps.yunohost.org/ci/apps/wetty/)
|
||||
* ARMv8-A - [](https://ci-apps-arm.yunohost.org/ci/apps/wetty/)
|
||||
|
||||
## Limitations
|
||||
* You can specify at install if Wetty should be visible by users not logged into Yunohost.
|
||||
|
||||
* You can't use ssh key authentication.
|
||||
|
||||
## Links
|
||||
## Documentation and resources
|
||||
|
||||
* Official app website: https://github.com/butlerx/wetty
|
||||
* Official admin documentation: https://github.com/butlerx/wetty/tree/main/docs
|
||||
* Upstream app code repository: 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
|
||||
* Upstream app repository: https://github.com/butlerx/wetty
|
||||
* YunoHost website: https://yunohost.org/
|
||||
|
||||
---
|
||||
|
||||
## Developer info
|
||||
|
||||
|
|
@ -66,3 +58,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/wetty_ynh/tree/testin
|
|||
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
|
||||
53
README_fr.md
53
README_fr.md
|
|
@ -4,57 +4,42 @@
|
|||
[](https://install-app.yunohost.org/?app=wetty)
|
||||
|
||||
*[Read this readme in english.](./README.md)*
|
||||
*[Lire ce readme en français.](./README_fr.md)*
|
||||
|
||||
> *Ce package vous permet d'installer Wetty rapidement et simplement sur un serveur YunoHost.
|
||||
Si vous n'avez pas YunoHost, consultez [le guide](https://yunohost.org/#/install) pour apprendre comment l'installer.*
|
||||
|
||||
## Vue d'ensemble
|
||||
Terminal dans un navigateur par HTTP/HTTPS. (Alternative à Ajaxterm/Anyterm, mais bien meilleure)
|
||||
|
||||
**Version incluse :** 2.0.3
|
||||
Un terminal dans le navigateur sur HTTP/HTTPS. (alternative à Ajaxterm/Anyterm)
|
||||
|
||||
## Captures d'écran
|
||||
**Version incluse:** 2.0.3~ynh5
|
||||
|
||||
|
||||
|
||||
## Configuration
|
||||
|
||||
## Avertissements / informations importantes
|
||||
|
||||
### Configuration
|
||||
|
||||
Il y a peu de configuration dans Wetty :
|
||||
* La configuration de démarrage (port d'écoute, chemin d'URL, hôte SSH) est contenue dans le fichier de service systemd
|
||||
* La configuration de l'interface utilisateur se fait via l'interface graphique Web elle-même.
|
||||
|
||||
## Documentation
|
||||
|
||||
* Documentation officielle : https://github.com/butlerx/wetty/tree/master/docs
|
||||
* Documentation YunoHost : Si une documentation spécifique est nécessaire, n'hésitez pas à contribuer.
|
||||
|
||||
## Caractéristiques spécifiques YunoHost
|
||||
|
||||
#### Support multi-utilisateur
|
||||
|
||||
* L'authentification LDAP et HTTP est-elle prise en charge ? **Non**
|
||||
* Néanmoins, la connection sur Yunohost interdit l'utilisation de `/wetty/ssh/<utilisateur>`
|
||||
* Vous devez vous connecter manuellement.
|
||||
* Vous pouvez spécifier l'utilisateur en accédent directement `https://<host>/wetty/ssh/<username>`
|
||||
|
||||
* L'application peut-elle être utilisée par plusieurs utilisateurs ? La notion de multi-utilisateur ne s'applique pas. Vous pouvez vous connecter en tant que n'importe quel utilisateur *système* qui autorise la connexion SSH locale.
|
||||
* Vous pouvez spécifier à l'installation si Wetty devrait être accessible par des visiteurs non connectés sur Yunohost.
|
||||
|
||||
Vous pouvez spécifier lors de l'installation si les utilisateurs doivent d'abord se connecter à YunoHost pour pouvoir accéder à Wetty, ou si les visiteurs peuvent également y accéder.
|
||||
* Vous ne pouvez pas vous authentifier par une clé SSH.
|
||||
|
||||
#### Architectures supportées
|
||||
## Documentations et ressources
|
||||
|
||||
* x86-64 - [](https://ci-apps.yunohost.org/ci/apps/wetty/)
|
||||
* ARMv8-A - [](https://ci-apps-arm.yunohost.org/ci/apps/wetty/)
|
||||
|
||||
## Limitations
|
||||
|
||||
* Vous ne pouvez pas vous authentifier avec des clés SSH.
|
||||
|
||||
## Liens
|
||||
|
||||
* Signaler un bug : https://github.com/YunoHost-Apps/wetty_ynh/issues
|
||||
* Dépôt de l'application principale : https://github.com/butlerx/wetty
|
||||
* Site web YunoHost : https://yunohost.org/
|
||||
|
||||
---
|
||||
* Site official de l'app : https://github.com/butlerx/wetty
|
||||
* Documentation officielle de l'admin: https://github.com/butlerx/wetty/tree/main/docs
|
||||
* Dépôt de code officiel de l'app: https://github.com/butlerx/wetty
|
||||
* Documentation YunoHost pour cette app: https://yunohost.org/app_wetty
|
||||
* Signaler un bug: https://github.com/YunoHost-Apps/wetty_ynh/issues
|
||||
|
||||
## Informations pour les développeurs
|
||||
|
||||
|
|
@ -63,6 +48,8 @@ Merci de faire vos pull request sur la [branche testing](https://github.com/Yuno
|
|||
Pour essayer la branche testing, procédez comme suit.
|
||||
```
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/wetty_ynh/tree/testing --debug
|
||||
ou
|
||||
or
|
||||
sudo yunohost app upgrade wetty -u https://github.com/YunoHost-Apps/wetty_ynh/tree/testing --debug
|
||||
```
|
||||
|
||||
**Plus d'infos sur le packaging d'applications:** https://yunohost.org/packaging_apps
|
||||
14
doc/DISCLAIMER.md
Normal file
14
doc/DISCLAIMER.md
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
### 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.
|
||||
13
doc/DISCLAIMER_fr.md
Normal file
13
doc/DISCLAIMER_fr.md
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
### Configuration
|
||||
|
||||
Il y a peu de configuration dans Wetty :
|
||||
* La configuration de démarrage (port d'écoute, chemin d'URL, hôte SSH) est contenue dans le fichier de service systemd
|
||||
* La configuration de l'interface utilisateur se fait via l'interface graphique Web elle-même.
|
||||
|
||||
* L'authentification LDAP et HTTP est-elle prise en charge ? **Non**
|
||||
* Vous devez vous connecter manuellement.
|
||||
* Vous pouvez spécifier l'utilisateur en accédent directement `https://<host>/wetty/ssh/<username>`
|
||||
|
||||
* Vous pouvez spécifier à l'installation si Wetty devrait être accessible par des visiteurs non connectés sur Yunohost.
|
||||
|
||||
* Vous ne pouvez pas vous authentifier par une clé SSH.
|
||||
|
|
@ -3,12 +3,18 @@
|
|||
"id": "wetty",
|
||||
"packaging_format": 1,
|
||||
"description": {
|
||||
"en": "Terminal in browser over HTTP/HTTPS.",
|
||||
"fr": "Un terminal dans le navigateur sur HTTP/HTTPS."
|
||||
"en": "Terminal in browser over HTTP/HTTPS. (Ajaxterm/Anyterm alternative)",
|
||||
"fr": "Un terminal dans le navigateur sur HTTP/HTTPS. (alternative à Ajaxterm/Anyterm)"
|
||||
},
|
||||
"version": "2.0.3~ynh5",
|
||||
"url": "https://github.com/butlerx/wetty/",
|
||||
"license": "MIT",
|
||||
"upstream": {
|
||||
"license": "MIT",
|
||||
"website": "https://github.com/butlerx/wetty",
|
||||
"admindoc": "https://github.com/butlerx/wetty/tree/main/docs",
|
||||
"code": "https://github.com/butlerx/wetty"
|
||||
},
|
||||
"maintainer": {
|
||||
"name": "Salamandar",
|
||||
"email": "salamandar@salamandar.fr"
|
||||
|
|
|
|||
Loading…
Reference in a new issue