Installation & First Steps

Step 1: Check your Version

First of all, it is important to choose the right product version for your project. In order to be able to determine this, it is relevant which WoltLab Suite version is used for your project. We have oriented ourselves to the product versions of the WoltLab Suite, the first two version numbers of the core are relevant, a small overview and an example:


WoltLab Suite Core Version 3.0.X corresponds to the product version 3.0.X

WoltLab Suite Core Version 3.1.X corresponds to the product version 3.1.X

WoltLab Suite Core Version 5.2.X corresponds to the product version 5.2.X

( "X" serves as a placeholder and stands for any version number )


Example:

If you are using WoltLab Suite Core 5.2.6, the latest product version with version number 5.2.X would be the right one for you. (For example 5.2.0).

The following applies here: the higher the last version number, the more up-to-date the product version - the highest number therefore corresponds to the current status.

If you are not sure which WoltLab Suite Core Version you are using, you can easily find out:

To do this, log into your ACP (= Admin ControlPanel (also called Administration)) and switch to "Configuration" in the left sidebar and then to the "Packages" menu item. Look for the "WoltLab Suite Core" package (ID: 1) in the package list and look up your version number of the WoltLab Suite Core.

Step 2: Download your Product

ATTENTION: This step is only necessary if you want to download and install the package manually (step 3 method 2), if you want to install the package via a package server (step 3 method 1), this step is not necessary and can be skipped!


Now that you have determined the correct version for your project, you only need to download it. Also make sure to download the correct version.


Download at SK-Designz:
Did you purchase the product on SK-Designz or linked your WoltLab customer account with your account on SK-Designz (PluginStore Verification) you can easily download your product in your Customer Account at the Downloadlist.


Download at WoltLab PluginStore:
If you have purchased the product in the WoltLab PluginStore, you can easily download it on the product page in the "Versions" tab. Alternatively, you can link your WoltLab customer account with your account on SK-Designz in order to be able to download your products on SK-Designz (PluginStore Verification).


Step 3 Method 1.1: Install your Product (WoltLab Package Server)

ATTENTION: This step is necessary for customers of the "WoltLab Cloud"!

ATTENTION: This step only works for customers who have purchased a product via the WoltLab PluginStore!


Once you have successfully purchased your product, it only needs to be installed. To do this, log into your ACP (= Admin ControlPanel (also called Administration)) and switch to "Configuration" in the left sidebar and then to the "Packages" menu item. You can now enter the name of your purchased product in the search field ("Search package" -> "Package name") (for example "GamerLevelz") - click on "Submit". You will now be offered a list of packages, select the relevant product here by selecting the "+" icon in front of the package name. Now log in (if necessary) with your WoltLab user data (login data), then the installation will run through automatically.


Step 3 Method 1.1: Install your Product (SK-Designz Package Server)

The simplest method to install the desired product is to use the "package server" variant. In order for this to work reliably, you must first add the respective package server to your WoltLab Suite installation. For this it is important that you add the respective package server for your WoltLab Suite Core version. If you have purchased our products in the WoltLab PluginStore, you must first synchronize your WoltLab customer account with your user account on SK-Designz, you can do this via the PluginStore verification. You can see which package server is suitable for which version here:


WoltLab Suite Core Version 3.0.X corresponds to our "Vortex" package server

WoltLab Suite Core Version 3.1.X corresponds to our "Tornado" package server

WoltLab Suite Core Version 5.2.X corresponds to our "Hurricane" packet server

( "X" serves as a placeholder and stands for any version number )


If you are not sure which WoltLab Suite Core Version you are using, you can easily find out:

To do this, log into your ACP (= Admin ControlPanel (also called Administration)) and switch to "Configuration" in the left sidebar and then to the "Packages" menu item. Look for the "WoltLab Suite Core" package (ID: 1) in the package list and look up your version number of the WoltLab Suite Core.


To add our packet servers to your WoltLab Suite installation, follow the steps below:

1. Log in to your ACP (= Admin ControlPanel (also called Administration)) and switch to "Configuration" in the left sidebar and then to the "Package Server" menu item.

2. Select the "Add server" button at the top right. Now enter your access data - which you can see in your customer account. Then click on the "Submit" button. Your changes are now saved!

3. Now select "Management" in the left sidebar of the ACP and then the menu item "Cronjobs". Execute the cronjob "Updates package information" (triangle / play button).


Once you have completed these steps, you have successfully added our package server to your project - now you can start the installation! In the left sidebar switch to "Configuration" and then to the menu item "Packages". You can now enter the name of your purchased product in the search field ("Search package" -> "Package name") (for example "GamerLevelz") - click on "Submit". You will now be offered a list of packages, select the relevant product here by selecting the "+" icon in front of the package name. Now log in (if necessary) with your customer data (My Account), and the installation will then run through automatically.


Step 3 Method 2: Install your Product (Package Upload)

Once you have successfully downloaded your product, you only need to install it. To do this, log into your ACP (= Admin ControlPanel (also called Administration)) and switch to "Configuration" in the left sidebar and then to the "Packages" menu item. Select the "Upload package" button and then select the product you just downloaded - click "Submit". Now you have to confirm the installation again with "Next" and the installation then runs automatically.



Alternative instructions from WoltLab: Install Additional Apps - WoltLab®