Scribd
Upload
316 views

Orange Scrum Installation Manual

This document provides installation instructions for Orangescrum, an open source project management application. It outlines requirements, a 5-step installation process including extracting files, configuring the database and PHP settings, and setting up cron jobs. Additional sections explain how to configure Google, Dropbox, and AWS integrations as well as a Node.js server and troubleshooting tips.

Uploaded by

Srinivasu Gadde
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
316 views

Orange Scrum Installation Manual

This document provides installation instructions for Orangescrum, an open source project management application. It outlines requirements, a 5-step installation process including extracting files, configuring the database and PHP settings, and setting up cron jobs. Additional sections explain how to configure Google, Dropbox, and AWS integrations as well as a Node.js server and troubleshooting tips.

Uploaded by

Srinivasu Gadde
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 6

Installation & Setup Manual

Orangescrumisafree,opensource,flexibleprojectmanagementwebapplicationwritten
usingCakePHP.

Just5simplestepstostartusingOrangescruminyourpremises.Thisprocedureis
welltestedonWindows,LinuxandMacoperatingsystem.

Requirements
Apachewith`mod_rewrite`
PHP5.3orhigher
Enable
curl
inphp.ini
Changethe'
post_max_size
'and`
upload_max_filesize
`to200Mbinphp.ini
MySQL4.1orhigher
IfSTRICTmodeisOn,turnitOff.

Installation
Minimum Configuration
1.

2.
3.
4.

Extractthearchive.Uploadallthefilesandfolderstoyourworkingdirectory.
1.1.
Provideproper
writepermission
to
app/tmp
and
app/webroot
foldersand
theirsubfolders.
1.2.
Makesurethat,therearethree
.htaccess
files.Oneintherootdirectory,
anotherintheappdirectoryandthelastoneisintheapp/webrootdirectory.
1.3.
Makesurethat,the
.htaccess
isworkinginyourserver.
CreateanewMySQLdatabase(`utf8_unicode_ci`collation)
Getthe
database.sql
filefromtherootdirectoryandimportthattoyourdatabase
Locateyour`app`directory,dothechangesonfollowingfiles
4.1.
app/Config/database.php
4.1.1.
Updatethedatabaseconnectiondetails.(host,login,passwordand
databasename)
4.2.
app/Config/constants.php
4.2.1.
Provideyourvalid
GmailIDandPassword
for
SMTPemailsending
Or,youcanuseSendgridorMandrill.
4.2.2.
FROM_EMAIL_NOTIFY
Allthetaskcreated/updatednotificationemail
willbesentfromthisEmailID.
4.2.3.
SUPPORT_EMAIL

AllotherEmailsandsupportrelatedEmailswillbe
sentfromthisEmailID.

4.2.4.

5.

SUB_FOLDER

Updatethefoldername,IfyourapplicationURLis

http://www.myorangescrum.com/
folder_name
/
(thevalueshould
followbyaforwardslash.e.g.
define('SUB_FOLDER',
folder_name/')
).LeaveitblankIfyourapplicationURLdoesnthave
anadditionalfolderpath.

Nowyouareallset,runOrangescrumashttp://yoursiteurl.com/fromyourbrowser.
Changethe
Configure::write('debug',2)
to

Configure::write('debug',0)
in
app/Config/core.php

YouwillbeaskedtoprovideyourCompanyName,EmailaddressandaPasswordtologin
andstartusingOrangescrum.

Other Configurations in
app/Config/constants.php
1.

2.

3.

CreateaGoogleProject(
https://console.developers.google.com/project
)forGoogle
Login,InviteGoogleContactsandGoogleDrivefileattachment.
1.1.
UpdatetheCLIENT_ID,CLIENT_ID_NUM,CLIENT_SECRET,API_KEY
values.
1.2.
SettheUSE_GOOGLEvalueto1touseGoogleGoogleLogin,InviteGoogle
ContactsandGoogleDrivefileattachment
CreateaDropboxApp(
https://www.dropbox.com/developers
)forDropboxfilefile
sharing.
2.1.
UpdatetheDROPBOX_KEYvalueandSettheUSE_DROPBOXvalueto1to
useDropboxfilefilesharing.
Create2BucketsinAWSS3tostoreallthefilesintheS3Bucket.
3.1.
ProvidetheS3BucketNames,awsAccessKey,awsSecretKeyvalues.
3.2.
SettheUSE_S3valueto1tostoreallfileattachmentandprofilephotoin
AWSS3bucket.

Getthe
DropboxandGooglSetup.pdf
ontherootdirectoryoftheOrangescrumproject
foldertoknow,HowtocreateappsandprojectsonDropboxandGoogleDrive.

CronJobSettings(LinuxServer)
Updateyourapplicationurlin
define('DOMAIN',"
www.myorangescrum.com/
")

in
theapp/Config/constants.php.
Belowarethe4CronJobstosetona
Linuxserver
,
(AssumingyourApplicationisin
/var/www/html/orangescrum/
)
1. 023***phpq
/var/www/html/orangescrum/app/webroot/cron_dispatcher.php
/cron/email_notification
1.1.
Daily/Weekly/MonthlyTaskStatusupdateemailintheEmailReportssection
ofOrangescrum.

2.

3.

4.

*/15****phpq
/var/www/html/orangescrum/app/webroot/cron_dispatcher.php
/cron/dailyupdate_notifications
2.1.
DailyUpdateReportsinthe
EmailReportssectionofOrangescrum
*/15****phpq
/var/www/html/orangescrum/app/webroot/cron_dispatcher.php
/cron/dailyUpdateMail
3.1.
DailyCatchUpEmailAlert
*/30****phpq
/var/www/html/orangescrum/app/webroot/cron_dispatcher.php
/cron/weeklyusagedetails
4.1.
WeeklyUsagereportofyouraccount

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

Email Reply - Nohup Cron Job setup (Linux Server)


MakesuretodothefollowingchangesontheEmailserverconnectiondetailsinthe
app/webroot/EmailReply.php
file.
1.
$username
Thiswillbethe
FROM_EMAIL_NOTIFY
Emailsetonyour
app/Config/constants.php
1.1.
Allthetaskcreated/updatednotificationemailwillbesentfrom
FROM_EMAIL_NOTIFY
.Whensomebodywillreplyonthattask
created/updatednotificationemail,the
FROM_EMAIL_NOTIFY
willgetthat
Emailintheinbox.
1.2.
EmailReply.php
pageisgoingtoreadtheemailsfrom
FROM_EMAIL_NOTIFY
andItwillposttothemasareplytotherespectivetasksinOrangescrum.
2.
$password
Passwordof
FROM_EMAIL_NOTIFY
3.
client
Changeit,ifyouarenotusingGmail

Afterthissetup,youcanreplytoataskcreated/updatednotificationemailandthatemailreply
willbepostedtoOrangescrumunderthatTask.Thiswillhelpyoutorespondtoataskwhile
onthegofromyourMobile.
(AssumingyourApplicationisin
/var/www/html/orangescrum/
)
1. Enable
extension=php_imap
inyourphp.inifile.
2. Createa
orangescrum.sh
fileinyourserver
3. viorangescrum.sh
(or,openthatfiletowritethebelowcode)
#!/bin/bash
while(true)

do
cd/var/www/html/orangescrum/app/webroot
phpqEmailReply.php1>&2
sleep1
done
4. Givetheexecutepermissionfororangescrum.sh:
chmod+xorangescrum.sh
5. StarttheNohupusingthecommand:
nohupshorangescrum.sh>customout.log
&

Node JS setup (Linux Server)

Makesurethatyouhaveinstalled
Node.js
and
NPM
Install
Socket.io
usingNPM
Install
Forever
FindhowtoaddaJavaScriptfiletorunNode.jsforever.
NowenabletheNODEJS_HOSTwithyourserverdetailson
app/Config/constants.php

Troubleshooting:
Youwillgetthefollowingoutput,ifyouhavenotsetupthedatabaseconfigurationin
thedatabase.php

Youwillgetthebelowoutput,iftheSUB_FOLDERintheconstants.phpfileisnotset
properly.
Ex
.Letyoursubfolderis"orangescrum".
YousetupSUB_FOLDERas
define('SUB_FOLDER','orangescrum')
insteadof
define('SUB_FOLDER','orangescrum/')

Version 1.6.7
02nd May 2015

Changelog
22 Sept 2014 - Release of Orangescrum Installation Manual
24 Sept 2014 - Changes in the Nohup Cron Job setup
26 Sept 2014 - Changes in the Cron Job section and added text for Drive
and Dropbox API.
29 Oct 2014 - Added Node.js setup

You might also like