Yoxel Systems v1.26 (beta) 11 Jan, 2010 YOXEL SW - Software project management + Customer Support Portals YOXEL KB - Knowledge Base / Q&A management YOXEL IT - IT project management + Customer Support Portals Before installing this software we recommend you to visit our web site http://yoxel.com and login to a demo account to see if this is what you are looking for. The key functionality demonstrated there is available in this package. We also host an on-demand version of Yoxel at http://yoxel.com so it could be easier for you to just sign-up for an account and use that. Most of the on-demand services are free. You can always request your MySQL database from us in case you want to switch to using this open-source version. For any help with installation or customisation do not hesitate to contact us directly at support@yoxel.com or through other support options available at our web site: http://yoxel.com/asp/support.php Please visit Yoxel Knowledge (Q&A) Base to ask questions and search the existing database of answers: http://yoxel.com/asp/support.php THIS SOFTWARE REQUIRES [Unix, Apache, MySQL, PHP5]: -------------------------------------------------- - MySQL server >=v4.1 - Apache web server >= 1.3 - PHP5 >= 5.2.0 with bundled PCRE >= 6.6 - Perl >=5.8 if you plan to connect Yoxel to an external bug-tracker (i.e. Bugzilla) (In PHP 5.2.0 the bundled PCRE was upgraded to 6.7 which supports UTF-8 based Perl regular expressions. Earlier versions of PCRE have problems with such regular expressions, which are now used throughout Yoxel's code. For more details refer to http://www.php.net/ChangeLog-5.php) PHP compilation 'configure' options: ------------------------------------ ** The following option is mandatory to build php_mod for Apache/Apache2: --with-apxs[=] or --with-apxs2[=] ** The following option is mandatory, as Yoxel communicates with MySQL: --with-mysql[=] ** The following option is mandatory, as our code has adopted UTF-8: --enable-mbstring ** Make sure you are not using the following option: --disable-all ++ This one is required if you plan to use LDAP based authentication: --with-ldap[=] [--with-ldap-sasl[=]] ++ This one is required if you plan to use email integration utility utils/imap_mail_handler.php: --with-imap[=] [--with-imap-ssl] ++ These are required if you decide to add 'jpgraph': --with-freetype-dir= --with-jpeg-dir= --with-png-dir= --with-zlib-dir=/usr --with-gd --enable-gd-native-ttf php.ini: -------- register_globals=Off, memory_limit = 64M // mostly for jpgraph; HOW TO INSTALL: --------------- 1. Unpack and install the files: a. Locate your webroot directory on your web server. Common locations for webroot include (your httpd.conf will tell you exactly): /var/www/htdocs or /var/www/html/ (Linux/Apache) /usr/local/www/apache22/data (FreeBSD/Apache22) b. gunzip/untar the tarball into your webroot. A yoxel_v* directory is automatically created within the webroot (rename this directory if desired). 2. Make sure Apache can access Yoxel files, then secure up Apache configuration: a. Your Apache httpd server is usually run under a specific UID/GID (www, apache, httpd, ...). Change the owner/group of the yoxel directory to that UID/GUID. Usually something like this will do: chown -R www chgrp -R www chmod -R o-rwx Another way (NOT SECURE), of allowing the httpd server UID to see the files in the directory is: chmod -R a+r * b. Your default Apache configuration leaves the yoxel/includes directory and all .inc and _inc.php files vulnerable for reading. We suggest securing it with the following directives: Order allow,deny Deny from all Satisfy All Order allow,deny Deny from all Satisfy All 3. Copy includes/yoxel-config.inc.sample file to includes/yoxel-config.inc and edit the new file. (See comments inside the file for more information.) By default Yoxel is set up to run in a debug mode ($production_mode=FALSE), without HTTS(SSL). We would recommend to continue using Yoxel in the debug mode in the beginning to make sure everything works properly. - To turn off the debug mode ($production_mode=TRUE) remove .debug file from Yoxel's root directory. 4. Make sure that the MySQL user specified in the includes/yoxel-config.inc file exists and has the following privileges: *Select, *Insert, *Update, *Delete, *Lock_tables, *Create That can be set by MySQL root user using the following MySQL command: (*Note: Instead of local_yoxeldb2 use whatever name you have specified by YXL_DB_NAME config parameter.) GRANT CREATE, SELECT, INSERT, UPDATE, DELETE, LOCK TABLES ON local_yoxeldb2.* TO 'yoxel_sw'@'localhost' IDENTIFIED BY 'mypasswd'; Or by modifying mysql.user and mysql.db tables directly: USE mysql; INSERT INTO user (Host, User, Password) VALUES ('localhost', 'yoxel_sw', PASSWORD('mypassword')); INSERT INTO db (Host, Db, User, Create_priv, Select_priv, Insert_priv, Update_priv, Delete_priv, Lock_tables_priv) VALUES ('localhost', 'local\_yoxeldb2', 'yoxel_sw', 'Y', 'Y', 'Y', 'Y', 'Y', 'Y'); FLUSH PRIVILEGES; (See these links for more details: http://dev.mysql.com/doc/refman/5.1/en/privilege-system.html http://dev.mysql.com/doc/refman/5.1/en/user-account-management.html) 5. Login to Yoxel by pointing your web browser to http:/// username: password: UPGRADES: --------- If you are upgrading from a previous version of Yoxel you MUST READ information provided in UPGRADE.txt file. You may have to alter your MySQL/Yoxel tables for the current version to work properly. *** v1.26: Some database tables have to be altered. Please read UPGRADE.txt for more details. ADDITIONAL FUNCTIONALITY: ------------------------- ezpdf - We include a slightly modified version of this public domain package developed by R&OS Ltd (http://www.ros.co.nz/pdf) to enable PDF output for our reporting system. (UTF-8 support is absent at the moment) PEAR/Spreadsheet::WriteExcel - you can install this PEAR module developed by Xavier Noguer under pear/ subdirectory to enable Excel output for our reporting system. (UTF-8 support is absent at the moment) jpgraph - you can enable charts and graphs by installing JPGRAPH package. Download and unpack it (http://www.aditus.nu/jpgraph/) and then place its 'src' directory as 'jpgraph' in Yoxel root-dir. DEFINE("CATCH_PHPERRMSG",false); # in jpgraph/jpg-config.inc.php Bugzilla/GNATS/Retrospectiva/Mantis/Trac import&sync module - Read the instructions in XBTS.Bugzilla file and see the blog article: http://yoxel.wordpress.com/2007/10/09/bugzilla-yoxel-synchronization-module/ (Setting up this module sometimes gets tricky so please do not hesitate to contact us at support@yoxel.com. We will help you make it work.) **Please, visit our public Knowledge Base for more details: http://yoxel.com/asp/support.php . SUPPORT (support@yoxel.com): ---------------------------- Check out our web site http://yoxel.com for the latest product news, support options, detailed product information, and much more. Please send us your feedback! Enjoy! Yoxel Systems www.yoxel.com