mirror of
https://github.com/YunoHost-Apps/plume_ynh.git
synced 2024-09-03 20:15:54 +02:00
Auto-update README
This commit is contained in:
parent
5de9596fb3
commit
8c855a31eb
2 changed files with 82 additions and 33 deletions
59
README.md
59
README.md
|
@ -1,15 +1,31 @@
|
|||
<!--
|
||||
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.
|
||||
-->
|
||||
|
||||
# Plume for YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/plume)  
|
||||
[](https://install-app.yunohost.org/?app=plume)
|
||||
|
||||
> *This package allows you to install Plume quickly and simply on a YunoHost server.
|
||||
*[Lire ce readme en français.](./README_fr.md)*
|
||||
|
||||
> *This package allows you to install Plume 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
|
||||
|
||||
Federated blogging engine, based on ActivityPub. It uses the Rocket framework, and Diesel to interact with the database.
|
||||
|
||||
**Shipped version:** 0.6.0
|
||||
**Shipped version:** 0.6.0~ynh2
|
||||
|
||||
**Demo:** https://joinplu.me/#instances
|
||||
|
||||
## Screenshots
|
||||
|
||||

|
||||
|
||||
## Disclaimers / important information
|
||||
|
||||
**Warning:** The package can take **15 to 30 minutes** to complete depending on your system configuration. **Don't intrupt the installation process while installing.**
|
||||
|
||||
|
@ -19,41 +35,16 @@ Federated blogging engine, based on ActivityPub. It uses the Rocket framework, a
|
|||
1. **Plume** 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 **multi-instance** that means you can run **multiple Plume instances** on a **single server**.
|
||||
|
||||
## Screenshots
|
||||
|
||||

|
||||
|
||||
## Demo
|
||||
|
||||
* [List of instances](https://joinplu.me/#instances)
|
||||
|
||||
## Documentation
|
||||
|
||||
* Official documentation: https://docs.joinplu.me/
|
||||
|
||||
## YunoHost specific features
|
||||
|
||||
#### Multi-user support
|
||||
|
||||
LDAP is activated but HTTP auth is not supported
|
||||
## Documentation and resources
|
||||
|
||||
#### Supported architectures
|
||||
|
||||
* x86-64 - [](https://ci-apps.yunohost.org/ci/apps/plume/)
|
||||
* ARMv8-A - [](https://ci-apps-arm.yunohost.org/ci/apps/plume/)
|
||||
|
||||
## Limitations
|
||||
|
||||
* No known limitations.
|
||||
|
||||
## Links
|
||||
|
||||
* Report a bug: https://github.com/YunoHost-Apps/plume_ynh/issues
|
||||
* App website: https://joinplu.me/
|
||||
* Upstream app repository: https://github.com/Plume-org/Plume
|
||||
* YunoHost website: https://yunohost.org/
|
||||
|
||||
---
|
||||
* Official app website: https://joinplu.me/
|
||||
* Official admin documentation: https://docs.joinplu.me/
|
||||
* Upstream app code repository: https://github.com/Plume-org/Plume
|
||||
* YunoHost documentation for this app: https://yunohost.org/app_plume
|
||||
* Report a bug: https://github.com/YunoHost-Apps/plume_ynh/issues
|
||||
|
||||
## Developer info
|
||||
|
||||
|
@ -65,3 +56,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/plume_ynh/tree/testin
|
|||
or
|
||||
sudo yunohost app upgrade plume -u https://github.com/YunoHost-Apps/plume_ynh/tree/testing --debug
|
||||
```
|
||||
|
||||
**More info regarding app packaging:** https://yunohost.org/packaging_apps
|
56
README_fr.md
Normal file
56
README_fr.md
Normal file
|
@ -0,0 +1,56 @@
|
|||
# Plume pour YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/plume)  
|
||||
[](https://install-app.yunohost.org/?app=plume)
|
||||
|
||||
*[Read this readme in english.](./README.md)*
|
||||
*[Lire ce readme en français.](./README_fr.md)*
|
||||
|
||||
> *Ce package vous permet d'installer Plume 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
|
||||
|
||||
Federated blogging engine, based on ActivityPub. It uses the Rocket framework, and Diesel to interact with the database.
|
||||
|
||||
**Version incluse :** 0.6.0~ynh2
|
||||
|
||||
**Démo :** https://joinplu.me/#instances
|
||||
|
||||
## Captures d'écran
|
||||
|
||||

|
||||
|
||||
## Avertissements / informations importantes
|
||||
|
||||
**Warning:** The package can take **15 to 30 minutes** to complete depending on your system configuration. **Don't intrupt the installation process while installing.**
|
||||
|
||||
## Important points to read before installing
|
||||
1. **Plume** is still in **pre-release** stage and undergoing heavy development, so there can be **bugs**.
|
||||
1. **Plume** require a dedicated **root domain**, eg. plume.domain.tld
|
||||
1. **Plume** 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 **multi-instance** that means you can run **multiple Plume instances** on a **single server**.
|
||||
|
||||
#### Multi-user support
|
||||
|
||||
LDAP is activated but HTTP auth is not supported
|
||||
## Documentations et ressources
|
||||
|
||||
* Site officiel de l'app : https://joinplu.me/
|
||||
* Documentation officielle de l'admin : https://docs.joinplu.me/
|
||||
* Dépôt de code officiel de l'app : https://github.com/Plume-org/Plume
|
||||
* Documentation YunoHost pour cette app : https://yunohost.org/app_plume
|
||||
* Signaler un bug : https://github.com/YunoHost-Apps/plume_ynh/issues
|
||||
|
||||
## Informations pour les développeurs
|
||||
|
||||
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/plume_ynh/tree/testing).
|
||||
|
||||
Pour essayer la branche testing, procédez comme suit.
|
||||
```
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/plume_ynh/tree/testing --debug
|
||||
ou
|
||||
sudo yunohost app upgrade plume -u https://github.com/YunoHost-Apps/plume_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