Dokumentation

In der StageWare® Dokumentation findest du eine Erklärung jedes einzelnen Konfigurationsfeldes und jeder einzelnen Funktion.

Inhaltsverzeichnis

Video-Tutorial und Anleitungen

Über diese Dokumentation hinaus, gibt es auch noch zahlreiche Anleitungen und Video-Tutorials.

All of these instructions are part of the StageWare® Utilitieswhich you can request free of charge as a StageWare® use.

Frequent Errors and Questions

If you have problems or questions, please first have a quick look at the Frequent Questions and/or Frequent Errors.
You will most likely find a solution to your problem right away.
Otherwise, please feel free to contact us at team@zwei.gmbh at any time.

Install StageWare® via the Shopware Backend.

  1. Install and activate StageWare® with the Plugin Manager
    Like any other Shopware plugin, StageWare® can easily be installed with the Plugin Manager. Please make sure to activate the plugin after installation.
  2. On-Time Basic Configuration
    Carry out the basic configuration in the plugin settings under Configuration > Plugin Manager > Installed > StageWare® (click on the pencil icon on the right side).
  3. Configure Test Environment
    Open the StageWare® Manager under Configuration > StageWare® Manager on your Shopware backend. Click the tab "PROFILE" and then on the tab "Staging 1". Now create a new database on your server and enter the database login data under "Database Settings".
  4. Done! Open and Use Your Test Enviroment
    Great, you did it! Now you can easily open the frontend or backend of your test environment under Actions > Test environment Open and work with it. By the way, you can also reset your test environment here at any time by setting up the test environment from scratch again.

Requirements for a Test Environment

To check the requirements for creating a test environment switch to the System Check tab in the StageWare® Manager, where there is a list of the minimum server-side recommendation next to the current values.

Over of the Recommended Minimum Requirements

Explanation of the Individual Requirements

PHP Version

The PHP version you use is crucial to the availability of certain functions, especially the performance of your shop and our plugins. For best performance you should use PHP 7.0 or higher. If you are unsure or have problems with the PHP version, contact your hosting provider and the technical service provider for your shop.


PHP memory_limit

PHP memory_limit is the maximum usable memory allocated to each individual script call. Copying and creating a test environment is a relatively demanding process, but we have optimized StageWare® so that 256MB memory_limit is usually sufficient. However, if you run into bottlenecks or problems, contact your hosting provider or technical service provider and ask them to increase the PHP memory_limit.


PHP max_execution_time

T PHP max_execution_time limits the maximum execution time for a script. The specified value is in seconds. Copying and creating a test environment is a demanding process and often takes a relatively long time. We have implemented batch processing for the steps in StageWare® so that 60 seconds max_execution is usually sufficient. However, if there are bottlenecks or problems with this value, contact your hosting provider or technical service provider and ask them to increase the PHP max_execution_time.


Memory

To create a test environment or a backup you need free disk space on your server. The disk space used must never reach the full capacity because then the functionality of your live shop can no longer be guaranteed. Make sure that there is always enough free space available. Talk to your hosting provider if you need more space.

Attention: The storage space used by StageWare® cannot be determined correctly on all systems. This is often the case with shared hosting packages, where you see the total memory of the server, but not the maximum amount available to you. In this case, please also check how much memory is used on your hosting provider account.


PHP log_errors (optional)

This function must be active for PHP error messages to be logged at all. We strongly recommend activating this function. This is the only way that errors can be detected, tracked and solved quickly. The best thing to do is to contact your hosting provider and ask them to activate the PHP errorlog (set path in error_log and activate log_errors).


PHP error_log (optional)

This value defines the path where the errorlog file is stored. We strongly recommend that the errorlog should be defined. This is the only way that errors can be detected, tracked and solved quickly. The best thing to do is to contact your hosting provider and ask them to activate the PHP errorlog (set path in error_log and activate log_errors).


Working with Stageware®.

To use StageWare® open the StageWare® Manager on your backend under “Configuration”.


Profiles

Profiles contain all the setting that are necessary for creating test environments and backups. It’s basically a profile telling StageWare® where data comes from and where it should go.

You can create as many profiles as you want.


Live Profile

The live profile is a special feature. It is your live shop and cannot be changed.


Create Profilen

To create a new profile, click on „New“ on the top right of your screen. You can make a copy of an existing profile so you don’t have to re-enter all the settings. When making a copy, the name and the path are automatically adjusted, but you can change them at any time.


Edit Profile

To edit a profile, simply click on it, make the desired changes and then click on „save“ on the bottom right side of your screen.


Profile Settings

The individual profile settings are explained below.

Name

The name of the profile is important for you to recognize and distinguish between the various test environments. It should be unique and describe your test environment unambiguously. The name is also used (automatically reduced to the allowed characters) in file names of backups.

Create from Profile

Each profile has a source profile from which the data for the test environment is copied. In most cases this will be the live profile. However, you can also create test environments from other test environments.

Folder

This is the folder name where the test environment is created within the Shopware folder. You can group multiple test environments in a common subfolder. Below are some examples.

Directly in the Shopware folder: /stagingl

Grouped in a sub-folder: /testenvironment/stagingl

Excluded Folders and Files

This can be used to exclude entire folders or individual files. You can configure which exclusions (source, destination or both) should be ignored in the plugin settings when setting up a test environment.

Exclusions must be entered as relative paths and are used intelligently in the respective context. Any number of exclusions can be entered separated by line break, comma (,) or semicolon (;). Other test environments, the cache folder and the stage_ware_data folder are always automatically excluded.

Some examples as follows:

  • Exclude phpMyAdmin: /phpmyadmin-1
  • Exclude file: /folder_name/file.txt

Database Settings

Each test environment needs its own empty database. You can usually create these yourself with a few clicks on the backend of your server.

Enter all required database settings here. If you don't know how to create a database, please contact your hosting provider.

Excluded Database Tables

If necessary, you can exclude database tables here so that they are only copied as a structure (without content) into the test environment or included in a backup backup.

  • s_statistics_search
  • s_article_also_bought_ro

Test Environments

A test environment is a copy of your live shop that runs completely autonomously and independently of the live shop. Each test environment is based on a profile in which all necessary settings (such as the source system and the target where the test environment is to be installed) are made. Changes in the test environment will not affect your live shop. You can create as many test environments as you want, and you can recreate existing test environments as many times as you want. Usually, a test environment is created from a live shop, but you can also create test environments from other test environments.

There is an overview of all your test environments under “Test Environments”, including their status and configuration.

Actions

You can control your test environment here, i.e. set it up and delete it. You can also review the configuration with which the test environments have been set up in each case (button Configured Setup).

1-click action
This performs all necessary steps for creating an executable test environment. Any existing files in the target path and data in the database are automatically removed beforehand. Meaning you can simply overwrite a test environment without having to delete it first. If you want to delete a test environment, just click the Delete button.

Open Test Environment

You can easily open the frontend or backend of your test environment here.

Source profile

There is a short overview of the settings that are stored in your source profile here. If you want to change the profile settings, please go to the Profiles section.

Target Profile

There is a short overview of the settings that are stored in your target profile (i.e. in the profile of this test environment) here. If you want to change the profile settings, please go to the Profiles section.

Exclusions

In this section you can review the exclusions, i.e. the folders that are not transferred to the test environment when setting up the files. Depending on the settings in the plugin configuration, the exclusions of the source or target profile or even both are taken into account. If you want to change the exclusions, please switch to the Profiles section. Some exclusions (like other test environments or cache folders) are automatically defined.

Backups

You can create backups of your systems here. A special feature is that in addition to complete backups, you can also create file-only or database-only backups. When creating a backup, the exclusions in the corresponding profile are taken into account and the data modified during the setup of the test environment (shop path, CronJobs, email address, etc.) is restored to its original state. Other test environments, the cache folder and the stage_ware_data folder are always automatically excluded.

Create

The overview shows all profiles, the respective backup path, possible actions as well as date and time of the last backups. You can choose whether you want to create a full backup or only one with files or the database.

Download and manage

There is an overview of all profiles and a list of all available backups here. You can also download them or delete them from the server here.