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

223 lines
20 KiB
HTML
Raw 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>Backup and restore databases for BRIX Standard</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="Data backup for BRIX Standard (KinD) should include:" />
<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="elma365-on-premises-standard.html">BRIX On-Premises Standard</a> / Backup and restore databases for BRIX Standard</p>
</div>
</div>
<div class="topic__title"><h1 class="p_Heading1"><span class="f_Heading1">Backup and restore databases for BRIX Standard</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">Data backup for BRIX Standard (KinD) should include:</p>
<ul style="list-style-type:disc">
<li class="p_Normal">PostgreSQL. The database stores the main system data: users, app items, workspace settings and app configurations, business processes, pages, widgets, tasks, events, and other configuration settings;</li><li class="p_Normal">MongoDB. The database contains unstructured system settings, live chat data, and feed entries;</li><li class="p_Normal">S3 Object Storage. The object storage holds files uploaded to and created in BRIX of any type and size, such as documents, photos, audio, and video files.</li></ul>
<p class="p_Normal">&nbsp;</p>
<h2 class="p_Heading2"><span class="f_Heading2">Backup of data for BRIX Standard (KinD)</span></h2>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">начало&nbsp;внимание</span></p>
<p class="p_Normal">During the backup process, the BRIX Standard (KinD) services are halted, rendering the app inaccessible.</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" style="page-break-inside: avoid;">Stop the BRIX Standard app by executing the command:</li></ol>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">sudo&nbsp;./elma365-docker.sh&nbsp;--stop</span></p>
<ol style="list-style-type:upper-roman">
<li value="2" class="p_Normal">To create a backup of the databases, run the installation script <code><b>elma365-docker.sh</b></code> with the<code><b> --dump</b></code> key:</li></ol>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">sudo</span><span class="f_CodeExample" style="color: #ffffff;">&nbsp;</span><span class="f_CodeExample">./elma365-docker.sh&nbsp;--dump</span></p>
<p class="p_Normal">Example of running the installation script with the <code><b> --dump</b></code> key:<br />
<img alt="backup-restore-2" title="backup-restore-2" width="977" height="203" style="margin:0;width:977px;height:203px;border:none" src="backup-restore-2.png"/></p>
<p class="p_Normal">Upon completion of the backup, you will see a message confirming the successful creation of the dump.</p>
<p class="p_Normal">The dump will be saved in a separate folder, named with the version of the distribution and a timestamp, for example, <code><b> "/backup/ELMA365_2023.2.15_2023.04.10-13.52.26"</b></code>.<br />
By default, dumps are saved in the <code><b>"/backup"</b></code> path. The directory where the BRIX Standard (KinD) system backups will be saved is specified in the <code><b>ELMA365_BACKUP_DIR</b></code> parameter of the <code><b>config-elma365.txt</b></code> configuration file. For more details on how to save backup copies, see <a href="change-elma365standard-parameters.html" class="topiclink">Modify BRIX Standard parameters</a>.</p>
<ol style="list-style-type:upper-roman">
<li value="3" class="p_Normal">Start the BRIX Standard application by executing the command:</li></ol>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">sudo</span><span class="f_CodeExample" style="color: #ffffff;">&nbsp;</span><span class="f_CodeExample">./elma365-docker.sh&nbsp;--start</span></p>
<h2 class="p_Heading2"><a id="restore" class="hmanchor"></a><span class="f_Heading2">Restore data for BRIX Standard (KinD)</span></h2>
<p class="p_Normal">Restoring data from a backup can help recover BRIX Standard (KinD) in the event of a virtual infrastructure failure or physical infrastructure breakdown.</p>
<p class="p_Normal">If you use external databases, prepare them for restoration. For more details, refer to the following articles: <a href="postgresql.html#prepare-to-restore" class="topiclink">PostgreSQL</a> and <a href="mongodb.html#prepare-to-restore" class="topiclink">MongoDB</a>.</p>
<p class="p_Normal">If restoration of the host system is not possible, install BRIX on a new server.</p>
<ol style="list-style-type:upper-roman">
<li value="1" class="p_Normal">Stop the BRIX Standard application by executing the command:</li></ol>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">sudo&nbsp;./elma365-docker.sh&nbsp;--stop</span></p>
<ol style="list-style-type:upper-roman" start="2">
<li value="2" class="p_Normal">If you have previously used PostgreSQL and MongoDB databases, prepare them for restoration by completing the following steps:</li></ol>
<ul style="list-style-type:disc">
<li class="p_Normal">recreate databases using the <code><b>drop</b></code> command. For more details, see <a href="postgresql.html#prepare-to-restore" class="topiclink">PostgreSQL</a> and <a href="mongodb.html#prepare-to-restore" class="topiclink">MongoDB</a>.</li><li class="p_Normal">configure the databases according to parameters given in <a href="infrastructure-preparation.html" class="topiclink">Prepare infrastructure</a>.</li></ul>
<ol style="list-style-type:upper-roman" start="2">
<li value="3" class="p_Normal">Restore data from a backup copy.</li></ol>
<p class="p_Normal"><span style="font-weight: bold;">Important</span>: Before restoring data, make sure that the folder containing the backup copy is located in the <code><b>/backup</b></code> folder or in another folder specified in the <span style="font-size: 15px; font-family: Inter; color: #0563c1;"><a href="change-elma365standard-parameters.html" class="topiclink">parameters of the configuration file</a></span><span style="font-size: 15px; font-family: Inter;">. Example of a path to the backup: </span><code><b>/backup/&lt;backup-folder-name&gt;</b></code><span style="font-size: 15px; font-family: Inter;">. Restoring data from folders with a deeper layer such as </span><code><b>/backup/elma365/&lt;backup-folder-name&gt;</b></code><span style="font-size: 15px; font-family: Inter;"> is not permitted.</span></p>
<p class="p_Normal">To restore the data, run the installation script with the keys<code><b> --restore</b></code> and <code><b>--path /backup/&lt;backup-folder-name&gt;</b></code>:</p>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">sudo&nbsp;./elma365-docker.sh&nbsp;--restore&nbsp;--path&nbsp;/backup/&lt;backup-folder-name&gt;</span></p>
<p class="p_Normal">Example of executing the installation script with the keys <code><b> --restore</b></code> and <code><b>--path /backup/&lt;backup-folder-name&gt;</b></code>:<br />
<img alt="backup-restore-3" title="backup-restore-3" width="981" height="167" style="margin:0;width:981px;height:167px;border:none" src="backup-restore-3.png"/></p>
<p class="p_Normal">Upon completion of data restoration from the backup, you will see a message confirming the successful restoration.</p>
<ol style="list-style-type:upper-roman" start="4">
<li value="4" class="p_CodeExample" style="page-break-inside: avoid;">Start&nbsp;BRIX&nbsp;Standard&nbsp;by&nbsp;executing&nbsp;the&nbsp;command:</li></ol>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">sudo</span><span class="f_CodeExample" style="color: #ffffff;">&nbsp;</span><span class="f_CodeExample">./elma365-docker.sh&nbsp;--start</span></p>
<div class="bottom-nav">
<a id="prev-link" class="topic__navi_prev" href="version-update-standard.html">
<span class="bottom-nav__arrow bottom-nav__arrow--prev"></span> <span
class="bottom-nav__link">version-update-standard.html</span>
</a>
<a id="next-link" class="topic__navi_next" href="embedded-to-external-database-standard.html">
<span class="bottom-nav__link">embedded-to-external-database-standard.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>
</body>
</html>