Documentation

Creating a new database

First thing you want to do before installing BeDesk is to create a new database on your mysql server. If you already know how to do this/or have already created one just skip to the next step.

Your host will most likely have phpMyAdmin as mysql manager, if that is the case here's a step by step guide (if not it will be very similar on other managers).

Login to your control panel, find and click phpMyAdmin link: Click on the database tab in the top menu, enter any name you like and click create.

Uploading Files

After creating a database, unzpip the .zip file you downloaded from CodeCanyon and upload the contents of server folder to your hosting root folder (usually called www or html) or a sub-directory.

Shared hosting providers usually have a web based file manager, but you should use something like Filezilla to do the upload as the web based managers can cause various problems fairly often.

Installing BeDesk

After you uploaded BeDesk files, simply open up your site url and follow on-screen instructions to finish the installation.

Updating to new versions

• 1. Extract the .zip file you downloaded from CodeCanyon.
• 2. Upload and overwrite all the files same way you did when you first installed.
• 3. Visit http://yoursite.com/update url and click Update Now button.
• 4. If you were redirected to homepage, it means update was applied successfully.

Facebook

1. Register for regular facebook account, if you don't already have one.
2. Open this url, click my apps in the top navigation bar, then Add a New App
3. Enter any display name, your email address and click Create App ID
4. Click Add Product in the left sidebar, then Facebook Login, select Web, enter your site url. You can ignore the rest of the panels in quickstart wizard.
5. Click Facebook Login > Settings and enter http://your-site-url.com/secure/auth/social/facebook/callback into Valid OAuth redirect URIs field.
6. Click Dashboard in left sidebar and copy/paste APP ID and APP SECRET into settings page.

Twitter

1. Register for regular twitter account, if you don't already have one.
2. Open this url, click Create New App, enter anything into name and description fields, enter your site url into Website and Callback URL fields and create the app.
3. Copy Consumer Key and Consumer Secret from "Keys and Access Tokens" tab into settings page.

Google

1. Register for regular google account, if you don't already have one.
2. Open this url, create a new project, click Credentials in left sidebar, select Oauth Client ID -> Web Application.
3. Enter http://your-site-url.com/secure/auth/social/google/callback into Authorized Redirect URIs field and click Create.
4. Copy/paste Client ID and Client Secret into settings page.

Envato

You only need to register for envato app if you are planning to use BeDesk envato integration module.

1. Register for regular envato account if you don't have one already.
2. Open this url, click My Apps, Register a new app
3. Request these permissions:
   • View the user's Envato Account username
   • View the user's email address
   • Verify purchases of the user's items
   • View the user's purchases of the app creator's items
4. Enter http://your-site-url.com/secure/auth/social/envato/callback into Confirmation URL field and click Register App
5. Copy/paste OAuth client ID and secret application key into settings page.

1. Open this url.
2. Click Create new token
3. Select all permissions and click Create Token.
4. Copy/paste newly created toekn into admin area > settings > authentication page.

Incoming Mail

Incoming emails can be automatically turned into tickets by BeDesk. Currently two methods are supported Mailgun and Webhook.

Mailgun

Note that if you already have mx records on your domain set to, for example, gmail, you can set mailgun mx records for a sub-domain, for example support.your-site.com now you can forward your email from your gmail account to support@support.your-site.com. Now you will receive emails to both your gmail inbox and BeDesk.

1. Make sure you have configured mailgun provider for outgoing mail.
2. Set up mx records in your domain page on mailgun site, so all mail sent to your domain is forwarded to mailgun.
3. Create a new mailgun route here. Select Catch All as expression type and, enter https://your-site.com/tickets/mail/incoming into "Store and notify" field. This will forward all emails received by your mailgun domain to BeDesk.
4. Create a new webhook here. Select Dropped Messages and enter https://your-site.com/tickets/mail/failed into URL field. This will allow BeDesk to notify you if any of the emails you have sent were not delivered.

Webhook

You should use this method if you already have a mail server setup for your domain that receives emails.

1. Select Webhook in admin area > settings > mail page.
2. Enter Secret Webhook Key. This should be pre-generated, but you can enter a custom random 30 character length string. This will be used to validate that incoming emails are actually coming from you.

3. Whenever you receive an email, send a http POST request to https://your-site.com/tickets/mail/incoming

   Http request should have these items in the body:

   • headers - key => value array of email headers.
   • body - array with three items:
     • plain - text version of the email.
     • html - html version of the email.
     • stripped-html - Optional. Html version of the email with quoted replies from previous emails removed. BeDesk will do this for you if needed.
   • Attachments - array of email attachments. Each attachment should have this information:
     • original_name
     • mime_type
     • size
     • contents
     • extension
     • cid. If attachment does not have a cid it should be null.

Pusher

Pusher free plan currently allows 100 simultaneous connections (users) and 200k messages per day. This should be more then enough for any medium to large sized site.

1. Register for pusher account here.
2. You should see "create new app" dialog, select the cluster that is closest to your server location and click create my app.
3. Copy credentials from App Keys tab into admin area > settings > realtime page.