From 18bbc4f5d94797d76d1f0d1703a90342df842129 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A9lix=20Pi=C3=A9dallu?= Date: Tue, 30 Jun 2020 18:14:20 +0200 Subject: [PATCH] Start updating READMEs --- README.md | 66 +++++++++++++++++++++------------------------------- README_fr.md | 54 +++++++++++++++++++----------------------- 2 files changed, 50 insertions(+), 70 deletions(-) diff --git a/README.md b/README.md index 52d619b..0a8adb4 100644 --- a/README.md +++ b/README.md @@ -1,72 +1,54 @@ -# Usage of this package (REMOVE THIS SECTION BEFORE RELEASE) -- Copy this app before working on it. -- Edit the `conf/nginx.conf` file to match app prerequisites. -- Edit the `manifest.json` with app specific info. -- Edit the `install`, `upgrade`, `remove`, `backup`, and `restore` scripts. - - Using the [script helpers documentation.](https://yunohost.org/#/packaging_apps_helpers) -- Add a `LICENSE` file for the package. -- Edit `README.md` and `README_fr.md`. +# Wetty for YunoHost -# Example app for YunoHost - -[![Integration level](https://dash.yunohost.org/integration/REPLACEBYYOURAPP.svg)](https://dash.yunohost.org/appci/app/REPLACEBYYOURAPP) ![](https://ci-apps.yunohost.org/ci/badges/REPLACEBYYOURAPP.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/REPLACEBYYOURAPP.maintain.svg) -[![Install REPLACEBYYOURAPP with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=REPLACEBYYOURAPP) +[![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) +[![Install wetty with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=wetty) *[Lire ce readme en français.](./README_fr.md)* -> *This package allows you to install REPLACEBYYOURAPP quickly and simply on a YunoHost server. +> *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 -Quick description of this app. +Terminal in browser over http/https. (Ajaxterm/Anyterm alternative, but much better) -**Shipped version:** 1.0 +**Shipped version:** 1.3.0 ## Screenshots -![](Link to a screenshot of this app.) - -## Demo - -* [Official demo](Link to a demo site for this app.) +![](https://raw.githubusercontent.com/butlerx/wetty/master/docs/terminal.png) ## Configuration -How to configure this app: From an admin panel, a plain file with SSH, or any other way. +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: Link to the official documentation of this app + * 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 -Are LDAP and HTTP auth supported? -Can the app be used by multiple users? +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 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/REPLACEBYYOURAPP%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/REPLACEBYYOURAPP/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/REPLACEBYYOURAPP%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/REPLACEBYYOURAPP/) +* 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/) ## Limitations -* Any known limitations. - -## Additional information - -* Other info you would like to add about this app. - -**More info on the documentation page:** -https://yunohost.org/packaging_apps +* You can't use ssh key authentication. ## Links - * Report a bug: https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/issues - * App website: Link to the official website of this app. - * Upstream app repository: Link to the official repository of the upstream app. + * Report a bug: https://github.com/YunoHost-Apps/wetty_ynh/issues + * Upstream app repository: https://github.com/butlerx/wetty * YunoHost website: https://yunohost.org/ --- @@ -75,11 +57,15 @@ Developer info ---------------- **Only if you want to use a testing branch for coding, instead of merging directly into master.** -Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing). +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. ``` -sudo yunohost app install https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing --debug +sudo yunohost app install https://github.com/YunoHost-Apps/wetty_ynh/tree/testing --debug or -sudo yunohost app upgrade REPLACEBYYOURAPP -u https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing --debug +sudo yunohost app upgrade wetty -u https://github.com/YunoHost-Apps/wetty_ynh/tree/testing --debug ``` + +# TODO +- Add a `LICENSE` file for the package. +- Edit `README_fr.md`. diff --git a/README_fr.md b/README_fr.md index 596e9cc..5be6dcb 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,33 +1,31 @@ -# App exemple pour YunoHost +# Wetty pour YunoHost -[![Niveau d'intégration](https://dash.yunohost.org/integration/REPLACEBYYOURAPP.svg)](https://dash.yunohost.org/appci/app/REPLACEBYYOURAPP) ![](https://ci-apps.yunohost.org/ci/badges/REPLACEBYYOURAPP.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/REPLACEBYYOURAPP.maintain.svg) -[![Installer REPLACEBYYOURAPP avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=REPLACEBYYOURAPP) +[![Niveau d'intégration](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) +[![Installer wetty avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=wetty) -*[Read this readme in english.](./README.md)* +*[Read this readme in english.](./README.md)* -> *Ce package vous permet d'installer REPLACEBYYOURAPP rapidement et simplement sur un serveur YunoHost. +> *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 -Description rapide de cette application. +Terminal dans un navigateur par http/https. (Alternative à Ajaxterm/Anyterm, mais bien meilleure) -**Version incluse :** 1.0 +**Version incluse :** 1.3.0 ## Captures d'écran -![](Lien vers une capture d'écran de cette application.) - -## Démo - -* [Démo officielle](Lien vers un site de démonstration de cette application.) +![](https://raw.githubusercontent.com/butlerx/wetty/master/docs/terminal.png) ## Configuration -Comment configurer cette application : via le panneau d'administration, un fichier brut en SSH ou tout autre moyen. +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 - * Documentation officielle : Lien vers la documentation officielle de cette application. + * 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 @@ -37,27 +35,23 @@ Comment configurer cette application : via le panneau d'administration, un fichi * L'authentification LDAP et HTTP est-elle prise en charge ? * L'application peut-elle être utilisée par plusieurs utilisateurs ? +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. + #### Architectures supportées -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/REPLACEBYYOURAPP%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/REPLACEBYYOURAPP/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/REPLACEBYYOURAPP%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/REPLACEBYYOURAPP/) +* 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/) ## Limitations -* Limitations connues. - -## Informations additionnelles - -* Autres informations que vous souhaitez ajouter sur cette application. - -**Plus d'informations sur la page de documentation :** -https://yunohost.org/packaging_apps +* Vous ne pouvez pas vous authentifier avec des clés SSH. ## Liens - * Signaler un bug : https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/issues - * Site de l'application : Lien vers le site officiel de cette application. - * Dépôt de l'application principale : Lien vers le dépôt officiel de l'application principale. + * 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/ --- @@ -66,11 +60,11 @@ Informations pour les développeurs ---------------- **Seulement si vous voulez utiliser une branche de test pour le codage, au lieu de fusionner directement dans la banche principale.** -Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing). +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/wetty_ynh/tree/testing). Pour essayer la branche testing, procédez comme suit. ``` -sudo yunohost app install https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing --debug +sudo yunohost app install https://github.com/YunoHost-Apps/wetty_ynh/tree/testing --debug ou -sudo yunohost app upgrade REPLACEBYYOURAPP -u https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing --debug +sudo yunohost app upgrade wetty -u https://github.com/YunoHost-Apps/wetty_ynh/tree/testing --debug ```