archinstall/help/report_bug.html

162 lines
8.7 KiB
HTML

<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="../">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Report Issues &amp; Bugs &mdash; python-archinstall v2.3.0 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=7ab3649f" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=4ae1632d" />
<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../_static/documentation_options.js?v=387c4177"></script>
<script src="../_static/doctools.js?v=fd6eb6e6"></script>
<script src="../_static/sphinx_highlight.js?v=6ffebe34"></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="Discord" href="discord.html" />
<link rel="prev" title="Known Issues" href="known_issues.html" />
<link href="../_static/style.css" rel="stylesheet" type="text/css">
</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">
python-archinstall
<img src="../_static/logo.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="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">
<p class="caption" role="heading"><span class="caption-text">Running Archinstall</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../installing/guided.html">Guided installation</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Getting help</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="known_issues.html">Known Issues</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Report Issues &amp; Bugs</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#log-files">Log files</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="discord.html">Discord</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Archinstall as a library</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../installing/python.html">Python library</a></li>
<li class="toctree-l1"><a class="reference internal" href="../examples/python.html">Python module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../archinstall/plugins.html">Python Plugins</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">API Reference</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../archinstall/Installer.html">archinstall.Installer</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">python-archinstall</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" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Report Issues &amp; Bugs</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="report-issues-bugs">
<span id="help-issues"></span><h1>Report Issues &amp; Bugs<a class="headerlink" href="#report-issues-bugs" title="Link to this heading"></a></h1>
<p>Issues and bugs should be reported over at <a class="reference external" href="https://github.com/archlinux/archinstall/issues">https://github.com/archlinux/archinstall/issues</a>.</p>
<p>General questions, enhancements and security issues can be reported over there too.
For quick issues or if you need help, head over to the Discord server which has a help channel.</p>
<section id="log-files">
<h2>Log files<a class="headerlink" href="#log-files" title="Link to this heading"></a></h2>
<p>When submitting a help ticket, please include the <code class="code docutils literal notranslate"><span class="pre">/var/log/archinstall/install.log</span></code>.
It can be found both on the live ISO but also in the installed filesystem if the base packages were strapped in.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<div class="line-block">
<div class="line">An easy way to submit logs is <code class="docutils literal notranslate"><span class="pre">archinstall</span> <span class="pre">share-log</span></code>, which uploads <code class="docutils literal notranslate"><span class="pre">install.log</span></code> to paste.rs and prints a shareable URL.</div>
<div class="line">Use caution when submitting other log files, but <code class="docutils literal notranslate"><span class="pre">archinstall</span></code> pledges to keep <code class="docutils literal notranslate"><span class="pre">install.log</span></code> safe for posting publicly!</div>
</div>
</div>
<p>There are additional log files under <code class="docutils literal notranslate"><span class="pre">/var/log/archinstall/</span></code> that can be useful:</p>
<blockquote>
<div><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">/var/log/archinstall/user_configuration.json</span></code> - Stores most of the guided answers in the installer</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">/var/log/archinstall/user_credentials.json</span></code> - Stores any usernames or passwords, can be passed to <code class="docutils literal notranslate"><span class="pre">--creds</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">/var/log/archinstall/user_disk_layouts.json</span></code> - Stores the chosen disks and their layouts</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">/var/log/archinstall/install.log</span></code> - A log file over what steps were taken by archinstall</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">/var/log/archinstall/cmd_history.txt</span></code> - A complete command history, command by command in order</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">/var/log/archinstall/cmd_output.txt</span></code> - A raw output from all the commands that were executed by archinstall</p></li>
</ul>
</div></blockquote>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>We only try to guarantee that <code class="docutils literal notranslate"><span class="pre">/var/log/archinstall/install.log</span></code> is free from sensitive information.
Any other log file should be pasted with <strong>utmost care</strong>!</p>
</div>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="known_issues.html" class="btn btn-neutral float-left" title="Known Issues" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="discord.html" class="btn btn-neutral float-right" title="Discord" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2022, Anton Hvornum.</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>