mirror of
https://github.com/YunoHost-Apps/pleroma_ynh.git
synced 2024-09-03 20:15:59 +02:00
Apply example_ynh to README.md
This commit is contained in:
parent
479ffb6b80
commit
3f09b65758
1 changed files with 71 additions and 8 deletions
79
README.md
79
README.md
|
@ -1,16 +1,12 @@
|
|||
# Pleroma app for Yunohost
|
||||
|
||||
[](https://ci-apps.yunohost.org/jenkins/job/pleroma%20%28Community%29/lastBuild/consoleFull)
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/pleroma)
|
||||
[](https://install-app.yunohost.org/?app=pleroma)
|
||||
|
||||
**Links:**<br>
|
||||
[Yunohost](https://yunohost.org)<br>
|
||||
[Pleroma](https://pleroma.social/)<br>
|
||||
[Pleroma Gitlab repo](https://git.pleroma.social/pleroma/pleroma)
|
||||
|
||||
## Pleroma
|
||||
> *This package allow you to install pleroma quickly and simply on a YunoHost server.
|
||||
If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.*
|
||||
|
||||
## Overview
|
||||
[Pleroma](https://pleroma.social/) is an **OStatus and ActivityPub compatible social networking server** written in Elixir, compatible with **GNU Social** and **Mastodon**. It is high-performance and can run on small devices like a **Raspberry Pi**.
|
||||
|
||||
For clients it supports both the **GNU Social API** with **Qvitter extensions** and the **Mastodon client API**.<br>
|
||||
|
@ -29,6 +25,8 @@ For user friendly details about Pleroma: [see here](https://blog.soykaf.com/post
|
|||
- Tootdon (Android + iOS)
|
||||
- Tootle (iOS)
|
||||
|
||||
**Shipped version:** 0.9.0
|
||||
|
||||
## Important points to read before installing
|
||||
|
||||
1. **Pleroma** require a dedicated **root domain**, eg. pleroma.domain.tld
|
||||
|
@ -36,6 +34,20 @@ For user friendly details about Pleroma: [see here](https://blog.soykaf.com/post
|
|||
1. This package is **multi-instance** that means you can run **multiple Pleroma instances** on a **single server**.
|
||||
1. There is **No LDAP** support for Pleroma yet.
|
||||
|
||||
## Screenshots
|
||||
|
||||

|
||||
|
||||
## Demo
|
||||
|
||||
* [Official demo](Link to a demo site for this app)
|
||||
|
||||
## Configuration
|
||||
|
||||
How to configure this app: by an admin panel, a plain file with SSH, or any other way.
|
||||
|
||||
|
||||
|
||||
## Admin Tasks
|
||||
Go to **cd /var/www/pleroma/pleroma**.
|
||||
|
||||
|
@ -67,3 +79,54 @@ You can make users **moderators**. They will then be able to **delete any post**
|
|||
|
||||
**True** option will **make the user moderator** and **flase** will **take away the moderator privileges** from the user.
|
||||
|
||||
## Documentation
|
||||
|
||||
* Official documentation: Link to the official documentation of this app
|
||||
* YunoHost documentation: If specific documentation is needed, feel free to contribute.
|
||||
|
||||
## YunoHost specific features
|
||||
|
||||
#### Multi-users support
|
||||
|
||||
Are LDAP and HTTP auth supported?
|
||||
Can the app be used by multiple users?
|
||||
|
||||
#### Supported architectures
|
||||
|
||||
* x86-64b - [](https://ci-apps.yunohost.org/ci/apps/pleroma/)
|
||||
* ARMv8-A - [](https://ci-apps-arm.yunohost.org/ci/apps/pleroma/)
|
||||
* Jessie x86-64b - [](https://ci-stretch.nohost.me/ci/apps/pleroma/)
|
||||
|
||||
## Limitations
|
||||
|
||||
* Any known limitations.
|
||||
|
||||
## Additional information
|
||||
|
||||
* Other information you would add about this application
|
||||
|
||||
**More information on the documentation page:**
|
||||
https://yunohost.org/packaging_apps
|
||||
|
||||
## Links
|
||||
|
||||
* Report a bug: https://github.com/YunoHost-Apps/pleroma_ynh/issues
|
||||
* App website: https://pleroma.social/
|
||||
* Pleroma Gitlab repo: https://git.pleroma.social/pleroma/pleroma/
|
||||
* YunoHost website: https://yunohost.org/
|
||||
|
||||
---
|
||||
|
||||
Developers info
|
||||
----------------
|
||||
|
||||
**Only if you want to use a testing branch for coding, instead of merging directly into master.**
|
||||
Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/pleroma_ynh/tree/testing).
|
||||
|
||||
To try the testing branch, please proceed like that.
|
||||
```
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/pleroma_ynh/tree/testing --debug
|
||||
or
|
||||
sudo yunohost app upgrade pleroma -u https://github.com/YunoHost-Apps/pleroma_ynh/tree/testing --debug
|
||||
```
|
||||
|
||||
|
|
Loading…
Add table
Reference in a new issue