|
Server : LiteSpeed System : Linux srv104790275 5.15.0-161-generic #171-Ubuntu SMP Sat Oct 11 08:17:01 UTC 2025 x86_64 User : dewac4139 ( 1077) PHP Version : 8.0.30 Disable Function : pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,pcntl_unshare, Directory : /usr/share/doc/restic/html/ |
Upload File : |
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Participating — restic 0.12.1
documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/restic.css" type="text/css" />
<link rel="shortcut icon" href="_static/favicon.ico"/>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="References" href="100_references.html" />
<link rel="prev" title="Examples" href="080_examples.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> restic
<img src="_static/logo.png" class="logo" alt="Logo"/>
</a>
<div class="version">
0.12.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="010_introduction.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="020_installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="030_preparing_a_new_repo.html">Preparing a new repository</a></li>
<li class="toctree-l1"><a class="reference internal" href="040_backup.html">Backing up</a></li>
<li class="toctree-l1"><a class="reference internal" href="045_working_with_repos.html">Working with repositories</a></li>
<li class="toctree-l1"><a class="reference internal" href="050_restore.html">Restoring from backup</a></li>
<li class="toctree-l1"><a class="reference internal" href="060_forget.html">Removing backup snapshots</a></li>
<li class="toctree-l1"><a class="reference internal" href="070_encryption.html">Encryption</a></li>
<li class="toctree-l1"><a class="reference internal" href="075_scripting.html">Scripting</a></li>
<li class="toctree-l1"><a class="reference internal" href="080_examples.html">Examples</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Participating</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#debugging">Debugging</a></li>
<li class="toctree-l2"><a class="reference internal" href="#contributing">Contributing</a></li>
<li class="toctree-l2"><a class="reference internal" href="#security">Security</a></li>
<li class="toctree-l2"><a class="reference internal" href="#compatibility">Compatibility</a></li>
<li class="toctree-l2"><a class="reference internal" href="#building-documentation">Building documentation</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="100_references.html">References</a></li>
<li class="toctree-l1"><a class="reference internal" href="110_talks.html">Talks</a></li>
<li class="toctree-l1"><a class="reference internal" href="faq.html">FAQ</a></li>
<li class="toctree-l1"><a class="reference internal" href="manual_rest.html">Manual</a></li>
<li class="toctree-l1"><a class="reference internal" href="developer_information.html">Developer Information</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">restic</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> »</li>
<li>Participating</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/090_participating.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="participating">
<h1>Participating<a class="headerlink" href="#participating" title="Permalink to this headline">¶</a></h1>
<section id="debugging">
<h2>Debugging<a class="headerlink" href="#debugging" title="Permalink to this headline">¶</a></h2>
<p>The program can be built with debug support like this:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>go run build.go -tags debug
</pre></div>
</div>
<p>Afterwards, extensive debug messages are written to the file in
environment variable <code class="docutils literal notranslate"><span class="pre">DEBUG_LOG</span></code>, e.g.:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span><span class="nv">DEBUG_LOG</span><span class="o">=</span>/tmp/restic-debug.log restic backup ~/work
</pre></div>
</div>
<p>If you suspect that there is a bug, you can have a look at the debug
log. Please be aware that the debug log might contain sensitive
information such as file and directory names.</p>
<p>The debug log will always contain all log messages restic generates. You
can also instruct restic to print some or all debug messages to stderr.
These can also be limited to e.g. a list of source files or a list of
patterns for function names. The patterns are globbing patterns (see the
documentation for <a class="reference external" href="https://golang.org/pkg/path/#Glob">path.Glob</a>), multiple
patterns are separated by commas. Patterns are case sensitive.</p>
<p>Printing all log messages to the console can be achieved by setting the
file filter to <code class="docutils literal notranslate"><span class="pre">*</span></code>:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span><span class="nv">DEBUG_FILES</span><span class="o">=</span>* restic check
</pre></div>
</div>
<p>If you want restic to just print all debug log messages from the files
<code class="docutils literal notranslate"><span class="pre">main.go</span></code> and <code class="docutils literal notranslate"><span class="pre">lock.go</span></code>, set the environment variable
<code class="docutils literal notranslate"><span class="pre">DEBUG_FILES</span></code> like this:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span><span class="nv">DEBUG_FILES</span><span class="o">=</span>main.go,lock.go restic check
</pre></div>
</div>
<p>The following command line instructs restic to only print debug
statements originating in functions that match the pattern <code class="docutils literal notranslate"><span class="pre">*unlock*</span></code>
(case sensitive):</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span><span class="nv">DEBUG_FUNCS</span><span class="o">=</span>*unlock* restic check
</pre></div>
</div>
</section>
<section id="contributing">
<h2>Contributing<a class="headerlink" href="#contributing" title="Permalink to this headline">¶</a></h2>
<p>Contributions are welcome! Please <strong>open an issue first</strong> (or add a
comment to an existing issue) if you plan to work on any code or add a
new feature. This way, duplicate work is prevented and we can discuss
your ideas and design first.</p>
<p>More information and a description of the development environment can be
found in <a class="reference external" href="https://github.com/restic/restic/blob/master/CONTRIBUTING.md">CONTRIBUTING.md</a>.
A document describing the design of restic and the data structures stored on the
back end is contained in <a class="reference external" href="https://restic.readthedocs.io/en/latest/design.html">Design</a>.</p>
<p>If you’d like to start contributing to restic, but don’t know exactly
what do to, have a look at this great article by Dave Cheney:
<a class="reference external" href="https://dave.cheney.net/2016/03/12/suggestions-for-contributing-to-an-open-source-project">Suggestions for contributing to an Open Source
project</a>
A few issues have been tagged with the label <code class="docutils literal notranslate"><span class="pre">help</span> <span class="pre">wanted</span></code>, you can
start looking at those:
<a class="reference external" href="https://github.com/restic/restic/labels/help%20wanted">https://github.com/restic/restic/labels/help%20wanted</a></p>
</section>
<section id="security">
<h2>Security<a class="headerlink" href="#security" title="Permalink to this headline">¶</a></h2>
<p><strong>Important</strong>: If you discover something that you believe to be a
possible critical security problem, please do <em>not</em> open a GitHub issue
but send an email directly to <a class="reference external" href="mailto:alexander%40bumpern.de">alexander<span>@</span>bumpern<span>.</span>de</a>. If possible, please
encrypt your email using the following PGP key
(<a class="reference external" href="https://pgp.mit.edu/pks/lookup?op=get&search=0xCF8F18F2844575973F79D4E191A6868BD3F7A907">0x91A6868BD3F7A907</a>):</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pub</span> <span class="mi">4096</span><span class="n">R</span><span class="o">/</span><span class="mi">91</span><span class="n">A6868BD3F7A907</span> <span class="mi">2014</span><span class="o">-</span><span class="mi">11</span><span class="o">-</span><span class="mi">01</span>
<span class="n">Key</span> <span class="n">fingerprint</span> <span class="o">=</span> <span class="n">CF8F</span> <span class="mi">18</span><span class="n">F2</span> <span class="mi">8445</span> <span class="mi">7597</span> <span class="mi">3</span><span class="n">F79</span> <span class="n">D4E1</span> <span class="mi">91</span><span class="n">A6</span> <span class="mi">868</span><span class="n">B</span> <span class="n">D3F7</span> <span class="n">A907</span>
<span class="n">uid</span> <span class="n">Alexander</span> <span class="n">Neumann</span> <span class="o"><</span><span class="n">alexander</span><span class="nd">@bumpern</span><span class="o">.</span><span class="n">de</span><span class="o">></span>
<span class="n">sub</span> <span class="mi">4096</span><span class="n">R</span><span class="o">/</span><span class="n">D5FC2ACF4043FDF1</span> <span class="mi">2014</span><span class="o">-</span><span class="mi">11</span><span class="o">-</span><span class="mi">01</span>
</pre></div>
</div>
</section>
<section id="compatibility">
<h2>Compatibility<a class="headerlink" href="#compatibility" title="Permalink to this headline">¶</a></h2>
<p>Backward compatibility for backups is important so that our users are
always able to restore saved data. Therefore restic follows <a class="reference external" href="https://semver.org">Semantic
Versioning</a> to clearly define which versions are
compatible. The repository and data structures contained therein are
considered the “Public API” in the sense of Semantic Versioning. This
goes for all released versions of restic, this may not be the case for
the master branch.</p>
<p>We guarantee backward compatibility of all repositories within one major
version; as long as we do not increment the major version, data can be
read and restored. We strive to be fully backward compatible to all
prior versions.</p>
</section>
<section id="building-documentation">
<h2>Building documentation<a class="headerlink" href="#building-documentation" title="Permalink to this headline">¶</a></h2>
<p>The restic documentation is built with <a class="reference external" href="https://www.sphinx-doc.org">Sphinx</a>,
therefore building it locally requires a recent Python version and requirements listed in <code class="docutils literal notranslate"><span class="pre">doc/requirements.txt</span></code>.
This example will guide you through the process using <a class="reference external" href="https://virtualenv.pypa.io">virtualenv</a>:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ virtualenv venv # create virtual python environment
$ source venv/bin/activate # activate the virtual environment
$ cd doc
$ pip install -r requirements.txt # install dependencies
$ make html # build html documentation
$ # open _build/html/index.html with your favorite browser
</pre></div>
</div>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="080_examples.html" class="btn btn-neutral float-left" title="Examples" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="100_references.html" class="btn btn-neutral float-right" title="References" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2024, restic authors.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>