DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:farmer

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
plugin:farmer [2016-07-20 16:20] andiplugin:farmer [2024-11-12 23:50] (current) – version upped andi
Line 6: Line 6:
 email      : dokuwiki@cosmocode.de  email      : dokuwiki@cosmocode.de 
 type       : admin, action type       : admin, action
-lastupdate : 2016-07-20 +lastupdate : 2024-11-12 
-compatible : Elenor of Tsort, !Detritus, !Hrun, !Ponder Stibbons, !Binky+compatible : 2023-04-04, Igor, Hogfather, Greebo, Frusterick Manners, Elenor of Tsort, !Detritus, !Hrun, !Ponder Stibbons, !Binky
 depends    :  depends    : 
 conflicts  conflicts 
Line 21: Line 21:
 ---- ----
  
-This plugin allows you to set up a "DokuWiki Farm" -- a single DokuWiki installation that can be used for many different Wikis ("animals") sharing the same code base but having different content. The plugin is similar to what's described [[:farms|DokuWiki Farms]] but offers more features and sometimes takes a slightly more opinionated approach((it does not use ''inc/farm.php'' but manages the farming on it's own)).+This plugin allows you to set up a "DokuWiki Farm" -- a single DokuWiki installation that can be used for many different Wikis ("animals") sharing the same code base but having different content. The plugin is similar to what's described in [[:farms|DokuWiki Farms]] but offers more features and sometimes takes a slightly more opinionated approach((it does not use ''inc/farm.php'' but manages the farming on it's own)).
  
-The plugin manages to set up the Farm allows to create new animals and lets you manage settings for the different animals. +[[https://www.cosmocode.de/en/open-source/dokuwiki-plugins/|{{ https://www.cosmocode.de/static/img/dokuwiki/dwplugins.png?recache|A CosmoCode Plugin}}]]
- +
-[[http://www.cosmocode.de/en/open-source/dokuwiki-plugins/|{{ http://cosmocode.de/static/img/dokuwiki/dwplugins.png?recache|A CosmoCode Plugin}}]]+
  
 ===== Installation ===== ===== Installation =====
  
-Install the plugin using the [[plugin:plugin|Plugin Manager]] and the download URL above, which points to latest version of the plugin. Refer to [[:Plugins]] on how to install plugins manually.+Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.
  
 ===== Features ===== ===== Features =====
Line 53: Line 51:
  
 The Farmer is a completely functional wiki. You can use it for it's own content, though generally it's recommended to keep the farmer mostly empty and have animals for each topic. The Farmer is a completely functional wiki. You can use it for it's own content, though generally it's recommended to keep the farmer mostly empty and have animals for each topic.
 +
 +The Farmer is the only wiki you need to upgrade and the only wiki where you install and upgrade plugins and templates in.
  
 ==== Animal ==== ==== Animal ====
Line 74: Line 74:
 === (Sub-)-Domain-Based === === (Sub-)-Domain-Based ===
  
-This is the cooler method, but requires a certain setup in your DNS system. Animals are recognized by the domain name. That could be a full qualified domain or a subdomain. To make this work, the domain's web root has to point to the directory the farmer is installed in.+This is the cooler method, but requires a certain setup in your DNS. Animals are recognized by the domain name. That could be a full qualified domain or a subdomain. To make this work, the domain's web root has to point to the directory the farmer is installed in.
  
 So if your farmer is available on ''%%http://yourdomain.com/%%'', an animal could be accessible under ''%%http://foo.yourdomain.com/%%'' or even ''%%http://www.thefoo.wiki/%%''. So if your farmer is available on ''%%http://yourdomain.com/%%'', an animal could be accessible under ''%%http://foo.yourdomain.com/%%'' or even ''%%http://www.thefoo.wiki/%%''.
Line 90: Line 90:
 ===== Farm Setup ===== ===== Farm Setup =====
  
-Once installed, you'll find a new "Farming" entry in the [[:admin_window|Admin window]]. When a farm hasn't been set upyet. The Farm Setup dialog will occur. It allows you to specify where your animals should be stored. Completing this setup will make your Wiki the Farmer.+Once installed, you'll find a new "Farming" entry in the [[:admin_window|Admin window]]. When a farm hasn't been set up yet, the Farm Setup dialog will occur automatically. It allows you to specify where your animals should be stored. Completing this setup will make your Wiki the Farmer.
  
 The setup can also modify your .htaccess to use rewrite based farms. The setup can also modify your .htaccess to use rewrite based farms.
Line 115: Line 115:
   * configure plugins for animals -- animal administrators are not able to install or enable plugins, this has to be done by the Farmer admin   * configure plugins for animals -- animal administrators are not able to install or enable plugins, this has to be done by the Farmer admin
   * delete animals   * delete animals
 +
 +===== Remote API =====
 +
 +The plugin provides a few endpoints via the [[devel:remote_api|Remote API]] to inspect the farm configuration and available animals. This can be used to auto-setup reverse proxy routes or Kubernetes ingress. Check the API explorer for details on the available endpoints.
  
 ===== Screenshots ===== ===== Screenshots =====
Line 120: Line 124:
 {{gallery>:plugin:farmer?crop&90x120&3&direct}} {{gallery>:plugin:farmer?crop&90x120&3&direct}}
  
 +===== Development =====
  
-===== Development ===== 
 === Change Log === === Change Log ===
  
Line 129: Line 133:
  
 Please report bugs and issues at: https://github.com/cosmocode/dokuwiki-plugin-farmer/issues Please report bugs and issues at: https://github.com/cosmocode/dokuwiki-plugin-farmer/issues
- 
- 
- 
- 
  
plugin/farmer.1469024422.txt.gz · Last modified: by andi

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki