Difference between revisions of "Setup:Installation Guide/Installation BlueSpice WikiFarm"

[quality revision][quality revision]
m (Text replacement - "[[en:{{PAGENAME}}]]" to "[[en:{{FULLPAGENAME}}]]")
(added note that farm is not a standard part of BlueSpice pro)
(Tag: 2017 source edit)
 

Preface[edit | edit source]

An existing BlueSpice pro installation can easily be extended with BlueSpiceWikiFarm.
The existing installation assumes the role of the main wiki (=farm management). The contents remain there and can be maintained there as usually. This documentation will guide you through the necessary steps to Install BlueSpiceWikiFarm

Note: WikiFarm is not a standard feature of BlueSpice pro and needs to be acquired separately.


PHP prerequisites[edit | edit source]

Please ensure that the PHP extension ZIP is archived, which is required for BlueSpiceWikFarm.

Ensuring the correct path in the file system[edit | edit source]

Important for the operation of BlueSpiceWikiFarm is that BlueSpice is located in the directory /w of the DocumentRoot of your web server or VirtualHost.

If this is not the case, you have to move the entire codebase there.

After that, the variable $wgScriptPath in the LocalSettings.php contains the path /w.

                    $ wgScriptPath = "/w";

                

Creating the necessary folders for BlueSpiceWikiFarm[edit | edit source]

BlueSpiceWikiFarm needs two additional folders in the folder /w at the same level as the LocalSettings.php. You have to create these two folders:

  • _sf_instances - all data and configurations for the respective instances are stored here
  • _sf_archive - deleted farm instances including your database dump are stored here as ZIP archive

Make sure that these folders are writable by the web server. See also our (Manual/Security Settings/File_System_Permissions notes in the helpdesk ) for this purpose.

Creating the LocalSettingsAppend.php[edit | edit source]

Including the extension "BlueSpiceWikiFarm" first requires an additional configuration file with the name LocalSettingsAppend.php. Create this file on the same level as the LocalSettings.php and eadd the following content:

                    <?php
require_once "$IP/LocalSettings.BlueSpice.php";

                

== Including the extension "BlueSpiceWikiFarm" == In the LocalSettings.php replace the line

                    require_once "$IP/LocalSettings.BlueSpice.php";

                

with

                    require_once "$IP/extensions/BlueSpiceWikiFarm/BlueSpiceWikiFarm.php";

                

Configuring the web server[edit | edit source]

In the folder extensions/BlueSpiceWikiFarm/SimpleFarmer/doc you will find example files for RewriteRules, which are necessary for BlueSpiceWikiFarm:

  • htaccess.template - RewriteRules for Apache
  • web.config.template - RewriteRules for IIS

Configure these RewriteRules for the DocumentRoot level of your Web server or VirtualHost.

Completion[edit | edit source]

The installation of BlueSpiceWikiFarm is now complete. From now on, you can reach the farm administration in the main wiki under the special page "Special:SimpleFarmer".

        __TOC__
        ==Preface==
        
        An existing BlueSpice pro installation can easily be extended with BlueSpiceWikiFarm. <br />
            The existing installation assumes the role of the main wiki (=farm management). The contents remain there and can be maintained there as usually. <br />
            
            This documentation will guide you through the necessary steps to Install BlueSpiceWikiFarm.
            

            {{Box Note|boxtype=note|Note text=WikiFarm is not a standard feature of BlueSpice pro and needs to be acquired separately.}}
        

        ==PHP prerequisites==
        
        Please ensure that the PHP extension ZIP is archived, which is  required for BlueSpiceWikFarm.
        

        == Ensuring the correct path in the file system ==
        
        Important for the operation of BlueSpiceWikiFarm is that BlueSpice is located in the directory <code>/w</code> of the DocumentRoot of your web server or VirtualHost. <br />
        

        If this is not the case, you have to move the entire codebase there. <br /> <br />
        
        After that, the variable <code>$wgScriptPath</code> in the <code>LocalSettings.php</code> contains the path <code>/w</code>. <br />
        <syntaxhighlight lang = ="php">
        
        $ wgScriptPath = "/w";
        </syntaxhighlight>
        
        == Creating the necessary folders for BlueSpiceWikiFarm ==
        
        BlueSpiceWikiFarm needs two additional folders in the folder <code>/w</code> at the same level as the <code>LocalSettings.php</code>. You have to create these two folders:
        

        * <code>_sf_instances</code> - all data and configurations for the respective instances are stored here
        
        * <code>_sf_archive</code> - deleted farm instances including your database dump are stored here as ZIP archive
        

        Make sure that these folders are writable by the web server. See also our ([https://en.wiki.bluespice.com/index.php?title=Setup:Installation Manual/Security Settings/File_System_Permissions notes in the helpdesk ]] ) for this purpose.
        

        == Creating the LocalSettingsAppend.php ==
        
        Including the extension "BlueSpiceWikiFarm" first requires an additional configuration file with the name <code>LocalSettingsAppend.php</code>. Create this file on the same level as the <code>LocalSettings.php</code> and eadd the following content: <br />
        
<syntaxhighlight lang="php">
        <?php
            
            require_once "$IP/LocalSettings.BlueSpice.php";
            </syntaxhighlight>
        
        ==
        
        Including the extension "BlueSpiceWikiFarm" ==
        
        In the <code>LocalSettings.php</code> replace the line
        <syntaxhighlight lang="php">
        
        require_once "$IP/LocalSettings.BlueSpice.php";
        </syntaxhighlight>
        
        with
        <syntaxhighlight lang="php">
        
        require_once "$IP/extensions/BlueSpiceWikiFarm/BlueSpiceWikiFarm.php";
        </syntaxhighlight>
        
        ==Configuring the web server==
        

        In the folder <code>extensions/BlueSpiceWikiFarm/SimpleFarmer/doc</code> you will find example files for RewriteRules, which are necessary for BlueSpiceWikiFarm:
        

        *<code>htaccess.template</code> - RewriteRules for Apache
        
        *<code>web.config.template</code> - RewriteRules for IIS
        

        Configure these RewriteRules for the DocumentRoot level of your Web server or VirtualHost.
        

        ==Completion==
        
        The installation of BlueSpiceWikiFarm is now complete. From now on, you can reach the farm administration in the main wiki under the special page "Special:SimpleFarmer".
        

        [[en:{{FULLPAGENAME}}]]
            [[de:Setup:Installationsanleitung/Installation_BlueSpice_WikiFarm]]
Line 1: Line 1:
  
 
__TOC__
 
__TOC__
==Preface==
+
 
An existing BlueSpice pro installation can easily be extended with BlueSpiceWikiFarm. <br />
+
An existing BlueSpice pro installation can easily be extended with BlueSpiceWikiFarm. The existing installation assumes the role of the main wiki (=farm management). The contents remain there and can be maintained as usually.  
The existing installation assumes the role of the main wiki (=farm management). The contents remain there and can be maintained there as usually. <br />
+
 
This documentation will guide you through the necessary steps to Install BlueSpiceWikiFarm.
+
{{Box Note|boxtype=note|Note text=WikiFarm is not a standard feature of BlueSpice pro and needs to be acquired separately.}}
  
 
==PHP prerequisites==
 
==PHP prerequisites==
 
Please ensure that the PHP extension ZIP is archived, which is  required for BlueSpiceWikFarm.
 
Please ensure that the PHP extension ZIP is archived, which is  required for BlueSpiceWikFarm.
  
== Ensuring the correct path in the file system ==
+
==Ensuring the correct path in the file system==
 
Important for the operation of BlueSpiceWikiFarm is that BlueSpice is located in the directory <code>/w</code> of the DocumentRoot of your web server or VirtualHost. <br />
 
Important for the operation of BlueSpiceWikiFarm is that BlueSpice is located in the directory <code>/w</code> of the DocumentRoot of your web server or VirtualHost. <br />
  
 
If this is not the case, you have to move the entire codebase there. <br /> <br />
 
If this is not the case, you have to move the entire codebase there. <br /> <br />
 
After that, the variable <code>$wgScriptPath</code> in the <code>LocalSettings.php</code> contains the path <code>/w</code>. <br />
 
After that, the variable <code>$wgScriptPath</code> in the <code>LocalSettings.php</code> contains the path <code>/w</code>. <br />
<syntaxhighlight lang = "php">
+
<syntaxhighlight lang="php">
 
$ wgScriptPath = "/w";
 
$ wgScriptPath = "/w";
 
</syntaxhighlight>
 
</syntaxhighlight>
== Creating the necessary folders for BlueSpiceWikiFarm ==
+
==Creating the necessary folders for BlueSpiceWikiFarm==
 
BlueSpiceWikiFarm needs two additional folders in the folder <code>/w</code> at the same level as the <code>LocalSettings.php</code>. You have to create these two folders:
 
BlueSpiceWikiFarm needs two additional folders in the folder <code>/w</code> at the same level as the <code>LocalSettings.php</code>. You have to create these two folders:
  
* <code>_sf_instances</code> - all data and configurations for the respective instances are stored here
+
*<code>_sf_instances</code> - all data and configurations for the respective instances are stored here
* <code>_sf_archive</code> - deleted farm instances including your database dump are stored here as ZIP archive
+
*<code>_sf_archive</code> - deleted farm instances including your database dump are stored here as ZIP archive
  
Make sure that these folders are writable by the web server. See also our ([https://en.wiki.bluespice.com/index.php?title=Setup:Installation Manual/Security Settings/File_System_Permissions notes in the helpdesk ]) for this purpose.
+
Make sure that these folders are writable by the web server. See also our ([https://en.wiki.bluespice.com/index.php?title=Setup:Installation Manual/Security Settings/File_System_Permissions notes in the helpdesk] ) for this purpose.
  
== Creating the LocalSettingsAppend.php ==
+
==Creating the LocalSettingsAppend.php==
 
Including the extension "BlueSpiceWikiFarm" first requires an additional configuration file with the name <code>LocalSettingsAppend.php</code>. Create this file on the same level as the <code>LocalSettings.php</code> and eadd the following content: <br />
 
Including the extension "BlueSpiceWikiFarm" first requires an additional configuration file with the name <code>LocalSettingsAppend.php</code>. Create this file on the same level as the <code>LocalSettings.php</code> and eadd the following content: <br />
  
Line 54: Line 54:
 
The installation of BlueSpiceWikiFarm is now complete. From now on, you can reach the farm administration in the main wiki under the special page "Special:SimpleFarmer".
 
The installation of BlueSpiceWikiFarm is now complete. From now on, you can reach the farm administration in the main wiki under the special page "Special:SimpleFarmer".
  
[[en:{{FULLPAGENAME}}]][[de:Setup:Installationsanleitung/Installation_BlueSpice_WikiFarm]]
+
[[en:{{FULLPAGENAME}}]]
 +
[[de:Setup:Installationsanleitung/Installation_BlueSpice_WikiFarm]]

Attachments

Discussions