diff --git a/README.md b/README.md index e8eba729..0d4f8d4b 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,43 @@ + + # Pixelfed for YunoHost [![Integration level](https://dash.yunohost.org/integration/pixelfed.svg)](https://dash.yunohost.org/appci/app/pixelfed) ![](https://ci-apps.yunohost.org/ci/badges/pixelfed.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/pixelfed.maintain.svg) [![Install Pixelfed with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=pixelfed) -> *This package allows you to install Pixelfed quickly and simply on a YunoHost server. +*[Lire ce readme en français.](./README_fr.md)* + +> *This package allows you to install Pixelfed 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 -The federated image sharing service Pixelfed, for YunoHost -**Shipped version:** 0.11.0~ynh2 +PixelFed is a decentralized and federated image sharing software under development. +In addition to taking over the functionality of Instagram, the functioning of PixelFed is: + +* Decentralized: Each instance can follow one or more other PixelFed instances in order to allow their respective members to interact. A first pixelfed.social public body limited to 10,000 members has already been created. + +* Federated: Via the ActivityPub protocol, PixelFed can interact with other software that is part of the Fediverse, such as Mastodon or PeerTube for example. + +It is also possible to import your data from Instagram. + +**Shipped version:** 0.11.1~ynh1 + +**Demo:** https://demo.example.com + +## Screenshots + +![](./doc/screenshots/screenshots.png) + +## Disclaimers / important information ## Important points to read before installing 1. **Pixelfed** require a dedicated **root domain**, eg. pixelfed.domain.tld -## Screenshots - -![](https://camo.githubusercontent.com/c1c2e74057dcff57e103fcbb3239840802fcf752/68747470733a2f2f706978656c6665642e6e7963332e63646e2e6469676974616c6f6365616e7370616365732e636f6d2f6d656469612f53637265656e25323053686f74253230323031392d30322d30352532306174253230362e33342e3539253230504d2e706e67) - -## Configuration - ### Administrator After being first registered, you need to execute the folloing command to promote first registered as admin @@ -48,31 +65,14 @@ Note: search engines will see that file and may or may not respect its content. Since 0.10.10, by default `/discover/places/`, `/stories/` and `/i/` are present in that file. -### Pixelfed php commands and php version +## Documentation and resources -Pixelfed might require some command line instructions if you want to make manual changes to your configuration. -By default php 7.0 is currently used when you type `php`. You need to use `php7.3 [command]` instead. -Those commands can be found in the official documentation. - -## Documentation - - * [Official documentation](https://docs.pixelfed.org/) - -## YunoHost specific features - -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/pixelfed.svg)](https://ci-apps.yunohost.org/ci/apps/pixelfed/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/pixelfed.svg)](https://ci-apps-arm.yunohost.org/ci/apps/pixelfed/) - -## Links - - * Report a bug: https://github.com/YunoHost-Apps/pixelfed_ynh - * App website: https://pixelfed.org - * Upstream app repository: https://github.com/pixelfed/pixelfed - * YunoHost website: https://yunohost.org - ---- +* Official app website: https://pixelfed.org/ +* Official user documentation: https://yunohost.org/apps +* Official admin documentation: https://yunohost.org/packaging_apps +* Upstream app code repository: https://some.forge.com/example/example +* YunoHost documentation for this app: https://yunohost.org/app_pixelfed +* Report a bug: https://github.com/YunoHost-Apps/pixelfed_ynh/issues ## Developer info @@ -84,3 +84,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/pixelfed_ynh/tree/tes or sudo yunohost app upgrade pixelfed -u https://github.com/YunoHost-Apps/pixelfed_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 new file mode 100644 index 00000000..27150314 --- /dev/null +++ b/README_fr.md @@ -0,0 +1,85 @@ +# Pixelfed pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/pixelfed.svg)](https://dash.yunohost.org/appci/app/pixelfed) ![](https://ci-apps.yunohost.org/ci/badges/pixelfed.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/pixelfed.maintain.svg) +[![Installer Pixelfed avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=pixelfed) + +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* + +> *Ce package vous permet d'installer Pixelfed 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 + +PixelFed est un logiciel décentralisé et fédéré de partage d'images en cours de développement. +En plus de reprendre les fonctionnalités d'Instagram, le fonctionnement de PixelFed est: + +* Décentralisé : Chaque instance peut suivre une ou plusieurs autres instances PixelFed afin de permettre à leurs membres respectifs d'interagir. Une première instance publique pixelfed.social limitée à 10 000 membres a déjà été créée. + +* Fédéré : Via le protocole ActivityPub, PixelFed peut interagir avec d'autres logiciels qui font partie du Fediverse, comme Mastodon ou PeerTube par exemple. + +Il est également possible d'importer ses données depuis Instagram. + + +**Version incluse :** 0.11.1~ynh1 + +**Démo :** https://demo.example.com + +## Captures d'écran + +![](./doc/screenshots/screenshots.png) + +## Avertissements / informations importantes + +## Points importants à lire avant l'installation + +1. **Pixelfed** nécessite un **domaine racine** dédié, par ex. pixelfed.domain.tld + +### Administrateur + +Après avoir été enregistré pour la première fois, vous devez exécuter la commande suivante pour promouvoir le premier enregistré en tant qu'administrateur + +**Courir:** + + $ (cd /var/www/pixelfed && php7.3 artisan user:admin 1) + +et répondez oui à la question « Ajouter des privilèges d'administrateur à cet utilisateur ? » + +### Autoriser/Fermer les inscriptions + +Les inscriptions sont ouvertes par défaut. +Pour modifier ce paramètre, modifiez `/var/www/pixelfed/.env` et définissez `OPEN_REGISTRATION=false` au lieu de `true`. +Ensuite, exécutez `php7.3 artisan config:cache` pour recharger les paramètres. + +### Désactiver l'indexation des moteurs de recherche + +Si vous ne voulez pas que votre instance Pixelfed soit indexée dans le moteur de recherche (et ainsi de suite), modifiez `/var/www/pixelfed/public/robots.txt` comme ceci : +``` +Agent utilisateur: * +Interdire : / +``` +Remarque : les moteurs de recherche verront ce fichier et pourront ou non respecter son contenu. + +Depuis la 0.10.10, par défaut `/discover/places/`, `/stories/` et `/i/` sont présents dans ce fichier. + +## Documentations et ressources + +* Site officiel de l'app : https://pixelfed.org/ +* 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://some.forge.com/example/example +* Documentation YunoHost pour cette app : https://yunohost.org/app_pixelfed +* Signaler un bug : https://github.com/YunoHost-Apps/pixelfed_ynh/issues + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/pixelfed_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/pixelfed_ynh/tree/testing --debug +ou +sudo yunohost app upgrade pixelfed -u https://github.com/YunoHost-Apps/pixelfed_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file