Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update installation guide to Orchid #115

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 30 additions & 30 deletions articles/en/installation.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,32 @@
---
Title: Vanilla OS Installation
Description: Learn how to install Vanilla OS to your device.
PublicationDate: 2022-11-05
PublicationDate: 2024-08-06
Listed: true
Authors:
- GabsEdits
- kra-mo
- kbdharun
---

> This guide is for Kinetic (22.10), not Orchid. The documentation for Orchid is still being written.

## Preparation

### Requirements

- A flash drive with at least **8GB** of capacity.
- A 64 bit (amd64) [x64] processor.
- A flash drive with at least **4GB** of capacity.
- A 64 bit (amd64)/[x64] processor.
- A drive with at least **50GB** of storage space (required for [ABRoot](https://documentation.vanillaos.org/docs/ABRoot/) A/B partitions).
- At least **4GB** of **RAM** (**8GB recommended**).
- 30 minutes to an hour of your time.
- Good to have **Secure Boot enabled**.
- Good to have **Secure Boot enabled** (if your device isn't with Nvidia graphics).

### Creating a bootable USB stick

This section will guide you through creating a bootable USB stick with Vanilla OS on it.

#### Downloading Vanilla OS

First, download the Vanilla OS disk image that will be written to your USB flash drive from [**here**](https://vanillaos.org/).
First, download the Vanilla OS disk image that will be written to your USB flash drive from [**here**](https://vanillaos.org/download/orchid/stable).

#### Installing Etcher

Expand All @@ -49,59 +48,60 @@ When the process is done, you will have a bootable USB stick with Vanilla OS on

Insert the USB flash drive into the computer to which you want to install Vanilla OS and power up or restart the device.

If your device does not automatically boot into the Vanilla OS installation media, reboot, and while it is starting up, hold down the key to `select boot device` or for `boot menu` indicated by a prompt on the boot screen. The most common keys are F2, F10, F11, F12, Delete and Escape. If the prompt isn't present, try searching online for your specific model. Select Vanilla OS or the name of your USB flash drive from the boot menu.
If your device does not automatically boot into the Vanilla OS installation media, reboot, and while it is starting up, hold down the key to `select boot device` or for `boot menu` indicated by a prompt on the boot screen. The most common keys are F2, F10, F11, F12, Delete and Escape. If the prompt isn't present, try searching online for your specific model of device. Select Vanilla OS or the name of your USB flash drive from the boot menu.

When your device has successfully booted from the USB stick, you should see a welcome screen inviting you to try or install Vanilla OS.

![Welcome](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/Installation/installer-welcome.webp)

You can try Vanilla OS without making any changes to your device. If you are satisfied, you can re-open the installer (the first icon in the dash) and proceed with the installation.

## Installing Vanilla OS

### First steps

Click "Install Vanilla OS" and set your preferred language, keyboard layout and timezone.
Click "Install" and set your preferred language, keyboard layout, internet connection, and timezone.

![Language](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/Installation/installation-language.webp)

### NVIDIA drivers and VM tools

### Types of installation
The installer will detect if you have an NVIDIA GPU or if you are installing Vanilla OS in a virtual machine and prompt you to install the necessary drivers and tools to improve the performance of Vanilla OS. Just click "Install (Recommended)" to install the required drivers and tools. If you don't want to install them, click "Skip".

Depending on whether you want to dual- or multiboot Vanilla OS alongside other operating systems, you will need to follow different steps when selecting your disk.
![VM Tools](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/Installation/installation-vmtools.webp)

This guide will help you with the following types of installation:
### Dual- or multibooting

- [Installing only Vanilla OS](/2022/11/05/installation.html#title10)
- [~~Advanced installation~~ (Disabled currently)](/2022/11/05/installation.html#title11)
Currently, Vanilla OS does not support dual- or multibooting with other operating systems on the same drive. If you want to dual- or multiboot, you can install Vanilla OS on a separate drive.

### Installing only Vanilla OS

This section will guide you through installing Vanilla OS to an entire disk, **erasing all previous data on it**. Make sure to back up all your important data before proceeding!
Installing Vanilla OS will **erase all data** on the selected disk. Make sure to back up all your important data before proceeding!

Select the disk you want to install Vanilla OS to, click "Configure", select "Use Entire Disk", click "Apply" and review your changes.
Select the disk you want to install Vanilla OS to, click "Use Entire Disk", then click "Confirm".

![Use Entire Disk](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/Installation/installation-partitioning.webp)

Create your user account and review the changes that will be made to your system. Click on "Install Vanilla OS" and the installation will begin.
You can also manually partition your disk by selecting "Manual Partitioning" and creating your own partitions.

![Confirming the installation](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/Installation/installer-confirm-installation.webp)
#### Manual partitioning

## Booting into Vanilla OS
/* WIP */

### If you only have Vanilla OS installed
### Device encryption

After the installer finishes, all you need to do is reboot and remove the USB stick. Vanilla OS will be waiting for you.
You can choose to encrypt your device by clicking the "Encrypt Device". Make sure to add a strong password that you will remember, as you will need it to unlock your device every time you boot it up.

### If you dual- or multiboot
![Encrypt Device](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/Installation/installation-encryption.webp)

#### On the same drive
Once you have set up your partitions and encryption, you will be prompted to confirm your changes. Click "Install Vanila OS" to start the installation process.

After the installer finishes, all you need to do is reboot and you will see a boot menu with your installed operating systems. Select Vanilla OS, wait for it to boot and remove the USB stick.
![Confirm Installation](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/Installation/installation-confirm.webp)

#### On different drives
The installation process will take a few minutes to complete. Once it is done, you will be prompted to restart your device.

After the installer finishes, you need to reboot and select Vanilla OS from your device's boot menu that you can access by holding down a specific key while the device is starting up indicated by a prompt on the boot screen. If the prompt isn't present, try searching online for your specific model. Once you're in Vanilla OS, remove the USB stick.
## Booting into Vanilla OS

You can configure the default boot order in your device's firmware settings.
After the installer finishes, all you need to do is reboot and remove the USB stick. Vanilla OS will be waiting for you.

## First Setup

After installing Vanilla OS, you can follow the [**First Setup guide**](/2022/11/18/first-setup.html) to set up your system.
After installing Vanilla OS, you can follow the [**First Setup guide**](https://docs.vanillaos.org/handbook/en/first-setup) to set up your system.
Binary file not shown.
Binary file not shown.
Binary file modified assets/uploads/Installation/installation-partitioning.webp
Binary file not shown.
Binary file added assets/uploads/Installation/installation-vm.webp
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/uploads/Installation/installer-welcome.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.