indexbackup
Version:
Manticore Search physical backup utility
68 lines (59 loc) • 6.22 kB
HTML
<html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>indexbackup - v0.1.3</title><meta name="description" content="Documentation for indexbackup - v0.1.3"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">indexbackup - v0.1.3</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><h1> indexbackup - v0.1.3 </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><div class="tsd-panel tsd-typography">
<a href="#manticore-search-physical-backup-utility" id="manticore-search-physical-backup-utility" style="color: inherit; text-decoration: none;">
<h1>Manticore Search physical backup utility</h1>
</a>
<p><a href="https://manticoresearch.com/">Manticore Search</a> index dump utility</p>
<p>WARNING! Early stage of development - working with Manticore > 5.0.3</p>
<p>Always check the result of creating a backup</p>
<a href="#quick-start" id="quick-start" style="color: inherit; text-decoration: none;">
<h2>Quick start</h2>
</a>
<p>To work correctly, the script must be run with sudo or as a root user</p>
<pre><code class="language-shell"><span class="hl-0">yarn global add indexbackup</span>
</code></pre>
<a href="#create-physical-backup" id="create-physical-backup" style="color: inherit; text-decoration: none;">
<h2>Create physical backup</h2>
</a>
<a href="#checking-the-availability-of-index-files" id="checking-the-availability-of-index-files" style="color: inherit; text-decoration: none;">
<h3>Checking the Availability of Index Files</h3>
</a>
<pre><code class="language-shell"><span class="hl-0">sudo indexbackup --dry-run index_name</span>
</code></pre>
<a href="#locally" id="locally" style="color: inherit; text-decoration: none;">
<h3>Locally</h3>
</a>
<pre><code class="language-shell"><span class="hl-0">sudo indexbackup index_name > backup.tar.gz</span>
</code></pre>
<a href="#aws-s3" id="aws-s3" style="color: inherit; text-decoration: none;">
<h3>AWS S3</h3>
</a>
<a href="#backup-all-indexes" id="backup-all-indexes" style="color: inherit; text-decoration: none;">
<h4>Backup all indexes</h4>
</a>
<pre><code class="language-shell"><span class="hl-0">sudo indexbackup --all | aws s3 cp - s3://buket-name/backup.tar.gz</span>
</code></pre>
<a href="#restore" id="restore" style="color: inherit; text-decoration: none;">
<h4>Restore</h4>
</a>
<pre><code class="language-shell"><span class="hl-1"># cd to manticore data dir</span><br/><span class="hl-2">cd</span><span class="hl-0"> /var/lib/manticore </span><br/><br/><span class="hl-1"># stop manticore</span><br/><span class="hl-0">systemctl stop manticore</span><br/><br/><span class="hl-1"># get data from aws s3 and unpack</span><br/><span class="hl-0">aws s3 cp s3://buket-name/backup.tar.gz - | tar -C </span><span class="hl-2">.</span><span class="hl-0"> -xzf</span><br/><br/><span class="hl-1"># start manticore</span><br/><span class="hl-0">systemctl start manticore</span><br/><br/><span class="hl-1"># check result</span><br/><span class="hl-0">mysql -P9306</span>
</code></pre>
<a href="#options" id="options" style="color: inherit; text-decoration: none;">
<h2>Options</h2>
</a>
<pre><code class="language-shell"><span class="hl-0">indexbackup --help</span>
</code></pre>
<ul>
<li>--all - backup of all indexes + manticore.json if the utility can find it</li>
<li>-h/--host - specify host (default: 127.0.0.1)</li>
<li>-P/--port - specify port (default: 9306)</li>
<li>--index=index1,index2 - specify indexes</li>
<li>--type=rt index types</li>
<li>--add-config Backup manticore.json if the utility can find it, </li>
<li>Or you can specify the data directory --data-dir=/var/lib/manticore</li>
</ul>
<a href="#check-version" id="check-version" style="color: inherit; text-decoration: none;">
<h3>Check version</h3>
</a>
<pre><code class="language-shell"><span class="hl-0">indexbackup -v</span>
</code></pre>
</div></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="assets/main.js"></script></body></html>