DailyQuote Plugin - Install Document

DailyQuote Plugin Version 1.0.5
by Alford Deeley aka machinari

Last Modified: Dec 15, 2004
E-mail: ajdeeley@summitpages.ca
Web site: http://summitpages.ca

DailyQuote Plugin 1.0.5
1. Introduction
2. License
3. Installation
4. Upgrade
5. Uninstall

1. Introduction This is the DailyQuote plugin using the GL Plugin API calls--some of them. It's most basic function displays a random quote in a PHP block or a center block. It is configurable to deliver much more functionality than simply displaying a random quote, e.g.: quotes may be cached; quotes may be searched and displayed; quote submissions may be moderated; permissions are configurable; and more. See the usage.html doc in the <geeklog_dir>/plugins/dailyquote/docs.
2. License This GeekLog Plug-in, like GeekLog is released under the GNU General Public License. It is a bona fide Open Source / Free Software project. Like all good open source projects, GeekLog and this Plug-in both depend on the community. Thanks for your continued support, and let us know what we can do to make GeekLog and the plugin even better.
3. Installation It is recommended that you read and reference the Plugin Installation Overview documentation located on the GeekLog Documentation Project site. There is a lot more detail on how to install plugins including annotated images. The Plugin installation requires that you manually create the plugin program directories and copy the program files into their appropriate directories.
   1. Database backup
      Make a backup of your current GeekLog database using the built-in admin feature. Verify your backup feature is configured correctly and backup file is not 0 bytes (This is worth a check)
   2. Copy plugin files into their required directories
      - Need to create these directories as noted below:
      uncompress the archive files into your <geeklog_dir>/plugins directory. It will create a dailyquote/ directory and associated subdirectories for the files. You will need to move the files in the admin and public subdirectories to their appropriate directory as indicated below.
      1. public_html/
         - Main program files
         The files in the public directory under your new plugins/dailyquote/ folder need to be moved to <geeklog_dir>/public_html/dailyquote/ directory. You will need to first create the: <geeklog_dir>/public_html/dailyquote/ directory.
      2. admin/
         -Plugin Install and Main admin program files
         The files in the admin directory under your new plugins/dailyquote/ folder need to be moved to <geeklog_dir>/public_html/admin/plugins/dailyquote/ directory. You will need to first create the: <geeklog_dir>/public_html/admin/plugins/dailyquote/ directory.
      3. Directory and File Permissions
         Directory and File owner should be same as web server
         All the files and directories should have Read permissions and directories need execute. Setting all plugin files and directories to have read + execute should not be a security issue but PHP files only need read access to execute. The directories need execute rights in order for them to be searched or accessed.
         The data/ dir, <pubilc_html>/dailyquote/data/, must be writable if you intend to use the batch add function.
   3. Run the install program
      
      1. Logged in as admin
         In your browser, go to http://your_geeklog_url/admin/plugins/dailyquote/install.php
         Note: The installer is designed to back out any database changes if there should be an error. You can monitor the installer by viewing the error.log, file <geeklog_dir>/logs/error.log.
      2. Verify successful operation
         Did you get a successful completion message that your database tables have been created--this message is found in your error log.
         There should now be a DailyQuote link in your top header. If not, refresh the page.
         As admin, you should see the DailyQuote menu item in the Admin Block.
      3. Check the install logging in the <geeklog_dir>/logs/error.log file
      4. One last step:
         You should now see a <public_html>/dailyquote/data/ directory. This directory must be made writable if you are going to add quotations using the batch add function or if you plan on using the database backup utility. If you do not see this directory then it will have to be created.
      5. To make use of the extended user's profile, read the "Profile Display Integration" section of usage.html.
4. Upgrade:
   • If you are upgrading from 1.0.5rc1, you need only to replace your files. No database changes were made.
   • If you are upgrading to 1.0.5, you need to create a new directory named <data/> under your <public_html>/dailyquote/ directory and make it writable. This dir will now be the temp directory for the batch add function as well as the directory responsible for housing the database backups. the <geeklog_dir>/plugins/dailyquote/tmp/ directory is no longer necessary and can be deleted. To make use of the extended user's profile, read the upgrade section of usage.html.
   • If you are upgrading from 1.0.4 to 1.0.5, be aware of one database change making it necessary to run the update script found in <geeklog_dir>/plugins/dailyquote/updates/. A number of files have been changed so you'll need to copy those over your old files remembering to take note of custom changes that you have made so those changes can be reapplied.
   • If you are upgrading from any other version to 1.0.5, be sure to apply all relevant update scripts in the proper order. All update scripts are found in <geeklog_dir>/plugins/dailyquote/updates/. A number of files have been changed so you'll need to copy those over your old files remembering to take note of custom changes that you have made so those changes can be reapplied.
   • See the change.log for changes. There is no list of changed files.
5. Uninstall:
   1. Go to Admin Block/Plugins
      Find the plugin in the list of plugins, click the number, then press Delete, confirm (or not) deletion, this will remove all the plugin data from your database.
   2. Delete the three plugin directories created in the install process: plugins/dailyquote/; <public_html>/dailyquote/; and /plugins/dailyquote/.