diff --git a/ALL_README.md b/ALL_README.md new file mode 100644 index 0000000..152f2e7 --- /dev/null +++ b/ALL_README.md @@ -0,0 +1,8 @@ +# All available README files by language + +- [Read the README in English](README.md) +- [Lea el README en español](README_es.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 62a41df..adc0d1b 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ @@ -9,10 +9,10 @@ It shall NOT be edited by hand. [![Install Akkoma with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=akkoma) -*[Lire ce readme en français.](./README_fr.md)* +*[Read this README in other languages.](./ALL_README.md)* -> *This package allows you to install Akkoma 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 Akkoma 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 @@ -21,7 +21,7 @@ Akkoma is a microblogging server software that can federate (= exchange messages **Shipped version:** 3.10.3~ynh1 -**Demo:** https://otp.akkoma.dev +**Demo:** ## Screenshots @@ -127,19 +127,19 @@ Note: `--admin` option will _make the user moderator_ and `--no-admin` will _tak ## Documentation and resources -* Official app website: -* Official admin documentation: -* Upstream app code repository: -* YunoHost Store: -* Report a bug: +- Official app website: +- Official admin documentation: +- Upstream app code repository: +- YunoHost Store: +- Report a bug: ## Developer info -Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/akkoma_ynh/tree/testing). +Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/akkoma_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/akkoma_ynh/tree/testing --debug or sudo yunohost app upgrade akkoma -u https://github.com/YunoHost-Apps/akkoma_ynh/tree/testing --debug diff --git a/README_es.md b/README_es.md new file mode 100644 index 0000000..4de7cb2 --- /dev/null +++ b/README_es.md @@ -0,0 +1,148 @@ + + +# Akkoma para Yunohost + +[![Nivel de integración](https://dash.yunohost.org/integration/akkoma.svg)](https://dash.yunohost.org/appci/app/akkoma) ![Estado funcional](https://ci-apps.yunohost.org/ci/badges/akkoma.status.svg) ![Estado En Mantención](https://ci-apps.yunohost.org/ci/badges/akkoma.maintain.svg) + +[![Instalar Akkoma con Yunhost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=akkoma) + +*[Leer este README en otros idiomas.](./ALL_README.md)* + +> *Este paquete le permite instalarAkkoma rapidamente y simplement en un servidor YunoHost.* +> *Si no tiene YunoHost, visita [the guide](https://yunohost.org/install) para aprender como instalarla.* + +## Descripción general + +Akkoma is a microblogging server software that can federate (= exchange messages with) other servers that support ActivityPub. What that means is that you can host a server for yourself or your friends and stay in control of your online identity, but still exchange messages with people on larger decentrilized and federated network. Akkoma will federate with all servers that implement ActivityPub, like Friendica, GNU Social, Hubzilla, Mastodon, Misskey, Pleroma, Peertube, or Pixelfed. + + +**Versión actual:** 3.10.3~ynh1 + +**Demo:** + +## Capturas + +![Captura de Akkoma](./doc/screenshots/screenshot1.png) + +## informaciones importantes + +## Package is broken + +*Akkoma doesn't seem to be compatible with Debian 11 anymore.* +To fix this, **we need akkoma/tech-savy people to help fixing the dependency issues, or to build a Debian 11 version of the latest release.** + +Until further improvements, **consider this package broken**. You can't install it, nor upgrade it. Security fixes are not released. + +Once Yunohost is compatible with Debian 12, this might be solved. + +If you would like to install the app, *please don't*, and install [Pleroma](https://github.com/YunoHost-Apps/pleroma_ynh/) instead. In the future, you will be able to migrate your Pleroma instance to Akkoma. + +## Limitations + +- Require a dedicated **root domain**, eg. `akkoma.domain.tld` +- Require a valid **certificate** installed on the domain. Yunohost can install **Letsencrypt certificate** on the domain from admin web-interface or through command-line. +- This package is currently set to **single-instance** that means you can run only a _single Akkoma instance_ on a single server. +- LDAP supported but HTTP auth not. +- You can normaly _upgrade a Pleroma instance_ to Akkoma... but not with Pleroma on Yunohost (work in progress). + +## Bugs + +- **Login fails** if password contains special characters. See [#4](https://github.com/YunoHost-Apps/akkoma_ynh/issues/4) for more explanation. +- **Login fails** for non YNH users if LDAP is activated (this is by default). See [#15](https://github.com/YunoHost-Apps/akkoma_ynh/issues/15) for more explanation. +- No way to **change user password** from admin interface. May be related to previous bug. Work like charm from CLI. + +## Backups + +This application uses the [core-only feature of the backup](https://yunohost.org/en/backup/include_exclude_files#do-not-backup-large-amoun). **This means the app data directory** (`/home/yunohost.app/akkoma`, with subfolder `/static/`, which contains terms of service, custom emoji, custom themes, and `/uploads/` which contains the media attachements) **is not saved during backup**. +Also to keep the integrity of the data and to have a better guarantee of the restoration it is recommended to stop Akkoma during the operation. Proceed as follows: +- Stop Akkoma service with this command: `service akkoma stop` +- Launch Akkoma backup with this command: `yunohost backup create --apps akkoma` +- Backup Akkoma data directory with your specific strategy (could be with rsync, borg backup or just cp). The data is generally stored in `/home/yunohost.app/akkoma`. +- Restart Akkoma service with this command: `service akkoma start` + +**If you want to create a Yunohost backup that contains also Akkoma data directory**, you should add `BACKUP_CORE_ONLY=0` at the start fo the command : `BACKUP_CORE_ONLY=0 yunohost backup create --app akkoma`. + +## Remove + +Due of the backup core only feature **the data directory in `/home/yunohost.app/akkoma` is not removed**. +If you want to delete the data folder `/home/yunohost.app/akkoma/` during removal of akkoma, you should add the `--purge` option. If you don't, it must be manually deleted to purge user data. +**This is a necessary step for complete removal** - and possibly a fresh install. + +*NB: don't forget this mean those data are* not *backed up by default. See above.* + +## Customization + +This application come with the default frontend (Pleroma FE) and admin interface pre-installed and activated. There is also the Mangane front-end who is installed but not active. Note that you can choose other _alternative public interfaces_ (Brutaldon, Fedi FE...) or even provide a custom one. + +**Mastodon frontend:** if you installed the Mastodon FE package (from CLI or Admin interface) you can have access to an alternate user interface, similar the Mastodons or Glitch frontend. This frontend live alongside the default Pleroma FE: to access just add `/web` at the end of your instance domain (eg. `akkoma.domain.tld/web`). + +### Custom theme + +You can eitheir create your custom theme or use [existing ones](https://docs.akkoma.dev/stable/configuration/howto_theming_your_instance/#get-an-existing-theme). +To add custom themes, you will have to upload them to your instance dedicated folder (`/home/yunohost.app/akkoma/static/themes/` in Yunohost case), then to edit `/home/yunohost.app/akkoma/static/styles.json` to add a new entry referencing it. See the [official documentation](https://docs.akkoma.dev/stable/configuration/howto_theming_your_instance/#adding-the-custom-theme-to-the-instance) for more details. +- Upload your custom theme, place it in `/home/yunohost.app/akkoma/static/themes/` (you could also directly edit the file from the command line and copy-paste the content). +- Make sure the file access rights are approriate (only akkoma user can access them) `sudo chown -R akkoma:akkoma /home/yunohost.app/akkoma/static/themes/` (= own by akkoma) and `sudo chmod 750 /home/yunohost.app/akkoma/static/themes/` (=only akkoma can read and edit the file). +- Then edit `/home/yunohost.app/akkoma/static/styles.json` for instance with `sudo su akkoma nano /home/yunohost.app/akkoma/static/styles.json`. + +### Uploaded files size +By default, the web server [NGINX is configured](https://github.com/YunoHost-Apps/akkoma_ynh/blob/testing/conf/nginx.conf#L12) with a maximum value for uploading files at 50 MB. You can change the value only in akkoma under this limit. To go higher, you also need to change NGINX value on `/etc/nginx/conf.d/my.domain.tld.d/akkoma.conf` : change `client_max_body_size 50M;` value in order to do so. + +Don't forget to reload NGINX `sudo service nginx reload` settings and possibly restart Akkoma `sudo service akkoma restart` for the changes to take effects. + +*NB: These settings are restored to the default configuration when updating Akkoma. Remember to restore your configuration after all updates. This should be improved in the future:tm:* + + +## Admin Tasks + +Connect with SSH to your Yunohost as YNH admin user. +For the commands syntax, have in mind the specificities of [Yunohost Akkoma install](./yunohost.md). + +### Adding users + +``` +sudo su akkoma -s $SHELL -lc "/var/www/akkoma/live/bin/pleroma_ctl user new " +``` + +### Password reset + +``` +sudo su akkoma -s $SHELL -lc "/var/www/akkoma/live/bin/pleroma_ctl user reset_password " +``` + +This will generate a **password reset link** that you can then send to the user. + +### Moderators + +You can make users **moderators**. They will then be able to _delete any post_. + + +``` +sudo su akkoma -s $SHELL -lc "/var/www/akkoma/live/bin/pleroma_ctl user set --admin" +``` + +Note: `--admin` option will _make the user moderator_ and `--no-admin` will _take away_ the moderator privileges from the user. + +## Documentaciones y recursos + +- Sitio web oficial: +- Documentación administrador oficial: +- Repositorio del código fuente oficial de la aplicación : +- Catálogo YunoHost: +- Reportar un error: + +## Información para desarrolladores + +Por favor enviar sus correcciones a la [`branch testing`](https://github.com/YunoHost-Apps/akkoma_ynh/tree/testing + +Para probar la rama `testing`, sigue asÍ: + +```bash +sudo yunohost app install https://github.com/YunoHost-Apps/akkoma_ynh/tree/testing --debug +o +sudo yunohost app upgrade akkoma -u https://github.com/YunoHost-Apps/akkoma_ynh/tree/testing --debug +``` + +**Mas informaciones sobre el empaquetado de aplicaciones:** diff --git a/README_eu.md b/README_eu.md new file mode 100644 index 0000000..82d1b74 --- /dev/null +++ b/README_eu.md @@ -0,0 +1,148 @@ + + +# Akkoma YunoHost-erako + +[![Integrazio maila](https://dash.yunohost.org/integration/akkoma.svg)](https://dash.yunohost.org/appci/app/akkoma) ![Funtzionamendu egoera](https://ci-apps.yunohost.org/ci/badges/akkoma.status.svg) ![Mantentze egoera](https://ci-apps.yunohost.org/ci/badges/akkoma.maintain.svg) + +[![Instalatu Akkoma YunoHost-ekin](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=akkoma) + +*[Irakurri README hau beste hizkuntzatan.](./ALL_README.md)* + +> *Pakete honek Akkoma YunoHost zerbitzari batean azkar eta zailtasunik gabe instalatzea ahalbidetzen dizu.* +> *YunoHost ez baduzu, kontsultatu [gida](https://yunohost.org/install) nola instalatu ikasteko.* + +## Aurreikuspena + +Akkoma is a microblogging server software that can federate (= exchange messages with) other servers that support ActivityPub. What that means is that you can host a server for yourself or your friends and stay in control of your online identity, but still exchange messages with people on larger decentrilized and federated network. Akkoma will federate with all servers that implement ActivityPub, like Friendica, GNU Social, Hubzilla, Mastodon, Misskey, Pleroma, Peertube, or Pixelfed. + + +**Paketatutako bertsioa:** 3.10.3~ynh1 + +**Demoa:** + +## Pantaila-argazkiak + +![Akkoma(r)en pantaila-argazkia](./doc/screenshots/screenshot1.png) + +## Ezespena / informazio garrantzitsua + +## Package is broken + +*Akkoma doesn't seem to be compatible with Debian 11 anymore.* +To fix this, **we need akkoma/tech-savy people to help fixing the dependency issues, or to build a Debian 11 version of the latest release.** + +Until further improvements, **consider this package broken**. You can't install it, nor upgrade it. Security fixes are not released. + +Once Yunohost is compatible with Debian 12, this might be solved. + +If you would like to install the app, *please don't*, and install [Pleroma](https://github.com/YunoHost-Apps/pleroma_ynh/) instead. In the future, you will be able to migrate your Pleroma instance to Akkoma. + +## Limitations + +- Require a dedicated **root domain**, eg. `akkoma.domain.tld` +- Require a valid **certificate** installed on the domain. Yunohost can install **Letsencrypt certificate** on the domain from admin web-interface or through command-line. +- This package is currently set to **single-instance** that means you can run only a _single Akkoma instance_ on a single server. +- LDAP supported but HTTP auth not. +- You can normaly _upgrade a Pleroma instance_ to Akkoma... but not with Pleroma on Yunohost (work in progress). + +## Bugs + +- **Login fails** if password contains special characters. See [#4](https://github.com/YunoHost-Apps/akkoma_ynh/issues/4) for more explanation. +- **Login fails** for non YNH users if LDAP is activated (this is by default). See [#15](https://github.com/YunoHost-Apps/akkoma_ynh/issues/15) for more explanation. +- No way to **change user password** from admin interface. May be related to previous bug. Work like charm from CLI. + +## Backups + +This application uses the [core-only feature of the backup](https://yunohost.org/en/backup/include_exclude_files#do-not-backup-large-amoun). **This means the app data directory** (`/home/yunohost.app/akkoma`, with subfolder `/static/`, which contains terms of service, custom emoji, custom themes, and `/uploads/` which contains the media attachements) **is not saved during backup**. +Also to keep the integrity of the data and to have a better guarantee of the restoration it is recommended to stop Akkoma during the operation. Proceed as follows: +- Stop Akkoma service with this command: `service akkoma stop` +- Launch Akkoma backup with this command: `yunohost backup create --apps akkoma` +- Backup Akkoma data directory with your specific strategy (could be with rsync, borg backup or just cp). The data is generally stored in `/home/yunohost.app/akkoma`. +- Restart Akkoma service with this command: `service akkoma start` + +**If you want to create a Yunohost backup that contains also Akkoma data directory**, you should add `BACKUP_CORE_ONLY=0` at the start fo the command : `BACKUP_CORE_ONLY=0 yunohost backup create --app akkoma`. + +## Remove + +Due of the backup core only feature **the data directory in `/home/yunohost.app/akkoma` is not removed**. +If you want to delete the data folder `/home/yunohost.app/akkoma/` during removal of akkoma, you should add the `--purge` option. If you don't, it must be manually deleted to purge user data. +**This is a necessary step for complete removal** - and possibly a fresh install. + +*NB: don't forget this mean those data are* not *backed up by default. See above.* + +## Customization + +This application come with the default frontend (Pleroma FE) and admin interface pre-installed and activated. There is also the Mangane front-end who is installed but not active. Note that you can choose other _alternative public interfaces_ (Brutaldon, Fedi FE...) or even provide a custom one. + +**Mastodon frontend:** if you installed the Mastodon FE package (from CLI or Admin interface) you can have access to an alternate user interface, similar the Mastodons or Glitch frontend. This frontend live alongside the default Pleroma FE: to access just add `/web` at the end of your instance domain (eg. `akkoma.domain.tld/web`). + +### Custom theme + +You can eitheir create your custom theme or use [existing ones](https://docs.akkoma.dev/stable/configuration/howto_theming_your_instance/#get-an-existing-theme). +To add custom themes, you will have to upload them to your instance dedicated folder (`/home/yunohost.app/akkoma/static/themes/` in Yunohost case), then to edit `/home/yunohost.app/akkoma/static/styles.json` to add a new entry referencing it. See the [official documentation](https://docs.akkoma.dev/stable/configuration/howto_theming_your_instance/#adding-the-custom-theme-to-the-instance) for more details. +- Upload your custom theme, place it in `/home/yunohost.app/akkoma/static/themes/` (you could also directly edit the file from the command line and copy-paste the content). +- Make sure the file access rights are approriate (only akkoma user can access them) `sudo chown -R akkoma:akkoma /home/yunohost.app/akkoma/static/themes/` (= own by akkoma) and `sudo chmod 750 /home/yunohost.app/akkoma/static/themes/` (=only akkoma can read and edit the file). +- Then edit `/home/yunohost.app/akkoma/static/styles.json` for instance with `sudo su akkoma nano /home/yunohost.app/akkoma/static/styles.json`. + +### Uploaded files size +By default, the web server [NGINX is configured](https://github.com/YunoHost-Apps/akkoma_ynh/blob/testing/conf/nginx.conf#L12) with a maximum value for uploading files at 50 MB. You can change the value only in akkoma under this limit. To go higher, you also need to change NGINX value on `/etc/nginx/conf.d/my.domain.tld.d/akkoma.conf` : change `client_max_body_size 50M;` value in order to do so. + +Don't forget to reload NGINX `sudo service nginx reload` settings and possibly restart Akkoma `sudo service akkoma restart` for the changes to take effects. + +*NB: These settings are restored to the default configuration when updating Akkoma. Remember to restore your configuration after all updates. This should be improved in the future:tm:* + + +## Admin Tasks + +Connect with SSH to your Yunohost as YNH admin user. +For the commands syntax, have in mind the specificities of [Yunohost Akkoma install](./yunohost.md). + +### Adding users + +``` +sudo su akkoma -s $SHELL -lc "/var/www/akkoma/live/bin/pleroma_ctl user new " +``` + +### Password reset + +``` +sudo su akkoma -s $SHELL -lc "/var/www/akkoma/live/bin/pleroma_ctl user reset_password " +``` + +This will generate a **password reset link** that you can then send to the user. + +### Moderators + +You can make users **moderators**. They will then be able to _delete any post_. + + +``` +sudo su akkoma -s $SHELL -lc "/var/www/akkoma/live/bin/pleroma_ctl user set --admin" +``` + +Note: `--admin` option will _make the user moderator_ and `--no-admin` will _take away_ the moderator privileges from the user. + +## Dokumentazioa eta baliabideak + +- Aplikazioaren webgune 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/akkoma_ynh/tree/testing). + +`testing` abarra probatzeko, ondorengoa egin: + +```bash +sudo yunohost app install https://github.com/YunoHost-Apps/akkoma_ynh/tree/testing --debug +edo +sudo yunohost app upgrade akkoma -u https://github.com/YunoHost-Apps/akkoma_ynh/tree/testing --debug +``` + +**Informazio gehiago aplikazioaren paketatzeari buruz:** diff --git a/README_fr.md b/README_fr.md index d2dc1e8..b22c712 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,6 +1,6 @@ # Akkoma pour YunoHost @@ -9,19 +9,19 @@ It shall NOT be edited by hand. [![Installer Akkoma avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=akkoma) -*[Read this readme in english.](./README.md)* +*[Lire le README dans d'autres langues.](./ALL_README.md)* -> *Ce package vous permet d’installer Akkoma 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 Akkoma 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 Akkoma is a microblogging server software that can federate (= exchange messages with) other servers that support ActivityPub. What that means is that you can host a server for yourself or your friends and stay in control of your online identity, but still exchange messages with people on larger decentrilized and federated network. Akkoma will federate with all servers that implement ActivityPub, like Friendica, GNU Social, Hubzilla, Mastodon, Misskey, Pleroma, Peertube, or Pixelfed. -**Version incluse :** 3.10.3~ynh1 +**Version incluse :** 3.10.3~ynh1 -**Démo :** https://otp.akkoma.dev +**Démo :** ## Captures d’écran @@ -127,22 +127,22 @@ Note: `--admin` option will _make the user moderator_ and `--no-admin` will _tak ## Documentations et ressources -* Site officiel de l’app : -* 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 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/akkoma_ynh/tree/testing). +Merci de faire vos pull request sur la [branche `testing`](https://github.com/YunoHost-Apps/akkoma_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/akkoma_ynh/tree/testing --debug ou sudo yunohost app upgrade akkoma -u https://github.com/YunoHost-Apps/akkoma_ynh/tree/testing --debug ``` -**Plus d’infos sur le packaging d’applications :** \ No newline at end of file +**Plus d’infos sur le packaging d’applications :** diff --git a/README_gl.md b/README_gl.md new file mode 100644 index 0000000..5c3b833 --- /dev/null +++ b/README_gl.md @@ -0,0 +1,148 @@ + + +# Akkoma para YunoHost + +[![Nivel de integración](https://dash.yunohost.org/integration/akkoma.svg)](https://dash.yunohost.org/appci/app/akkoma) ![Estado de funcionamento](https://ci-apps.yunohost.org/ci/badges/akkoma.status.svg) ![Estado de mantemento](https://ci-apps.yunohost.org/ci/badges/akkoma.maintain.svg) + +[![Instalar Akkoma con YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=akkoma) + +*[Le este README en outros idiomas.](./ALL_README.md)* + +> *Este paquete permíteche instalar Akkoma 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 + +Akkoma is a microblogging server software that can federate (= exchange messages with) other servers that support ActivityPub. What that means is that you can host a server for yourself or your friends and stay in control of your online identity, but still exchange messages with people on larger decentrilized and federated network. Akkoma will federate with all servers that implement ActivityPub, like Friendica, GNU Social, Hubzilla, Mastodon, Misskey, Pleroma, Peertube, or Pixelfed. + + +**Versión proporcionada:** 3.10.3~ynh1 + +**Demo:** + +## Capturas de pantalla + +![Captura de pantalla de Akkoma](./doc/screenshots/screenshot1.png) + +## Avisos / información importante + +## Package is broken + +*Akkoma doesn't seem to be compatible with Debian 11 anymore.* +To fix this, **we need akkoma/tech-savy people to help fixing the dependency issues, or to build a Debian 11 version of the latest release.** + +Until further improvements, **consider this package broken**. You can't install it, nor upgrade it. Security fixes are not released. + +Once Yunohost is compatible with Debian 12, this might be solved. + +If you would like to install the app, *please don't*, and install [Pleroma](https://github.com/YunoHost-Apps/pleroma_ynh/) instead. In the future, you will be able to migrate your Pleroma instance to Akkoma. + +## Limitations + +- Require a dedicated **root domain**, eg. `akkoma.domain.tld` +- Require a valid **certificate** installed on the domain. Yunohost can install **Letsencrypt certificate** on the domain from admin web-interface or through command-line. +- This package is currently set to **single-instance** that means you can run only a _single Akkoma instance_ on a single server. +- LDAP supported but HTTP auth not. +- You can normaly _upgrade a Pleroma instance_ to Akkoma... but not with Pleroma on Yunohost (work in progress). + +## Bugs + +- **Login fails** if password contains special characters. See [#4](https://github.com/YunoHost-Apps/akkoma_ynh/issues/4) for more explanation. +- **Login fails** for non YNH users if LDAP is activated (this is by default). See [#15](https://github.com/YunoHost-Apps/akkoma_ynh/issues/15) for more explanation. +- No way to **change user password** from admin interface. May be related to previous bug. Work like charm from CLI. + +## Backups + +This application uses the [core-only feature of the backup](https://yunohost.org/en/backup/include_exclude_files#do-not-backup-large-amoun). **This means the app data directory** (`/home/yunohost.app/akkoma`, with subfolder `/static/`, which contains terms of service, custom emoji, custom themes, and `/uploads/` which contains the media attachements) **is not saved during backup**. +Also to keep the integrity of the data and to have a better guarantee of the restoration it is recommended to stop Akkoma during the operation. Proceed as follows: +- Stop Akkoma service with this command: `service akkoma stop` +- Launch Akkoma backup with this command: `yunohost backup create --apps akkoma` +- Backup Akkoma data directory with your specific strategy (could be with rsync, borg backup or just cp). The data is generally stored in `/home/yunohost.app/akkoma`. +- Restart Akkoma service with this command: `service akkoma start` + +**If you want to create a Yunohost backup that contains also Akkoma data directory**, you should add `BACKUP_CORE_ONLY=0` at the start fo the command : `BACKUP_CORE_ONLY=0 yunohost backup create --app akkoma`. + +## Remove + +Due of the backup core only feature **the data directory in `/home/yunohost.app/akkoma` is not removed**. +If you want to delete the data folder `/home/yunohost.app/akkoma/` during removal of akkoma, you should add the `--purge` option. If you don't, it must be manually deleted to purge user data. +**This is a necessary step for complete removal** - and possibly a fresh install. + +*NB: don't forget this mean those data are* not *backed up by default. See above.* + +## Customization + +This application come with the default frontend (Pleroma FE) and admin interface pre-installed and activated. There is also the Mangane front-end who is installed but not active. Note that you can choose other _alternative public interfaces_ (Brutaldon, Fedi FE...) or even provide a custom one. + +**Mastodon frontend:** if you installed the Mastodon FE package (from CLI or Admin interface) you can have access to an alternate user interface, similar the Mastodons or Glitch frontend. This frontend live alongside the default Pleroma FE: to access just add `/web` at the end of your instance domain (eg. `akkoma.domain.tld/web`). + +### Custom theme + +You can eitheir create your custom theme or use [existing ones](https://docs.akkoma.dev/stable/configuration/howto_theming_your_instance/#get-an-existing-theme). +To add custom themes, you will have to upload them to your instance dedicated folder (`/home/yunohost.app/akkoma/static/themes/` in Yunohost case), then to edit `/home/yunohost.app/akkoma/static/styles.json` to add a new entry referencing it. See the [official documentation](https://docs.akkoma.dev/stable/configuration/howto_theming_your_instance/#adding-the-custom-theme-to-the-instance) for more details. +- Upload your custom theme, place it in `/home/yunohost.app/akkoma/static/themes/` (you could also directly edit the file from the command line and copy-paste the content). +- Make sure the file access rights are approriate (only akkoma user can access them) `sudo chown -R akkoma:akkoma /home/yunohost.app/akkoma/static/themes/` (= own by akkoma) and `sudo chmod 750 /home/yunohost.app/akkoma/static/themes/` (=only akkoma can read and edit the file). +- Then edit `/home/yunohost.app/akkoma/static/styles.json` for instance with `sudo su akkoma nano /home/yunohost.app/akkoma/static/styles.json`. + +### Uploaded files size +By default, the web server [NGINX is configured](https://github.com/YunoHost-Apps/akkoma_ynh/blob/testing/conf/nginx.conf#L12) with a maximum value for uploading files at 50 MB. You can change the value only in akkoma under this limit. To go higher, you also need to change NGINX value on `/etc/nginx/conf.d/my.domain.tld.d/akkoma.conf` : change `client_max_body_size 50M;` value in order to do so. + +Don't forget to reload NGINX `sudo service nginx reload` settings and possibly restart Akkoma `sudo service akkoma restart` for the changes to take effects. + +*NB: These settings are restored to the default configuration when updating Akkoma. Remember to restore your configuration after all updates. This should be improved in the future:tm:* + + +## Admin Tasks + +Connect with SSH to your Yunohost as YNH admin user. +For the commands syntax, have in mind the specificities of [Yunohost Akkoma install](./yunohost.md). + +### Adding users + +``` +sudo su akkoma -s $SHELL -lc "/var/www/akkoma/live/bin/pleroma_ctl user new " +``` + +### Password reset + +``` +sudo su akkoma -s $SHELL -lc "/var/www/akkoma/live/bin/pleroma_ctl user reset_password " +``` + +This will generate a **password reset link** that you can then send to the user. + +### Moderators + +You can make users **moderators**. They will then be able to _delete any post_. + + +``` +sudo su akkoma -s $SHELL -lc "/var/www/akkoma/live/bin/pleroma_ctl user set --admin" +``` + +Note: `--admin` option will _make the user moderator_ and `--no-admin` will _take away_ the moderator privileges from the user. + +## Documentación e recursos + +- Web oficial da app: +- 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/akkoma_ynh/tree/testing). + +Para probar a rama `testing`, procede deste xeito: + +```bash +sudo yunohost app install https://github.com/YunoHost-Apps/akkoma_ynh/tree/testing --debug +ou +sudo yunohost app upgrade akkoma -u https://github.com/YunoHost-Apps/akkoma_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 0000000..bdf2a95 --- /dev/null +++ b/README_zh_Hans.md @@ -0,0 +1,148 @@ + + +# YunoHost 上的 Akkoma + +[![集成程度](https://dash.yunohost.org/integration/akkoma.svg)](https://dash.yunohost.org/appci/app/akkoma) ![工作状态](https://ci-apps.yunohost.org/ci/badges/akkoma.status.svg) ![维护状态](https://ci-apps.yunohost.org/ci/badges/akkoma.maintain.svg) + +[![使用 YunoHost 安装 Akkoma](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=akkoma) + +*[阅读此 README 的其它语言版本。](./ALL_README.md)* + +> *通过此软件包，您可以在 YunoHost 服务器上快速、简单地安装 Akkoma。* +> *如果您还没有 YunoHost，请参阅[指南](https://yunohost.org/install)了解如何安装它。* + +## 概况 + +Akkoma is a microblogging server software that can federate (= exchange messages with) other servers that support ActivityPub. What that means is that you can host a server for yourself or your friends and stay in control of your online identity, but still exchange messages with people on larger decentrilized and federated network. Akkoma will federate with all servers that implement ActivityPub, like Friendica, GNU Social, Hubzilla, Mastodon, Misskey, Pleroma, Peertube, or Pixelfed. + + +**分发版本：** 3.10.3~ynh1 + +**演示：** + +## 截图 + +![Akkoma 的截图](./doc/screenshots/screenshot1.png) + +## 免责声明 / 重要信息 + +## Package is broken + +*Akkoma doesn't seem to be compatible with Debian 11 anymore.* +To fix this, **we need akkoma/tech-savy people to help fixing the dependency issues, or to build a Debian 11 version of the latest release.** + +Until further improvements, **consider this package broken**. You can't install it, nor upgrade it. Security fixes are not released. + +Once Yunohost is compatible with Debian 12, this might be solved. + +If you would like to install the app, *please don't*, and install [Pleroma](https://github.com/YunoHost-Apps/pleroma_ynh/) instead. In the future, you will be able to migrate your Pleroma instance to Akkoma. + +## Limitations + +- Require a dedicated **root domain**, eg. `akkoma.domain.tld` +- Require a valid **certificate** installed on the domain. Yunohost can install **Letsencrypt certificate** on the domain from admin web-interface or through command-line. +- This package is currently set to **single-instance** that means you can run only a _single Akkoma instance_ on a single server. +- LDAP supported but HTTP auth not. +- You can normaly _upgrade a Pleroma instance_ to Akkoma... but not with Pleroma on Yunohost (work in progress). + +## Bugs + +- **Login fails** if password contains special characters. See [#4](https://github.com/YunoHost-Apps/akkoma_ynh/issues/4) for more explanation. +- **Login fails** for non YNH users if LDAP is activated (this is by default). See [#15](https://github.com/YunoHost-Apps/akkoma_ynh/issues/15) for more explanation. +- No way to **change user password** from admin interface. May be related to previous bug. Work like charm from CLI. + +## Backups + +This application uses the [core-only feature of the backup](https://yunohost.org/en/backup/include_exclude_files#do-not-backup-large-amoun). **This means the app data directory** (`/home/yunohost.app/akkoma`, with subfolder `/static/`, which contains terms of service, custom emoji, custom themes, and `/uploads/` which contains the media attachements) **is not saved during backup**. +Also to keep the integrity of the data and to have a better guarantee of the restoration it is recommended to stop Akkoma during the operation. Proceed as follows: +- Stop Akkoma service with this command: `service akkoma stop` +- Launch Akkoma backup with this command: `yunohost backup create --apps akkoma` +- Backup Akkoma data directory with your specific strategy (could be with rsync, borg backup or just cp). The data is generally stored in `/home/yunohost.app/akkoma`. +- Restart Akkoma service with this command: `service akkoma start` + +**If you want to create a Yunohost backup that contains also Akkoma data directory**, you should add `BACKUP_CORE_ONLY=0` at the start fo the command : `BACKUP_CORE_ONLY=0 yunohost backup create --app akkoma`. + +## Remove + +Due of the backup core only feature **the data directory in `/home/yunohost.app/akkoma` is not removed**. +If you want to delete the data folder `/home/yunohost.app/akkoma/` during removal of akkoma, you should add the `--purge` option. If you don't, it must be manually deleted to purge user data. +**This is a necessary step for complete removal** - and possibly a fresh install. + +*NB: don't forget this mean those data are* not *backed up by default. See above.* + +## Customization + +This application come with the default frontend (Pleroma FE) and admin interface pre-installed and activated. There is also the Mangane front-end who is installed but not active. Note that you can choose other _alternative public interfaces_ (Brutaldon, Fedi FE...) or even provide a custom one. + +**Mastodon frontend:** if you installed the Mastodon FE package (from CLI or Admin interface) you can have access to an alternate user interface, similar the Mastodons or Glitch frontend. This frontend live alongside the default Pleroma FE: to access just add `/web` at the end of your instance domain (eg. `akkoma.domain.tld/web`). + +### Custom theme + +You can eitheir create your custom theme or use [existing ones](https://docs.akkoma.dev/stable/configuration/howto_theming_your_instance/#get-an-existing-theme). +To add custom themes, you will have to upload them to your instance dedicated folder (`/home/yunohost.app/akkoma/static/themes/` in Yunohost case), then to edit `/home/yunohost.app/akkoma/static/styles.json` to add a new entry referencing it. See the [official documentation](https://docs.akkoma.dev/stable/configuration/howto_theming_your_instance/#adding-the-custom-theme-to-the-instance) for more details. +- Upload your custom theme, place it in `/home/yunohost.app/akkoma/static/themes/` (you could also directly edit the file from the command line and copy-paste the content). +- Make sure the file access rights are approriate (only akkoma user can access them) `sudo chown -R akkoma:akkoma /home/yunohost.app/akkoma/static/themes/` (= own by akkoma) and `sudo chmod 750 /home/yunohost.app/akkoma/static/themes/` (=only akkoma can read and edit the file). +- Then edit `/home/yunohost.app/akkoma/static/styles.json` for instance with `sudo su akkoma nano /home/yunohost.app/akkoma/static/styles.json`. + +### Uploaded files size +By default, the web server [NGINX is configured](https://github.com/YunoHost-Apps/akkoma_ynh/blob/testing/conf/nginx.conf#L12) with a maximum value for uploading files at 50 MB. You can change the value only in akkoma under this limit. To go higher, you also need to change NGINX value on `/etc/nginx/conf.d/my.domain.tld.d/akkoma.conf` : change `client_max_body_size 50M;` value in order to do so. + +Don't forget to reload NGINX `sudo service nginx reload` settings and possibly restart Akkoma `sudo service akkoma restart` for the changes to take effects. + +*NB: These settings are restored to the default configuration when updating Akkoma. Remember to restore your configuration after all updates. This should be improved in the future:tm:* + + +## Admin Tasks + +Connect with SSH to your Yunohost as YNH admin user. +For the commands syntax, have in mind the specificities of [Yunohost Akkoma install](./yunohost.md). + +### Adding users + +``` +sudo su akkoma -s $SHELL -lc "/var/www/akkoma/live/bin/pleroma_ctl user new " +``` + +### Password reset + +``` +sudo su akkoma -s $SHELL -lc "/var/www/akkoma/live/bin/pleroma_ctl user reset_password " +``` + +This will generate a **password reset link** that you can then send to the user. + +### Moderators + +You can make users **moderators**. They will then be able to _delete any post_. + + +``` +sudo su akkoma -s $SHELL -lc "/var/www/akkoma/live/bin/pleroma_ctl user set --admin" +``` + +Note: `--admin` option will _make the user moderator_ and `--no-admin` will _take away_ the moderator privileges from the user. + +## 文档与资源 + +- 官方应用网站： +- 官方管理文档： +- 上游应用代码库： +- YunoHost 商店： +- 报告 bug： + +## 开发者信息 + +请向 [`testing` 分支](https://github.com/YunoHost-Apps/akkoma_ynh/tree/testing) 发送拉取请求。 + +如要尝试 `testing` 分支，请这样操作： + +```bash +sudo yunohost app install https://github.com/YunoHost-Apps/akkoma_ynh/tree/testing --debug +或 +sudo yunohost app upgrade akkoma -u https://github.com/YunoHost-Apps/akkoma_ynh/tree/testing --debug +``` + +**有关应用打包的更多信息：**