diff --git a/ALL_README.md b/ALL_README.md new file mode 100644 index 00000000..3d6c579b --- /dev/null +++ b/ALL_README.md @@ -0,0 +1,6 @@ +# All available README files by language + +- [Read the README in English](README.md) +- [Lire le README en français](README_fr.md) +- [Le o README en galego](README_gl.md) +- [Leggi il “README” in italiano](README_it.md) diff --git a/README.md b/README.md index 04157462..ac7cce20 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ @@ -9,10 +9,10 @@ It shall NOT be edited by hand. [![Install Pixelfed with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=pixelfed) -*[Lire ce readme en français.](./README_fr.md)* +*[Read this README is other languages.](./ALL_README.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.* +> *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 @@ -75,11 +75,11 @@ Be aware that this will generate a lot of "jobs" that will take time to be compl ## Developer info -Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/pixelfed_ynh/tree/testing). +Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/pixelfed_ynh/tree/testing). -To try the testing branch, please proceed like that. +To try the `testing` branch, please proceed like that: -``` bash +```bash sudo yunohost app install https://github.com/YunoHost-Apps/pixelfed_ynh/tree/testing --debug or sudo yunohost app upgrade pixelfed -u https://github.com/YunoHost-Apps/pixelfed_ynh/tree/testing --debug diff --git a/README_fr.md b/README_fr.md index 0ef5a87c..0cd2a256 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,6 +1,6 @@ # Pixelfed pour YunoHost @@ -9,10 +9,10 @@ It shall NOT be edited by hand. [![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 le README dans d'autres langues.](./ALL_README.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.* +> *Ce package vous permet d’installer Pixelfed rapidement et simplement sur un serveur YunoHost.* +> *Si vous n’avez pas YunoHost, consultez [ce guide](https://yunohost.org/install) pour savoir comment l’installer et en profiter.* ## Vue d’ensemble @@ -26,7 +26,7 @@ En plus de reprendre les fonctionnalités d'Instagram, le fonctionnement de Pixe Il est également possible d'importer ses données depuis Instagram. -**Version incluse :** 0.11.13~ynh1 +**Version incluse :** 0.11.13~ynh1 ## Captures d’écran @@ -67,23 +67,23 @@ Be aware that this will generate a lot of "jobs" that will take time to be compl ## Documentations et ressources -- Site officiel de l’app : -- Documentation officielle utilisateur : -- Documentation officielle de l’admin : -- Dépôt de code officiel de l’app : -- YunoHost Store : -- Signaler un bug : +- Site officiel de l’app : +- Documentation officielle utilisateur : +- Documentation officielle de l’admin : +- Dépôt de code officiel de l’app : +- YunoHost Store : +- Signaler un bug : ## Informations pour les développeurs -Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/pixelfed_ynh/tree/testing). +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. +Pour essayer la branche `testing`, procédez comme suit : -``` bash +```bash 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 :** +**Plus d’infos sur le packaging d’applications :** diff --git a/README_gl.md b/README_gl.md new file mode 100644 index 00000000..0a6338d6 --- /dev/null +++ b/README_gl.md @@ -0,0 +1,88 @@ + + +# Pixelfed para YunoHost + +[![Nivel de integración](https://dash.yunohost.org/integration/pixelfed.svg)](https://dash.yunohost.org/appci/app/pixelfed) ![Estado de funcionamento](https://ci-apps.yunohost.org/ci/badges/pixelfed.status.svg) ![Estado de mantemento](https://ci-apps.yunohost.org/ci/badges/pixelfed.maintain.svg) + +[![Instalar Pixelfed con YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=pixelfed) + +*[Le este README en outros idiomas.](./ALL_README.md)* + +> *Este paquete permíteche instalar Pixelfed de xeito rápido e doado nun servidor YunoHost.* +> *Se non usas YunoHost, le a [documentación](https://yunohost.org/install) para saber como instalalo.* + +## Vista xeral + +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. + +**Versión proporcionada:** 0.11.13~ynh1 + +## Capturas de pantalla + +![Captura de pantalla de Pixelfed](./doc/screenshots/screenshots.jpg) + +## Avisos / información importante + +## Some useful commands to know to manage your instance +You need to run them from you pixelfed folder (usually `/var/www/pixelfed`). The `php.VERSION` might be changed according to you current package version. + +### Applying changes from the `.env` config file + +Once you made some changes, you need to run `php8.2 artisan config:cache && php8.2 artisan cache:clear` to apply them. +Note: this will disconnect any logged-in account (including from the admin web UI). + +### Removing avatar cache to save space +`php8.2 artisan avatar:storage-deep-clean` + +Use it to prune old avatars that are outdated or no longer used. This might save some disk space. + +### Fix missing avatars or refetch them. +`php8.2 artisan avatar:storage` + +It can be used to fetch remote avatars that are not loaded (or in case you deleted `/var/www/pixelfed/storage/app/public/cache/avatars` where they are stored). +It might also be usefull to migrate that cache (only, not the other existing media) to an S3 storage, by refectching all of them. + +Be aware that this will generate a lot of "jobs" that will take time to be completed, and have a significant load on your server (especially bandwith and CPU). + +### When using S3 + +- Delete non-used media that where not cleaned (it happens) : `php8.2 artisanmedia:gc` (Delete media uploads not attached to any active statuses) + +- Same but for media stored on S3 storage and still locally stored (doubles) : `php8.2 artisan media:s3gc` (Delete (local) media uploads that exist on S3) + +- Migrate your media to an S3 storage (you need to configure it first), so media uploaded before configuring S3 are migrated there: `php8.2 artisanmedia:migrate2cloud` (Move older media to cloud storage) + +- Migrate from one S3 backend the other one (change the configuration first): `php8.2 artisanmedia:cloud-url-rewrite` (Rewrite S3 media urls from local users) + +## Documentación e recursos + +- Web oficial da app: +- Documentación oficial para usuarias: +- Documentación oficial para admin: +- Repositorio de orixe do código: +- Tenda YunoHost: +- Informar dun problema: + +## Info de desenvolvemento + +Envía a túa colaboración á [rama `testing`](https://github.com/YunoHost-Apps/pixelfed_ynh/tree/testing). + +Para probar a rama `testing`, procede deste xeito: + +```bash +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 +``` + +**Máis info sobre o empaquetado da app:** diff --git a/README_it.md b/README_it.md new file mode 100644 index 00000000..862aa3b3 --- /dev/null +++ b/README_it.md @@ -0,0 +1,88 @@ + + +# Pixelfed per YunoHost + +[![Livello di integrazione](https://dash.yunohost.org/integration/pixelfed.svg)](https://dash.yunohost.org/appci/app/pixelfed) ![Stato di funzionamento](https://ci-apps.yunohost.org/ci/badges/pixelfed.status.svg) ![Stato di manutenzione](https://ci-apps.yunohost.org/ci/badges/pixelfed.maintain.svg) + +[![Installa Pixelfed con YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=pixelfed) + +*[Leggi questo README in altre lingue.](./ALL_README.md)* + +> *Questo pacchetto ti permette di installare Pixelfed su un server YunoHost in modo semplice e veloce.* +> *Se non hai YunoHost, consulta [la guida](https://yunohost.org/install) per imparare a installarlo.* + +## Panoramica + +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. + +**Versione pubblicata:** 0.11.13~ynh1 + +## Screenshot + +![Screenshot di Pixelfed](./doc/screenshots/screenshots.jpg) + +## Attenzione/informazioni importanti + +## Some useful commands to know to manage your instance +You need to run them from you pixelfed folder (usually `/var/www/pixelfed`). The `php.VERSION` might be changed according to you current package version. + +### Applying changes from the `.env` config file + +Once you made some changes, you need to run `php8.2 artisan config:cache && php8.2 artisan cache:clear` to apply them. +Note: this will disconnect any logged-in account (including from the admin web UI). + +### Removing avatar cache to save space +`php8.2 artisan avatar:storage-deep-clean` + +Use it to prune old avatars that are outdated or no longer used. This might save some disk space. + +### Fix missing avatars or refetch them. +`php8.2 artisan avatar:storage` + +It can be used to fetch remote avatars that are not loaded (or in case you deleted `/var/www/pixelfed/storage/app/public/cache/avatars` where they are stored). +It might also be usefull to migrate that cache (only, not the other existing media) to an S3 storage, by refectching all of them. + +Be aware that this will generate a lot of "jobs" that will take time to be completed, and have a significant load on your server (especially bandwith and CPU). + +### When using S3 + +- Delete non-used media that where not cleaned (it happens) : `php8.2 artisanmedia:gc` (Delete media uploads not attached to any active statuses) + +- Same but for media stored on S3 storage and still locally stored (doubles) : `php8.2 artisan media:s3gc` (Delete (local) media uploads that exist on S3) + +- Migrate your media to an S3 storage (you need to configure it first), so media uploaded before configuring S3 are migrated there: `php8.2 artisanmedia:migrate2cloud` (Move older media to cloud storage) + +- Migrate from one S3 backend the other one (change the configuration first): `php8.2 artisanmedia:cloud-url-rewrite` (Rewrite S3 media urls from local users) + +## Documentazione e risorse + +- Sito web ufficiale dell’app: +- Documentazione ufficiale per gli utenti: +- Documentazione ufficiale per gli amministratori: +- Repository upstream del codice dell’app: +- Store di YunoHost: +- Segnala un problema: + +## Informazioni per sviluppatori + +Si prega di inviare la tua pull request alla [branch di `testing`](https://github.com/YunoHost-Apps/pixelfed_ynh/tree/testing). + +Per provare la branch di `testing`, si prega di procedere in questo modo: + +```bash +sudo yunohost app install https://github.com/YunoHost-Apps/pixelfed_ynh/tree/testing --debug +o +sudo yunohost app upgrade pixelfed -u https://github.com/YunoHost-Apps/pixelfed_ynh/tree/testing --debug +``` + +**Maggiori informazioni riguardo il pacchetto di quest’app:**