From b7d98901935a5f177725e3c7c6110d61b513ef94 Mon Sep 17 00:00:00 2001 From: Tagada <36127788+Tagadda@users.noreply.github.com> Date: Thu, 13 May 2021 20:02:49 +0200 Subject: [PATCH] Update manifest.json and ran make_readme.py --- README.md | 126 +++++++++++++++++++--------------------------- README_fr.md | 79 +++++++++-------------------- doc/DISCLAIMER.md | 6 +++ manifest.json | 23 ++++----- 4 files changed, 89 insertions(+), 145 deletions(-) create mode 100644 doc/DISCLAIMER.md diff --git a/README.md b/README.md index 5b4ecaf..c15009e 100644 --- a/README.md +++ b/README.md @@ -1,86 +1,62 @@ -# Glich-Soc for YunoHost -[![Integration level](https://dash.yunohost.org/integration/glitchsoc.svg)](https://dash.yunohost.org/appci/app/glitchsoc) ![](https://ci-apps.yunohost.org/ci/badges/glitchsoc.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/glitchsoc.maintain.svg) -[![Install Glich-Soc with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=glitchsoc) - -*[Lire ce readme en français.](./README_fr.md)* - -> *This package allows you to install Glich-Soc 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 -Glich-Soc is a free, open-source microblogging social network. It is a decentralized alternative to commercial platforms like Twitter and avoids the risks of a single company monopolizing your communication for commercial purposes. - -**Shipped version:** 3.3.0 - -## Important points to read before installing - -1. **Glich-Soc** require a dedicated **root domain**, eg. glitchsoc.domain.tld -1. The user choosen during the installation is automatically created in Glich-Soc with admin rights -1. At the end of the installation a mail is sent to the user with the automatically generated password -1. It seems important to close the inscriptions for your Glich-Soc, so that it remains a private body. We invite you to block remote malicious instances from the administration interface. You can also add text on your home page. - -## Screenshots - -![](https://framalibre.org/sites/default/files/mastodon.png) - -## Configuration - -### Install - -#### Using *screen* in case of disconnect -``` -$ sudo apt-get install screen -$ screen -$ sudo yunohost app install https://github.com/YunoHost-Apps/glitch-soc_ynh.git -``` -Recover after disconnect: -``` -$ screen -d -$ screen -r -``` - -### Update - -#### Using *screen* highly recommended - -`$ sudo yunohost app upgrade glitchsoc -u https://github.com/YunoHost-Apps/glitch-soc_ynh --debug ` - -### Administrate with tooctl - -`$ (cd /var/www/glitchsoc/live && sudo -u glitchsoc RAILS_ENV=production PATH=/opt/rbenv/versions/glitchsoc/bin bin/tootctl --help)` - -## Documentation - - * Official documentation: https://glitch-soc.github.io/docs/ - -## YunoHost specific features - -#### Multi-users support - -LDAP authentication is activated. All YunoHost users can authenticate. - -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/glitchsoc.svg)](https://ci-apps.yunohost.org/ci/apps/glitchsoc/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/glitchsoc.svg)](https://ci-apps-arm.yunohost.org/ci/apps/glitchsoc/) - -## Links - - * Report a bug: https://github.com/YunoHost-Apps/glitch-soc_ynh/issues - * App website: https://glitch-soc.github.io/docs/ - * Upstream app repository: https://github.com/glitch-soc/mastodon - * YunoHost website: https://yunohost.org/ --- + + +# Glich-Soc for YunoHost + +[![Integration level](https://dash.yunohost.org/integration/glitchsoc.svg)](https://dash.yunohost.org/appci/app/glitchsoc) ![](https://ci-apps.yunohost.org/ci/badges/glitchsoc.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/glitchsoc.maintain.svg) +[![Install glitchsoc with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=glitchsoc) + +*[Lire ce readme en français.](./README_fr.md)* + +> *This package allows you to install glitchsoc 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 + +A libre and federated social network, fork of Mastodon. + +**Shipped version:** 3.3.0~ynh1 + + + + + + +## Disclaimers / important information + +Glitch-Soc is beta software, and under active development. Use at your own risk! + +* This app require a dedicated domain or subdomain. +* The user choosen during the installation is created in Glich-Soc with admin rights. At the end of the installation a mail is sent to the user with the a generated password. +* LDAP authentication is activated. All YunoHost users can authenticate. +* It seems important to close the inscriptions for your Glitch-Soc, so that it remains a private body. We invite you to block remote malicious instances from the administration interface. You can also add text on your home page. + + + +## Documentation and resources + +* Official app website: https://glitch-soc.github.io/docs/ + + +* Upstream app code repository: https://github.com/glitch-soc/mastodon +* YunoHost documentation for this app: https://yunohost.org/app_glitchsoc +* Report a bug: https://github.com/YunoHost-Apps/glitchsoc_ynh/issues + ## Developer info -Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/glitch-soc_ynh/tree/testing). +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/glitchsoc_ynh/tree/testing). To try the testing branch, please proceed like that. ``` -sudo yunohost app install https://github.com/YunoHost-Apps/glitch-soc_ynh/tree/testing --debug +sudo yunohost app install https://github.com/YunoHost-Apps/glitchsoc_ynh/tree/testing --debug or -sudo yunohost app upgrade glitchsoc -u https://github.com/YunoHost-Apps/glitch-soc_ynh/tree/testing --debug +sudo yunohost app upgrade glitchsoc -u https://github.com/YunoHost-Apps/glitchsoc_ynh/tree/testing --debug ``` + +**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/README_fr.md b/README_fr.md index 72e86b8..31dafd4 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,87 +1,54 @@ # Glich-Soc pour YunoHost -[![Niveau d'intégration](https://dash.yunohost.org/integration/glitchsoc.svg)](https://dash.yunohost.org/appci/app/glitchsoc) ![](https://ci-apps.yunohost.org/ci/badges/glitchsoc.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/glitchsoc.maintain.svg) -[![Installer Glich-Soc avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=glitchsoc) +[![Niveau d'intégration](https://dash.yunohost.org/integration/glitchsoc.svg)](https://dash.yunohost.org/appci/app/glitchsoc) ![](https://ci-apps.yunohost.org/ci/badges/glitchsoc.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/glitchsoc.maintain.svg) +[![Installer glitchsoc avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=glitchsoc) -*[Read this readme in english.](./README.md)* +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* > *Ce package vous permet d'installer Glich-Soc 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 -Glich-Soc est un réseau social de microblog auto-hébergé et open source. C'est une alternative décentralisée aux plates-formes commerciales comme Twitter. Glich-Soc évite ainsi les risques qu'une seule société monopolise votre communication à des fins commerciales. -**Version incluse:** 3.3.0 +Un réseau social libre et fédéré, scission de Mastodon. -## Points importants à lire avant l'installation +**Version incluse:** 3.3.0~ynh1 -1. **Glich-Soc** nécessite un **nom de domaine** dédié, par exemple : glitchsoc.domain.tld -1. L'utilisateur sélectionné pendant l'installation sera créé automatiquement dans Glich-Soc avec des droits d'administration. -1. À la fin de l'installation, un mail est envoyé à cet utilisateur avec un mot de passe généré automatiquement. -1. Pour que votre instance Glich-Soc reste privée, il est important de fermer les inscriptions. Nous vous invitons à bloquer les instances distantes indésirables depuis l'interface d'administration. Vous pouvez également ajouter un texte sur votre page d'accueil dans l'administration. -## Captures d'écran -![](https://framalibre.org/sites/default/files/mastodon.png) -## Configuration -### Installation -#### Utilisation de *screen* en cas de déconnection -``` -$ sudo apt-get install screen -$ screen -$ sudo yunohost app install https://github.com/YunoHost-Apps/glitch-soc_ynh.git -``` -Récupérer l'installation après une deconnection : -``` -$ screen -d -$ screen -r -``` -L'utilisateur admin est créé automatiquement comme : user@domain.tld +## Avertissements / informations importantes -### Mise à jour +Glitch-Soc is beta software, and under active development. Use at your own risk! -#### Utilisation de *screen* fortement recommandée +* This app require a dedicated domain or subdomain. +* The user choosen during the installation is created in Glich-Soc with admin rights. At the end of the installation a mail is sent to the user with the a generated password. +* LDAP authentication is activated. All YunoHost users can authenticate. +* It seems important to close the inscriptions for your Glitch-Soc, so that it remains a private body. We invite you to block remote malicious instances from the administration interface. You can also add text on your home page. -`$ sudo yunohost app upgrade glitchsoc -u https://github.com/YunoHost-Apps/glitch-soc_ynh --debug ` -### Administration avec tooctl -`$ (cd /var/www/glitchsoc/live && sudo -u glitchsoc RAILS_ENV=production PATH=/opt/rbenv/versions/glitchsoc/bin bin/tootctl --help)` +## Documentations et ressources -## Documentation +* Site official de l'app : https://glitch-soc.github.io/docs/ - * Documentation officielle : https://glitch-soc.github.io/docs/ -## Caractéristiques spécifiques YunoHost - -#### Support multi-utilisateur - -L'authentification LDAP est activée. Tous les utilisateurs YunoHost peuvent s'authentifier. - -#### Architectures supportées - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/glitchsoc.svg)](https://ci-apps.yunohost.org/ci/apps/glitchsoc/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/glitchsoc.svg)](https://ci-apps-arm.yunohost.org/ci/apps/glitchsoc/) - -## Liens - - * Signaler un bug : https://github.com/YunoHost-Apps/glitch-soc_ynh/issues - * Site de l'application : https://glitch-soc.github.io/docs/ - * Dépôt de l'application principale : https://github.com/glitch-soc/mastodon - * Site web YunoHost : https://yunohost.org/ - ---- +* Dépôt de code officiel de l'app: https://github.com/glitch-soc/mastodon +* Documentation YunoHost pour cette app: https://yunohost.org/app_glitchsoc +* Signaler un bug: https://github.com/YunoHost-Apps/glitchsoc_ynh/issues ## Informations pour les développeurs -Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/glitch-soc_ynh/tree/testing). +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/glitchsoc_ynh/tree/testing). Pour essayer la branche testing, procédez comme suit. ``` -sudo yunohost app install https://github.com/YunoHost-Apps/glitch-soc_ynh/tree/testing --debug -ou -sudo yunohost app upgrade glitchsoc -u https://github.com/YunoHost-Apps/glitch-soc_ynh/tree/testing --debug +sudo yunohost app install https://github.com/YunoHost-Apps/glitchsoc_ynh/tree/testing --debug +or +sudo yunohost app upgrade glitchsoc -u https://github.com/YunoHost-Apps/glitchsoc_ynh/tree/testing --debug ``` + +**Plus d'infos sur le packaging d'applications:** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md new file mode 100644 index 0000000..3a3413c --- /dev/null +++ b/doc/DISCLAIMER.md @@ -0,0 +1,6 @@ +Glitch-Soc is beta software, and under active development. Use at your own risk! + +* This app require a dedicated domain or subdomain. +* The user choosen during the installation is created in Glich-Soc with admin rights. At the end of the installation a mail is sent to the user with the a generated password. +* LDAP authentication is activated. All YunoHost users can authenticate. +* It seems important to close the inscriptions for your Glitch-Soc, so that it remains a private body. We invite you to block remote malicious instances from the administration interface. You can also add text on your home page. diff --git a/manifest.json b/manifest.json index 5ec4806..1a0a785 100644 --- a/manifest.json +++ b/manifest.json @@ -3,25 +3,20 @@ "id": "glitchsoc", "packaging_format": 1, "description": { - "en": "A libre and federated social network.", - "fr": "Un réseau social libre et fédéré." + "en": "A libre and federated social network, fork of Mastodon.", + "fr": "Un réseau social libre et fédéré, scission de Mastodon." }, - "version": "2021-04-11-ynh3", + "version": "3.3.0~ynh1", "url": "https://github.com/glitch-soc/mastodon", + "upstream": { + "license": "free", + "website": "https://glitch-soc.github.io/docs/", + "code": "https://github.com/glitch-soc/mastodon" + }, "license": "AGPL-3.0-or-later", "maintainer": { - "name": "" + "name": "Tagada" }, - "previous_maintainer": [ - { - "name": "cyp", - "email": "cyp@rouquin.me" - }, - { - "name": "nemsia", - "email": "nemsia@nemsia.org" - } - ], "requirements": { "yunohost": ">= 4.2.0" },