Diag UI, error reporting

This commit is contained in:
kn0wmad
2022-01-24 12:05:01 -07:00
committed by Lucy Cifferello
parent e028278168
commit 0883e6a336
10 changed files with 49 additions and 22 deletions

View File

@@ -1,7 +1,7 @@
.. _basic-config:
===================
Basic Configuration - ***NEEDS BUG REPORT LINK***
Basic Configuration
===================
.. _auto-reporting:
@@ -9,7 +9,7 @@ Basic Configuration - ***NEEDS BUG REPORT LINK***
Automatically Report Bugs
-------------------------
You are asked at first setup if you would like to provide bug reports to Start9. You can edit that setting here if you change your mind. This data is anonymous and you can see exactly what is collected `here<>`.
You are asked at first setup if you would like to provide bug reports to Start9. You can edit that setting here if you change your mind. This data is anonymous and you can see exactly what is collected :ref:`here<error-logs>`.
1. As in the :ref:`Set Device Name<device-name>` steps above, go to the ``Embasssy`` tab, then under ``Settings``, click ``Preferences``
2. Click ``Auto Report Bugs`` and either ``Enable`` or ``Disable``

View File

@@ -1,8 +1,8 @@
.. _dg-android:
=======
Android
=======
==============
Android Guides
==============
.. tip:: Please see Android's :ref:`Known Limitations<lim-android>` to understand what is currently not possible on these devices

View File

@@ -1,8 +1,8 @@
.. _dg-ios:
===
iOS
===
==========
iOS Guides
==========
.. tip:: Please see iOS's :ref:`Known Limitations<lim-ios>` to understand what is currently not possible on these devices

View File

@@ -1,8 +1,8 @@
.. _dg-mac:
===
Mac
===
==========
Mac Guides
==========
.. tip:: Please see Mac's :ref:`Known Limitations<lim-mac>` to understand what is currently not possible on these devices

View File

@@ -1,8 +1,8 @@
.. _dg-windows:
=======
Windows
=======
==============
Windows Guides
==============
.. tip:: Please see Window's :ref:`Known Limitations<lim-windows>` to understand what is currently not possible on these devices.

View File

@@ -11,9 +11,9 @@ User Manual
getting-started/index
walkthrough/index
configuration/index
troubleshooting/index
tuning/index
services/index
troubleshooting/index
.. panel-box::
:title: Overview

View File

@@ -11,7 +11,11 @@ Embassy is making noises
========================
The plug and play Embassy sold by Start9 has no moving parts, so the only noises it should ever make would come from its internal speaker. The following is a list of all possible sounds:
#.
#.
Embassy boots into "Diagnostic Mode"
====================================
Diagnostic Mode is a new UI that will launch in the event that no drive, or an incorrect drive (such as one from another Embassy) has been plugged into Embassy. Simply plug your external drive in and reboot (power off and on again).
Embassy will not boot
=====================

View File

@@ -0,0 +1,25 @@
.. _error-logs:
=============================
Anonymous Error Log Reporting
=============================
When you fire up your Embassy for the first time, you will be greeted with a modal asking you if you would be willing to provide your error logs to Start9 to assist us in improving EmbassyOS and its ecosystem. The decision to send or retain this data is 100% yours. Below are details to aid you in determining your choice.
Why do we ask for this?
-----------------------
The last thing Start9 wants is data that relates to users of EmbassyOS, but data that is generated within the system is *extremely* helpful for our engineers to stabilize and enhance the software.
What data is sent?
------------------
* Every log entry that is WARN or above, such as:
* Service crashes
* Failed updates
* Metadata, such as:
* What services are running
Data is catalogued with a random 64-bit integer that is generated upon creating a new :ref:`Session<sessions>`. Data cannot be correlated across sessions. This means that every time you create a new session, such as a browser log on, error logs are attached to that session *only*, and you can kill a session at any time (see :ref:`Active Sessions<active-sessions>`). These session ids are NOT used during support sessions (they are not even provided to the user), such that a support technician CAN NOT attach any kind of identity to a session or its logs.
How is data sent?
-----------------
These error logs are sent exclusively across Tor, and as such, we cannot even identify what machine, address, or user sent them.

View File

@@ -9,6 +9,7 @@ An overview of EmbassyOS general capabilities.
.. toctree::
:maxdepth: 2
error-logs
overview
updates
backups