Files
help365/platform/redis.html
koziavin 00717a92fb
All checks were successful
Deploy Static Site / deploy (push) Successful in 6m6s
update
2025-05-29 16:42:45 +04:00

250 lines
22 KiB
HTML
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html lang="en">
<head>
<title>Redis</title>
<meta name="generator" content="Help+Manual" />
<meta name="keywords" content="" />
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="For the proper functioning of the system, Redis version 5 or 6.2 is required. The article describes the installation of Redis 6.2.12 for Ubuntu Linux 20.04 and 22.04. You can..." />
<meta name="picture" content="" />
<meta property="og:type" content="website" />
<meta property="og:title" content="Full documentation for BRIX365 platform. Low-code developer guide. User guide. Admin guide. Developer guide." />
<meta property="og:url" content="https://brix365.com/en/help" />
<meta property="og:image" content="" />
<link rel="icon" href="favicon.png" type="image/png" />
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&display=swap" rel="stylesheet" />
<link rel="stylesheet" href="./jquery-ui.min.css" />
<link rel="stylesheet" href="default.css" />
<link rel="stylesheet" href="./search-yandex.css" />
<link rel="stylesheet" href="./article.css" />
<link rel="stylesheet" href="./glossary.css" />
<link rel="stylesheet" href="./theme.css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="helpman_settings.js"></script>
<script type="text/javascript" src="helpman_topicinit.js"></script>
<script type="text/javascript" src="highlight.js"></script>
<script type="text/javascript">
$(document).ready(function(){highlight();});
</script>
</head>
<body>
<script>!function(e,t,c,n,r,a,m){e.ym=e.ym||function(){(e.ym.a=e.ym.a||[]).push(arguments)},e.ym.l=1*new Date;for(var s=0;s<document.scripts.length;s++)if(document.scripts[s].src===n)return;a=t.createElement(c),m=t.getElementsByTagName(c)[0],a.async=1,a.src=n,m.parentNode.insertBefore(a,m)}(window,document,"script","https://mc.yandex.ru/metrika/tag.js"),ym(83179930,"init",{clickmap:!0,trackLinks:!0,accurateTrackBounce:!0,webvisor:!0})</script><noscript><div><img alt=""src=https://mc.yandex.ru/watch/83179930 style=position:absolute;left:-9999px></div></noscript>
<header class="header elma-365">
<div class="container">
<a class="header__logo" href="https://brix365.com/en/help">
<img src="./logo-en.svg" alt="header logo">
</a>
<!-- <div class="hero__search-form" id="search-panel">
<form class="search-form" onsubmit="ym(83180416,'reachGoal','poisk')">
<label class="search-form__label">
<span id="reset-search" class="search__icon"></span>
<input class="search-form__input" type="text">
</label>
<input class="search-form__submit" type="submit" value="Submit">
</form>
</div> -->
<div class="hero__search-form" id="search-panel"> <form class="search-form"> <label class="search-form__label"> <span id="reset-search" class="search__icon"></span> <input class="search-form__input" type="text"> </label> <input class="search-form__submit" type="submit" value="Submit"> </form> </div>
<div class="hero__search">
<a href="#" id="search-icon" class="hero__search-icon">
<img src="search-icon-white.svg" alt="search string">
</a>
<a href="#" id="side-menu-icon" class="hero__side-icon">
<img src="side_menu.svg" alt="side menu">
</a>
</div>
<div class="header__navi">
<ul class="header__list"><li><span class="solution-select"><span class="solution-select__selected"></span><svg width="7" height="4" viewBox="0 0 7 4" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M1 1L3.5 3.5L6 1" stroke="white" stroke-linecap="round" stroke-linejoin="round"/></svg><ul class="solution-select__list"><li><a class="project-link" href="https://brix365.com/en/help/platform/get-trial.html">Platform</a></li><li><a class="project-link" href="https://brix365.com/en/help/ecm/ecm-functions.html">ECM</a></li><li><a class="project-link" href="https://brix365.com/en/help/crm/crm_overview.html">CRM</a></li><li><a class="project-link" href="https://brix365.com/en/help/service/service-functions.html">Service</a></li><li><a class="project-link" href="https://brix365.com/en/help/projects/projects-functions.html">Projects</a></li><li><a class="project-link" href="https://brix365.com/en/help/business_solutions/-elma365-store.html">Business Solutions</a></li></ul></span></li><li><a href="https://api.brix365.com/en/" target="_blank">API</a></li><li><a href="https://tssdk.brix365.com/" target="_blank">SDK</a></li></ul>
</div>
</div>
</header>
<main class="main container">
<aside class="sidebar" id="sidebar">
<div class="sidebar__header">
<a class="header__logo" href="https://brix365.com/en/help">
<img src="./logo-light-en.svg">
</a>
<span class="sidebar__close elma-365-close" id="close"></span>
</div>
<div class="sidebar__wrapper" id="side-menu">
</div>
</aside>
<article class="article" id="article">
<div class="article-inner">
<div class="content">
<header class="article__header">
<div class="article__bread" style="display:flex; gap:10px;">
<span id="subcategory" class="search-res__item-category search-res__item-category_subcategory subcategory article__badge"></span>
<div class="topic__breadcrumbs">
<p><a href="elma365-on-premises.html">BRIX On-Premises</a> &gt; <a href="infrastructure-preparation.html">Prepare infrastructure</a> &gt; Databases &gt; Prepare external databases / Redis</p>
</div>
</div>
<div class="topic__title"><h1 class="p_Heading1"><span class="f_Heading1">Redis</span></h1>
</div>
</header>
<section class="article__content">
<div class="scroll-top-inner">
<a href="#h1-article" class="scroll-top"></a>
</div>
<!-- Placeholder for topic body. -->
<p class="p_Normal">For the proper functioning of the system, Redis version 5 or 6.2 is required. The article describes the installation of Redis 6.2.12 for Ubuntu Linux 20.04 and 22.04. You can also refer to the guide in the <a href="https://redis.io/docs/getting-started/installation/install-redis-on-linux/" target="_blank" class="weblink">official Redis documentation</a>.</p>
<p class="p_Normal">Installation consists of three steps:</p>
<ol style="list-style-type:decimal">
<li value="1" class="p_Normal"><a href="redis.html#1redis" class="topiclink">Install Redis</a>.</li><li value="2" class="p_Normal"><a href="redis.html#2redis" class="topiclink">Configure Redis</a>.</li><li value="3" class="p_Normal"><a href="redis.html#3redis" class="topiclink">Connect to Redis</a>.</li></ol>
<h2 class="p_Heading2"><a id="1redis" class="hmanchor"></a><span class="f_Heading2">Step 1: Install Redis</span></h2>
<ol style="list-style-type:upper-roman">
<li value="1" class="p_Normal">Install the necessary packages:</li></ol>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">sudo&nbsp;apt&nbsp;install&nbsp;lsb-release&nbsp;curl&nbsp;gpg</span></p>
<ol style="list-style-type:upper-roman" start="2">
<li value="2" class="p_Normal">Import the necessary keys and add the Redis repository:</li></ol>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">curl&nbsp;-fsSL&nbsp;https://packages.redis.io/gpg&nbsp;|&nbsp;sudo&nbsp;gpg&nbsp;--dearmor&nbsp;-o&nbsp;/usr/share/keyrings/redis-archive-keyring.gpg</span><br />
<span class="f_CodeExample">echo&nbsp;&quot;deb&nbsp;[signed-by=/usr/share/keyrings/redis-archive-keyring.gpg]&nbsp;https://packages.redis.io/deb&nbsp;$(lsb_release&nbsp;-cs)&nbsp;main&quot;&nbsp;|&nbsp;sudo&nbsp;tee&nbsp;/etc/apt/sources.list.d/redis.list</span></p>
<ol style="list-style-type:upper-roman" start="3">
<li value="3" class="p_Normal">Update the package cache:</li></ol>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">sudo&nbsp;apt-get&nbsp;update</span></p>
<ol style="list-style-type:upper-roman" start="4">
<li value="4" class="p_CodeExample" style="page-break-inside: avoid;">Install&nbsp;Redis:</li></ol>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">sudo&nbsp;apt-get&nbsp;-y&nbsp;install&nbsp;redis=6:6.2.12-1rl1~$(lsb_release&nbsp;-cs)1&nbsp;redis-server=6:6.2.12-1rl1~$(lsb_release&nbsp;-cs)1&nbsp;redis-tools=6:6.2.12-1rl1~$(lsb_release&nbsp;-cs)1</span></p>
<h2 class="p_Heading2"><a id="2redis" class="hmanchor"></a><span class="f_Heading2">Step 2: Configure Redis</span></h2>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">Начало&nbsp;примечание</span></p>
<p class="p_Normal"><span style="font-weight: bold;">Note</span></p>
<p class="p_Normal">The password can contain the following characters:</p>
<ul style="list-style-type:disc">
<li class="p_Normal">Uppercase Latin letters: A to Z</li><li class="p_Normal">Lowercase Latin letters: a to z</li><li class="p_Normal">Digits: 0 to 9</li><li class="p_Normal">Symbols: -_</li></ul>
<p class="p_Normal">Reserved (invalid) characters: ! * ' ( ) ; : @ &amp; = + $ , / ? % # [ ]</p>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">Конец&nbsp;примечание</span></p>
<ol style="list-style-type:upper-roman">
<li value="1" class="p_Normal">Allow connection to the Redis server. To do this, edit the <code><b>/etc/redis/redis.conf</b></code> configuration file and add the machine's IP address (e.g., 192.168.10.10):</li></ol>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">sudo&nbsp;nano&nbsp;/etc/redis/redis.conf</span><br />
<span class="f_CodeExample">bind&nbsp;192.168.10.10</span></p>
<p class="p_Normal"><a class="dropdown-toggle" style="font-style: normal; font-weight: normal; color: #000000; background-color: transparent; text-decoration: none;" href="javascript:HMToggle('toggle','TOGGLE0186A1')">Configuring TLS/SSL in Redis</a></p>
<div id="TOGGLE0186A1" class="dropdown-toggle-body" style="text-align: left; text-indent: 0; line-height: 1.80; padding: 0 0 0 0; margin: 0 0 0 0;"><table style="border:none; border-spacing:0;">
<tr>
<td style="vertical-align:top; padding:0; border:none"><p class="p_Normal">To enable TLS/SSL support in Redis, in the configuration file <code><b>redis.conf</b></code> do the following:</p>
<ol style="list-style-type:decimal">
<li value="1" class="p_Normal">Disable unprotected connections by setting <code><b>0</b></code> in the parameter <code><b>port</b></code>. </li><li value="2" class="p_Normal">Set the port for TLS connections. Uncomment the parameter <code><b>tls-port</b></code>.</li><li value="3" class="p_Normal">Specify the path to the server certificate file in the parameter <code><b>tls-cert-file</b></code>.</li><li value="4" class="p_Normal">Specify the path to the private key file in the parameter <code><b>tls-key-file</b></code>.</li><li value="5" class="p_Normal">Specify the path to the root CA file in the parameter <code><b>tls-ca-cert-file</b></code>.</li><li value="6" class="p_Normal">Disable client authentication using the active certificate by setting <code><b>no</b></code> in the parameter <code><b>tls-auth-clients</b></code>.</li></ol>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">port&nbsp;0</span><br />
<span class="f_CodeExample">tls-port&nbsp;6379</span><br />
<span class="f_CodeExample">tls-cert-file&nbsp;/path/redis.crt</span><br />
<span class="f_CodeExample">tls-key-file&nbsp;/path/redis.key</span><br />
<span class="f_CodeExample">tls-ca-cert-file&nbsp;/path/to/ca.crt</span><br />
<span class="f_CodeExample">tls-auth-clients&nbsp;no</span></p>
<p class="p_Normal">For more details on TLS/SSL configuration in Redis, refer to the <a href="https://redis.io/docs/management/security/encryption/" target="_blank" class="weblink">official Redis documentation</a>.</p>
</td>
</tr>
</table>
</div>
<ol style="list-style-type:upper-roman" start="2">
<li value="2" class="p_Normal">Increase the maximum number of clients by changing the value of the parameter <code><b>maxclients</b></code> to <code><b>20000</b></code>. Uncomment the line by removing the # sign:</li></ol>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">maxclients&nbsp;20000</span></p>
<ol style="list-style-type:upper-roman" start="3">
<li value="3" class="p_Normal">Set the key eviction policy by changing the value of the parameter <code><b>maxmemory-policy</b></code> to <code><b>allkeys-lfu</b></code>. Uncomment the line by removing the # sign:</li></ol>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">maxmemory-policy&nbsp;allkeys-lfu</span></p>
<ol style="list-style-type:upper-roman" start="4">
<li value="4" class="p_Normal"> Disable <span style="font-weight: bold;">snapshot</span> creation by changing the value of the parameter <code><b>save</b></code> to <code><b>""</b></code>. Uncomment the line by removing the # sign:</li></ol>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">save&nbsp;&quot;&quot;</span></p>
<ol style="list-style-type:upper-roman" start="5">
<li value="5" class="p_Normal">Disable <span style="font-weight: bold;">AOF</span> (saving the Redis database to a file). To do this, change the value of the parameter <code><b>appendonly</b></code> to <code><b>no</b></code>. Uncomment the line, removing the # sign:</li></ol>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">appendonly&nbsp;no</span></p>
<ol style="list-style-type:upper-roman" start="6">
<li value="6" class="p_CodeExample" style="page-break-inside: avoid;">Restart&nbsp;Redis:</li></ol>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">sudo&nbsp;systemctl&nbsp;restart&nbsp;redis-server</span></p>
<h2 class="p_Heading2"><a id="3redis" class="hmanchor"></a><span class="f_Heading2">Step 3: Connect to Redis</span></h2>
<p class="p_Normal">Connection string to Redis:</p>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">redis://&lt;redis-server-address&gt;:6379/0</span></p>
<p class="p_Normal">Connection string to Redis with TLS/SSL:</p>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">redis:</span><span class="f_CodeExample">//&lt;redis-server-address&gt;:6379/0</span></p>
<p class="p_Normal">If you already have a Redis cluster, you can use it as a cache for BRIX. For information on deploying a Redis Cluster, refer to the <a href="https://redis.io/docs/management/scaling/#redis-cluster-101)" target="_blank" class="weblink">official documentation</a>.</p>
<div class="bottom-nav">
<a id="prev-link" class="topic__navi_prev" href="mongodb.html">
<span class="bottom-nav__arrow bottom-nav__arrow--prev"></span> <span
class="bottom-nav__link">mongodb.html</span>
</a>
<a id="next-link" class="topic__navi_next" href="rabbitmq.html">
<span class="bottom-nav__link">rabbitmq.html</span> <span
class="bottom-nav__arrow bottom-nav__arrow--next"></span>
</a>
</div>
<!-- добавляет на страницу строку блок Была ли статья полезной? -->
<div class="feedback" id="feedback"><div class="feedback-help"><span><b>Was this helpful?</b></span><form action="" method="POST" class="feedback-form" id="feedback-form"><div class="feedback__popup feedback__popup-response" id="feedback__popup_thx" style="display: none;">Thanks for your feedback!</div><div class="feedback__popup" id="feedback__popup_why" style="display: none;"><div class="feedback__popup-header">Please specify why:</div><input type="radio" name="category" id="bad_recommendation" value="bad_recommendation"><label for="bad_recommendation">Recommendations did not help me</label><input type="radio" name="category" id="difficult_text" value="difficult_text"><label for="difficult_text">Article is hard to understand</label><input type="radio" name="category" id="no_answer" value="no_answer"><label for="no_answer">Didn`t answer my question</label><input type="radio" name="category" id="bad_header" value="bad_header"><label for="bad_header">Content does not match the topic</label><input type="radio" name="category" id="other_reason" value="other_reason"><label for="other_reason">Other</label></div><div class="feedback__popup" id="feedback__popup-other" style="display: none;"><div class="feedback__popup-header">How we can improve it?</div><textarea class="feedback__textarea" name="other" id=""></textarea><input type="submit" class="feedback__other-btn" value="Submit"></div><div class="feedback-form__btn-group"><input type="radio" name="useful" id="feedback__useful_yes" value="true"><label for="feedback__useful_yes"><img src="like.svg" class="small-img" alt="like"><spanclass="feedback-form__btn-group_yes-btn">Yes</spanclass="feedback-form__btn-group_yes-btn"></label><input type="radio" name="useful" id="feedback__useful_no" value="false"><label for="feedback__useful_no"><img src="dislike.svg" class="small-img" alt="dislike"><spanclass="feedback-form__btn-group_no-btn">No</spanclass="feedback-form__btn-group_no-btn"></label></div><select name="category"><option disabled="">Please specify why</option><option value="bad_recommendation" selected="">Recommendations did not help me</option><option value="difficult_text">Article is hard to understand</option><option value="no_answer">Didn`t answer my question</option><option value="bad_header">Content does not match the topic</option><option value="other_reason">Other</option></select><input type="submit"></form></div><div class="found_typo"><p style="margin: 0px; margin-top: 16px !important;"><span><b>Found a typo?</b></span> Select it and press <i>Ctrl+Enter</i> to send us feedback</p></div></div>
</section>
</div>
<aside class="article__sidebar" style="display:none">
<input type="checkbox" />
<div class="article__arrow"></div>
<div class="table-of-contents elma365-right" id="toc2Content">
<h3 class="h3-toc">In this topic</h3>
<nav id="toc2"></nav>
</div>
</aside>
</div>
</article>
</main>
<footer class="footer">
<div class="footer-container">
<div class="footer-mobile">
<ul class="footer-mobile__list"><li><a href="https://brix365.com/en/" target="_blank">BRIX</a></li><li><a href="https://tssdk.brix365.com/en/latest/" target="_blank">SDK</a></li><li><a href="https://api.brix365.com/en/" target="_blank">API</a></li></ul><ul class="footer-mobile__list"><li><a href="https://brix365.com/en/help/platform/get-trial.html">Platform</a></li><li><a href="https://brix365.com/en/help/ecm/ecm-functions.html">ECM</a></li><li><a href="https://brix365.com/en/help/service/service-functions.html">Service</a></li><li><a href="https://brix365.com/en/help/projects/projects-functions.html">Projects</a></li></ul>
</div>
<div class="footer-wrap">
<div><span class="mobile-question-popup">Send feedback</span><form method="POST" action class="question__popup question-xs" id="question__popup"><div class="question-wrap"><span class="close"></span><span class="title">Ask a question</span><label for="help_question" style="display: none;"></label><textarea name="help_question" id="help_question"></textarea><input type="submit" value="Send"></div></form><div class="hidden fade-in question-success-xs">Sent</div></div>
<div class="footer-flex-b">
<span class="footer-copy">&copy; 2025 BRIX</span>
<ul class="footer-list">
<li class="footer-item">
<a href="#" class="arrow-top" style="display: block;"></a>
</li>
</ul>
</div>
</div>
</div>
</footer>
<iframe name="hmnavigation" style="display:none!important"></iframe>
<script src="./jquery-ui.js"></script>
<!--script src="//cdn.jsdelivr.net/npm/featherlight@1.7.14/release/featherlight.min.js" type="text/javascript" charset="utf-8"></script-->
<script src="./jquery.tocify.min.js"></script>
<script src="./TypoReporter.min.js"></script>
<script src="./google-search.js"></script>
<script src="./main.js"></script>
<script type="text/javascript">
HMInitToggle('TOGGLE0186A1','hm.type','dropdown','hm.state','0');
</script>
</body>
</html>