Send patches - preferably formatted by git format-patch - to patches at archlinux32 dot org.
summaryrefslogtreecommitdiff
path: root/docs/help/report_bug.rst
diff options
context:
space:
mode:
authorAnton Hvornum <anton@hvornum.se>2023-11-21 14:34:30 +0100
committerGitHub <noreply@github.com>2023-11-21 14:34:30 +0100
commitcc806d9c4ce29212c2848c15b4b184feace3e1ac (patch)
tree28f4f1cb3b943d178a07a37369d3133093c51e17 /docs/help/report_bug.rst
parente6344f93f7e476d05bbcd642f2ed91fdde545870 (diff)
Started a re-write of the docs (#1967)
* Started a re-write of the docs, using CSV for tables and re-organizing parameter definitions * Added final config options in --config, some have external references which needs to be populated * Forgot to escape a comma * Clarified a note * Added disk configuration and disk encryption docs * Changed way of installing using source and python * Added a 'list script' that lists available scripts. This could be converted to a argparse later. But this does the trick for now. And it's added to ease documentation and listing of available options. * Added a 'Known issues' section, as well as renamed the issues tab * Finished up the known issues section * Added a section regarding --plugin * Added plugin description, tweaked disk_config to the latest changes from #2221 * Added custom-commands docs, and improved some creds and known issue links
Diffstat (limited to 'docs/help/report_bug.rst')
-rw-r--r--docs/help/report_bug.rst33
1 files changed, 33 insertions, 0 deletions
diff --git a/docs/help/report_bug.rst b/docs/help/report_bug.rst
new file mode 100644
index 00000000..bd0ac50a
--- /dev/null
+++ b/docs/help/report_bug.rst
@@ -0,0 +1,33 @@
+.. _help.issues:
+
+Report Issues & Bugs
+====================
+
+Issues and bugs should be reported over at `https://github.com/archlinux/archinstall/issues <https://github.com/Torxed/archinstall/issues>`_.
+
+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.
+
+Log files
+---------
+
+| When submitting a help ticket, please include the :code:`/var/log/archinstall/install.log`.
+| It can be found both on the live ISO but also in the installed filesystem if the base packages were strapped in.
+
+.. tip::
+ | An easy way to submit logs is ``curl -F'file=@/var/log/archinstall/install.log' https://0x0.st``.
+ | Use caution when submitting other log files, but ``archinstall`` pledges to keep ``install.log`` safe for posting publicly!
+
+| There are additional log files under ``/var/log/archinstall/`` that can be useful:
+
+ - ``/var/log/archinstall/user_configuration.json`` - Stores most of the guided answers in the installer
+ - ``/var/log/archinstall/user_credentials.json`` - Stores any usernames or passwords, can be passed to ``--creds``
+ - ``/var/log/archinstall/user_disk_layouts.json`` - Stores the chosen disks and their layouts
+ - ``/var/log/archinstall/install.log`` - A log file over what steps were taken by archinstall
+ - ``/var/log/archinstall/cmd_history.txt`` - A complete command history, command by command in order
+ - ``/var/log/archinstall/cmd_output.txt`` - A raw output from all the commands that were executed by archinstall
+
+.. warning::
+
+ We only try to guarantee that ``/var/log/archinstall/install.log`` is free from sensitive information.
+ Any other log file should be pasted with **utmost care**!