[ Index ] |
PHP Cross Reference of Eventum |
[Summary view] [Print] [Text view]
1 2 Installation Process 3 ==================== 4 5 Installation is pretty simple and quick. Eventum already bundles the libraries 6 that it needs to work properly: 7 8 - JpGraph 1.5.3 (last GPL version) 9 - Smarty 2.6.18 (http://smarty.php.net) 10 - PEAR packages: 11 Auth_SASL 1.0.2 12 Benchmark 1.2.7 13 DB 1.7.13 14 Date 1.4.7 15 HTTP 1.4.0 16 HTTP_Request 1.4.2 17 Mail 1.1.14 18 Mail_Mime 1.5.2 19 Mail_mimeDecode 1.5.0 20 Net_DIME 0.3 21 Net_POP3 1.3.6 22 Net_SMTP 1.2.10 23 Net_Socket 1.0.8 24 Net_URL 1.0.15 25 PEAR 1.6.2 26 Text_Diff 0.3.1 27 XML_RPC 1.5.1 28 - dTree 2.0.5 (http://www.destroydrop.com/javascript/tree/) 29 - dynCalendar.js (http://www.phpguru.org/dyncalendar.html) 30 - overLIB 3.5.1 (http://www.bosrup.com/web/overlib/) 31 - A few other small javascript libraries 32 33 Anyway, all you should have to do is place the Eventum files in a directory that 34 is viewable from the web, and open it up with your browser. Eventum should 35 redirect you to the installation screen, and it will try to guess some of 36 required parameters, like path in the server and etc. 37 38 http://yourserver.com/eventum/ 39 40 If Eventum's installation script finds that it needs a few directories or 41 permissions changed, it will print the warnings before actually displaying 42 the installation screen. So just fix what it says it's wrong/missing and 43 everything should go well. 44 45 After the installation is done, you should go and take all of the available 46 privileges from the '/setup' directory, so other people are not allowed to 47 go in there and mess with your configuration. 48 49 IMPORTANT: If you already have an installation of Eventum, please read the 50 UPGRADE file. 51 52 IMPORTANT: If you are having trouble getting Eventum to work, please read 53 the trouble shooting section of the FAQ file and visit 54 http://eventum.mysql.org 55 56 57 58 Setting Up The Required Cron Scripts 59 ==================================== 60 61 1)- Mail Queue Process (misc/process_mail_queue.php) 62 63 Beginning with the first release of Eventum, emails are not directly sent out 64 from the various scripts, but rather added to a mail queue table that is 65 processed by a cron job. If an email cannot be sent, it will be marked as such 66 in the mail queue log, and the cron job script will re-try to send it again the 67 next time it runs. 68 69 * * * * * cd /path-to-eventum/misc; /usr/bin/php process_mail_queue.php 70 71 The above line will run the mail queue script every minute. To setup the SMTP 72 server that Eventum should use to send these queued emails, go to: 73 74 Administration >>> General Setup > SMTP (Outgoing Email) Settings 75 76 77 2)- Email Download (misc/download_emails.php) 78 79 In order for Eventum's email integration feature to work, you need to setup a 80 cron job to run the script above every so often. The following is an example of 81 the required crontab line: 82 83 0 * * * * cd /path-to-eventum/misc; /usr/bin/php download_emails.php username_here mail.domain.com INBOX 84 85 The above will run the command every hour, and will download emails associated 86 with the given email account. If you have more than one email account, you may 87 add another crontab entry for the other accounts. To setup the email integration 88 feature with the appropriate email accounts, go to: 89 90 Administration >>> Manage Email Accounts 91 92 You can also call the download_emails script via the web, using the following URL: 93 http://eventum_server/path-to-eventum/misc/download_emails.php?username=username_here&hostname=mail.domain.com&mailbox=INBOX 94 95 96 3)- Reminder System (misc/check_reminders.php) 97 98 The reminder system was designed with the objective as serving as a safe net 99 for issues that need attention. Depending on what configuration you create, you 100 may have several reminders (or alerts) be sent out whenever an issue needs 101 attention, for whatever parameter you may deem necessary. 102 103 */10 * * * * cd /path-to-eventum/misc; /usr/bin/php check_reminders.php 104 105 It is recommended that you run the reminder cron job every 10 minutes, so it 106 won't flood you with alerts too often, but it would still be enough to handle 107 most cases. 108 109 110 4)- Heartbeat Monitor (misc/monitor.php) 111 112 The heartbeat monitor is a feature designed for the administrator that wants to 113 be alerted whenever a common problem in Eventum is detected, like the database 114 server not being available anymore, or maybe when the recommended permissions 115 for certain configuration files are changed. Please note that before running 116 the heartbeat monitor, you may need to customize some of the checks to be 117 appropriate for your own system, particularly the permission and file checks on 118 Monitor::checkConfiguration(). 119 120 */10 * * * * cd /path-to-eventum/misc; /usr/bin/php monitor.php 121 122 123 124 125 Other Features Requiring System Setup 126 ===================================== 127 128 Note: Starting with Eventum 1.5.2 there is a new way of routing emails,notes 129 and drafts. You will need to setup up a wild card address to route all 130 messages that should be in eventum (usually issue-<number>@<domain>, 131 note-<number>@<domain> and draft-<number>@<domain>) to an email account. Then 132 add that email account to eventum by going to the email account administration 133 page: 134 135 Administration >>> Manage Email Accounts 136 137 When setting up the account, check 'Use account for email/note/draft routing'. 138 Once the account is added, set the account to be downloaded as describe above 139 (2)- Email Download). 140 141 142 1)- Email Routing Script (misc/route_emails.php) 143 144 The email routing feature is used to automatically associate a thread of emails 145 into an Eventum issue. By setting up qmail (or even postfix) to deliver emails 146 sent to a specific address (usually issue-<number>@<domain>) to the above 147 script, users are able to use their email clients to reply to emails coming from 148 Eventum, and those replies will be automatically associated with the issue and 149 broadcasted to the entire notification list. 150 151 The entire email message should be passed as standard input to the script, and 152 the only parameter to it should be email account to which this email should be 153 associated with. The following is an example of a successful run of this script: 154 155 cat example_email.txt | php route_emails.php 1 156 157 This script also saves any routed messages it receives in a separate directory, 158 so you would never lose emails. Create a 'routed_emails' sub-directory under 159 /path-to-eventum/misc/ and setup the proper permission bits on it. 160 161 IMPORTANT: Please be aware that depending on the MDA that you are using (qmail, 162 postfix or whatever), you may need to manually change the exit codes used in 163 this script to handle the proper signals to the MDA. For example, postfix uses 164 exit code 78 to signal a configuration problem, but other agents may need 165 different exit codes. 166 167 168 2)- Note Routing Script (misc/route_notes.php) 169 170 The note routing feature is used to automatically associate a thread of notes 171 into an Eventum issue. By setting up qmail (or even postfix) to deliver emails 172 sent to a specific address (usually note-<number>@<domain>) to the above 173 script, users are able to use their email clients to reply to internal notes 174 coming from Eventum, and those replies will be automatically associated with 175 the issue and broadcasted to the notification list staff members. 176 177 The entire email message should be passed as standard input to the script. The 178 following is an example of a successful run of this script: 179 180 cat example_note_email.txt | php route_notes.php 181 182 This script also saves any routed messages it receives in a separate directory, 183 so you would never lose notes. Create a 'routed_notes' sub-directory under 184 /path-to-eventum/misc/ and setup the proper permission bits on it. 185 186 IMPORTANT: Please be aware that depending on the MDA that you are using (qmail, 187 postfix or whatever), you may need to manually change the exit codes used in 188 this script to handle the proper signals to the MDA. For example, postfix uses 189 exit code 78 to signal a configuration problem, but other agents may need 190 different exit codes. 191 192 193 3)- Draft Routing Script (misc/route_drafts.php) 194 195 The draft routing feature is used to automatically associate a thread of drafts 196 into an Eventum issue. By setting up qmail (or even postfix) to deliver emails 197 sent to a specific address (usually draft-<number>@<domain>) to the above 198 script, users are able to send drafts written in their mail client to be stored 199 in Eventum. These drafts will NOT broadcasted to the notification list. 200 201 The entire email message should be passed as standard input to the script. The 202 following is an example of a successful run of this script: 203 204 cat example_draft_email.txt | php route_drafts.php 205 206 This script also saves any routed messages it receives in a separate directory, 207 so you would never lose drafts. Create a 'routed_drafts' sub-directory under 208 /path-to-eventum/misc/ and setup the proper permission bits on it. 209 210 IMPORTANT: Please be aware that depending on the MDA that you are using (qmail, 211 postfix or whatever), you may need to manually change the exit codes used in 212 this script to handle the proper signals to the MDA. For example, postfix uses 213 exit code 78 to signal a configuration problem, but other agents may need 214 different exit codes. 215 216 217 4)- IRC Notification Bot (misc/irc/bot.php) 218 219 The IRC notification bot is a nice feature for remote teams that want to handle 220 issues and want to have a quick and easy way to get simple notifications. Right 221 now the bot notifies of the following actions: 222 223 - New Issues 224 - Blocked emails 225 - Issues that got their assignment list changed 226 227 To invoke the notification bot and let it running on the server, this is the 228 proper command: 229 230 php bot.php & 231 232 NOTE: You will need to manually edit config/irc_config.php to set your appropriate 233 preferences, like IRC server and channel that the bot should join. An example 234 config file is located in setup/irc_config.php 235 236 237 5)- Command-line Interface (misc/cli/eventum) 238 239 The Eventum command-line interface allows you to access most of the features 240 of the web interface straight from your command shell. In order to install it, 241 you will need PHP and if you use SSL, the curl and openssl PHP extensions. 242 243 Assuming you have the requirements properly setup:: 244 245 - Just copy the path-to-eventum/misc/cli directory to another location (e.g. 246 copy to ~/bin/) 247 - Add that location to your PATH environment variable 248 - Set the required permission in the script (chmod 700 ~/bin/cli/eventum) 249 - Copy the new .eventumrc example file to your home directory 250 (cp ~/bin/cli/eventumrc_example ~/.eventumrc) 251 -> Edit ~/.eventumrc and set the appropriate values in there 252 - Run it (eventum --help) 253 - Test it with 'eventum 1' (display issue #1 details) 254
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
Generated: Wed Dec 19 21:21:33 2007 | Cross-referenced by PHPXref 0.7 |