diff --git a/doc/DESCRIPTION.md b/doc/DESCRIPTION.md new file mode 100644 index 0000000..04cfd65 --- /dev/null +++ b/doc/DESCRIPTION.md @@ -0,0 +1 @@ +Federated blogging engine, based on ActivityPub. It uses the Rocket framework, and Diesel to interact with the database. \ No newline at end of file diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md new file mode 100644 index 0000000..8b56d96 --- /dev/null +++ b/doc/DISCLAIMER.md @@ -0,0 +1,11 @@ +**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 \ No newline at end of file diff --git a/doc/screenshots/screenshot.png b/doc/screenshots/screenshot.png new file mode 100644 index 0000000..c251d1a Binary files /dev/null and b/doc/screenshots/screenshot.png differ diff --git a/manifest.json b/manifest.json index d1b6d17..e4525d5 100755 --- a/manifest.json +++ b/manifest.json @@ -8,6 +8,13 @@ }, "version": "0.6.0~ynh2", "url": "https://joinplu.me/", + "upstream": { + "license": "AGPL-3.0-only", + "website": "https://joinplu.me/", + "demo": "https://joinplu.me/#instances", + "admindoc": "https://docs.joinplu.me/", + "code": "https://github.com/Plume-org/Plume" + }, "license": "AGPL-3.0-only", "maintainer": { "name": "yalh76" @@ -53,7 +60,7 @@ "type": "boolean", "ask": { "en": "Is registrations open to everyone?", - "fr": "Les inscriptions sont t'elles ouvertes à tout le monde?" + "fr": "Les inscriptions sont t'elles ouvertes à tout le monde ?" }, "default": false }