1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/commento_ynh.git synced 2024-09-03 18:16:16 +02:00
commento_ynh/README.md

64 lines
2.4 KiB
Markdown
Raw Normal View History

2021-11-25 15:34:19 +01:00
<!--
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.
-->
2021-11-25 15:34:24 +01:00
# Commento for YunoHost
2021-11-25 15:34:19 +01:00
2023-03-02 11:55:26 +01:00
[![Integration level](https://dash.yunohost.org/integration/commento.svg)](https://dash.yunohost.org/appci/app/commento) ![Working status](https://ci-apps.yunohost.org/ci/badges/commento.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/commento.maintain.svg)
2021-11-25 15:34:24 +01:00
[![Install Commento with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=commento)
2021-11-25 15:34:19 +01:00
*[Lire ce readme en français.](./README_fr.md)*
2021-11-25 15:34:24 +01:00
> *This package allows you to install Commento quickly and simply on a YunoHost server.
2021-11-25 15:34:19 +01:00
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview
2022-01-11 07:47:44 +01:00
Commento++ allows you to foster discussion on your website if you have a blog, you can embed Commento if you want your readers to add comments. It's fast and bloat-free, has a modern interface, and is reasonably secure. Unlike most alternatives, Commento is lightweight and privacy-focused.
2021-11-25 15:34:19 +01:00
2021-11-25 15:34:24 +01:00
### Features
2021-11-25 15:34:19 +01:00
2022-01-11 07:47:44 +01:00
- Markdown support
- Import from Disqus
- Voting
- Automated spam detection (Askimet integration)
2021-11-25 16:15:26 +01:00
- Moderation tools
- Sticky comments
2022-01-11 07:47:44 +01:00
- Thread locking
- OAuth login (Google, Github, Twitter) and single sign-on
- Hot-reloading of comments
- Email notifications.
2021-11-25 15:34:19 +01:00
2023-03-02 12:06:09 +01:00
**Shipped version:** 1.8.7~ynh2
2021-11-25 15:34:19 +01:00
2021-12-01 21:39:10 +01:00
**Demo:** https://demo.souradip.com/chat.html
2021-11-25 15:34:19 +01:00
2021-11-25 15:34:24 +01:00
## Screenshots
2021-11-25 15:34:19 +01:00
2022-08-14 11:13:21 +02:00
![Screenshot of Commento](./doc/screenshots/Screenshot.png)
2021-11-25 15:34:19 +01:00
## Documentation and resources
2022-08-14 11:13:21 +02:00
* Official app website: <https://commento.io/>
* Official admin documentation: <https://docs.commento.io/>
* Upstream app code repository: <https://github.com/souramoo/commentoplusplus>
* YunoHost documentation for this app: <https://yunohost.org/app_commento>
* Report a bug: <https://github.com/YunoHost-Apps/commento_ynh/issues>
2021-11-25 15:34:19 +01:00
## Developer info
2021-11-25 15:34:24 +01:00
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/commento_ynh/tree/testing).
2021-11-25 15:34:19 +01:00
To try the testing branch, please proceed like that.
2022-08-14 11:13:21 +02:00
``` bash
2021-11-25 15:34:24 +01:00
sudo yunohost app install https://github.com/YunoHost-Apps/commento_ynh/tree/testing --debug
2021-11-25 15:34:19 +01:00
or
2021-11-25 15:34:24 +01:00
sudo yunohost app upgrade commento -u https://github.com/YunoHost-Apps/commento_ynh/tree/testing --debug
2021-11-25 15:34:19 +01:00
```
2022-08-14 11:13:21 +02:00
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>