YunoHost-Apps/osticket_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/osticket_ynh.git synced 2024-09-03 19:56:17 +02:00
Code Issues Activity Actions

Merge pull request #23 from YunoHost-Apps/example

Browse source 
Apply last example_ynh
This commit is contained in:
yalh76 2021-07-31 20:53:52 +02:00 • committed by GitHub
commit 21e0b03cb4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
13 changed files with 121 additions and 102 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

72
README.md
View file

@ -1,70 +1,42 @@
<!--
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.
-->
# osTicket for YunoHost # 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) [![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) [![Install osTicket with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=osticket)
*[Lire ce readme en français.](./README_fr.md)*
> *This package allows you to install osTicket quickly and simply on a YunoHost server. > *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.* If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview ## 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.3.1 Open source support ticket system
**Shipped version:** 1.15.3.1~ynh1
**Demo:** http://www.ostickethacks.com/demo/demo_info.php
## Screenshots ## 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
* 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 * 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/
---
## Developer info ## Developer info
@ -76,3 +48,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/osticket_ynh/tree/tes
or or
sudo yunohost app upgrade osticket -u https://github.com/YunoHost-Apps/osticket_ynh/tree/testing --debug 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

48
README_fr.md Normal file
View file

@ -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.3.1~ynh1
**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

15
check_process
View file

@ -1,16 +1,11 @@
# See here for more information
# https://github.com/YunoHost/package_check#syntax-check_process-file
# Move this file from check_process.default to check_process when you have filled it.
;; Test complet ;; Test complet
; Manifest ; Manifest
domain="domain.tld" (DOMAIN) domain="domain.tld"
path="/path" (PATH) path="/path"
admin="john" (USER) admin="john"
language="fr" language="fr"
is_public=1 (PUBLIC|public=1|private=0) is_public=1
password="pass" password="1Strong-Password"
; Checks ; Checks
pkg_linter=1 pkg_linter=1
setup_sub_dir=1 setup_sub_dir=1

0
doc/.gitkeep Normal file
View file

2
doc/DISCLAIMER.md Normal file
View file

@ -0,0 +1,2 @@
* Any known limitations, constrains or stuff not working, such as (but not limited to):
* LDAP and HTTP auth are supported through plugins

0
doc/screenshots/.gitkeep Normal file
View file

0
screenshot.png → doc/screenshots/screenshot.png
View file

Side by side Swipe Overlay

Before

Width:  |  Height:  |  Size: 379 KiB

After

Width:  |  Height:  |  Size: 379 KiB

9
manifest.json
View file

@ -7,7 +7,14 @@
"fr": "Système de ticket de support open source" "fr": "Système de ticket de support open source"
}, },
"version": "1.15.3.1~ynh1", "version": "1.15.3.1~ynh1",
"url": "https://osticket.com/", "url": "https://osticket.com",
"upstream": {
"license": "GPL-2.0-or-later",
"website": "https://osticket.com",
"demo": "http://www.ostickethacks.com/demo/demo_info.php",
"userdoc": "https://docs.osticket.com",
"code": "https://github.com/osTicket/osTicket"
},
"license": "GPL-2.0-or-later", "license": "GPL-2.0-or-later",
"maintainer": { "maintainer": {
"name": "yalh76" "name": "yalh76"

2
scripts/backup
View file

@ -58,7 +58,7 @@ ynh_backup --src_path="/etc/php/$phpversion/fpm/pool.d/$app.conf"
#================================================= #=================================================
# SPECIFIC BACKUP # SPECIFIC BACKUP
#================================================= #=================================================
# BACKUP A CRON FILE # BACKUP VARIOUS FILES
#================================================= #=================================================
ynh_backup --src_path="/etc/cron.d/$app" ynh_backup --src_path="/etc/cron.d/$app"

6
scripts/install
View file

@ -68,7 +68,7 @@ ynh_install_app_dependencies $pkg_dependencies
ynh_script_progression --message="Configuring system user..." ynh_script_progression --message="Configuring system user..."
# Create a system user # Create a system user
ynh_system_user_create --username=$app --home_dir="$final_path" ynh_system_user_create --username=$app --home_dir=$final_path
#================================================= #=================================================
# CREATE A MYSQL DATABASE # CREATE A MYSQL DATABASE
@ -135,7 +135,7 @@ ynh_add_config --template="../conf/cron" --destination="/etc/cron.d/$app"
#================================================= #=================================================
# ADD A CONFIGURATION # ADD A CONFIGURATION
#================================================= #=================================================
ynh_script_progression --message="Adding a config file..." ynh_script_progression --message="Adding a configuration file..."
cp -f "../conf/ost-sampleconfig.php" "$final_path/include/ost-config.php" cp -f "../conf/ost-sampleconfig.php" "$final_path/include/ost-config.php"
@ -207,6 +207,8 @@ ynh_secure_remove --file="$final_path/setup"
chmod 400 "$final_path/include/ost-config.php" chmod 400 "$final_path/include/ost-config.php"
chown $app:www-data "$final_path/include/ost-config.php" chown $app:www-data "$final_path/include/ost-config.php"
ynh_store_file_checksum --file="$final_path/include/ost-config.php"
#================================================= #=================================================
# GENERIC FINALIZATION # GENERIC FINALIZATION
#================================================= #=================================================

4
scripts/remove
View file

@ -66,9 +66,9 @@ ynh_remove_fpm_config
#================================================= #=================================================
# SPECIFIC REMOVE # SPECIFIC REMOVE
#================================================= #=================================================
# REMOVE THE CRON FILE # REMOVE VARIOUS FILES
#================================================= #=================================================
ynh_script_progression --message="Removing the cron file..." ynh_script_progression --message="Removing various files..."
# Remove a cron file # Remove a cron file
ynh_secure_remove --file="/etc/cron.d/$app" ynh_secure_remove --file="/etc/cron.d/$app"

18
scripts/restore
View file

@ -59,7 +59,7 @@ ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf"
ynh_script_progression --message="Recreating the dedicated system user..." ynh_script_progression --message="Recreating the dedicated system user..."
# Create the dedicated user (if not existing) # Create the dedicated user (if not existing)
ynh_system_user_create --username=$app --home_dir="$final_path" ynh_system_user_create --username=$app --home_dir=$final_path
#================================================= #=================================================
# RESTORE THE APP MAIN DIR # RESTORE THE APP MAIN DIR
@ -75,7 +75,7 @@ chown -R $app:www-data "$final_path"
#================================================= #=================================================
# RESTORE THE PHP-FPM CONFIGURATION # RESTORE THE PHP-FPM CONFIGURATION
#================================================= #=================================================
ynh_script_progression --message="Restoring PHP-FPM configuration..." ynh_script_progression --message="Restoring the PHP-FPM configuration..."
ynh_restore_file --origin_path="/etc/php/$phpversion/fpm/pool.d/$app.conf" ynh_restore_file --origin_path="/etc/php/$phpversion/fpm/pool.d/$app.conf"
@ -85,13 +85,6 @@ phpversion=$(ynh_app_setting_get --app=$app --key=phpversion)
#================================================= #=================================================
# SPECIFIC RESTORATION # SPECIFIC RESTORATION
#=================================================
# RESTORE THE CRON FILE
#=================================================
ynh_script_progression --message="Restoring the cron file..."
ynh_restore_file --origin_path="/etc/cron.d/$app"
#================================================= #=================================================
# REINSTALL DEPENDENCIES # REINSTALL DEPENDENCIES
#================================================= #=================================================
@ -109,6 +102,13 @@ db_pwd=$(ynh_app_setting_get --app=$app --key=mysqlpwd)
ynh_mysql_setup_db --db_user=$db_user --db_name=$db_name --db_pwd=$db_pwd ynh_mysql_setup_db --db_user=$db_user --db_name=$db_name --db_pwd=$db_pwd
ynh_mysql_connect_as --user=$db_user --password=$db_pwd --database=$db_name < ./db.sql ynh_mysql_connect_as --user=$db_user --password=$db_pwd --database=$db_name < ./db.sql
#=================================================
# RESTORE VARIOUS FILES
#=================================================
ynh_script_progression --message="Restoring various files..."
ynh_restore_file --origin_path="/etc/cron.d/$app"
#================================================= #=================================================
# GENERIC FINALIZATION # GENERIC FINALIZATION
#================================================= #=================================================

43
scripts/upgrade
View file

@ -23,8 +23,6 @@ final_path=$(ynh_app_setting_get --app=$app --key=final_path)
language=$(ynh_app_setting_get --app=$app --key=language) language=$(ynh_app_setting_get --app=$app --key=language)
db_name=$(ynh_app_setting_get --app=$app --key=db_name) db_name=$(ynh_app_setting_get --app=$app --key=db_name)
config_file=$final_path/include/ost-config.php
#================================================= #=================================================
# CHECK VERSION # CHECK VERSION
#================================================= #=================================================
@ -32,18 +30,6 @@ ynh_script_progression --message="Checking version..."
upgrade_type=$(ynh_check_app_version_changed) upgrade_type=$(ynh_check_app_version_changed)
#=================================================
# ENSURE DOWNWARD COMPATIBILITY
#=================================================
ynh_script_progression --message="Ensuring downward compatibility..."
# Cleaning legacy permissions
if ynh_legacy_permissions_exists; then
ynh_legacy_permissions_delete_all
ynh_app_setting_delete --app=$app --key=is_public
fi
#================================================= #=================================================
# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP # BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
#================================================= #=================================================
@ -60,13 +46,25 @@ ynh_abort_if_errors
#================================================= #=================================================
# STANDARD UPGRADE STEPS # STANDARD UPGRADE STEPS
#=================================================
# ENSURE DOWNWARD COMPATIBILITY
#=================================================
ynh_script_progression --message="Ensuring downward compatibility..."
# Cleaning legacy permissions
if ynh_legacy_permissions_exists; then
ynh_legacy_permissions_delete_all
ynh_app_setting_delete --app=$app --key=is_public
fi
#================================================= #=================================================
# CREATE DEDICATED USER # CREATE DEDICATED USER
#================================================= #=================================================
ynh_script_progression --message="Making sure dedicated system user exists..." ynh_script_progression --message="Making sure dedicated system user exists..."
# Create a dedicated user (if not existing) # Create a dedicated user (if not existing)
ynh_system_user_create --username=$app --home_dir="$final_path" ynh_system_user_create --username=$app --home_dir=$final_path
#================================================= #=================================================
# DOWNLOAD, CHECK AND UNPACK SOURCE # DOWNLOAD, CHECK AND UNPACK SOURCE
@ -80,7 +78,7 @@ then
mkdir $tmpdir/plugins mkdir $tmpdir/plugins
rsync -a "$final_path/include/plugins" "$tmpdir/." rsync -a "$final_path/include/plugins" "$tmpdir/."
rsync -a "$config_file" "$tmpdir/." rsync -a "$final_path/include/ost-config.php" "$tmpdir/."
ynh_secure_remove --file="$final_path" ynh_secure_remove --file="$final_path"
# Download, check integrity, uncompress and patch the source from app.src # Download, check integrity, uncompress and patch the source from app.src
@ -137,7 +135,9 @@ phpversion=$(ynh_app_setting_get --app=$app --key=phpversion)
#================================================= #=================================================
# UPDATE A CONFIG FILE # UPDATE A CONFIG FILE
#================================================= #=================================================
ynh_script_progression --message="Updating a config file..." ynh_script_progression --message="Updating a configuration file..."
ynh_store_file_checksum --file="$final_path/include/ost-config.php"
chmod 400 "$final_path/include/ost-config.php" chmod 400 "$final_path/include/ost-config.php"
chown $app:www-data "$final_path/include/ost-config.php" chown $app:www-data "$final_path/include/ost-config.php"
@ -190,15 +190,6 @@ ynh_script_progression --message="Setting the cron file..."
ynh_add_config --template="../conf/cron" --destination="/etc/cron.d/$app" ynh_add_config --template="../conf/cron" --destination="/etc/cron.d/$app"
#=================================================
# STORE THE CONFIG FILE CHECKSUM
#=================================================
ynh_script_progression --message="Storing the config file checksum..."
ynh_backup_if_checksum_is_different --file="$config_file"
# Recalculate and store the checksum of the file for the next upgrade.
ynh_store_file_checksum --file="$config_file"
#================================================= #=================================================
# GENERIC FINALIZATION # GENERIC FINALIZATION
#================================================= #=================================================