Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update guide_shopware-6.rst #1849

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update guide_shopware-6.rst #1849

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2c34b32
Update guide_shopware-6.rst
EDVStuttgart Dec 20, 2024
b2197a5
Update guide_shopware-6.rst
EDVStuttgart Feb 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
136 changes: 90 additions & 46 deletions source/guide_shopware-6.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
.. highlight:: console

.. author:: Yannick Ihmels <yannick@ihmels.org>
.. author:: Dominik Kustermann <hilfe@edvstuttgart.de>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please leave Yannick, feel free to add yourself to the list.

Translated with ChatGPT
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's not relevant and does not show up anywhere in the final document


.. tag:: lang-php
.. tag:: web
Expand All @@ -18,7 +19,7 @@ Shopware 6

.. tag_list::

Shopware_ is a open source e-commerce software powered by Symfony_ and Vue.js_. The community
Shopware_ is an open-source e-commerce software powered by Symfony_ and Vue.js_. The community
edition is distributed under the MIT license. It's the successor of Shopware 5.

----
Expand Down Expand Up @@ -49,80 +50,123 @@ We're using PHP in the stable version 8.1:

.. include:: includes/my-print-defaults.rst

Your shop URL needs to be setup:
Your shop URL needs to be set up:

.. include:: includes/web-domain-list.rst

Configuration
=============

To configure PHP according to the `Shopware system requirements`_, go to
``$HOME/etc/php.d/``, create ``shopware.ini`` and add the following lines:

::

memory_limit = 512M
apc.enable_cli = 1
opcache.memory_consumption = 256

After setting these PHP parameters, restart PHP to activate the changes

.. code-block:: console

[isabell@stardust ~]$ uberspace tools restart php
Your PHP configuration has been loaded.
[isabell@stardust ~]$

Installation
============

Download
--------
Setup the Environment
----------------------

Check the `Shopware website`_ for the latest release and copy the URL to the ZIP file. Replace the
URL with the one you just copied.
Switch to your user directory and create a folder for Shopware:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's the DocumentRoot and not the user directory 😅


.. code-block:: console
:emphasize-lines: 2

[isabell@stardust ~]$ cd /var/www/virtual/$USER/
[isabell@stardust isabell]$ curl -o shopware.zip https://releases.shopware.com/sw6/install_v6.4.17.2_4d2c85fb448571fa4f30edce635f33a67dda1d76.zip
[isabell@stardust isabell]$ unzip -d shopware shopware.zip
[isabell@stardust isabell]$ rm shopware.zip
[isabell@stardust isabell]$
[isabell@stardust $USER]$ mkdir shopware
[isabell@stardust $USER]$ cd shopware

Download the Installer
----------------------

Since Shopware uses the sub directory public/ as the :manual:`DocumentRoot <web-documentroot>`,
you need to remove your DocumentRoot and create a symlink to the shopware/public/ directory:
Download the Shopware installer script:

.. code-block:: console
:emphasize-lines: 2

[isabell@stardust isabell]$ rm -f html/nocontent.html; rmdir html
[isabell@stardust isabell]$ ln -s /var/www/virtual/$USER/shopware/public html
[isabell@stardust isabell]$
[isabell@stardust shopware]$ wget https://github.com/shopware/web-recovery/releases/latest/download/shopware-installer.phar.php

Setup
------
Adjust DocumentRoot
-------------------

Point your browser to your domain, e.g. ``https://isabell.uber.space`` and follow the instructions
to set up Shopware. We suggest you use an
:manual_anchor:`additional database <database-mysql.html#additional-databases>`. For example:
isabell_shopware.
Move one level up, remove the default ``html`` symlink, and point it to the Shopware installation:

Configuration
=============
.. code-block:: console

To configure PHP according to the `Shopware system requirements`_, go to
``$HOME/etc/php.d/``, create ``shopware.ini`` and add the following lines:
[isabell@stardust shopware]$ cd ..
[isabell@stardust $USER]$ rm -f html
[isabell@stardust $USER]$ ln -s /var/www/virtual/$USER/shopware html

::
Complete the Installation
-------------------------

memory_limit = 512M
apc.enable_cli = 1
opcache.memory_consumption = 256
Open your browser and navigate to your domain, e.g., ``https://isabell.uber.space``, and follow the installation steps.

.. note:: After setting these PHP parameters, restart PHP to activate the changes
.. warning:: When attempting to install the latest version of Shopware directly, I encountered an issue where Shopware requires MariaDB version 10.11. However, Uberspace currently provides only version 10.6.19 on Uberspace 7. According to Uberspace support, this limitation may be resolved with Uberspace 8. Until then, it is mandatory to install Shopware version 6.6.8, as any newer versions will cause issues.

.. code-block:: console
If errors occur during the process, refer to the :ref:`Troubleshooting <troubleshooting>` section below.

[isabell@stardust ~]$ uberspace tools restart php
Your php configuration has been loaded.
[isabell@stardust ~]$
Post-Installation Configuration
===============================

Updates
=======
After installation, follow these steps for further configuration:

1. Perform all available updates via `Shopware > Settings > System > Shopware Updates`.
2. Update the DocumentRoot symlink to the ``public`` directory:

.. code-block:: console

[isabell@stardust ~]$ cd /var/www/virtual/$USER/
[isabell@stardust $USER]$ rm html
[isabell@stardust $USER]$ ln -s /var/www/virtual/$USER/shopware/public html

3. Adjust the API URL:

.. code-block:: console

[isabell@stardust $USER]$ cd /var/www/virtual/$USER/shopware
[isabell@stardust shopware]$ nano .env.local

Remove the ``/public`` part from ``APP_URL=[...]``.

4. Upgrade plugins in the Shopware admin.
5. Update the domain under "Sales Channels".

.. note:: Check the update feed_ regularly to stay informed about the newest version.
Domain Adjustment
=================

If switching to a custom domain, repeat the steps above to update the symlink and API URL.

.. _troubleshooting:

Troubleshooting
===============

If issues occur during installation, delete the Shopware folder and database to start over:

Follow the steps outlined in the `Download the Installer`_ section to restart the process.

.. code-block:: console

[isabell@stardust ~]$ rm -rf /var/www/virtual/$USER/shopware
[isabell@stardust ~]$ mysql -e "DROP DATABASE isabell_shopware"

----

.. _Shopware: https://www.shopware.com
.. _Shopware website: https://www.shopware.com/en/download/
.. _Shopware system requirements: https://docs.shopware.com/en/shopware-6-en/first-steps/system-requirements
.. _Symfony: https://symfony.com
.. _Vue.js: https://vuejs.org
.. _feed: https://github.com/shopware/platform/releases.atom

----

Tested with Shopware 6.4.17.2, PHP 8.1 and Uberspace 7.13.0
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is relevant information, please add it with your tested versions.


.. author_list::