Orangescrum Installation Manual

Orangescrum Base Code Automated Installation

OrangeScrum is a free, open source, flexible project management web application written using

CakePHP.

Just 5 simple steps to start using OrangeScrum in your premises. This procedure is well tested

on Windows, Linux and Mac operating system.

Requirements

 Apache with 'mod_rewrite'

 PHP 5.6 or PHP 7.x

Installation

Minimum Configuration

 Download Orangescrum zip file and extract the archive. Upload all the files and

folders to your working directory.

 Provide proper write permission (777 or 755) to "app/tmp" and "app/webroot"

folders and their sub-folders.

 Make sure that, there are three .htaccess files. One in the root directory, another in

the "app" directory and the last one is in the "app/webroot" directory.

 Make sure that, the .htaccess is working in your server.

Email ID.

 SUB_FOLDER -Update the folder name, If your application URL is

"http://www.myorangescrum.com/folder_name/" (the value should follow by a

forward slash. e.g. define('SUB_FOLDER', folder_name/')). Leave it blank If your

application URL doesn’t have an additional folder path.

 Run Orangescrum as http://yoursiteurl.com/ from your browser. If Orangescrum is

hosted on local network, then run http://localhost/orangescrum-master or run the

IP/domain as configured.

 Once you hit the URL, you can see the Database Configuration Wizard

 On the Database Configuration wizard, provide your Database Name, Database

Note: You can Skip SMTP setup by clicking on “Skip”. Also, this step doesn’t verify

 Once you click on “Finish” button, you’ll be ask to provide your Company Name,

Email address and a Password to login and start using OrangeScrum.

Note: If you’re unable to see the Sign up page, then change the

 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

 Create a Dropbox App (https://www.dropbox.com/developers) for Dropbox file file

sharing.

 Update the DROPBOX_KEY value and Set the USE_DROPBOX value to 1 to use

Dropbox file file sharing.

 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

"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-master/")

 0 23 * * * php -q /var/www/html/orangescrum-

master/app/webroot/cron_dispatcher.php /cron/email_notification

o Daily/Weekly/Monthly Task Status update email in the "Email Reports" section

of Orangescrum.

 */15 * * * * php -q /var/www/html/orangescrum-

master/app/webroot/cron_dispatcher.php /cron/dailyupdate_notifications

o Daily Update Reports in the "Email Reports" section of Orangescrum

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

 http://www.yourorangescrum/cron/email_notification

 http://www.yourorangescrum/cron/dailyupdate_notifications

 http://www.yourorangescrum/cron/dailyUpdateMail

 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

2. $password- Password of FROM_EMAIL_NOTIFY

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-

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

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

Node JS setup (Linux Server)

 Make sure that you have installed Node.js and NPM

 Install Socket.io using NPM

 Find how to add a JavaScript file to run Node.js forever.

 Now enable the "NODEJS_HOST" with your server details under

"define("NODEJS_HOST", '');"[ex: http://your IP address:3002/] on

"app/Config/constants.php"

For Troubleshooting, kindly follow these links:

https://groups.google.com/forum/#!forum/orangescrum-community-support