diff --git a/ALL_README.md b/ALL_README.md new file mode 100644 index 00000000..a01b345b --- /dev/null +++ b/ALL_README.md @@ -0,0 +1,7 @@ +# All available README files by language + +- [Read the README in English](README.md) +- [Irakurri README euskaraz](README_eu.md) +- [Lire le README en français](README_fr.md) +- [Le o README en galego](README_gl.md) +- [阅读中文（简体）的 README](README_zh_Hans.md) diff --git a/README.md b/README.md index 04157462..e113dda9 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 in 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 @@ -25,7 +25,7 @@ In addition to taking over the functionality of Instagram, the functioning of Pi It is also possible to import your data from Instagram. -**Shipped version:** 0.11.13~ynh1 +**Shipped version:** 0.12.1~ynh1 ## Screenshots @@ -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_eu.md b/README_eu.md new file mode 100644 index 00000000..bd47b2d8 --- /dev/null +++ b/README_eu.md @@ -0,0 +1,88 @@ + + +# Pixelfed YunoHost-erako + +[![Integrazio maila](https://dash.yunohost.org/integration/pixelfed.svg)](https://dash.yunohost.org/appci/app/pixelfed) ![Funtzionamendu egoera](https://ci-apps.yunohost.org/ci/badges/pixelfed.status.svg) ![Mantentze egoera](https://ci-apps.yunohost.org/ci/badges/pixelfed.maintain.svg) + +[![Instalatu Pixelfed YunoHost-ekin](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=pixelfed) + +*[Irakurri README hau beste hizkuntzatan.](./ALL_README.md)* + +> *Pakete honek Pixelfed YunoHost zerbitzari batean azkar eta zailtasunik gabe instalatzea ahalbidetzen dizu.* +> *YunoHost ez baduzu, kontsultatu [gida](https://yunohost.org/install) nola instalatu ikasteko.* + +## Aurreikuspena + +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. + +**Paketatutako bertsioa:** 0.12.1~ynh1 + +## Pantaila-argazkiak + +![Pixelfed(r)en pantaila-argazkia](./doc/screenshots/screenshots.jpg) + +## Ezespena / informazio garrantzitsua + +## 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) + +## Dokumentazioa eta baliabideak + +- Aplikazioaren webgune ofiziala: +- Erabiltzaileen dokumentazio ofiziala: +- Administratzaileen dokumentazio ofiziala: +- Jatorrizko aplikazioaren kode-gordailua: +- YunoHost Denda: +- Eman errore baten berri: + +## Garatzaileentzako informazioa + +Bidali `pull request`a [`testing` abarrera](https://github.com/YunoHost-Apps/pixelfed_ynh/tree/testing). + +`testing` abarra probatzeko, ondorengoa egin: + +```bash +sudo yunohost app install https://github.com/YunoHost-Apps/pixelfed_ynh/tree/testing --debug +edo +sudo yunohost app upgrade pixelfed -u https://github.com/YunoHost-Apps/pixelfed_ynh/tree/testing --debug +``` + +**Informazio gehiago aplikazioaren paketatzeari buruz:** diff --git a/README_fr.md b/README_fr.md index 0ef5a87c..4c2b948d 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.12.1~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..9e20f65b --- /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.12.1~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_zh_Hans.md b/README_zh_Hans.md new file mode 100644 index 00000000..84018b6a --- /dev/null +++ b/README_zh_Hans.md @@ -0,0 +1,88 @@ + + +# YunoHost 上的 Pixelfed + +[![集成程度](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) + +[![使用 YunoHost 安装 Pixelfed](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=pixelfed) + +*[阅读此 README 的其它语言版本。](./ALL_README.md)* + +> *通过此软件包，您可以在 YunoHost 服务器上快速、简单地安装 Pixelfed。* +> *如果您还没有 YunoHost，请参阅[指南](https://yunohost.org/install)了解如何安装它。* + +## 概况 + +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. + +**分发版本：** 0.12.1~ynh1 + +## 截图 + +![Pixelfed 的截图](./doc/screenshots/screenshots.jpg) + +## 免责声明 / 重要信息 + +## 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) + +## 文档与资源 + +- 官方应用网站： +- 官方用户文档： +- 官方管理文档： +- 上游应用代码库： +- YunoHost 商店： +- 报告 bug： + +## 开发者信息 + +请向 [`testing` 分支](https://github.com/YunoHost-Apps/pixelfed_ynh/tree/testing) 发送拉取请求。 + +如要尝试 `testing` 分支，请这样操作： + +```bash +sudo yunohost app install https://github.com/YunoHost-Apps/pixelfed_ynh/tree/testing --debug +或 +sudo yunohost app upgrade pixelfed -u https://github.com/YunoHost-Apps/pixelfed_ynh/tree/testing --debug +``` + +**有关应用打包的更多信息：**