Auto-update README

2024-09-03 18:36:14 +02:00 · 2021-07-17 15:35:26 +00:00 · 2021-07-17 15:35:26 +00:00 · 4964f3100e
commit 4964f3100e
parent dab9fbe086
2 changed files with 93 additions and 35 deletions
--- a/README.md
+++ b/README.md
@ -1,36 +1,31 @@
+<!--
+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.
+-->
+
 # Friendica for YunoHost

 [![Integration level](https://dash.yunohost.org/integration/friendica.svg)](https://dash.yunohost.org/appci/app/friendica) ![](https://ci-apps.yunohost.org/ci/badges/friendica.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/friendica.maintain.svg)  
-[![Install Friendica with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=friendica)
+[![Install Friendica with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=friendica)

+*[Lire ce readme en français.](./README_fr.md)*

-> *This package allow you to install Friendica quickly and simply on a YunoHost server.
-If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to learn how to install and enjoy it.*
+> *This package allows you to install Friendica 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
-Friendica is a software to create a distributed social network. It is part of the federation of servers that are running with Friendica, Diaspora and Hubzilla which are compatible to each other.

-**Version:** 2021.04
+Social Communication Server

-Current snapshot in *sources*:
+**Shipped version:** 2021.07~ynh1

-* https://github.com/friendica/friendica: 2021.04
-* https://github.com/friendica/friendica-addons: 2021.04
+**Demo:** https://demo.example.com

-**Warning:** It's advised to use Barracuda as MySQL DB file format for your Friendica database.
+## Screenshots

-## Friendica
-[Friendica](http://friendi.ca/) is a decentralised communications platform that integrates social communication. Our platform links to independent social projects and corporate services.
+![](./doc/screenshots/friendica-vier-profile.png)

-Friendica connects you effortlessly to a federated communications network of several thousand servers, with more than half a million user registrations. You can directly connect to anyone on **Friendica**, **Mastodon**, **Diaspora**, **GnuSocial**, **Pleroma**, or **Hubzilla**, regardless where each user profile is hosted.
-
-![](https://raw.githubusercontent.com/friendica/friendica/develop/images/screenshots/friendica-frio-green-profle-1.png)
-
-## This app claims following features:
- [ ] Ldap integration(Ldap is broken in the latest version.[See this](https://github.com/friendica/friendica/issues/4140#issuecomment-731579013))
- [X] Multi-instance
- [ ] Add 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**).
- [ ] Fail2Ban
+## Disclaimers / important information

 ## Installation

@ -47,28 +42,23 @@ Use the YunoHost admin panel to install Friendica by entering the GitHub repo ad

 		https://github.com/YunoHost-Apps/friendica_ynh

-## User with ldap admin rights
+## User with LDAP admin rights
 **For admin rights**: When installation is complete, you will need to visit your domain page and login with the **admin account username and password** which was entered at the time of installation process. You can then create your profile and access the admin panel.

 **For normal YunoHost users :** Normal LDAP users can login through Ldap authentication and create there profiles.

-#### Supported architectures
+## Documentation and resources

-* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/friendica%20%28Official%29.svg)](https://ci-apps.yunohost.org/ci/apps/friendica/)
-* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/friendica%20%28Official%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/friendica/)
+* Official app website: http://friendi.ca
+* Official user documentation: https://wiki.friendi.ca/
+* Official admin documentation: https://github.com/friendica/friendica/wiki
+* Upstream app code repository: https://github.com/friendica/friendica
+* YunoHost documentation for this app: https://yunohost.org/app_friendica
+* Report a bug: https://github.com/YunoHost-Apps/friendica_ynh/issues

-## Links
+## Developer info

- * Report a bug: https://github.com/YunoHost-Apps/friendica_ynh/issues
- * App website: http://friendi.ca/
- * Upstream app repository: https://github.com/friendica/friendica
- * YunoHost website: https://yunohost.org/
-
---
-
-## Developers info
-
-Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/friendica_ynh/tree/testing).
+Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/friendica_ynh/tree/testing).

 To try the testing branch, please proceed like that.
 ```
@ -76,3 +66,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/friendica_ynh/tree/te
 or
 sudo yunohost app upgrade friendica -u https://github.com/YunoHost-Apps/friendica_ynh/tree/testing --debug
 ```
+
+**More info regarding app packaging:** https://yunohost.org/packaging_apps
--- a/README_fr.md
+++ b/README_fr.md
@ -0,0 +1,66 @@
+# Friendica pour YunoHost
+
+[![Niveau d'intégration](https://dash.yunohost.org/integration/friendica.svg)](https://dash.yunohost.org/appci/app/friendica) ![](https://ci-apps.yunohost.org/ci/badges/friendica.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/friendica.maintain.svg)  
+[![Installer Friendica avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=friendica)
+
+*[Read this readme in english.](./README.md)*
+*[Lire ce readme en français.](./README_fr.md)*
+
+> *Ce package vous permet d'installer Friendica 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
+
+Serveur de Communication Social
+
+**Version incluse :** 2021.07~ynh1
+
+**Démo :** https://demo.example.com
+
+## Captures d'écran
+
+![](./doc/screenshots/friendica-vier-profile.png)
+
+## Avertissements / informations importantes
+
+## Installation
+
+### Enregistrez un nouveau domaine et ajoutez-le à YunoHost
+
+Avant l'installation, lisez les [instructions d'installation de Friendica](https://github.com/friendica/friendica/blob/develop/doc/Install.md) pour obtenir des informations importantes sur l'installation.
+
+- Domaine dédié (doit être installé sous la racine Web comme **https://friendica.example.com/** et non **https://example.com/friendica/** )
+
+- Friendica nécessite des certificats SSL approuvés par le navigateur.
+
+### Installer Friendica
+Utilisez le panneau d'administration YunoHost pour installer Friendica en saisissant l'adresse du dépôt GitHub dans l'URL de l'application personnalisée :
+
+https://github.com/YunoHost-Apps/friendica_ynh
+
+## Utilisateur avec des droits d'administrateur LDAP
+**Pour les droits d'administrateur** : une fois l'installation terminée, vous devrez visiter la page de votre domaine et vous connecter avec le **nom d'utilisateur et le mot de passe du compte administrateur** qui ont été saisis au moment du processus d'installation. Vous pouvez ensuite créer votre profil et accéder au panneau d'administration.
+
+ **Pour les utilisateurs normaux de YunoHost :** Les utilisateurs LDAP normaux peuvent se connecter via l'authentification LDAP et y créer des profils. 
+
+## Documentations et ressources
+
+* Site officiel de l'app : http://friendi.ca
+* Documentation officielle utilisateur : https://wiki.friendi.ca/
+* Documentation officielle de l'admin : https://github.com/friendica/friendica/wiki
+* Dépôt de code officiel de l'app : https://github.com/friendica/friendica
+* Documentation YunoHost pour cette app : https://yunohost.org/app_friendica
+* Signaler un bug : https://github.com/YunoHost-Apps/friendica_ynh/issues
+
+## Informations pour les développeurs
+
+Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/friendica_ynh/tree/testing).
+
+Pour essayer la branche testing, procédez comme suit.
+```
+sudo yunohost app install https://github.com/YunoHost-Apps/friendica_ynh/tree/testing --debug
+ou
+sudo yunohost app upgrade friendica -u https://github.com/YunoHost-Apps/friendica_ynh/tree/testing --debug
+```
+
+**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps