From c4d4345b55b407f568d1ec697b9f761c43f55ab1 Mon Sep 17 00:00:00 2001 From: Daniel Micay Date: Wed, 23 Dec 2020 18:33:44 -0500 Subject: [PATCH] expand information on install requirements --- static/install.html | 43 ++++++++++++++++++++----------------------- 1 file changed, 20 insertions(+), 23 deletions(-) diff --git a/static/install.html b/static/install.html index 27ac3c10..bf3f1f7a 100644 --- a/static/install.html +++ b/static/install.html @@ -92,10 +92,13 @@

You should have at least 2GB of free memory available.

-

You need a USB cable for attaching the device to a laptop or desktop. If it - doesn't have a USB-C port, you'll need a high quality USB-C to USB-A cable. Avoid - low quality USB hubs and cables including the low quality front panel hubs on many - desktop computers.

+

You need a USB cable for attaching the device to a laptop or desktop. Whenever + possible, use the high quality standards compliant USB-C cable that comes with the + device. If your computer doesn't have any USB-C ports, you'll need a high quality + USB-C to USB-A cable. You should avoid using a USB hub such as the front panel on + a desktop computer case. Connect directly to a rear port on a desktop or the ports + on a laptop. Many widely distributed USB cables and hubs are broken and are the + most common source of issues for installing GrapheneOS.

Windows 10, macOS Catalina, Arch Linux, Debian buster and Ubuntu 20.04 LTS are the officially supported operating systems for installing GrapheneOS. You should make sure @@ -103,6 +106,11 @@ versions and other Linux distributions usually work, but if you encounter problems try using one of the officially supported options.

+

Installing from an OS in a virtual machine is not recommended. USB passthrough + is often not reliable. To rule out these problems, install from an OS running on + bare metal. Virtual machines are also often configured to have overly limited + memory and storage space.

+

You need one of the officially supported devices. To make sure that the device can be unlocked to install GrapheneOS, avoid carrier variants of the devices. Carrier variants of Pixels use the same stock OS and firmware with a non-zero carrier id @@ -121,8 +129,9 @@ Pixel phones can be obtained from the full update package page.

-

These instructions use command-line tools. On Windows, use PowerShell rather than - the legacy Command Prompt.

+

These instructions use command-line tools. On Windows, use PowerShell rather + than the legacy Command Prompt. Open up a single terminal and use it for the whole + installation process.

Obtaining fastboot

@@ -344,6 +353,11 @@ curl -O https://releases.grapheneos.org/sunfish-factory-2020.12.12.03.zip.sig

Troubleshooting

+

The text output from a failed attempt at flashing will contain valuable + diagnostic information which is essential in knowing where and how the process + went wrong. Please provide this information when asking for help on the + GrapheneOS IRC / Matrix channel.

+

A common issue on Linux distributions is that they mount the default temporary file directory /tmp as tmpfs which results in it being backed by memory and swap rather than persistent storage. By default, the size is 50% of the available @@ -353,23 +367,6 @@ curl -O https://releases.grapheneos.org/sunfish-factory-2020.12.12.03.zip.sig

mkdir tmp TMPDIR="$PWD/tmp" ./flash-all.sh - -

A majority of failed flashes tend to be caused by substandard USB connectors, - plugging in via hubs or bad cables which aren't properly up to the USB standard. The - scrollback from a failed flash will contain valuable diagnostic information which - is essential in knowing where and how the process went wrong.

- -

Front I/O ports on desktop computer cases and USB 3.1 or USB C on many laptops - often aren't implemented properly or are broken in subtle ways, which may cause flashing - to fail even on a USB port that works for other peripherals. Older Linux kernels that - predate version 5 may have inadequate or patchwork support for USB C or USB 3. If you - are installing from a Linux distribution, ensure your distribution uses a modern - kernel.

- -

Always use a high quality USB A to USB C cable with a rear USB port directly on your - motherboard, and never use a USB hub for flashing. Never install from a virtual - machine; USB passthrough in software emulation may be broken or inadequate and this - can cause the flashing to fail.