Skip to content

Latest commit

 

History

History
103 lines (67 loc) · 3.95 KB

from-scratch.md

File metadata and controls

103 lines (67 loc) · 3.95 KB
Raw

Installation from scratch

If it's impossible to get docker up and running on your development environment you can install Shopware 6 locally.

{% hint style="info" %} Be aware this will be by far the more complex solution since additional or changed system requirements need to be managed by you. {% endhint %}

Prerequisites

Once you set up all the required packages mentioned in the Installation overview, there are two main goals you need to accomplish.

Please note that this guide is rather based on plugin development and contribution. If you need a template for full composer based shop projects, please refer to the production template.

Setting up your webserver

First up, we need to set up Apache to locate Shopware 6. Nginx is also possible but in this guide we will explain apache installation. In order to do this, you should add a vhost to your Apache site configuration that looks like this:

<VirtualHost *:80>
   ServerName "HOST_NAME"
   DocumentRoot _DEVELOPMENT_DIR_/public

   <Directory _DEVELOPMENT_DIR_>
      Options Indexes FollowSymLinks MultiViews
      AllowOverride All
      Order allow,deny
      allow from all
   </Directory>

   ErrorLog ${APACHE_LOG_DIR}/shopware-platform.error.log
   CustomLog ${APACHE_LOG_DIR}/shopware-platform.access.log combined
   LogLevel debug
</VirtualHost>

Please remember to replace _DEVELOPMENT_DIR_ and _HOST_NAME_ with your preferences respectively and add the corresponding entry to your /etc/hosts file.

Make sure following Apache modules are enabled:

  • mod_rewrite
  • mod_headers
  • mod_negotiation

After a quick restart of apache you are done here.

A short recommendation, at least for Mac operating system: In the apache config, it is recommended to drag the document root folder to the own user folder in order to avoid permission issues. This is the folder where Apache looks to serve file from. By default, the document root is configured as /usr/local/var/www. As this is a development machine, let's assume we want to change the document root to point to a folder in our own home directory. Search for the term "DocumentRoot" in your httpd.conf apache configuration, and you should see the following line:

DocumentRoot "/usr/local/var/www"

Change this to point to your user directory where your_user is the name of your user account:

DocumentRoot /Users/your_user/Sites

You also need to change the tag reference right below the DocumentRoot line. This should also be changed to point to your new document root also:

<Directory "/Users/your_user/Sites">

Setting up Shopware

Before you're able to set up Shopware, you need to checkout our Shopware's repositories. This is explained in the "Preparatory steps" paragraph of the Installation overview.

Starting Shopware installation

A simple cli installation wizard can be invoked by executing:

> bin/setup

{% hint style="info" %} One little note: If something goes wrong during installation check if .psh.yaml.override exists. If not restart setup, if yes execute ./psh.phar install to restart the setup process. {% endhint %}

Voila, Shopware 6 is installed. To be sure the installation succeeded, just open the configured host url in your favorite browser.

Updating the repositories

It is important to keep the platform and the development repository in sync.

{% hint style="danger" %} We highly discourage to update each without the other! {% endhint %}

The following steps should always yield a positive result:

> git pull
> cd platform
> git pull
> cd ..
> composer update
> rm -R var/cache/*
> ./psh.phar install

Please note that this will reset your database.

Next steps

You're all set now! Now that you got a running Shopware installation, why not start with your first very own plugin? Please refer to the Plugin base guide for a nice starting point.