Getting Started

This summary is still in progress and not completed yet!

= Getting started =

Thank you for choosing OXID eShop! To make the work efficient and satisfying, please have a look for some basic features and logics of the OXID system first. Still searching a hoster? Please check the list of OXID Hosting Partners.

Installation
The downloaded package is a zip-file which needs to be unpacked using WinZip, 7zip or similar programs. Newer Windows-versions have already included an unpacker. After unzipping the files, please load up all files and folders to your web space using an ftp-client like Filezilla or cuteFTP. Please be sure to set the upload-mode to "binary". When the upload is finished, just access the setup under www.your-domain.tld/setup and follow the instructions. Please make sure that you have already set up a database (e.g. via the admin panel of your hoster) and keep ready the username, password and URL for accessing it. The first screen you will see is the system requirements check. Make sure to have all topics “green” before you go on. Maybe you need to adjust some settings of your web space first.

(check for mod rewrite: http://www.yourshop.com/oxseo.php?mod_rewrite_module_is=off) Please find more information about installation in the Manual.

As well the Community Forums can help. Please do not hesitate to ask, there are no dump questions, just dump answers! But be sure to use the search function first.

Common Problems
If you get an error similar to this while installation, but you have put in the correct user / password in the step before - maybe the problem is the Suhosin patch on your server with too restrictive settings: "Access denied for user 'www-data'@'localhost' (using password: NO)" To solve this, you or your provider needs to adjust the value in php.ini: suhosin.get.max_value_length = 1024 Another often seen problem is the missing right “CRATE VIEW” for the database-user. Maybe you need to ask your hoster to change it for you.

Templates and Themes
Your installation comes with two standard themes, "Basic" and "Azure". There are several ways to get your own, custom template. If you don´t want to rework your templates on every update, it would be better to create your own template-set. You can achieve this on two ways: Either you use the Template-Override-System, or you create a completely independent set.

It´s strongly recommend choosing one of those possibilities and never modify the original template sets.

The Override-System
The Override-System works really simple – it uses all template files from the father-theme in the original directory, except of those, which are in your custom directory. So you just have place the modified files into the child-theme directory, further updates will not overwrite your changes.

Check the OXID Wiki for more information about the Override System and how to generate a child-theme it.

Your own Template
The other possibility is to develop a completely own template-set and integrate this into the shop. The override functionality will work with this new one as well.

Check the OXID Wiki for more information to clone an independant theme with independant setings.

Template Debug
Starting with eShop Version 4.6.0, there is an easy way to find out which template file is responsible for what output in the frontend, just set $this-&gt;iDebug=8 in config.inc.php and template name and path will be displayed in frontend.

If you are using a version prior 4.6.0 you can achieve the same with the snippets provided here: http://www.oxid-esales.com/forum/showthread.php?t=11709

Basic settings
There are a few settings, which should be set right from the beginning.

Here you can find a quick overview about the backend and whre to find which settings: http://www.oxid-esales.com/en/resources/help-faq/eshop-manual/administration-area-a-glance

Company Details
After installation on first login to the backend, please proceed to Master Settings -&gt; Core Settings and fill in your company details. These details will be used in several places inside the shop and as well in several automatically sent emails. There is no need to fill in all fields, but the shop can of course only display given data. http://www.oxid-esales.com/en/resources/help-faq/eshop-manual/entering-data-your-eshop-contact-data-bank-details-etc

Please do not forget to configure the email settings at the right side. Here you can specify as well the name of the eshop which is displayed in the browser title. Just click on the question marks besides the fields to get more info. http://www.oxid-esales.com/en/resources/help-faq/eshop-manual/setting-e-mail-sending

Countries
Set up the countries early, as those are needed for other settings like payment and shipment. http://www.oxid-esales.com/en/resources/help-faq/eshop-manual/setting-countries

After that go to Master Settings -&gt; Core Settings -&gt; Settings -&gt; "Global" and define users from which countries are automatically put into the "Domestic Users" group.

Currencies
http://forum.oxid-esales.com/showthread.php?p=101499#post101499 (5 decimals)

SEO Title - Prefix and Suffix
In Backend -&gt; Master Settings -&gt; Core Settings -&gt; "SEO" you can set the Prefix and Suffix whis is used in the browser title.

Standard Footer
You may wonder how to change the line at the very bottom, saying "OXID Online Shop - All about watersports, sportswear and fashion" ? This can be edited in the CMS-page oxstdfooter to be found in backend below Customer Info -&gt; CMS Pages.

Shipping Methods / Payment Methods / Shipping Cost Rules
Those settings in Shopsettings have to be made very carefully as it may block any customers to purchase some products when those are not working correctly.

First you have to set up your Payment Methods. You will find some sample settings, can add own methods and enhance them with a bunch of payment modules for certain payment providers. Check the OXID eXchange for available modules.

Then set up the Shipping Cost Rules. It is a simple logic behind them - they will be checked like a chain one by another until a matching set is found.

After that you need to set the Shipping Methods, where you combine Payment Methods and Shipping Cost Rules. These Methods will be shown in frontend for matching users and they can choose their preferred set.

Other settings in backend
Check out this quick overview about the settings which can be made in backend: http://www.oxid-esales.com/en/resources/help-faq/eshop-manual/administration-area-a-glance

A lot of fields have a question mark besides them. You will see more information for it by clicking on that question mark.

Languages
The OXID eShop supports unlimited languages - nothing is hardcoded in the templates, therefore you can easily enhance your shop with more languages needed. The idea behind that is simple, placeholders are used inside the Templates which can be filled with individual phrases in whatever laguage needed.

One simple example to explain that:

Depending on selected language in frontend the matching phrase will be shown.

These phrases are stored within a file named lang.php in an individual folder named after the language, for example in out/en/ or in out/de. You can add more languages by simply upload the named folder containing the lang.php and activating it in Backend in Master Settings -&gt; Languages by filling in the required info. Find more about where to find and how to add languages here: http://wiki.oxidforge.org/Downloads/Languages

You can as well change existing phrases according to your needs or even add new ones and use them by using your chosen placeholder inside the Templates. For this purpose please use the cust_lang.php to be sure, that with next update your individual changes will not be overwritten. Just copy the complete code for the phrase you want to change into this file and change it to your needs. All placeholders found in cust_lang.php will be used instead of the ones in lang.php.

Please remember to update VIEWS after changes within languages in Service -&gt; Tools and clear the folder /tmp after changes within Templates!

Downloadable Products
http://wiki.oxidforge.org/Features/Downloadable_products

(German) http://wiki.oxidforge.org/Features/Downloadable_products/de

Promotions on Startpage
Slider for Brands: http://forum.oxid-esales.com/showthread.php?p=101287#post101226

promotion assignments (frontend / admin): http://forum.oxid-esales.com/showthread.php?t=16688&page=2#post122853

Individualizing Articles (PersParams)
http://forum.oxid-esales.com/showthread.php?t=19027&page=2#post121685

more Modules
OXID Partners, Freelancers, Wiki, Forum

Moving Data from other Shop-Systems
http://rh-flow.de/php/2012/daten-migration-von-strato-epages-zu-oxid-eshop-ce

Community Forum, Oxid-Wiki and Tutorials
= Diggin‘ deeper =

More Information and Documentation
http://forum.oxid-esales.com/showthread.php?t=16195 (integrating new custom single templates)

Forum, Oxid Wiki and Oxid Forge
= Quickstarters Overview =

= Appendix =