Install Manual: FMYiRC V1.10

From FMYiRCWiki

Jump to: navigation, search

Install Manual: Freemed-YiRC V1.10


NOTE: This document mostly has not changed since V1.00. Over time, it may be tweaked to include V1.10 idiosyncrasies. Any V1.10 changes will be marked with: (NEW IN V1.10)

Contents


[edit]

Summary

This document details how to get Freemed-YiRC V1.10 up and running from the freemed_yirc-v1.10.tar.gz distribution file on a server already loaded with Linux without using the FMYiRC Helper CD. This document DOES NOT cover setting up a server from scratch, nor does it go into great detail about getting some of the other required software up and running. It is highly recommended that you instead place FMYiRC on a server by itself and follow the Freemed-YiRC V1.10 MDV2007.1 Installation Manual!!!


[edit]

Other Software Required

  • Linux (Windows is no longer supported)
    • FMYiRC has been tested for years using Mandriva Linux (previously Mandrake Linux). However, other Linux distributions may work fine, provided the following required packages are installed.
  • PHP5 is recommended. FMYiRC V1.10 may still work on systems with PHP4, but this is currently untested. PHP6 is not supported at this time.
    • The following lines in the stock php.ini (typically /etc/php.ini) file MUST be changed!
      • These changes will be fixed in FMYiRC V2.00 as PHP6 depricates these, but for V1.10, they are absolutely required.
        • magic_quotes_gpc MUST be set to On
          • magic_quotes_gpc = On
        • register_globals MUST be set to On
          • register_globals = On
      • These changes are also helpful for uploading larger files into FMYiRC. By default, PHP does not allow for files larger than 2MB to be uploaded. The following changes this to 24MB (the upper limit for PHP). (NEW IN V1.10)
        • post_max_size should be set to 24M
          • post_max_size = 24M
        • upload_max_size should be set to 24M
          • upload_max_size = 24M
    • You may also wish to edit /etc/php.d/Z99_suhosin.ini in order to make the spell checker accept longer notes.
      • Set suhosin.get.max_value_length to 65000
        • suhosin.get.max_value_length = 65000
    • The following PHP modules are required (and may in turn require other packages to be installed):
      • php-gd - for IRS Graphing
      • php-pspell - for spell checking
      • php-xml & php-dom (php-domxml)
        • May be depricated due to efforts to remove old XML code...
      • php-cgi
      • php-cli - To run background FMYiRC processes (fy_nightly, etc...)
      • php-ini
      • php-ssh2 - To run SSH/SCP commands through PHP (FTPSCP module)
  • MySQL (PostgreSQL is no longer supported)
    • In /etc/my.cnf
      • max_allowed_packet should be set to 24M. Otherwise, uploaded pictures may be too big to store in the DB!
        • max_allowed_packet = 24M
  • html2ps - For FMYiRC printing
    • html2ps command should be placed into /usr/bin
      • Configure with ./configure --prefix=/usr
    • May need to edit the html2ps command and place #! /usr/bin/perl as first line
      • If so, get rid of original first line (starts with a colon)
    • Must be chmod a+s for web use!
      • chmod a+s /usr/bin/html2ps
    • FMYiRC distribution contains a config file:
      • Copy .html2psrc file to /usr/lib/html2ps/html2psrc
    • (NEW IN V1.10): If you have installed Freemed-YiRC V1.10 from scratch, then html2ps has already been modified to enable the use of images/pictures. However, if you are upgrading from V1.00, you need to do the following to get the html2ps program from V1.00 working with images:
      • Edit /usr/bin/html2ps
        • Find the following line (line 36?)
          • ImageMagick: 0;
        • Change it to:
          • ImageMagick: 1;
  • makelabels - For label creation in FMYiRC Mailing Lable System (MLS) module
    • makelabels command must place into /usr/bin
      • Configure with ./configure --prefix=/usr
    • Must be chmod a+s for web use!
      • chmod a+s /usr/bin/makelabels
    • May need to modify makelabels command file, comment out line (228?):
      • rcfile = os.environ["HOME"] + '/.makelabelsrc'
      • This line may prevent makelabels from running via the web
    • FMYiRC distribution contains a config file for makelabels, nothing more necessary
  • netpbm - For converting various graphics formats
  • ImageMagick - For converting BMP image files to JPG images in Contact DB File Upload (using convert)
  • HTMLArea (3.0 Beta or above) - For FMYiRC Word Processor and Service Plan modules.
    • This is expected to reside in /var/www/html/htmlarea
    • May require perl-Text-Aspell module for HTMLArea spell-checker to function.
  • (NEW IN V1.10): R - For creating very nice looking graphs (Incident Report System module, Ohio Scales module, more in the future)
    • Also required is the Cairo module for R. This is required in order to create the images FMYiRC uses in reports.
  • (NEW IN V1.10): HTMLDOC - Used to create PDFs in FMYiRC.
[edit]

Freemed-YiRC V1.10 Distribution File Install

  • Copy the FMYiRC distribution freemed_yirc-v1.10.tar.gz file into your webserver directory (typically /var/www/html)
    • cp freemed_yirc-v1.10.tar.gz /var/www/html
  • Go into your webserver directory
    • cd /var/www/html
  • Untar/uncompress the file
    • tar -xzvf freemed_yirc-v1.10.tar.gz
  • Fix the permissions of the new FMYiRC directory and files
    • chmod 755 /var/www/html/freemed-yirc
    • chown root.root /var/www/html/freemed-yirc
    • cd /var/www/html/freemed-yirc
    • ./FIXPERMS
  • Because Freemed-YiRC V1.10 is PHP-based, using scripts and not compiled programs, FMYiRC does NOT need to be compiled (i.e., no ./configure;make;make install is necessary)


[edit]

Post FMYiRC Install

You'll also need to do the following for some of the FMYiRC modules to work correctly:

  • Create /home/fmyirc-files and /home/fmyirc-filestorage directories
    • mkdir /home/fmyirc-files
    • chown apache.apache /home/fmyirc-files
    • chmod 755 /homefmyirc-files
    • mkdir /home/fmyirc-filestorage
    • chown apache.apache /home/fmyirc-filestorage
    • chmod 755 /home/fmyirc-filestorage
  • Set up FMYiRC scheduler/maintenance script to run EVERY MINUTE
    • echo "* * * * * root /var/www/html/freemed-yirc/fmyirc_cron" >> /etc/crontab
  • Set up FMYiRC Behavioral Objectives Log Updater to run nightly.
    • echo "30 0 * * * root /var/www/html/freemed-yirc/fmyirc_cron_bh" >> /etc/crontab


[edit]

Initial Database Setup

You'll need to do the following to get FMYiRC up and running with MySQL:

  • Configure Freemed-YiRC to know how to connect to your MySQL.
    • Copy the freemed_yirc-vars.inc.sample to freemed_yirc-vars.inc
      • cd /var/www/html/freemed-yirc
      • cp freemed_yirc-vars.inc.sample freemed_yirc-vars.inc
    • Edit freemed_yirc-vars.inc
      • In particular, you may need to modify the $fydb_user and $fydb_password variables if the root user cannot connect to your MySQL server via localhost with no password.
  • Issue the RELOAD command from the DB/mysql directory so FMYiRC can initialize the freemed_yirc database and tables.
    • cd /var/www/html/freemed-yirc/DB/mysql
    • ./RELOAD


[edit]

What's Next?

Congratuations! Your FMYiRC server should now be ready to access from a web browser.

To access, please point a computer with a web browser and network connection to: https://IP_ADDRESS/freemed-yirc/

NOTES:

  • If you omit the /freemed-yirc/ portion of the above address, you may only see a blank page. This is a security feature to reduce unwanted access to your server.
  • If you omit only the final forward slash (/), you may also receive an error or time-out. Unless your FMYiRC server is configured with a Fully Qualified Domain Name, you should ALWAYS include the final forward slash!
  • In addition, you will receive an error if you use http instead of https. This is also a security feature.

At this point, you may wish to view the following documents:

Retrieved from "http://freemed-yirc.familyandyouth.org/freemed-yirc/wiki/index.php/Install_Manual:_FMYiRC_V1.10"
Personal tools