Auto-update README

README.md

@@ -1,27 +1,34 @@
+<!--
+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.
+-->
+
 # Gogs for YunoHost
 
 [![Integration level](https://dash.yunohost.org/integration/gogs.svg)](https://dash.yunohost.org/appci/app/gogs) ![](https://ci-apps.yunohost.org/ci/badges/gogs.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/gogs.maintain.svg)  
-[![Install Gogs with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=gogs)
+[![Install Gogs with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=gogs)
 
-> *This package allows you to install Gogs quickly and simply on a YunoHost server.  
+*[Lire ce readme en français.](./README_fr.md)*
+
+> *This package allows you to install Gogs 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.*
 
-> :warning: **Note that this package will not be longer be maintened by the actual maintener.
-> The idea is to migrate to [gitea](https://github.com/YunoHost-Apps/gitea_ynh) which is more featured.**
-
 ## Overview
-Gogs is a self-hosted Git service written in Go. Alternative to Github.
 
-**Shipped version:** 0.11.66
+Lightweight Git forge
+
+**Shipped version:** 0.11.66~ynh2
+
+**Demo:** https://try.gogs.io/user/login
 
 ## Screenshots
 
-![](https://gogs.io/img/screenshots/2.png)
+![](./doc/screenshots/screenshot.png)
 
+## Disclaimers / important information
 
-## Demo
+> :warning: **Note that this package will not be longer be maintened by the actual maintener.
-
+> The idea is to migrate to [gitea](https://github.com/YunoHost-Apps/gitea_ynh) which is more featured.**
-* [Official demo](https://try.gogs.io/user/login)
 
 For the old install you can migrate to gitea easly by juste upgrading your actuall gogs instance with the gitea source by this command:
 ```
@@ -63,20 +70,14 @@ Previous versions of this package used to build Gogs from sources instead of usi
 
 Also, in some cases, Gogs will not restart properly during the update. If so, you can rerun the update safely or try to start Gogs with `sudo systemctl restart gogs.service`.
 
+## Documentation and resources
 
-#### Supported architectures
+* Official app website: http://gogs.io
-
+* Official user documentation: https://yunohost.org/apps
-* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/gogs%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/gogs/)
+* Official admin documentation: https://yunohost.org/packaging_apps
-* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/gogs%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/gogs/)
+* Upstream app code repository: https://github.com/gogs/gogs
-
+* YunoHost documentation for this app: https://yunohost.org/app_gogs
-## Links
+* Report a bug: https://github.com/YunoHost-Apps/gogs_ynh/issues
-
- * Report a bug: https://github.com/YunoHost-Apps/gogs_ynh/issues
- * App website: http://gogs.io
- * Upstream app repository: https://github.com/gogs/gogs
- * YunoHost website: https://yunohost.org/
-
----
 
 ## Developer info
 
@@ -88,3 +89,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/gogs_ynh/tree/testing
 or
 sudo yunohost app upgrade gogs -u https://github.com/YunoHost-Apps/gogs_ynh/tree/testing --debug
 ```
+
+**More info regarding app packaging:** https://yunohost.org/packaging_apps

README_fr.md

@@ -0,0 +1,89 @@
+# Gogs pour YunoHost
+
+[![Niveau d'intégration](https://dash.yunohost.org/integration/gogs.svg)](https://dash.yunohost.org/appci/app/gogs) ![](https://ci-apps.yunohost.org/ci/badges/gogs.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/gogs.maintain.svg)  
+[![Installer Gogs avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=gogs)
+
+*[Read this readme in english.](./README.md)*
+*[Lire ce readme en français.](./README_fr.md)*
+
+> *Ce package vous permet d'installer Gogs rapidement et simplement sur un serveur YunoHost.
+Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
+
+## Vue d'ensemble
+
+Forge Git légère
+
+**Version incluse :** 0.11.66~ynh2
+
+**Démo :** https://try.gogs.io/user/login
+
+## Captures d'écran
+
+![](./doc/screenshots/screenshot.png)
+
+## Avertissements / informations importantes
+
+> :warning: **Note that this package will not be longer be maintened by the actual maintener.
+> The idea is to migrate to [gitea](https://github.com/YunoHost-Apps/gitea_ynh) which is more featured.**
+
+For the old install you can migrate to gitea easly by juste upgrading your actuall gogs instance with the gitea source by this command:
+```
+sudo yunohost app upgrade -u https://github.com/YunoHost-Apps/gitea_ynh gogs
+```
+**Note that this command contains some risk of data lost. So it's important to make a backup of the app before the install.**
+To make a backup you can use this command:
+```
+sudo yunohost backup create --debug --apps gogs
+```
+
+For the new install just install gitea by this command:
+```
+sudo yunohost app install -l Gitea https://github.com/YunoHost-Apps/gitea_ynh
+```
+
+## Notes on SSH usage
+If you want to use Gogs with ssh and be able to pull/push with you ssh key, your ssh daemon must be properly configured to use private/public keys. Here is a sample configuration of `/etc/ssh/sshd_config` that works with Gogs:
+
+```bash
+PubkeyAuthentication yes
+AuthorizedKeysFile %h/.ssh/authorized_keys
+ChallengeResponseAuthentication no
+PasswordAuthentication no
+UsePAM no
+```
+
+You also need to add your public key to your Gogs profile.
+
+If you use ssh on another port than 22, you need to add theses lines to your ssh config in `~/.ssh/config`:
+
+```bash
+Host domain.tld
+    port 2222 # change this with the port you use
+```
+
+## Info on upgrading from the old package version (gogs <0.9.xx)
+Previous versions of this package used to build Gogs from sources instead of using the pre-compiled binary. It also left data in many places which was not good. The upgrade tries to take care of moving everything to the right place **BUT it's strongly advised to do a backup of your repositories and of the Gogs directory before the update**. Your avatars and issue attachments files may be lost in the process.
+
+Also, in some cases, Gogs will not restart properly during the update. If so, you can rerun the update safely or try to start Gogs with `sudo systemctl restart gogs.service`.
+
+## Documentations et ressources
+
+* Site officiel de l'app : http://gogs.io
+* Documentation officielle utilisateur : https://yunohost.org/apps
+* Documentation officielle de l'admin : https://yunohost.org/packaging_apps
+* Dépôt de code officiel de l'app : https://github.com/gogs/gogs
+* Documentation YunoHost pour cette app : https://yunohost.org/app_gogs
+* Signaler un bug : https://github.com/YunoHost-Apps/gogs_ynh/issues
+
+## Informations pour les développeurs
+
+Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/gogs_ynh/tree/testing).
+
+Pour essayer la branche testing, procédez comme suit.
+```
+sudo yunohost app install https://github.com/YunoHost-Apps/gogs_ynh/tree/testing --debug
+ou
+sudo yunohost app upgrade gogs -u https://github.com/YunoHost-Apps/gogs_ynh/tree/testing --debug
+```
+
+**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps