Auto-update README

README.md

@@ -1,22 +1,32 @@
+<!--
+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.
+-->
+
 # Osada for YunoHost
 
-[![Integration level](https://dash.yunohost.org/integration/osada.svg)](https://dash.yunohost.org/appci/app/osada) ![](https://ci-apps.yunohost.org/ci/badges/osada.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/osada.maintain.svg)
+[![Integration level](https://dash.yunohost.org/integration/osada.svg)](https://dash.yunohost.org/appci/app/osada) ![](https://ci-apps.yunohost.org/ci/badges/osada.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/osada.maintain.svg)  
-
-
 [![Install Osada with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=osada)
 
-> *This package allow you to install Osada quickly and simply on a YunoHost server.
+*[Lire ce readme en français.](./README_fr.md)*
-If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.*
 
+> *This package allows you to install Osada 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
 
 ## Overview
 [Osada](http://zotlabs.com/osada/) uses **Zot6 protocol** which is next version of **zot5 protocol**. Osada has native support for the **ActivityPub protocol** (W3C standard) as well as the more advanced features. It can inter-operate with other social networking applications and projects in either of these spaces, including **Mastodon, Pleroma, Pixelfed, PeerTube, Funkwhale, Zap, Friendica, Hubzilla,** and many more.
 
-**Shipped version:**  21.05.21
+**Shipped version:** 21.05.21~ynh1
+
+
 
 ## Screenshots
 
-![](http://zotlabs.com/osada/img/comment_on_posts.gif)
+![](./doc/screenshots/comment_on_posts.gif)
+
+## Disclaimers / important information
 
 ## This app claims following features:
 - [X] LDAP integration
@@ -37,19 +47,12 @@ If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to
 
 - **Failed Database after Upgrade:** Some times databse upgrade fails after version upgrade. You can go to hub eg. `https://osada.example.com/admin/dbsync/` and check the numbers of failled update. These updates will have to be ran manually by **phpMyAdmin**.
 
-#### Supported architectures
+## Documentation and resources
 
-* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/osada%20%28Official%29.svg)](https://ci-apps.yunohost.org/ci/apps/osada/)
+* Official app website: http://zotlabs.com/osada/
-* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/osada%20%28Official%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/osada/)
+* Upstream app code repository: https://codeberg.org/zot/osada
-
+* YunoHost documentation for this app: https://yunohost.org/app_osada
-### Interesting links
+* Report a bug: https://github.com/YunoHost-Apps/osada_ynh/issues
-
-- [YunoHost project](https://yunohost.org)
-- [Osada website](http://zotlabs.com/osada/)
-- [Osada code on Codeberg](https://codeberg.org/zot/osada)
-- [Osada addons on Codeberg](https://codeberg.org/zot/osada-addons)
-
----
 
 ## Developer info
 
@@ -61,3 +64,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/osada_ynh/tree/testin
 or
 sudo yunohost app upgrade osada -u https://github.com/YunoHost-Apps/osada_ynh/tree/testing --debug
 ```
+
+**More info regarding app packaging:** https://yunohost.org/packaging_apps

README_fr.md

@@ -0,0 +1,64 @@
+# Osada pour YunoHost
+
+[![Niveau d'intégration](https://dash.yunohost.org/integration/osada.svg)](https://dash.yunohost.org/appci/app/osada) ![](https://ci-apps.yunohost.org/ci/badges/osada.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/osada.maintain.svg)  
+[![Installer Osada avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=osada)
+
+*[Read this readme in english.](./README.md)*
+*[Lire ce readme en français.](./README_fr.md)*
+
+> *Ce package vous permet d'installer Osada 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
+
+## Overview
+[Osada](http://zotlabs.com/osada/) uses **Zot6 protocol** which is next version of **zot5 protocol**. Osada has native support for the **ActivityPub protocol** (W3C standard) as well as the more advanced features. It can inter-operate with other social networking applications and projects in either of these spaces, including **Mastodon, Pleroma, Pixelfed, PeerTube, Funkwhale, Zap, Friendica, Hubzilla,** and many more.
+
+**Version incluse :** 21.05.21~ynh1
+
+
+
+## Captures d'écran
+
+![](./doc/screenshots/comment_on_posts.gif)
+
+## Avertissements / informations importantes
+
+## This app claims following features:
+- [X] LDAP integration
+- [X] Multi-instance
+- [X] Adeed php.log in the root folder for debugging PHP, with logrotate applied on it (can be accesssed by **admin->logs** and entering the **php.log**).
+- [X] Fail2Ban
+- [X] Option to choose between **Mysql** and **PostgreSQL** for the Osada
+
+## Ldap Admin user rights, logs and failed database updates
+
+- **For admin rights**: When installation is complete, you will need to visit your new hub's page and login with the **admin account username** which was entered at the time of installation process. You should then be able to create your first channel and have the **admin rights** for the hub.
+
+- **For normal YunoHost users**: Normal LDAP users can login through LDAP authentication and create there channels.
+
+- **Failing to get admin rights**: If the admin cannot access the admin settings at `https://osada.example.com/admin` then you have to **manually add 4096** to the **account_roles** under **accounts** for that user in the **database through phpMyAdmin**.
+
+- **For logs**: Go to **admin->logs** and enter the file name **php.log**.
+
+- **Failed Database after Upgrade:** Some times databse upgrade fails after version upgrade. You can go to hub eg. `https://osada.example.com/admin/dbsync/` and check the numbers of failled update. These updates will have to be ran manually by **phpMyAdmin**.
+
+## Documentations et ressources
+
+* Site officiel de l'app : http://zotlabs.com/osada/
+* Dépôt de code officiel de l'app : https://codeberg.org/zot/osada
+* Documentation YunoHost pour cette app : https://yunohost.org/app_osada
+* Signaler un bug : https://github.com/YunoHost-Apps/osada_ynh/issues
+
+## Informations pour les développeurs
+
+Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/osada_ynh/tree/testing).
+
+Pour essayer la branche testing, procédez comme suit.
+```
+sudo yunohost app install https://github.com/YunoHost-Apps/osada_ynh/tree/testing --debug
+ou
+sudo yunohost app upgrade osada -u https://github.com/YunoHost-Apps/osada_ynh/tree/testing --debug
+```
+
+**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps