CINXE.COM

<!doctype html> <html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-platform/databases/redis" data-has-hydrated="false"> <head> <meta charset="UTF-8"> <meta name="generator" content="Docusaurus v3.7.0"> <title data-rh="true">Redis | mittwald Developer Portal</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://developer.mittwald.de/docs/v2/platform/databases/redis/"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" property="og:locale:alternate" content="de"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Redis | mittwald Developer Portal"><meta data-rh="true" name="description" content="For an e-commerce website, good performance is a real competitive advantage. To further minimize your load times, you can use Redis in all Space server and proSpace plans. Here you can read about what you can use the database for and how to set it up. "><meta data-rh="true" property="og:description" content="For an e-commerce website, good performance is a real competitive advantage. To further minimize your load times, you can use Redis in all Space server and proSpace plans. Here you can read about what you can use the database for and how to set it up. "><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://developer.mittwald.de/docs/v2/platform/databases/redis/"><link data-rh="true" rel="alternate" href="https://developer.mittwald.de/docs/v2/platform/databases/redis/" hreflang="en"><link data-rh="true" rel="alternate" href="https://developer.mittwald.de/de/docs/v2/platform/databases/redis/" hreflang="de"><link data-rh="true" rel="alternate" href="https://developer.mittwald.de/docs/v2/platform/databases/redis/" hreflang="x-default"><link rel="alternate" type="application/rss+xml" href="/changelog/rss.xml" title="mittwald Developer Portal RSS Feed"> <link rel="alternate" type="application/atom+xml" href="/changelog/atom.xml" title="mittwald Developer Portal Atom Feed"><link rel="stylesheet" href="/assets/css/styles.c85814f8.css"> <script src="/assets/js/runtime~main.ce944b64.js" defer="defer"></script> <script src="/assets/js/main.6e70ae12.js" defer="defer"></script> </head> <body class="navigation-with-keyboard"> <script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"light")}(),function(){try{const n=new URLSearchParams(window.location.search).entries();for(var[t,e]of n)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><link rel="preload" as="image" href="/img/mittwald-logo.svg"><div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/mittwald-logo.svg" alt="mittwald" class="themedComponent_mlkZ themedComponent--light_NVdE"><img src="/img/mittwald-logo.svg" alt="mittwald" class="themedComponent_mlkZ themedComponent--dark_xIcU"></div>Developer Portal</a><a class="navbar__item navbar__link" href="/docs/v2/api/intro/">API</a><a class="navbar__item navbar__link" href="/docs/v2/cli/">CLI</a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/docs/v2/category/platform/">Platform</a><a class="navbar__item navbar__link" href="/docs/v2/contribution/">Contribution</a><a class="navbar__item navbar__link" href="/docs/v2/reference/">Reference</a><a class="navbar__item navbar__link" href="/changelog/">Changelog</a></div><div class="navbar__items navbar__items--right"><a href="https://github.com/mittwald/developer-portal" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link"><svg viewBox="0 0 24 24" width="20" height="20" aria-hidden="true" class="iconLanguage_nlXk"><path fill="currentColor" d="M12.87 15.07l-2.54-2.51.03-.03c1.74-1.94 2.98-4.17 3.71-6.53H17V4h-7V2H8v2H1v1.99h11.17C11.5 7.92 10.44 9.75 9 11.35 8.07 10.32 7.3 9.19 6.69 8h-2c.73 1.63 1.73 3.17 2.98 4.56l-5.09 5.02L4 19l5-5 3.11 3.11.76-2.04zM18.5 10h-2L12 22h2l1.12-3h4.75L21 22h2l-4.5-12zm-2.62 7l1.62-4.33L19.12 17h-3.24z"></path></svg>English</a><ul class="dropdown__menu"><li><a href="/docs/v2/platform/databases/redis/" target="_self" rel="noopener noreferrer" class="dropdown__link dropdown__link--active" lang="en">English</a></li><li><a href="/de/docs/v2/platform/databases/redis/" target="_self" rel="noopener noreferrer" class="dropdown__link" lang="de">Deutsch</a></li></ul></div><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="Switch between dark and light mode (currently light mode)" aria-label="Switch between dark and light mode (currently light mode)" aria-live="polite" aria-pressed="false"><svg viewBox="0 0 24 24" width="24" height="24" class="lightToggleIcon_pyhR"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" class="darkToggleIcon_wfgR"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg></button></div><div class="navbarSearchContainer_Bca1"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0"><div class="docsWrapper_hBAB"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docRoot_UBD9"><aside class="theme-doc-sidebar-container docSidebarContainer_YfHR"><div class="sidebarViewport_aRkj"><div class="sidebar_njMd"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--active" href="/docs/v2/category/platform/">Platform</a><button aria-label="Collapse sidebar category 'Platform'" aria-expanded="true" type="button" class="clean-btn menu__caret"></button></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" tabindex="0" href="/docs/v2/platform/workloads/">Application workloads</a><button aria-label="Expand sidebar category 'Application workloads'" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--active" tabindex="0" href="/docs/v2/category/databases/">Databases</a><button aria-label="Collapse sidebar category 'Databases'" aria-expanded="true" type="button" class="clean-btn menu__caret"></button></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/v2/platform/databases/mysql/">MySQL</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/docs/v2/platform/databases/redis/">Redis</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/v2/platform/databases/opensearch/">OpenSearch</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" tabindex="0" href="/docs/v2/category/development-support/">Development support</a><button aria-label="Expand sidebar category 'Development support'" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" tabindex="0" href="/docs/v2/category/deployment-guides/">Deployment guides</a><button aria-label="Expand sidebar category 'Deployment guides'" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li></ul></li></ul></nav></div></div></aside><main class="docMainContainer_TBSr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_YNFT"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item"><a class="breadcrumbs__link" itemprop="item" href="/docs/v2/category/platform/">Platform</a><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item"><a class="breadcrumbs__link" itemprop="item" href="/docs/v2/category/databases/">Databases</a><meta itemprop="position" content="2"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active">Redis<meta itemprop="position" content="3"></li></ul></nav><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Redis</h1></header><aside class="flow--alert flow--alert--info"><h3 class="flow--heading flow--heading--s flow--alert--heading"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="tabler-icon tabler-icon-info-circle flow--icon flow--alert--icon flow--icon--size-m flow--icon--info" focusable="false" role="img" aria-hidden="false" aria-label="Status information"><path d="M3 12a9 9 0 1 0 18 0a9 9 0 0 0 -18 0"></path><path d="M12 9h.01"></path><path d="M11 12h1v4h1"></path></svg>Compatibility notice</h3><div class="flow--alert--content">This documentation applies only to the following plans: <a href="https://www.mittwald.de/prospace" target="_blank" rel="noopener noreferrer">proSpace</a>, <a href="https://www.mittwald.de/space-server" target="_blank" rel="noopener noreferrer">Space Server</a>.</div></aside> <h2 class="anchor anchorWithStickyNavbar_LWe7" id="what-is-redis">What is Redis?<a href="#what-is-redis" class="hash-link" aria-label="Direct link to What is Redis?" title="Direct link to What is Redis?"></a></h2> For an e-commerce website, good performance is a real competitive advantage. To further minimize your load times, you can use Redis in all Space server and proSpace plans. Here you can read about what you can use the database for and how to set it up. Redis (short for Remote Dictionary Server) is an in-memory database and key-value store in one. That means your data is stored in the working memory instead of on the hard drive. Each entry receives its own key, through which it can be accessed directly. This ensures very short access times. <h2 class="anchor anchorWithStickyNavbar_LWe7" id="why-do-i-need-redis">Why do I need Redis?<a href="#why-do-i-need-redis" class="hash-link" aria-label="Direct link to Why do I need Redis?" title="Direct link to Why do I need Redis?"></a></h2> In general, Redis speeds up your projects when data needs to be written and queried quickly. Thanks to its outstanding performance, Redis is ideal as a cache. The database is also popular as a session storage for shop systems. <h2 class="anchor anchorWithStickyNavbar_LWe7" id="how-do-i-create-a-redis-database">How do I create a Redis database?<a href="#how-do-i-create-a-redis-database" class="hash-link" aria-label="Direct link to How do I create a Redis database?" title="Direct link to How do I create a Redis database?"></a></h2> Setting up Redis is easy. However, depending on the CMS or shop system you use, there are a few things you need to consider. I will explain to you step by step how to do it. <div class="tabs-container tabList__CuJ"><ul role="tablist" aria-orientation="horizontal" class="tabs"><li role="tab" tabindex="0" aria-selected="true" class="tabs__item tabItem_LNqP tabs__item--active">mStudio UI</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_LNqP">CLI</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_LNqP">API</li></ul><div class="margin-top--md"><div role="tabpanel" class="tabItem_Ymn6">To create a Redis database in the mStudio, follow these steps:<ol> <li>Navigate to the project that you want to create the database in.</li> <li>Select the "Databases" menu item in the sidebar.</li> <li>Click the "Create Database" button and select "Redis".</li> <li>Enter a description for the database and select the desired version.</li> </ol>After the installation has completed, observe the host and port in the details under connection information. You need both for the configuration of your system.</div><div role="tabpanel" class="tabItem_Ymn6" hidden="">To create a Redis database from the CLI, run the following command:<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-background-color:hsl(230, 1%, 98%);--prism-color:hsl(230, 8%, 24%)"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="background-color:hsl(230, 1%, 98%);color:hsl(230, 8%, 24%)"><code class="codeBlockLines_e6Vv">$ mw database redis create --description "My Redis database" --version 7.2 </code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></button></div></div></div>After the installation has completed, use the <code>mw database redis get</code> command to observe the connection information.</div><div role="tabpanel" class="tabItem_Ymn6" hidden="">To learn how to create a Redis database via the API, read the article <a href="/docs/v2/api/howtos/create-redis/">"Creating a Redis database"</a>.</div></div></div> <h2 class="anchor anchorWithStickyNavbar_LWe7" id="configuring-redis-as-a-session-storage-for-php">Configuring Redis as a session storage for PHP<a href="#configuring-redis-as-a-session-storage-for-php" class="hash-link" aria-label="Direct link to Configuring Redis as a session storage for PHP" title="Direct link to Configuring Redis as a session storage for PHP"></a></h2> The <code>php.ini</code> file is located in your project under <code>.config/php/php.ini</code>. Add the following code: <div class="language-ini codeBlockContainer_Ckt0 theme-code-block" style="--prism-background-color:hsl(230, 1%, 98%);--prism-color:hsl(230, 8%, 24%)"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-ini codeBlock_bY9V thin-scrollbar" style="background-color:hsl(230, 1%, 98%);color:hsl(230, 8%, 24%)"><code class="codeBlockLines_e6Vv">extension=redis.so session.save_handler = redis session.save_path = "tcp://HOST:PORT?database=15" </code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></button></div></div></div> Now change the variables <code>HOST</code> and <code>PORT</code>. Use the information from the connection information. By default, each Redis database has 16 databases that can be accessed from 0 to 15. <h2 class="anchor anchorWithStickyNavbar_LWe7" id="setting-up-common-applications">Setting up common applications<a href="#setting-up-common-applications" class="hash-link" aria-label="Direct link to Setting up common applications" title="Direct link to Setting up common applications"></a></h2> <h3 class="anchor anchorWithStickyNavbar_LWe7" id="shopware-6">Shopware 6<a href="#shopware-6" class="hash-link" aria-label="Direct link to Shopware 6" title="Direct link to Shopware 6"></a></h3> In your Shopware 6 installation, you enter the configuration for Redis in the <code>services.yaml</code>. It is located in the directory <code>/config</code>. If there is no file there yet, simply create one. Add the following lines at the end of the file: <div class="language-yaml codeBlockContainer_Ckt0 theme-code-block" style="--prism-background-color:hsl(230, 1%, 98%);--prism-color:hsl(230, 8%, 24%)"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-yaml codeBlock_bY9V thin-scrollbar" style="background-color:hsl(230, 1%, 98%);color:hsl(230, 8%, 24%)"><code class="codeBlockLines_e6Vv">parameters: app.redis.cache.host: "%env(REDIS_CACHE_HOST)%" app.redis.cache.port: "%env(int:REDIS_CACHE_PORT)%" app.redis.cache.database: "%env(int:REDIS_CACHE_DATABASE)%" services: Redis: class: Redis calls: - method: connect arguments: - "%env(REDIS_SESSION_HOST)%" - "%env(int:REDIS_SESSION_PORT)%" - method: select arguments: - "%env(int:REDIS_SESSION_DATABASE)%" Symfony\Component\HttpFoundation\Session\Storage\Handler\RedisSessionHandler: arguments: - "@Redis" </code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></button></div></div></div> Now create the file <code>framework.yaml</code> in the <code>config/packages</code> folder. Add the following to the file: <div class="language-yaml codeBlockContainer_Ckt0 theme-code-block" style="--prism-background-color:hsl(230, 1%, 98%);--prism-color:hsl(230, 8%, 24%)"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-yaml codeBlock_bY9V thin-scrollbar" style="background-color:hsl(230, 1%, 98%);color:hsl(230, 8%, 24%)"><code class="codeBlockLines_e6Vv">framework: cache: app: cache.adapter.redis system: cache.adapter.redis default_redis_provider: "redis://%app.redis.cache.host%:%app.redis.cache.port%/%app.redis.cache.database%" session: handler_id: Symfony\Component\HttpFoundation\Session\Storage\Handler\RedisSessionHandler </code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></button></div></div></div> Finally, add the following at the end of <code>.env</code>: <div class="language-shell codeBlockContainer_Ckt0 theme-code-block" style="--prism-background-color:hsl(230, 1%, 98%);--prism-color:hsl(230, 8%, 24%)"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-shell codeBlock_bY9V thin-scrollbar" style="background-color:hsl(230, 1%, 98%);color:hsl(230, 8%, 24%)"><code class="codeBlockLines_e6Vv">REDIS_CACHE_HOST="HOST" REDIS_CACHE_PORT="PORT" REDIS_CACHE_DATABASE="1" REDIS_SESSION_HOST="HOST" REDIS_SESSION_PORT="PORT" REDIS_SESSION_DATABASE="0" </code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></button></div></div></div> <h3 class="anchor anchorWithStickyNavbar_LWe7" id="shopware-5">Shopware 5<a href="#shopware-5" class="hash-link" aria-label="Direct link to Shopware 5" title="Direct link to Shopware 5"></a></h3> Add the following to <code>config.php</code> in the Shopware directory: <div class="language-php codeBlockContainer_Ckt0 theme-code-block" style="--prism-background-color:hsl(230, 1%, 98%);--prism-color:hsl(230, 8%, 24%)"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-php codeBlock_bY9V thin-scrollbar" style="background-color:hsl(230, 1%, 98%);color:hsl(230, 8%, 24%)"><code class="codeBlockLines_e6Vv">// Sessions for backend and frontend in Redis in DB2 'session' => [ 'save_handler' => 'redis', 'save_path' => 'tcp://HOST:PORT/2', ], 'backendsession' => [ 'save_handler' => 'redis', 'save_path' => 'tcp://HOST:PORT/2', ], // Models Cache in Redis in DB3 'model' => [ 'redisHost' => 'tcp://HOST', 'redisPort' => 'PORT', 'redisDbIndex' => '3', 'cacheProvider' => 'redis', ], // Shopware backend cache in Redis in DB3 'cache' => [ 'backend' => 'redis', 'backendOptions' => [ 'servers' => [ [ 'host' => 'tcp://HOST', 'port' => 'PORT', 'dbindex' => '3', ], ], ], ], </code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></button></div></div></div> <h3 class="anchor anchorWithStickyNavbar_LWe7" id="joomla-4">Joomla 4<a href="#joomla-4" class="hash-link" aria-label="Direct link to Joomla 4" title="Direct link to Joomla 4"></a></h3> In the Joomla administration, go to System -> Configuration -> System and configure the following under "Session": <ul> <li>Session handler: Redis</li> <li>Persistent Redis: Yes</li> <li>Redis server host/socket: Enter HOST</li> <li>Redis port: Enter PORT</li> <li>Redis server authentication: Leave as is</li> <li>Redis database: Enter a desired free database number between 0 and 15</li> </ul> Select the desired database number for Redis database and save. <h3 class="anchor anchorWithStickyNavbar_LWe7" id="wordpress">WordPress<a href="#wordpress" class="hash-link" aria-label="Direct link to WordPress" title="Direct link to WordPress"></a></h3> We recommend the plugin <a href="https://wordpress.org/plugins/redis-cache/" target="_blank" rel="noopener noreferrer">Redis Object Cache</a>. Install said plugin via the CLI <div class="language-shell codeBlockContainer_Ckt0 theme-code-block" style="--prism-background-color:hsl(230, 1%, 98%);--prism-color:hsl(230, 8%, 24%)"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-shell codeBlock_bY9V thin-scrollbar" style="background-color:hsl(230, 1%, 98%);color:hsl(230, 8%, 24%)"><code class="codeBlockLines_e6Vv">wp plugin install redis-cache --activate </code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></button></div></div></div> and set the required configuration constants: <div class="language-shell codeBlockContainer_Ckt0 theme-code-block" style="--prism-background-color:hsl(230, 1%, 98%);--prism-color:hsl(230, 8%, 24%)"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-shell codeBlock_bY9V thin-scrollbar" style="background-color:hsl(230, 1%, 98%);color:hsl(230, 8%, 24%)"><code class="codeBlockLines_e6Vv">wp config set --type=constant WP_REDIS_PATH HOST wp config set --type=constant WP_REDIS_PORT PORT wp config set --type=constant WP_REDIS_DATABASE 0 wp config set --type=constant WP_REDIS_SCHEME unix </code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></button></div></div></div> <ul> <li>use the <code>hostname</code> and <code>port</code> specified for the database as values for <code>WP_REDIS_PATH</code> and <code>WP_REDIS_PORT</code> (see <a href="https://developer.mittwald.de/reference/v2#tag/Database/operation/database-get-redis-database" target="_blank" rel="noopener noreferrer"><code>GET https://api.mittwald.de/v2/redis-databases/{id}</code></a>)</li> <li>Choose a free database number between 0 and 15 for the <code>WP_REDIS_DATABASE</code> value.</li> </ul> If you don’t like to use the WP-CLI, you can also install the plugin via the WordPress backend. After installation and activation, add the following entries to <code>wp-config.php</code>: <div class="language-php codeBlockContainer_Ckt0 theme-code-block" style="--prism-background-color:hsl(230, 1%, 98%);--prism-color:hsl(230, 8%, 24%)"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-php codeBlock_bY9V thin-scrollbar" style="background-color:hsl(230, 1%, 98%);color:hsl(230, 8%, 24%)"><code class="codeBlockLines_e6Vv">define('WP_REDIS_PATH', 'HOST'); define('WP_REDIS_PORT', 'PORT'); define('WP_REDIS_DATABASE', '0'); define('WP_REDIS_SCHEME', 'unix'); </code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></button></div></div></div> <h3 class="anchor anchorWithStickyNavbar_LWe7" id="typo3">TYPO3<a href="#typo3" class="hash-link" aria-label="Direct link to TYPO3" title="Direct link to TYPO3"></a></h3> For all versions up to TYPO3 11.5 you create a file named <code>AdditionalConfiguration.php</code> in the <code>typo3conf</code> folder. For TYPO3 version 12.4 and higher you create a file named <code>additional.php</code> in the folders <code>typo3conf/system</code> (for symlink installations) or <code>config/system</code> (for composer installations). Please add the following in each case. If the file already exists, you can omit <code><?php</code>. <div class="language-php codeBlockContainer_Ckt0 theme-code-block" style="--prism-background-color:hsl(230, 1%, 98%);--prism-color:hsl(230, 8%, 24%)"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-php codeBlock_bY9V thin-scrollbar" style="background-color:hsl(230, 1%, 98%);color:hsl(230, 8%, 24%)"><code class="codeBlockLines_e6Vv"><?php $redisHost = 'HOST'; $redisPort = PORT; $redisCaches = [ 'pages' => [ 'defaultLifetime' => 86400*7, 'compression' => true, ], 'pagesection' => [ 'defaultLifetime' => 86400*7, ], 'hash' => [], 'rootline' => [], ]; $redisDatabase = 0; foreach ($redisCaches as $name => $values) { $GLOBALS['TYPO3_CONF_VARS']['SYS']['caching']['cacheConfigurations'][$name]['backend'] = \TYPO3\CMS\Core\Cache\Backend\RedisBackend::class; $GLOBALS['TYPO3_CONF_VARS']['SYS']['caching']['cacheConfigurations'][$name]['options'] = [ 'database' => $redisDatabase++, 'hostname' => $redisHost, 'port' => $redisPort ]; if (isset($values['defaultLifetime'])) { $GLOBALS['TYPO3_CONF_VARS']['SYS']['caching']['cacheConfigurations'][$name]['options']['defaultLifetime'] = $values['defaultLifetime']; } if (isset($values['compression'])) { $GLOBALS['TYPO3_CONF_VARS']['SYS']['caching']['cacheConfigurations'][$name]['options']['compression'] = $values['compression']; } } </code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></button></div></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/mittwald/developer-portal/tree/master/docs/platform/databases/redis.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages navigation"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/v2/platform/databases/mysql/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">MySQL</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/v2/platform/databases/opensearch/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">OpenSearch</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#what-is-redis" class="table-of-contents__link toc-highlight">What is Redis?</a></li><li><a href="#why-do-i-need-redis" class="table-of-contents__link toc-highlight">Why do I need Redis?</a></li><li><a href="#how-do-i-create-a-redis-database" class="table-of-contents__link toc-highlight">How do I create a Redis database?</a></li><li><a href="#configuring-redis-as-a-session-storage-for-php" class="table-of-contents__link toc-highlight">Configuring Redis as a session storage for PHP</a></li><li><a href="#setting-up-common-applications" class="table-of-contents__link toc-highlight">Setting up common applications</a><ul><li><a href="#shopware-6" class="table-of-contents__link toc-highlight">Shopware 6</a></li><li><a href="#shopware-5" class="table-of-contents__link toc-highlight">Shopware 5</a></li><li><a href="#joomla-4" class="table-of-contents__link toc-highlight">Joomla 4</a></li><li><a href="#wordpress" class="table-of-contents__link toc-highlight">WordPress</a></li><li><a href="#typo3" class="table-of-contents__link toc-highlight">TYPO3</a></li></ul></li></ul></div></div></div></div></main></div></div></div><footer class="footer"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/docs/v2/api/intro/">API usage</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/v2/category/platform/">Platform</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/v2/category/sdks-and-libraries/">SDKs and Libraries</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/v2/reference/">Reference</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/mittwald/developer-portal/issues" target="_blank" rel="noopener noreferrer" class="footer__link-item">Feedback<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://agenturen.mittwald.de" target="_blank" rel="noopener noreferrer" class="footer__link-item">Agency Hub (german)<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://www.mittwald.de/agb" target="_blank" rel="noopener noreferrer" class="footer__link-item">Terms of Service<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://www.mittwald.de/datenschutz" target="_blank" rel="noopener noreferrer" class="footer__link-item">Privacy Policy<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://www.mittwald.de/impressum" target="_blank" rel="noopener noreferrer" class="footer__link-item">Legal<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 Mittwald CM Service GmbH & Co. KG. Built with Docusaurus.</div></div></div></footer></div> </body> </html>