mirror of
https://github.com/YunoHost-Apps/fider_ynh.git
synced 2024-09-03 18:36:11 +02:00
67 lines
2.7 KiB
Markdown
67 lines
2.7 KiB
Markdown
<!--
|
|
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.
|
|
-->
|
|
|
|
# Fider for YunoHost
|
|
|
|
[](https://dash.yunohost.org/appci/app/fider)  
|
|
[](https://install-app.yunohost.org/?app=fider)
|
|
|
|
*[Lire ce readme en français.](./README_fr.md)*
|
|
|
|
> *This package allows you to install Fider 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
|
|
|
|
Fider is a feedback portal that helps teams collect and prioritize customer feedback in one place, based on votes and ideas submitted.
|
|
|
|
### Features
|
|
|
|
- Share ideas, vote and discuss
|
|
- Authentication with support for Github, Facebook, Google, and custom OAuth providers
|
|
- Customizable branding
|
|
- Public API, webhooks etc
|
|
- Markdown support
|
|
|
|
|
|
**Shipped version:** 0.21.1~ynh1 *(:warning: This is the `testing` branch. The [`master` branch](https://github.com/YunoHost-Apps/fider_ynh/tree/master) used in the catalog is currently on version 1.0\~ynh1.)*
|
|
|
|
|
|
**Demo:** https://feedback.fider.io
|
|
|
|
## Screenshots
|
|
|
|
|
|
|
|
## Disclaimers / important information
|
|
|
|
* Only installable on a domain root (or a subdomain root)!
|
|
* No Yunohost LDAP connection (yet)
|
|
* Email required for administation (uses "magic links" instead of admin passwords)
|
|
|
|
* You should manually configure the app after installation.
|
|
* You should edit /opt/yunohost/fider/run_fider to add environment variables, e.g for Github integration
|
|
|
|
## Documentation and resources
|
|
|
|
* Official app website: <https://fider.io>
|
|
* Official admin documentation: <https://fider.io/docs>
|
|
* Upstream app code repository: <https://github.com/getfider/fider>
|
|
* YunoHost documentation for this app: <https://yunohost.org/app_fider>
|
|
* Report a bug: <https://github.com/YunoHost-Apps/fider_ynh/issues>
|
|
|
|
## Developer info
|
|
|
|
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/fider_ynh/tree/testing).
|
|
|
|
To try the testing branch, please proceed like that.
|
|
|
|
``` bash
|
|
sudo yunohost app install https://github.com/YunoHost-Apps/fider_ynh/tree/testing --debug
|
|
or
|
|
sudo yunohost app upgrade fider -u https://github.com/YunoHost-Apps/fider_ynh/tree/testing --debug
|
|
```
|
|
|
|
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|