Difference between revisions of "How To Install A Geeklog Plugin"

From GeeklogWiki
Jump to: navigation, search
(link to plugin installation overview image)
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
Note: Up until Geeklog version 1.3.4, there was an automatic install procedure for plugins. This, however, caused too many problems and support issues and has been removed from later versions. The manual install as outlined below is now the recommended way to install a plugin and should work for both old and new versions of Geeklog.
+
For details, you should always refer to the README that comes with the plugin. In general, however, a plugin will be installed like this:
  
−
For details, you should always refer to the README that comes with the plugin. In general, however, a plugin will be installed like this:
+
# Depending on your setup and server access, you should either upload the tarball and unpack it remotely or unpack the tarball locally and upload the extracted files and folders afterwards.
 +
# The <tt>public_html</tt> directory in the tarfile is copied to the webtree under <tt><plugin name></tt>. e.g. if my Geeklog web is in <tt>/path/to/geeklog/public_html/</tt> then the <tt>public_html</tt> from the tarfile is copied to <tt>/path/to/geeklog/public_html/<plugin name></tt>
 +
# The <tt>admin</tt> directory in the tarfile is copied to the admin webtree.  e.g. if my Geeklog admin webtree is in <tt>/path/to/geeklog/public_html/admin/</tt> then the <tt>admin</tt> directory from the tarfile is copied to <tt>/path/to/geeklog/public_html/admin/plugins/<plugin name></tt>
 +
# Log into your Geeklog site and go to the Plugins admin panel (from the [[Admins Block]])
 +
#* If this is a new install (plugin doesn't exist in the <tt>gl_plugins</tt> table), then you should find it listed in the "New Plugin" section at the end of the Plugins page. Click on the "Install" link there to initiate the plugin install.
 +
#* If this is an upgrade, then you should find the plugin listed with the other installed plugins, sporting a note asking you to update it. Click on the edit link (the little pen icon). On the next page, you will find an "Update" button. Click it to initiate the plugin update.
 +
# That's it!
 +
 
 +
There's also a [[Plugins#Installation|graphical overview]] of the above steps.
  
−
#Depending on your setup and server access, you should either upload the tarball and unpack it remotely or unpack the tarball locally and upload the extracted files and folders afterwards.
 
−
#The public_html directory in the tarfile is copied to the webtree under <plugin name>. e.g. if my geeklog web is in /path/to/geeklog/public_html/ then the public_html from the tarfile is copied to /path/to/geeklog/public_html/<plugin name>
 
−
#The admin directory in the tarfile is copied to the admin webtree.  e.g. if my geeklog admin webtree is in /path/to/geeklog/public_html/admin/ then the admin directory from the tarfile is copied to /path/to/geeklog/public_html/admin/plugins/<plugin name> 
 
−
#Call the plugins install script at http://yourgeeklogsite/admin/plugins/<plugin name>/install.php
 
−
#*If this is a new install (plugin doesn't exist in plugins table) then table.sql is executed and then data.sql is executed
 
−
#*If this is an upgrade that the necessary upgrade_<version>.sql script is searched for and, if found, executed.
 
−
#That's it!
 
  
−
[[Category:Plugin Development]]
+
[[Category:Plugin Development]] [[Category:Plugins]]

Latest revision as of 12:29, 5 June 2009

For details, you should always refer to the README that comes with the plugin. In general, however, a plugin will be installed like this:

  1. Depending on your setup and server access, you should either upload the tarball and unpack it remotely or unpack the tarball locally and upload the extracted files and folders afterwards.
  2. The public_html directory in the tarfile is copied to the webtree under <plugin name>. e.g. if my Geeklog web is in /path/to/geeklog/public_html/ then the public_html from the tarfile is copied to /path/to/geeklog/public_html/<plugin name>
  3. The admin directory in the tarfile is copied to the admin webtree. e.g. if my Geeklog admin webtree is in /path/to/geeklog/public_html/admin/ then the admin directory from the tarfile is copied to /path/to/geeklog/public_html/admin/plugins/<plugin name>
  4. Log into your Geeklog site and go to the Plugins admin panel (from the Admins Block)
    • If this is a new install (plugin doesn't exist in the gl_plugins table), then you should find it listed in the "New Plugin" section at the end of the Plugins page. Click on the "Install" link there to initiate the plugin install.
    • If this is an upgrade, then you should find the plugin listed with the other installed plugins, sporting a note asking you to update it. Click on the edit link (the little pen icon). On the next page, you will find an "Update" button. Click it to initiate the plugin update.
  5. That's it!

There's also a graphical overview of the above steps.

Retrieved from "http://gwiki3.thatlinuxbox.com/index.php?title=How_To_Install_A_Geeklog_Plugin&oldid=5516"