wiki/deploy/install.md

148 lines
7.4 KiB
Markdown
Raw Normal View History

2021-11-14 16:19:03 +00:00
---
title: Install Phyllome OS
description:
published: true
2023-05-29 18:21:01 +00:00
date: 2023-05-29T18:20:59.583Z
2021-11-14 16:19:03 +00:00
tags:
editor: markdown
dateCreated: 2021-11-14T16:19:00.348Z
---
2022-11-01 19:47:29 +00:00
# Install Phyllome OS
2021-11-22 16:11:39 +00:00
*This page is intended for users that would like to install Phyllome OS permanently on a computer. Make sure you understand what [Phyllome OS](/phyllomeos/purpose.md) is about before installing it*
2021-11-22 16:11:39 +00:00
Installing Phyllome OS involves booting from a [bootable USB flash drive](/deploy/medium) and fetching an online kickstart file, which contains instructions to automatically deploy Phyllome OS.
2022-10-31 20:47:43 +00:00
2022-11-01 19:47:29 +00:00
* General requirements:
* **A bootable USB flash drive**
* *If you don't have a USB flash drive ready to use, please go back to [the last section](/deploy/medium)*
2022-11-01 19:47:29 +00:00
* **A wired Internet connection**
* *Many files will be fetched online during the installation process*
* *Wireless is not supported*
2022-11-01 19:47:29 +00:00
* **A storage device**
* *The kickstart file will look for a storage device and install Phyllome OS on it. If there is no disk available, the installation will fail*
2021-11-22 21:21:48 +00:00
> The process to install Phyllome OS is destructive. Only follow the following instructions on a computer whose data has been backed-up and which has only one storage device attached to it.
{.is-danger}
2022-10-31 21:03:12 +00:00
## Choose your edition
2022-10-31 21:03:12 +00:00
| | GPU-agnostic | Intel GPUs (5th to 9th gen)[^2] |
|---|---|---|
| *Intel CPU* | **Phyllome OS Desktop I** | **Phyllome OS Desktop II** |
| *AMD CPU* | **Phyllome OS Desktop A** | N/A |
| CPU-agnostic | **Phyllome OS Desktop** | N/A |
[^2]: Only [Broadwell-based SoC](https://en.wikipedia.org/wiki/Broadwell_(microarchitecture)) (5th generation) to [Cascade Lake-based SoC](https://en.wikipedia.org/wiki/Cascade_Lake_(microarchitecture)) (9th generation) are supported. If you possess a more recent SoC from Intel, for instance one based on the Tiger Lake SoC, please pick Phyllome OS Desktop I or Phyllome OS Desktop A instead.
2022-10-31 21:03:12 +00:00
## Boot from the USB flash drive
2023-05-29 18:21:01 +00:00
The following section illustrates how to change the boot order *temporarily*. The process to change the boot order depends on your current computer platform. Please follow the instruction that match your platform.
2021-11-22 16:11:39 +00:00
### macOS
* Make sure that your computer is turned-off.
* Plug the USB flash drive loaded with the official Fedora ISO.
* Locate the <kbd>Alt</kbd> / <kbd>Option</kbd> key on your keyboard.
2022-05-20 20:00:36 +00:00
* Turn your computer on and immediately hold down the <kbd>Alt</kbd> / <kbd>Option</kbd> key.
2021-11-22 16:11:39 +00:00
* The startup manager should appear after a few seconds.
* Click on the option called *EFI* and the GRUB splash screen will appear. Go to the section below to learn what to do next.
![kickstart-1](/assets/grub-kickstart/kickstart-1.png)
2021-11-22 16:11:39 +00:00
## Boot into the automated install process
2021-11-22 14:29:07 +00:00
2023-05-29 18:21:01 +00:00
One needs to alter the GRUB instructions in order to trigger the automated installation.
2021-11-22 14:29:07 +00:00
> GRUB is universal bootloader that ship with many Linux distributions.
{.is-info}
2021-11-22 16:11:39 +00:00
### EFI-based firmware
2021-11-22 16:35:49 +00:00
* On the GRUB splash screen, navigate to the first entry using your keyboard arrow key and press <kbd>e</kbd>.
2021-11-22 16:11:39 +00:00
![kickstart-1](/assets/grub-kickstart/kickstart-2.png)
2021-11-22 16:11:39 +00:00
2022-05-20 20:28:22 +00:00
* On the new screen, use the arrow keys to place your cursor just after the word `quiet`.
2021-11-22 16:11:39 +00:00
![kickstart-2](/assets/grub-kickstart/kickstart-3.png)
2021-11-22 16:11:39 +00:00
> GRUB defaults to the US keyboard layout. Have a look at [this online resource](https://en.wikipedia.org/wiki/QWERTY#/media/File:KB_United_States.svg) to find the corresponding keys if you are not using a US keyboard layout
2021-11-22 16:11:39 +00:00
{.is-info}
* Write-down the URL associated to the edition you picked
| | Edition | Kickstart URL |
|---|---|---|
2023-05-29 15:14:21 +00:00
| *CPU and GPU agnostic* | **Phyllome OS Desktop** | [ks.phyllo.me/d](https://ks.phyllo.me/d) |
| *Intel CPU* | **Phyllome OS Desktop I** | [ks.phyllo.me/di](https://ks.phyllo.me/di) |
| *AMD CPU* | **Phyllome OS Desktop A** | [ks.phyllo.me/da](https://ks.phyllo.me/da) |
| *Intel CPU and GPU* | **Phyllome OS Desktop II** | [ks.phyllo.me/dii](https://ks.phyllo.me/dii) |
> **Danger Zone**: the following instruction will trigger a process that will automatically **destroy** any data located on the internal disk present in your computer *without* asking for a confirmation*
2021-11-22 16:11:39 +00:00
{.is-danger}
* Leave a blank space after the word `quiet` and write exactly the following `inst.ks=https://ks.phyllo.me/dii`, then press <kbd>Ctrl</kbd> + <kbd>x</kbd> simultaneously or <kbd>F10</kbd>. This command will trigger the automated installation of Phyllome OS.
2021-11-22 16:11:39 +00:00
![kickstart-3.png](/assets/grub-kickstart/kickstart-4.png)
2021-11-22 16:11:39 +00:00
2021-11-22 21:21:48 +00:00
* During the installation process, you can use <kbd>Alt</kbd> + <kbd>Tab</kbd> to cycle through tabs, and look at the logs in real-time
![kickstart-4](/assets/grub-kickstart/kickstart-5.png)
2021-11-22 16:35:49 +00:00
2021-11-22 21:21:48 +00:00
* After a few minutes, you should be greeted with a welcome screen.
2021-11-22 16:35:49 +00:00
![kickstart-5](/assets/grub-kickstart/kickstart-6.png)
2021-11-22 16:11:39 +00:00
> If you wish to learn more about how kickstart files are used to create Phyllome OS, please have a look at [the official git repository](https://github.com/PhyllomeOS/phyllomeos).
2022-10-31 21:03:12 +00:00
{.is-info}
2021-11-22 16:44:07 +00:00
## First-launch
2021-11-22 16:43:58 +00:00
2021-11-23 09:36:27 +00:00
* **Welcome screen**: on first-launch, for the *Desktop edition*, you will be greeted with the GNOME Welcome Screen. As of now, only English is available out of the box. Click *Next* when you are ready.
![first-launch-1.png](/assets/first-launch/first-launch-1.png)
2021-11-23 09:36:27 +00:00
* **Keyboard layout**: you can select your favorite keyboard layout by clicking on the three stacked vertical dots at the bottom of the screen.
> By default, Phyllome OS is set to use the *fr-CH* keyboard layout. This keyboard layout is used by people living in [Romandy](https://en.wikipedia.org/wiki/Romandy), Switzerland, which is also where the original author of Phyllome OS is from.
2021-11-23 09:36:27 +00:00
{.is-info}
![first-launch-2.png](/assets/first-launch/first-launch-2.png)
2021-11-23 09:36:27 +00:00
* **Time zone**: you can pick your current location by clicking on the map or writing it down inside the box. The time will be adjusted according to the provided location.
2021-11-23 09:36:27 +00:00
![first-launch-3.png](/assets/first-launch/first-launch-3.png)
2021-11-23 09:36:27 +00:00
* **Online Accounts**: Phyllome OS strongly discourages the use of *Online Accounts*, and therefore provides no option here. Click on *Skip* to go to the next screen.
![first-launch-4.png](/assets/first-launch/first-launch-4.png)
2021-11-23 09:36:27 +00:00
* **Create a user account**: you are invited to create a user account, which by default will be granted administrator or root privileges. Click on *Next* when you are done.
![first-launch-5.png](/assets/first-launch/first-launch-5.png)
2021-11-23 09:36:27 +00:00
* **Provide a password**: please do provide a strong password. In case you ever forget it, write it down on a piece of paper and store it somewhere safe, or/and rely on an online password manager like [Bitwarden](https://bitwarden.com/). Click on *Next* when you are done.
2021-11-23 09:36:27 +00:00
![first-launch-6.png](/assets/first-launch/first-launch-6.png)
2021-11-23 09:36:27 +00:00
* **Setup complete**: Click on start *Start Using Generic*.
![first-launch-7.png](/assets/first-launch/first-launch-7.png)
2021-11-23 09:36:27 +00:00
2021-11-23 09:37:58 +00:00
* **Provide password**: The Virtual Machine Manager is set to auto-launch, and requires elevated permission. Please provide the user password you just set up and click on *Authenticate* to start using Phyllome OS.
2021-11-23 09:36:27 +00:00
![first-launch-9.png](/assets/first-launch/first-launch-9.png)
2021-11-23 09:36:27 +00:00
2022-11-01 19:59:10 +00:00
> *Congratulations, you are done!*
2021-11-23 09:36:27 +00:00
{.is-success}
![first-launch-10.png](/assets/first-launch/first-launch-10.png)
2021-11-22 16:43:58 +00:00
> Don't forget to remove the USB flash drive from your computer, so that next time your computer will boot, it will use the internal disk where Phyllome OS has been deployed.
2021-11-23 09:41:43 +00:00
{.is-info}
2021-11-22 16:35:49 +00:00
---
2021-11-22 16:11:39 +00:00
2023-06-21 23:49:27 +00:00
*[**You are ready to get started**](https://wiki.phyllo.me/#get-started)*