Advanced features Configuration Guide for
Orangescrum Community Edition

Step by step guide to integrate advanced features of Orangescrum in Community Version.

Quick configuration steps to setup Google Login, Amazon S3, integration with Google Drive and Dropbox, Cron Job Settings, Nohup Cron Job Setup and Node JS setup in Orangescrum Community.

Last Updated: 10th June, 2016
Print Print this page

  1. Step 1:-Google Login, Amazon S3, Google Drive and Dropbox Setup

    1. Create a Google Project for Google Login, Invite Google Contacts and Google Drive file attachment.
      • Update the CLIENT_ID, CLIENT_ID_NUM, CLIENT_SECRET, API_KEY values.
      • Set the USE_GOOGLE value to 1 to use Google Google Login, Invite Google Contacts and Google Drive file attachment
    2. Create a Dropbox App for Dropbox file file sharing.
      • Update the DROPBOX_KEY value and Set the USE_DROPBOX value to 1 to use Dropbox file file sharing.
    3. Create 2 Buckets in AWS S3 to store all the files in the S3 Bucket.
      • Provide the S3 Bucket Names, awsAccessKey, awsSecretKey values
      • Set the USE_S3 value to "1" to store all file attachment and profile photo in AWS S3 bucket.
  2. Get the " Dropbox and Google Setup.pdf " on the root directory of the Orangescrum project folder to know, How to create apps and projects on Dropbox and Google Drive.
  3. Step 2:-Cron Job Settings (Linux Server)

    Update your application url in define('DOMAIN', ") in the "app/Config/constants.php".

    Below are the 4 Cron Jobs to set on a Linux server ,

    (Assuming your Application is in " /var/www/html/orangescrum/ ")

    1. 0 23 * * * php q   /var/www/html/orangescrum/app/webroot/cron_dispatcher.php   /cron/email_notification
      • Daily/Weekly/Monthly Task Status update email in the "Email Reports" section of Orangescrum.
    2. */15 * * * * php q   /var/www/html/orangescrum/app/webroot/cron_dispatcher.php /cron/  dailyupdate_notifications
      • Daily Update Reports in the "Email Reports" section of Orangescrum
    3. */15 * * * * php -q   /var/www/html/orangescrum/app/webroot/cron_dispatcher.php /cron/  dailyUpdateMail
      • Daily Catch Up Email Alert
    4. */30 * * * * php q   /var/www/html/orangescrum/app/webroot/cron_dispatcher.php /cron/  weeklyusagedetails
      • Weekly Usage report of your account
  4. Step 3:- Nohup Cron Job Setup

    You can also set the Cron Jobs using the absolute urls.

    1. http://www.yourorangescrum/cron/email_notification
    2. http://www.yourorangescrum/cron/dailyupdate_notifications
    3. http://www.yourorangescrum/cron/dailyUpdateMail
    4. http://www.yourorangescrum/cron/weeklyusagedetails

    Email Reply - Nohup Cron Job setup (Linux Server)

    Make sure to do the following changes on the Email server connection details in the app/webroot/EmailReply.php file.

    1. $username- This will be the FROM_EMAIL_NOTIFY Email set on your app/Config/constants.php
      • All the task created/updated notification email will be sent from FROM_EMAIL_NOTIFY . When somebody will reply on that task created/updated notification email, the FROM_EMAIL_NOTIFY will get that Email in the inbox.
      • EmailReply.phppage is going to read the emails from FROM_EMAIL_NOTIFY and It will post to them as a reply to the respective tasks in Orangescrum.
    2. $password- Password of FROM_EMAIL_NOTIFY
    3. client- Change it, if you are not using Gmail

    After this setup, you can reply to a task created/updated notification email and that email reply will be posted to Orangescrum under that Task. This will help you to respond to a task while on the go from your Mobile.

    (Assuming your Application is in "/var/www/html/orangescrum/ ")

    1. Enable extension=php_imap in your php.ini file
    2. Create a orangescrum.sh file in your server
    3. vi orangescrum.sh (or, open that file to write the below code) #!/bin/bash
      while(true)
      do
      cd /var/www/html/orangescrum/app/webroot
      php q EmailReply.php 1>&2
      sleep 1?
      done
    4. Give the execute permission for orangescrum.sh: chmod +x orangescrum.sh
    5. Start the Nohup using the command: nohup sh orangescrum.sh > customout.log &
  5. Step 4:- Node JS setup (Linux Server)

    1. Make sure that you have installed Node.js and NPM
    2. Install Socket.io using NPM
    3. Install Forever
    4. Find how to add a JavaScript file to run Node.js forever.
    5. Now enable the "NODEJS_HOST" with your server details on "app/Config/constants.php"

Last Updated: 10th June, 2016

24×7,We are there for you

Free Forum support is provided by the Orangescrum Community.

If you require any urgent or professional help, contact Orangescrum Professional Services team!

Download Now Try All Add-on Demo