mirror of
https://github.com/YunoHost-Apps/pleroma_ynh.git
synced 2024-09-03 20:15:59 +02:00
Merge branch 'example' of https://github.com/YunoHost-Apps/pleroma_ynh into example
This commit is contained in:
yalh76
commit
f668f9a320
2 changed files with 128 additions and 50 deletions
88
README.md
88
README.md
|
|
@ -1,44 +1,48 @@
|
|||
<!--
|
||||
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
|
||||
It shall NOT be edited by hand.
|
||||
-->
|
||||
|
||||
# Pleroma for YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/pleroma)  
|
||||
[](https://install-app.yunohost.org/?app=pleroma)
|
||||
|
||||
> *This package allows you to install Pleroma quickly and simply on a YunoHost server.
|
||||
*[Lire ce readme en français.](./README_fr.md)*
|
||||
|
||||
> *This package allows you to install Pleroma 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
|
||||
Pleroma 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 servers. Pleroma will federate with all servers that implement ActivityPub, like Friendica, GNU Social, Hubzilla, Mastodon, Misskey, Peertube, and Pixelfed.
|
||||
|
||||
For user friendly details about Pleroma: [see here](https://blog.soykaf.com/post/what-is-pleroma/)
|
||||
A free, federated social networking server built on open protocols.
|
||||
|
||||
**Mastodon web front-end for Pleroma:** Add **/web** in front of your Pleroma domain, eg. pleroma.domain.tld/web
|
||||
**Shipped version:** 2.4.0~ynh2
|
||||
|
||||
## Mobile clients that work with Pleroma:
|
||||
|
||||
- Twidere
|
||||
- Tusky
|
||||
- Pawoo (Android + iOS)
|
||||
- Subway Tooter
|
||||
- Amaroq (iOS)
|
||||
- Tootdon (Android + iOS)
|
||||
- Tootle (iOS)
|
||||
|
||||
**Shipped version:** 2.4.0
|
||||
|
||||
## Important points to read before installing
|
||||
|
||||
1. **Pleroma** require a dedicated **root domain**, eg. pleroma.domain.tld
|
||||
1. **Pleroma** require a valid **certificate** installed on the domain. Yunohost can **install Letsencrypt certificate** on the domain from **admin web-interface** or through **command-line**.
|
||||
1. This package is currently set to **single-instance** that means you can run a **single Pleroma instance** on a **single server**.
|
||||
1. The admin **password** entered when installing must **not** contain **special characters**. (See [issue #132](https://github.com/YunoHost-Apps/pleroma_ynh/issues/132))
|
||||
**Demo:** http://distsn.org/pleroma-instances.html
|
||||
|
||||
## Screenshots
|
||||
|
||||
|
||||
|
||||
|
||||
## Demo
|
||||
## Disclaimers / important information
|
||||
|
||||
* [List of instances](http://distsn.org/pleroma-instances.html)
|
||||
* Any known limitations, constrains or stuff not working, such as (but not limited to):
|
||||
* **Pleroma** require a dedicated **root domain**, eg. pleroma.domain.tld
|
||||
* **Pleroma** 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 a **single Pleroma instance** on a **single server**.
|
||||
* The admin **password** entered when installing must **not** contain **special characters**. (See [issue #132](https://github.com/YunoHost-Apps/pleroma_ynh/issues/132))
|
||||
* requiring a full dedicated domain ?
|
||||
* architectures not supported ?
|
||||
* LDAP supported but HTTP auth not.
|
||||
* the app requires an important amount of RAM / disk / .. to install or to work properly
|
||||
* etc...
|
||||
|
||||
* Other infos that people should be aware of, such as:
|
||||
* any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...)
|
||||
* how to configure / administrate the application if it ain't obvious
|
||||
* upgrade process / specificities / things to be aware of ?
|
||||
* security considerations ?
|
||||
|
||||
## Admin Tasks
|
||||
Go to **cd /var/www/pleroma/pleroma**.
|
||||
|
|
@ -67,32 +71,14 @@ You can make users **moderators**. They will then be able to **delete any post**
|
|||
|
||||
**--admin** option will **make the user moderator** and **--no-admin** will **take away the moderator privileges** from the user.
|
||||
|
||||
## Documentation
|
||||
## Documentation and resources
|
||||
|
||||
* Official documentation: https://docs.pleroma.social/
|
||||
* Yunohost apps documentation: https://yunohost.org/#/app_pleroma
|
||||
|
||||
## YunoHost specific features
|
||||
|
||||
#### Multi-user support
|
||||
|
||||
LDAP supported but HTTP auth not.
|
||||
|
||||
The app can be used by multiple users.
|
||||
|
||||
#### Supported architectures
|
||||
|
||||
* x86-64 - [](https://ci-apps.yunohost.org/ci/apps/pleroma/)
|
||||
* ARMv8-A - [](https://ci-apps-arm.yunohost.org/ci/apps/pleroma/)
|
||||
|
||||
## Links
|
||||
|
||||
* Report a bug: https://github.com/YunoHost-Apps/pleroma_ynh/issues
|
||||
* App website: https://pleroma.social/
|
||||
* Upstream app repository https://git.pleroma.social/pleroma/pleroma/
|
||||
* YunoHost website: https://yunohost.org/
|
||||
|
||||
---
|
||||
* Official app website: https://pleroma.social/
|
||||
* Official user documentation: https://yunohost.org/apps
|
||||
* Official admin documentation: https://docs.pleroma.social/
|
||||
* Upstream app code repository: https://git.pleroma.social/pleroma/pleroma/
|
||||
* YunoHost documentation for this app: https://yunohost.org/app_pleroma
|
||||
* Report a bug: https://github.com/YunoHost-Apps/pleroma_ynh/issues
|
||||
|
||||
## Developer info
|
||||
|
||||
|
|
@ -104,3 +90,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/pleroma_ynh/tree/test
|
|||
or
|
||||
sudo yunohost app upgrade pleroma -u https://github.com/YunoHost-Apps/pleroma_ynh/tree/testing --debug
|
||||
```
|
||||
|
||||
**More info regarding app packaging:** https://yunohost.org/packaging_apps
|
||||
90
README_fr.md
Normal file
90
README_fr.md
Normal file
|
|
@ -0,0 +1,90 @@
|
|||
# Pleroma pour YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/pleroma)  
|
||||
[](https://install-app.yunohost.org/?app=pleroma)
|
||||
|
||||
*[Read this readme in english.](./README.md)*
|
||||
*[Lire ce readme en français.](./README_fr.md)*
|
||||
|
||||
> *Ce package vous permet d'installer Pleroma 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
|
||||
|
||||
Un serveur de réseautage social fédéré et gratuit basé sur des protocoles ouverts.
|
||||
|
||||
**Version incluse :** 2.4.0~ynh2
|
||||
|
||||
**Démo :** http://distsn.org/pleroma-instances.html
|
||||
|
||||
## Captures d'écran
|
||||
|
||||
|
||||
|
||||
## Avertissements / informations importantes
|
||||
|
||||
* Any known limitations, constrains or stuff not working, such as (but not limited to):
|
||||
* **Pleroma** require a dedicated **root domain**, eg. pleroma.domain.tld
|
||||
* **Pleroma** 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 a **single Pleroma instance** on a **single server**.
|
||||
* The admin **password** entered when installing must **not** contain **special characters**. (See [issue #132](https://github.com/YunoHost-Apps/pleroma_ynh/issues/132))
|
||||
* requiring a full dedicated domain ?
|
||||
* architectures not supported ?
|
||||
* LDAP supported but HTTP auth not.
|
||||
* the app requires an important amount of RAM / disk / .. to install or to work properly
|
||||
* etc...
|
||||
|
||||
* Other infos that people should be aware of, such as:
|
||||
* any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...)
|
||||
* how to configure / administrate the application if it ain't obvious
|
||||
* upgrade process / specificities / things to be aware of ?
|
||||
* security considerations ?
|
||||
|
||||
## Admin Tasks
|
||||
Go to **cd /var/www/pleroma/pleroma**.
|
||||
|
||||
### Adding users
|
||||
|
||||
**Run:**
|
||||
|
||||
$ ( cd /var/www/pleroma/pleroma && sudo -u pleroma MIX_ENV=prod ./bin/pleroma_ctl user new <NICKNAME> <EMAIL> )
|
||||
|
||||
### Password reset
|
||||
|
||||
**Run:**
|
||||
|
||||
$ ( cd /var/www/pleroma/pleroma && sudo -u pleroma MIX_ENV=prod ./bin/pleroma_ctl user reset_password <NICKNAME> )
|
||||
|
||||
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**.
|
||||
|
||||
**Run:**
|
||||
|
||||
$ ( cd /var/www/pleroma/pleroma && sudo -u pleroma MIX_ENV=prod ./bin/pleroma_ctl user set <NICKNAME> --[no-]admin )
|
||||
|
||||
**--admin** option will **make the user moderator** and **--no-admin** will **take away the moderator privileges** from the user.
|
||||
|
||||
## Documentations et ressources
|
||||
|
||||
* Site officiel de l'app : https://pleroma.social/
|
||||
* Documentation officielle utilisateur : https://yunohost.org/apps
|
||||
* Documentation officielle de l'admin : https://docs.pleroma.social/
|
||||
* Dépôt de code officiel de l'app : https://git.pleroma.social/pleroma/pleroma/
|
||||
* Documentation YunoHost pour cette app : https://yunohost.org/app_pleroma
|
||||
* Signaler un bug : https://github.com/YunoHost-Apps/pleroma_ynh/issues
|
||||
|
||||
## Informations pour les développeurs
|
||||
|
||||
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/pleroma_ynh/tree/testing).
|
||||
|
||||
Pour essayer la branche testing, procédez comme suit.
|
||||
```
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/pleroma_ynh/tree/testing --debug
|
||||
ou
|
||||
sudo yunohost app upgrade pleroma -u https://github.com/YunoHost-Apps/pleroma_ynh/tree/testing --debug
|
||||
```
|
||||
|
||||
**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps
|
||||
Loading…
Add table
Reference in a new issue