diff --git a/README.md b/README.md index a29096b..a6644d6 100644 --- a/README.md +++ b/README.md @@ -1,70 +1,42 @@ + + # osTicket for YunoHost [![Integration level](https://dash.yunohost.org/integration/osticket.svg)](https://dash.yunohost.org/appci/app/osticket) ![](https://ci-apps.yunohost.org/ci/badges/osticket.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/osticket.maintain.svg) [![Install osTicket with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=osticket) -> *This package allows you to install osTicket quickly and simply on a YunoHost server. +*[Lire ce readme en français.](./README_fr.md)* + +> *This package allows you to install osTicket 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 -osTicket is a widely-used open source support ticket system. It seamlessly integrates inquiries created via email, phone and web-based forms into a simple easy-to-use multi-user web interface. Manage, organize and archive all your support requests and responses in one place while providing your customers with accountability and responsiveness they deserve. -**Shipped version:** 1.15.2 +Open source support ticket system + +**Shipped version:** 1.15.2~ynh2 + +**Demo:** http://www.ostickethacks.com/demo/demo_info.php ## Screenshots -![](screenshot.png) +![](./doc/screenshots/screenshot.png) -## Demo +## Disclaimers / important information -* [Official demo](http://www.ostickethacks.com/demo/demo_info.php) +* Any known limitations, constrains or stuff not working, such as (but not limited to): + * LDAP and HTTP auth are supported through plugins -## Documentation +## Documentation and resources - * Official documentation: https://docs.osticket.com - -## YunoHost specific features - -#### Multi-user support - -LDAP and HTTP auth are supported through plugins - -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/osticket.svg)](https://ci-apps.yunohost.org/ci/apps/osticket/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/osticket.svg)](https://ci-apps-arm.yunohost.org/ci/apps/osticket/) - -## Additional information - -* The package include several plugins to be installed and enabled: - - Archiver - - Attachment Inline - - Attachments hosted in Amazon S3 - - Attachments on the filesystem - - Fetch Note - - HTTP Passthru Authentication - - JASIG CAS Authentication - - LDAP Authentication and Lookup - - Mattermost integration - - Mentioner - - Microsoft Teams notifier - - Oauth2 Authentication and Lookup - - Prevent Autoscroll - - Radiobuttons - - Slack notifier - - Ticket Closer - - Ticket Rewriter - -* The package includes many languages available through `Admin Panel > Settings > System - -## Links - - * Report a bug: https://github.com/YunoHost-Apps/osticket_ynh/issues - * App website: https://osticket.com - * Upstream app repository: https://github.com/osTicket/osTicket - * YunoHost website: https://yunohost.org/ - ---- +* Official app website: https://osticket.com +* Official user documentation: https://docs.osticket.com +* Upstream app code repository: https://github.com/osTicket/osTicket +* YunoHost documentation for this app: https://yunohost.org/app_osticket +* Report a bug: https://github.com/YunoHost-Apps/osticket_ynh/issues ## Developer info @@ -76,3 +48,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/osticket_ynh/tree/tes or sudo yunohost app upgrade osticket -u https://github.com/YunoHost-Apps/osticket_ynh/tree/testing --debug ``` + +**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/README_fr.md b/README_fr.md new file mode 100644 index 0000000..ac808b6 --- /dev/null +++ b/README_fr.md @@ -0,0 +1,48 @@ +# osTicket pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/osticket.svg)](https://dash.yunohost.org/appci/app/osticket) ![](https://ci-apps.yunohost.org/ci/badges/osticket.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/osticket.maintain.svg) +[![Installer osTicket avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=osticket) + +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* + +> *Ce package vous permet d'installer osTicket 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 + +Système de ticket de support open source + +**Version incluse :** 1.15.2~ynh2 + +**Démo :** http://www.ostickethacks.com/demo/demo_info.php + +## Captures d'écran + +![](./doc/screenshots/screenshot.png) + +## Avertissements / informations importantes + +* Any known limitations, constrains or stuff not working, such as (but not limited to): + * LDAP and HTTP auth are supported through plugins + +## Documentations et ressources + +* Site officiel de l'app : https://osticket.com +* Documentation officielle utilisateur : https://docs.osticket.com +* Dépôt de code officiel de l'app : https://github.com/osTicket/osTicket +* Documentation YunoHost pour cette app : https://yunohost.org/app_osticket +* Signaler un bug : https://github.com/YunoHost-Apps/osticket_ynh/issues + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/osticket_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/osticket_ynh/tree/testing --debug +ou +sudo yunohost app upgrade osticket -u https://github.com/YunoHost-Apps/osticket_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file