DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin_installation_instructions

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
Both sides next revision
plugin_installation_instructions [2016-02-21 16:17]
2003:76:6e4f:6001:359b:e64c:ef16:52ba [With a Plugin Package File]
plugin_installation_instructions [2018-05-26 22:44] (current)
Klap-in only Extension manager, simplify manual install
Line 5: Line 5:
 ===== Automatic Installation ===== ===== Automatic Installation =====
  
-Most plugins can be installed automatically using the [[plugin:extension|extension manager]] (since Ponder Stibbons) or the [[plugin:plugin|plugin manager]] (before Ponder Stibbons). Each tool itself is an independent plugin. The extension manager lets you install a plugin by clicking the "install" button. This is by far the quickest and least error prone way to install plugins. Refer to [[plugin:plugin#installing_a_plugin_from_a_remote_url|installation instructions for using the plugin manager]]. +Most plugins can be installed automatically using the [[plugin:extension|extension manager]] (since Ponder Stibbons). The extension manager lets you search and directly install a plugin by clicking the "Install" button. This is by far the quickest and least error prone way to install plugins. Refer to [[plugin:extension#usage|instructions for using the extension manager]]. 
  
-There are some circumstances where it is not possible to use the plugin or extension manager to install a plugin: +There are some circumstances where it is not possible to use the extension manager to install a plugin: 
-  * [[ACL]] is not enabled. The plugin/extension manager is accessed via the [[admin_window|admin menu]] which makes it only available on wikis with ACL enabled. Even in a completely public wiki it can be worth enabling ACL to gain access to DokuWiki's admin functions, like the plugin manager. +  * [[ACL]] is not enabled. The extension manager is accessed via the [[admin_window|admin menu]] which makes it only available on wikis with ACL enabled. Even in a completely public wiki it can be worth enabling ACL to gain access to DokuWiki's admin functions, like the extension manager. 
-  * No plugin package. The plugin/extension manager requires a specially prepared archive containing the plugin files. +  * No plugin package. The extension manager requires a specially prepared archive containing the plugin files. 
-  * The webserver doesn't have write access to DokuWiki's ''lib/plugins'' directory. The plugin/extension manager needs to be able to add the new plugin to this directory.+  * The webserver doesn't have write access to DokuWiki's ''lib/plugins'' directory. The extension manager needs to be able to add the new plugin to this directory.
   * Developers building their own plugins from scratch. Developers should read about [[devel:plugin file structure]].   * Developers building their own plugins from scratch. Developers should read about [[devel:plugin file structure]].
  
Line 16: Line 16:
  
 ===== Manual Instructions ===== ===== Manual Instructions =====
 +==== Direct access to server filesystem====
 +
 +  * Download the extension and unpack it into ''lib/plugins/<base-plugin-name>''.
 +  * The base name of the plugin can be found in [[:devel:plugin_info|plugin.info.txt]]\\ (e.g. for the gallery plugin its defined by the line ''%%base  gallery%%'')
 +
 +==== Or Using FTP ====
  
 These instructions assume that you don't have console access to your server and will need to upload the files using FTP or the file manager in your server's control panel. These instructions assume that you don't have console access to your server and will need to upload the files using FTP or the file manager in your server's control panel.
  
  
-==== With a Plugin Package File ====+=== With a Plugin Package File ===
  
   - If the plugin has a package file, download that file to your computer. If the plugin comes in different formats, choose the one that fits you best (Windows user will prefer zip).   - If the plugin has a package file, download that file to your computer. If the plugin comes in different formats, choose the one that fits you best (Windows user will prefer zip).
   - Expand (i.e. unzip) the package (See [[install:unpacking]] for some help and utilities). That should give you a directory named after the plugin. Inside that directory you will see files or directories named for the type of plugin (e.g. syntax.php or /syntax/).   - Expand (i.e. unzip) the package (See [[install:unpacking]] for some help and utilities). That should give you a directory named after the plugin. Inside that directory you will see files or directories named for the type of plugin (e.g. syntax.php or /syntax/).
     * **Note:** some decompression software will place all the decompressed files in a directory named after the original archive file. If that is the case you will need to move up one directory to find the directory named for the plugin. This could get confusing if the archive file actually has the same name as the plugin too!     * **Note:** some decompression software will place all the decompressed files in a directory named after the original archive file. If that is the case you will need to move up one directory to find the directory named for the plugin. This could get confusing if the archive file actually has the same name as the plugin too!
-    * **Note:** Many plugin authors host their plugins at github and let github automatically create a ZIP file from the most current check in. These automatically created archives usually contain the wrong foldername. You need to rename the folder to the correct name.\\ Example: unpacking the [[plugin:gallery|Gallery Plugin]] will result in a folder name like ''splitbrain-dokuwiki-plugin-gallery-169c0bb'' -- you need to rename it to ''gallery''.\\ Hint for plugin developersuse the [[:devel:plugin_info|plugin.info.txt]], which will avoid this problem.+    * **Note:** Many plugin authors host their plugins at github and let github automatically create a ZIP file from the most current check in. These automatically created archives usually contain the wrong foldername. You need to rename the folder to the correct name.\\ Example: unpacking the [[plugin:gallery|Gallery Plugin]] will result in a folder name like ''splitbrain-dokuwiki-plugin-gallery-169c0bb'' -- you need to rename it to ''gallery''.\\ Hint:  in the file [[:devel:plugin_info|plugin.info.txt]] you could find the base name (e.g''base  gallery'')
   - Using your file uploader (e.g. FTP or your Control Panel File Manager), on the server navigate to DokuWiki's ''lib/plugins'' directory and upload the plugin directory you just created (on your computer) along with all its contents. The end result should be a new directory on the server, ''lib/plugins/<new-plugin-name>'', containing the files and directories of the plugin.   - Using your file uploader (e.g. FTP or your Control Panel File Manager), on the server navigate to DokuWiki's ''lib/plugins'' directory and upload the plugin directory you just created (on your computer) along with all its contents. The end result should be a new directory on the server, ''lib/plugins/<new-plugin-name>'', containing the files and directories of the plugin.
  
 The plugin is now installed. The plugin is now installed.
  
-==== Without a Plugin Package File ====+=== Without a Plugin Package File ===
  
 Installing a plugin without a package is still quite straightforward, especially for simple plugins that consist of only a few files. However there are more ifs and buts and greater familiarity with DokuWiki and PHP maybe required if some crucial information is not clear from the plugin documentation. Actually making a plugin package is very easy, so if you are totally unfamiliar with PHP it may be worth dropping the plugin author an email politely asking if they can email you the plugin package or at least clarifying the exact name to use for the plugin. Installing a plugin without a package is still quite straightforward, especially for simple plugins that consist of only a few files. However there are more ifs and buts and greater familiarity with DokuWiki and PHP maybe required if some crucial information is not clear from the plugin documentation. Actually making a plugin package is very easy, so if you are totally unfamiliar with PHP it may be worth dropping the plugin author an email politely asking if they can email you the plugin package or at least clarifying the exact name to use for the plugin.
plugin_installation_instructions.1456067864.txt.gz · Last modified: 2016-02-21 16:17 by 2003:76:6e4f:6001:359b:e64c:ef16:52ba