FAQ Plugin

Check the README for information on license and support information.

Installation instructions

Pre-Installation Checklist (new installation)

Before installing the FAQ plugin for the first time, please make sure you have or know the following:
  1. A working GeekLog installation
  2. A telnet or SSH connection to your web server (although FTP will work). This document will be written assuming you have command line access to your server, but we will note the major differences for FTP users.
  3. The ability to unpack a tarball (file ending in tar.gz).
  4. You know the difference between a path and a URL.
  5. You know how to determine your system paths.
  6. You understand the reference to public_html as described in the GeekLog Pre-Installation checklist.

Installation Instructions (new installation)

Please read this section COMPLETELY before beginning.
  1. Unpack the tarball *within* your geeklog plugin directory by running the following in your shell (this assumes you have ssh access and that you are working with the tarball on the designated server - this can be locally or hosted elsewhere): 
    cd /path/to/geeklog/plugins
tar -zxvf /path/to/tarball/faq_1.1.0_1.5.0.tar.gz
    FTP, Windows Users: unpack the tarball on your local computer and upload the result to your designated server. Everything uploads as ASCII except the images.

    The result of this step should be a new folder named faq located at /path/to/geeklog/plugins/faq.

  2. For *nix installations the following may be required: 
    chown -R webuser:webuser /path/to/geeklog/plugins/faq
    This guarantees that everything in that path belongs to you, typical settings are www:www or nobody:nobody and more often than not doesn't matter.
  3. Move the plugin public_html directory to the geeklog directory, renaming it to faq by running the following in your shell: 
    cd /path/to/geeklog
mv plugins/faq/public_html public_html/faq
  4. Move the plugin admin directory to the geeklog admin/plugins directory, renaming it to faq by running the following in your shell: 
    cd /path/to/geeklog
mv plugins/faq/admin public_html/admin/plugins/faq
  5. Open the /path/to/geeklog/plugins/faq/config.php file and potentially change any of the default settings.
  6. Go to the plugin administration panel on your geeklog site: 
    http:/your_geeklog_url/admin/plugins.php
    You should see the faq plugin listed at the bottom under New Plugin. Hit the Install link and the plugin will install.

Pre-Upgrade Checklist (upgrade)

Before upgrading the FAQ plugin, please make sure you have or know the following:
  1. You are able to make a new plugin installation - see the Pre-Installation Checklist
  2. You have a newly made complete back up of your current Geeklog installation. This includes all files and a back up of the database.

Upgrade Instructions (upgrade)

Upgrading is no different than a fresh installation except you need to run a upgrade command.
  1. Back up any old FAQ plugin files with custom code. This is typically the plugin config.php (/path/to/geeklog/plugins/faq/config.php) and any change plugin templates.
  2. Back up the database.
  3. You can choose to either rename or remove your current plugin directories. Although in the end you will be deleting the older install it's probably safer to keep the old copy around for a few days *just* in-case you forgot to transfer some files. The directories you should rename/remove are: 
    /path/to/geeklog/plugins/faq
/path/to/geeklog/public_html/faq
/path/to/geeklog/public_html/admin/plugins/faq
  4. From the Installation Instructions, perform step 1 through 4 (uncompressing and copying files). DO NOT perform any other steps than step 1, 2, 3 and 4.
  5. Open the /path/to/geeklog/plugins/faq/config.php file and copy any changes from the old (backed up) file into the new.
  6. Go to the plugin administration panel on your geeklog site: 
    http:/your_geeklog_url/admin/plugins.php
    Your FAQ plugin should be listed as needing an upgrade. Klick the edit icon for the FAQ plugin. On the FAQ plugin editor screen now showing, click the upgrade button and wait for the plugin to complete the upgrade.

Installation Problems (common)

Post-Install Problems (common)

I have installed the plugin but do not understand how it works.
When the plugin is installed it creates a simple FAQ about it self. Please consult this FAQ for more information about the plugin.
If you have a problem not listed here, please do one or more of the following:
  1. Go to https://www.geeklog.net and search there. If the search does not help you, try asking a question in the forum there.
  2. Go to Github FAQ Repository and see if you can find any additional information about your problem (try searching for the error message, if you get one).
  3. Try entering the text of the error message on Google. Chances are you will find someone else who had the same problem and fixed it. And sometimes searching for a specific error will cause Google to bring up broken pages that have the same error.