-
Notifications
You must be signed in to change notification settings - Fork 561
Installer API
Description : To create an alternative installer outside Faveo Helpdesk to install Faveo Helpdesk via one step installation.
Parameters :
Name | Data Type | Required/Optional | Description |
---|---|---|---|
default | String | Required | Faveo makes connection with databases and running queries extremely simple across a variety of database.Currently Faveo supports three database systems (mysql,pgsql,sqlsrv) |
host | String | Required | Here goes the database server IP address |
databasename | String | Required | Name of database |
dbusername | String | Required | Database user name |
dbpassword | String | Required | Database user’s password |
port | Integer | Optional | Port has to be filled if required. In some cases port are required to connect to the database server.Eg:- 8888 |
firstname | String | Required, Alphabetical | first name of Admin |
lastname | String | Required, Alphabetical | last name of Admin |
String | Required, Email | email of admin | |
username | String | Required | Username of the admin / could be admin |
password | String | Required | Password (min:6) |
timezone | String | Required | Below are the mentioned the list of time-zones supported by Faveo Pacific/Midway US/Samoa US/Hawaii US/Alaska US/Pacific America/Tijuana US/Arizona US/Mountain America/Chihuahua America/Mazatlan America/Mexico_City America/Monterrey Canada/Saskatchewan US/Central US/Eastern US/EastIndiana America/Bogota America/Lima America/Caracas Canada/Atlantic America/La_Paz America/Santiago Canada/Newfoundland America/Buenos_Aires Greenland Atlantic/Stanley Atlantic/Azores Atlantic/Cape_Verde Africa/Casablanca Europe/Dublin Europe/Lisbon Europe/London Africa/Monrovia Europe/Amsterdam Europe/Belgrade Europe/Berlin Europe/Bratislava Europe/Brussels Europe/Budapest Europe/Copenhagen Europe/Ljubljana Europe/Madrid Europe/Paris Europe/Prague Europe/Rome Europe/Sarajevo Europe/Skopje Europe/Stockholm Europe/Vienna Europe/Warsaw Europe/Zagreb Europe/Athens Europe/Bucharest Africa/Cairo Africa/Harare Europe/Helsinki Europe/Istanbul Asia/Jerusalem Europe/Kiev Europe/Minsk Europe/Riga Europe/Sofia Europe/Tallinn Europe/Vilnius Asia/Baghdad Asia/Kuwait Africa/Nairobi Asia/Riyadh Asia/Tehran Europe/Moscow Asia/Baku Europe/Volgograd Asia/Muscat Asia/Tbilisi Asia/Yerevan Asia/Kabul Asia/Karachi Asia/Tashkent Asia/Kolkata Asia/Kathmandu Asia/Yekaterinburg Asia/Almaty Asia/Dhaka Asia/Novosibirsk Asia/Bangkok Asia/Ho_Chi_Minh Asia/Jakarta Asia/Krasnoyarsk Asia/Chongqing Asia/Hong_Kong Asia/Kuala_Lumpur Australia/Perth Asia/Singapore Asia/Taipei Asia/Ulaanbaatar Asia/Urumqi Asia/Irkutsk Asia/Seoul Asia/Tokyo Australia/Adelaide Australia/Darwin Asia/Yakutsk Australia/Brisbane Australia/Canberra Pacific/Guam Australia/Hobart Australia/Melbourne Pacific/Port_Moresby Australia/Sydney Asia/Vladivostok Asia/Magadan Pacific/Auckland Pacific/Fiji |
datetime | String | Required | Below are mentioned the required format for date formats d/m/Y H:i:s d.m.Y H:i:s d-m-Y H:i:s m/d/Y H:i:s m.d.Y H:i:s m-d-Y H:i:s Y/m/d H:i:s Y.m.d H:i:s Y-m-d H:i:s |
HTTP Method : GET
URL Request Example :
Url to config database :
1. If you have public in your URL then try this mentioned below :
Parameters :
1.Database
2.Host
3.Databsename
4.Databaseusername
5.Databasepassword
6.Port
2. Url to migrate database and create admin credentials :
http://www.website.com/support/api/v1/system-config?firstname=admin&lastname=admin&email=admin%40faveo.com&username=admin%40faveo.com&password=demopass&timezone=Asia%2FKolkata&datetime=d%2Fm%2FY+H%3Ai%3As If you have public in your URL then try this mentioned below http://www.website.com/support/public/api/v1/system-config?firstname=admin&lastname=admin&email=admin%40faveo.com&username=admin%40faveo.com&password=demopass&timezone=Asia%2FKolkata&datetime=d%2Fm%2FY+H%3Ai%3As
Parameters :
1.firstname
2.lastname
3.email
4.username
5.password
6.timezone
7.datetime
Explanation of the URL’s :
Here we have two urls :
1.In the first url one can configure the config database file. 2.In the second url one needs to migrate the database and register the user details to the database.
Response :
Success response :
{‘response'=>'success','status'=>'1'}
Failure response :
For re-installation :
{'response'=>'fail','reason'=>'this system is already installed', 'status'=>'0'}
For insufficient/error in parameters :
- {"response":"fail","reason":"The firstname field is required,The lastname field is required,The email field is required,The username field is required,The password field is required,The timezone field is required,The datetime field is required","status":"0"}
- {"response":"fail","reason":"The database field is required,The host field is required,The databasename field is required,The dbusername field is required","status":"0"}
- {'response'=>'fail','reason'=>'insufficient parameters','status'=>'0'}
- {'response'=>'fail','reason'=>'Invalid time-zone','status'=>'0'}
- {'response'=>'fail','reason'=>'invalid date-time format','status'=>'0'}
Did you find it helpful? If not email us on support@faveohelpdesk.com
Installation and Upgrade Guide
- GUI Install Wizard
- Manual Install
- CLI Install
- Server Requirements
- Installation with Apache
- Installation with cPanel
- Cron Job or any Job scheduler
- Faveo Helpdesk Installation on CentOS 7 with Apache on PHP 7.1
- Faveo Helpdesk Installation on CentOS 7 with Nginx on PHP 7.1
- Faveo Helpdesk Installation on Ubuntu 18.04 LTS with Apache on PHP 7.1
- Faveo Helpdesk Installation on Ubuntu 18.04 LTS with Nginx on PHP 7.1
- Faveo Helpdesk Installation on Debian 9 with Nginx on PHP 7.1
- Faveo Helpdesk Installation on Debian 9 with Apache on PHP 7.1
- Migrating Faveo from one server to another
- Configuration of Redis with Faveo
- Install and configure Redis, Supervisor and Worker for Faveo on Ubuntu 16.04
- Install Let’s Encrypt SSL on CentOS 7 Running Apache Web Server
- Install and configure a simple mail server for sending mails using PHP mail function in Faveo on Ubuntu 16.04 server
- Install and configure Redis, Supervisor and Worker for Faveo on Centos 7
- Install and configure a simple mail server for sending mails using PHP mail function in Faveo on Centos 7 server
- Faveo Helpdesk Pro Installation on Windows Server 2012 R2
- Install Active Directory Domain Services in Windows Server 2012 R2
- Install Faveo Helpdesk Community on Centos, Ubuntu or Debian Using Script
- Set up automatic backup for Faveo-Helpdesk
Administrator's Guide
- Faveo File Storage
- Change client side theme color
- How to edit or change the footer in faveo
- How to change agent and admin panel Faveo logo link and logo
- Agents
- Departments
- Team
- Priority
- SLA
- Workflow
- Helptopic
- Default Ticket Settings
- Status
- Rating
- Close Ticket Workflow
- Company Settings
- Social Login
- Language
- Security
- Debugging/Logs
- Ban Emails
- Widgets
Agent's Guide
Email Integration
Release & Upgrade Notes
- General Faveo Upgrade Guide Manual
- General Faveo Upgrade Guide Auto
- Upgrade guide to v1.9.2
- Upgrade guide to v1.9.0
- How to update v1.0.7.9 to v1.0.8.0
- Manual Upgrade from v1.0.7.8 to v1.0.7.9
- Faveo Release notes & upgrade guide for V1.0.7.7
- Faveo Release notes & upgrade guide for V1.0.7.5
- Faveo Release notes & upgrade guide for V1.0.7
Known Issues
- The open_basedir restriction in effect
- 404 Not Found
- 500 Internal Server Error
- Bug after update from 1.0.7.4 to 1.0.7.5 or higher version
- Syntax error, unexpected ‘var’(T_VAR), expecting ‘;’
Contribute & Feedback
- Support the community edition
- Contribution Guide
- Faveo Feedback & Customisation
- Help in language translate
Knowledge Base
Third Party Integration
Plugins
API