From 8deb0de0853e1b1138eb25d9e8c289df0143111d Mon Sep 17 00:00:00 2001 From: "K.B.Dharun Krishna" Date: Tue, 26 Mar 2024 11:54:37 +0530 Subject: [PATCH] cleanup: remove chronos files, add notice about new docs location Signed-off-by: K.B.Dharun Krishna --- .github/workflows/lint.yml | 4 +- _posts/2022-11-05-installation.md | 2 + _posts/2022-11-11-contributing.md | 2 + _posts/2022-11-18-first-setup.md | 2 + _posts/2022-12-09-install-flatpaks.md | 2 + .../2022-12-10-install-additional-drivers.md | 3 + _posts/2022-12-10-updates.md | 2 + _posts/2023-01-02-install-distrobox.md | 2 + _posts/2023-01-07-install-steam.md | 2 + ...3-01-11-install-and-manage-applications.md | 2 + _posts/2023-01-11-install-vpn-from-file.md | 2 + _posts/2023-01-19-change-default-shell.md | 2 + _posts/2023-01-21-install-in-vm.md | 2 + .../2023-01-23-install-jekyll-and-bundler.md | 2 + _posts/2023-01-24-install-openrgb.md | 2 + _posts/2023-01-26-install-homebrew.md | 2 + ...023-01-28-install-heroic-games-launcher.md | 2 + _posts/2023-01-28-install-lutris.md | 2 + _posts/2023-02-05-install-docker.md | 2 + _posts/2023-10-26-install-vivaldi.md | 2 + articles/en/change-default-shell.md | 165 ------- articles/en/contributing.md | 149 ------ articles/en/first-setup.md | 71 --- articles/en/install-additional-drivers.md | 88 ---- .../en/install-and-manage-applications.md | 237 ---------- articles/en/install-distrobox.md | 35 -- articles/en/install-docker.md | 89 ---- articles/en/install-flatpaks.md | 71 --- articles/en/install-heroic-games-launcher.md | 61 --- articles/en/install-homebrew.md | 42 -- articles/en/install-in-vm.md | 428 ------------------ articles/en/install-jekyll-and-bundler.md | 142 ------ articles/en/install-lutris.md | 65 --- articles/en/install-openrgb.md | 72 --- articles/en/install-steam.md | 145 ------ articles/en/install-vpn-from-file.md | 47 -- articles/en/installation.md | 106 ----- articles/en/updates.md | 80 ---- 38 files changed, 41 insertions(+), 2095 deletions(-) delete mode 100644 articles/en/change-default-shell.md delete mode 100644 articles/en/contributing.md delete mode 100644 articles/en/first-setup.md delete mode 100644 articles/en/install-additional-drivers.md delete mode 100644 articles/en/install-and-manage-applications.md delete mode 100644 articles/en/install-distrobox.md delete mode 100644 articles/en/install-docker.md delete mode 100644 articles/en/install-flatpaks.md delete mode 100644 articles/en/install-heroic-games-launcher.md delete mode 100644 articles/en/install-homebrew.md delete mode 100644 articles/en/install-in-vm.md delete mode 100644 articles/en/install-jekyll-and-bundler.md delete mode 100644 articles/en/install-lutris.md delete mode 100644 articles/en/install-openrgb.md delete mode 100644 articles/en/install-steam.md delete mode 100644 articles/en/install-vpn-from-file.md delete mode 100644 articles/en/installation.md delete mode 100644 articles/en/updates.md diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index 317683a..22d4075 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -2,9 +2,9 @@ name: Lint on: push: - branches: [main] + branches: [kinetic] pull_request: - branches: [main] + branches: [kinetic] types: [opened, synchronize, ready_for_review, edited] jobs: diff --git a/_posts/2022-11-05-installation.md b/_posts/2022-11-05-installation.md index 46c07ad..988c69b 100644 --- a/_posts/2022-11-05-installation.md +++ b/_posts/2022-11-05-installation.md @@ -9,6 +9,8 @@ authors: published: true --- +> This guide is for Kinetic (22.10). For newer versions of Vanilla OS, refer to for the latest documentation. + ## Preparation ### Requirements diff --git a/_posts/2022-11-11-contributing.md b/_posts/2022-11-11-contributing.md index cdb5046..2712d15 100644 --- a/_posts/2022-11-11-contributing.md +++ b/_posts/2022-11-11-contributing.md @@ -10,6 +10,8 @@ authors: published: true --- +> This guide is for Kinetic (22.10). For newer versions of Vanilla OS, refer to for the latest documentation. + Thank you for your interest in our project. This guide will help you with writing articles. The [**Handbook**](https://github.com/Vanilla-OS/handbook) uses Jekyll and GitHub pages for generating the website. diff --git a/_posts/2022-11-18-first-setup.md b/_posts/2022-11-18-first-setup.md index 871ae09..6cde67a 100644 --- a/_posts/2022-11-18-first-setup.md +++ b/_posts/2022-11-18-first-setup.md @@ -9,6 +9,8 @@ authors: published: true --- +> This guide is for Kinetic (22.10). For newer versions of Vanilla OS, refer to for the latest documentation. + ## Introduction Congratulations, you have successfully installed Vanilla OS. diff --git a/_posts/2022-12-09-install-flatpaks.md b/_posts/2022-12-09-install-flatpaks.md index ecb11b4..4cff070 100644 --- a/_posts/2022-12-09-install-flatpaks.md +++ b/_posts/2022-12-09-install-flatpaks.md @@ -8,6 +8,8 @@ authors: published: true --- +> This guide is for Kinetic (22.10). For newer versions of Vanilla OS, refer to for the latest documentation. + Flatpak is a universal package format for Linux desktop applications. It works on most Linux distributions, Vanilla OS included. Flatpak applications get distributed as bundles, similar to native packages, but they are sandboxed and can be updated independently from the host system. ## Install Flatpak diff --git a/_posts/2022-12-10-install-additional-drivers.md b/_posts/2022-12-10-install-additional-drivers.md index 9b75c51..5ddaa04 100644 --- a/_posts/2022-12-10-install-additional-drivers.md +++ b/_posts/2022-12-10-install-additional-drivers.md @@ -9,6 +9,9 @@ authors: - mrunix00 published: true --- + +> This guide is for Kinetic (22.10). For newer versions of Vanilla OS, refer to for the latest documentation. + Drivers are software components that allow the operating system to communicate with hardware devices. In Vanilla OS, primary drivers are installed automatically during the first setup, but some devices may need additional drivers to work ideally. You can install them using two methods:- diff --git a/_posts/2022-12-10-updates.md b/_posts/2022-12-10-updates.md index c985cb4..f4df048 100644 --- a/_posts/2022-12-10-updates.md +++ b/_posts/2022-12-10-updates.md @@ -9,6 +9,8 @@ authors: published: true --- +> This guide is for Kinetic (22.10). For newer versions of Vanilla OS, refer to for the latest documentation. + Vanilla OS is a point release distribution that receives two new releases annually with security updates and bug fixes for system components distributed between releases, usually without any new features introduced. ## Difference between Update and Upgrade diff --git a/_posts/2023-01-02-install-distrobox.md b/_posts/2023-01-02-install-distrobox.md index b816da9..63a4fde 100644 --- a/_posts/2023-01-02-install-distrobox.md +++ b/_posts/2023-01-02-install-distrobox.md @@ -8,6 +8,8 @@ authors: published: true --- +> This guide is for Kinetic (22.10). For newer versions of Vanilla OS, refer to for the latest documentation. + ## What is Distrobox? [**Distrobox**](https://github.com/89luca89/distrobox) is a utility that allows you to run multiple Linux distributions in your system without the need to dual boot or install them in a virtual machine. It enables backward and forward compatibility with software and provides freedom to use whatever distribution you need. diff --git a/_posts/2023-01-07-install-steam.md b/_posts/2023-01-07-install-steam.md index fb168f7..ee74c91 100644 --- a/_posts/2023-01-07-install-steam.md +++ b/_posts/2023-01-07-install-steam.md @@ -8,6 +8,8 @@ authors: published: true --- +> This guide is for Kinetic (22.10). For newer versions of Vanilla OS, refer to for the latest documentation. + ## What is Steam? [**Steam**](https://steampowered.com) is the most popular gaming platform. It allows you to download and play a vast library of games. It's client is available natively on Linux. diff --git a/_posts/2023-01-11-install-and-manage-applications.md b/_posts/2023-01-11-install-and-manage-applications.md index f5d5d8c..f6dc2f7 100644 --- a/_posts/2023-01-11-install-and-manage-applications.md +++ b/_posts/2023-01-11-install-and-manage-applications.md @@ -9,6 +9,8 @@ authors: published: true --- +> This guide is for Kinetic (22.10). For newer versions of Vanilla OS, refer to for the latest documentation. + ## Introduction Vanilla OS allows installing packages and software from various sources. This guide will discuss them in detail. diff --git a/_posts/2023-01-11-install-vpn-from-file.md b/_posts/2023-01-11-install-vpn-from-file.md index 07f5fa3..ecd460d 100644 --- a/_posts/2023-01-11-install-vpn-from-file.md +++ b/_posts/2023-01-11-install-vpn-from-file.md @@ -8,6 +8,8 @@ authors: published: true --- +> This guide is for Kinetic (22.10). For newer versions of Vanilla OS, refer to for the latest documentation. + ## Introduction This guide provides a step-by-step process for installing an OpenVPN file graphically without using the terminal. It helps users who may be uncomfortable with command-line interfaces or who prefer a more user-friendly approach. diff --git a/_posts/2023-01-19-change-default-shell.md b/_posts/2023-01-19-change-default-shell.md index 9d46bec..ab2cb96 100644 --- a/_posts/2023-01-19-change-default-shell.md +++ b/_posts/2023-01-19-change-default-shell.md @@ -8,6 +8,8 @@ authors: published: true --- +> This guide is for Kinetic (22.10). For newer versions of Vanilla OS, refer to for the latest documentation. + ## Introduction Vanilla OS allows you to change your Default Shell to optimize your workflow. This guide will show you how to change your Default Shell to [**Zsh**](https://zsh.sourceforge.io/) or [**Fish**](https://fishshell.com/). diff --git a/_posts/2023-01-21-install-in-vm.md b/_posts/2023-01-21-install-in-vm.md index 493b136..cd35b18 100644 --- a/_posts/2023-01-21-install-in-vm.md +++ b/_posts/2023-01-21-install-in-vm.md @@ -10,6 +10,8 @@ authors: published: true --- +> This guide is for Kinetic (22.10). For newer versions of Vanilla OS, refer to for the latest documentation. + ## Introduction If you are interested in Vanilla OS, it's a good idea to try it out in a VM before using it on your hardware to get used to the Vanilla OS components. This guide will guide you through installing Vanilla OS with various VM software. diff --git a/_posts/2023-01-23-install-jekyll-and-bundler.md b/_posts/2023-01-23-install-jekyll-and-bundler.md index bcf2a49..8cdf5dc 100644 --- a/_posts/2023-01-23-install-jekyll-and-bundler.md +++ b/_posts/2023-01-23-install-jekyll-and-bundler.md @@ -9,6 +9,8 @@ authors: published: true --- +> This guide is for Kinetic (22.10). For newer versions of Vanilla OS, refer to for the latest documentation. + ## Introduction Jekyll is a popular static site generator for creating blogs, documentation, and personal websites. diff --git a/_posts/2023-01-24-install-openrgb.md b/_posts/2023-01-24-install-openrgb.md index 9a38802..54b703f 100644 --- a/_posts/2023-01-24-install-openrgb.md +++ b/_posts/2023-01-24-install-openrgb.md @@ -8,6 +8,8 @@ authors: published: true --- +> This guide is for Kinetic (22.10). For newer versions of Vanilla OS, refer to for the latest documentation. + ## Introduction [**OpenRGB**](https://openrgb.org/) is an essential application for managing your RGB appliances. This guide will help you install the Flatpak and AppImage of OpenRGB correctly. diff --git a/_posts/2023-01-26-install-homebrew.md b/_posts/2023-01-26-install-homebrew.md index dfa1857..41f23b7 100644 --- a/_posts/2023-01-26-install-homebrew.md +++ b/_posts/2023-01-26-install-homebrew.md @@ -8,6 +8,8 @@ authors: published: true --- +> This guide is for Kinetic (22.10). For newer versions of Vanilla OS, refer to for the latest documentation. + ## Terminologies - **Package Manager**:- A package manager or package-management system is a utility with a collection of software tools that automates installing, upgrading, configuring, and removing applications or packages. diff --git a/_posts/2023-01-28-install-heroic-games-launcher.md b/_posts/2023-01-28-install-heroic-games-launcher.md index 2d6e80f..9a48882 100644 --- a/_posts/2023-01-28-install-heroic-games-launcher.md +++ b/_posts/2023-01-28-install-heroic-games-launcher.md @@ -8,6 +8,8 @@ authors: published: true --- +> This guide is for Kinetic (22.10). For newer versions of Vanilla OS, refer to for the latest documentation. + ## What is Heroic Games Launcher? [**Heroic Games Launcher**](https://heroicgameslauncher.com/) is an open source game launcher for Linux. It allows you to download and play games from the Epic Games Store and the GOG Galaxy client through a user-friendly interface. diff --git a/_posts/2023-01-28-install-lutris.md b/_posts/2023-01-28-install-lutris.md index eca41c5..cff4a65 100644 --- a/_posts/2023-01-28-install-lutris.md +++ b/_posts/2023-01-28-install-lutris.md @@ -8,6 +8,8 @@ authors: published: true --- +> This guide is for Kinetic (22.10). For newer versions of Vanilla OS, refer to for the latest documentation. + ## What is Lutris? [**Lutris**](https://lutris.net/) is an open-source game launcher for Linux that allows you to download and play games from various platforms such as the Epic Games Store, GOG Galaxy client, Origin, Humble Bundle and many others through a simple interface. diff --git a/_posts/2023-02-05-install-docker.md b/_posts/2023-02-05-install-docker.md index a4ea815..ec69728 100644 --- a/_posts/2023-02-05-install-docker.md +++ b/_posts/2023-02-05-install-docker.md @@ -10,6 +10,8 @@ authors: published: true --- +> This guide is for Kinetic (22.10). For newer versions of Vanilla OS, refer to for the latest documentation. + ## Introduction [**Docker**](https://www.docker.com/) is an open platform for developing, shipping, and running applications in containerized environments. This guide provides the steps to install the Docker engine and Docker desktop in Vanilla OS. diff --git a/_posts/2023-10-26-install-vivaldi.md b/_posts/2023-10-26-install-vivaldi.md index 6cb3bcd..3880233 100644 --- a/_posts/2023-10-26-install-vivaldi.md +++ b/_posts/2023-10-26-install-vivaldi.md @@ -9,6 +9,8 @@ authors: published: true --- +> This guide is for Kinetic (22.10). For newer versions of Vanilla OS, refer to for the latest documentation. + ## Introduction [**Vivaldi**](https://vivaldi.com) is a freeware, cross-platform web browser based on Chromium, the open-source project behind Google Chrome. Vivaldi is intended to be a customizable, functional, and practical browser for the web. diff --git a/articles/en/change-default-shell.md b/articles/en/change-default-shell.md deleted file mode 100644 index 9ef36f4..0000000 --- a/articles/en/change-default-shell.md +++ /dev/null @@ -1,165 +0,0 @@ ---- -Title: Change your Default Shell -Description: Learn how to change your Default Shell in Vanilla OS. -PublicationDate: 2023-01-19 -Authors: - - MonsterObserver ---- - -> This guide is for Kinetic (22.10), not Orchid. The documentation for Orchid is still being written. - -## Introduction - -Vanilla OS allows you to change your Default Shell to optimize your workflow. This guide will show you how to change your Default Shell to [**Zsh**](https://zsh.sourceforge.io/) or [**Fish**](https://fishshell.com/). - -**_Note_**:- Changing the Default Shell isn't recommended, and this guide is for advanced users only. - -## Change your Default Shell to Zsh - -### ABRoot - -First, we need to install Zsh on the Host System with the following command:- - -```bash -sudo abroot exec apt install zsh -``` - -After installing Zsh, we need to reboot the system to apply the changes. You can do this by simply running `reboot`. - -After rebooting the system, we need to change the Default Shell to Zsh with the following command:- - -```bash -chsh -s /usr/bin/zsh -``` - -After changing the Default Shell to Zsh, we need to reboot the system to apply the changes. - -The next time you open your Terminal Emulator, you will be prompted to set up Zsh. - -### Nix - -First, we need to initialize Nix with Apx by running the following command:- - -```bash -apx init --nix -``` - -After initializing Nix, we need to reboot the system to use it. You can do this by simply running `reboot`. - -After rebooting the system, we need to install Zsh with Nix by running the following command:- - -```bash -apx install --nix zsh -``` - -After installing Zsh, we need to add the path to Zsh in `/etc/shells` by following these steps:- - -```text -- Execute: sudo nano /etc/shells -- Add: `/home//.nix-profile/bin/zsh` (Note:- Replace the given placeholder with your username). -- Save and Exit. -``` - -After adding the path and saving the file, we need to change the Default Shell to Zsh with the following command:- - -```bash -chsh -s /home//.nix-profile/bin/zsh -``` - -After changing the Default Shell to Zsh, we need to reboot the system to apply the changes. - -The next time you open your Terminal Emulator, you will be prompted to set up Zsh. - -## Change your Default Shell to Fish - -First, we need to install Fish on the Host System with the following command:- - -```bash -sudo abroot exec apt install fish -``` - -After installing Fish, we need to reboot the system to apply the changes. You can do this by simply running `reboot`. - -After rebooting the system, we need to change the Default Shell to Fish with the following command:- - -```bash -chsh -s /usr/bin/fish -``` - -After changing the Default Shell to Fish, we need to reboot the system to apply the changes. - -The next time you open your Terminal Emulator, you will be in Fish Shell. - -### Nix - -First, we need to initialize Nix with Apx by running the following command:- - -```bash -apx init --nix -``` - -After initializing Nix, we need to reboot the system to use it. You can do this by simply running `reboot`. - -After rebooting the system, we need to install Fish with Nix by running the following command:- - -```bash -apx install --nix fish -``` - -After installing Fish, we need to add the path to Fish in `/etc/shells` by following these steps:- - -```bash -- Execute: sudo nano /etc/shells -- Add: `/home//.nix-profile/bin/fish` (Note:- Replace the given placeholder with your username). -- Save and Exit. -``` - -After adding the path and saving the file, we need to change the Default Shell to Fish with the following command:- - -```bash -chsh -s /home//.nix-profile/bin/fish -``` - -After changing the Default Shell to Fish, we need to reboot the system to apply the changes. - -The next time you open your Terminal Emulator, you will be in Fish Shell. - -## Revert your Default Shell to Bash - -You can run the following command to revert your Default Shell to Bash:- - -```bash -chsh -s /usr/bin/bash -``` - -You will now have to reboot the system to apply the changes. You can do this by simply running `reboot`. - -The next time you open your Terminal Emulator, you will be in Bash Shell. - -## Changing Container's Default Shell - -`apx` containers initialized after changing your Default Shell will use your current Shell. You can check what Shell you are using by running the following command:- - -```bash -echo $SHELL -``` - -If you already initialized your containers before changing your Default Shell, you will have to reinitialize them with the following commands:- - -```bash -apx init -apx init --aur -apx init --dnf -apx init --apk -``` - -**_Warning_**: This will remove all applications installed inside the container! - -If you wish to use a specific Shell for your container, you can manually set the SHELL variable before creating the container with the following commands:- - -```bash -env SHELL=/path/to/shell apx init -env SHELL=/path/to/shell apx init --aur -env SHELL=/path/to/shell apx init --dnf -env SHELL=/path/to/shell apx init --apk -``` diff --git a/articles/en/contributing.md b/articles/en/contributing.md deleted file mode 100644 index 75097fa..0000000 --- a/articles/en/contributing.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -Title: Contribute to Handbook -Description: Learn how to contribute to Vanilla OS Handbook. -PublicationDate: 2022-11-11 -Authors: - - kbdharun - - kra-mo - - MonsterObserver ---- - -> This guide is for Kinetic (22.10), not Orchid. The documentation for Orchid is still being written. - -Thank you for your interest in our project. This guide will help you with writing articles. - -The [**Handbook**](https://github.com/Vanilla-OS/handbook) uses Jekyll and GitHub pages for generating the website. - -Handbook progress with a to-do list is present at our [**GitHub project**](https://github.com/orgs/Vanilla-OS/projects/2). - -## Prerequisites for Writing a guide - -A basic knowledge of [**Markdown**](https://www.markdownguide.org/basic-syntax/) is required for writing posts. - -## Writing a guide - -If you want to write a guide for the handbook, follow these instructions:- - -- Add the new article to the [**`_posts` directory**](https://github.com/Vanilla-OS/handbook/tree/main/_posts). -- The filename must be in the format `YYYY-MM-DD-title.md`. -- See [**markdownlint**](https://github.com/DavidAnson/markdownlint) for best markdown practices. -- The guide must use the following structure at the beginning: - -```md ---- -Title: -Description -PublicationDate: YYYY-MM-DD - -Authors: - - 1st author GitHub username - - 2nd author GitHub username - - ... - ---- -``` - -- You must fill in your article's metadata here. - -For example:- - -```md ---- -Title: Installing a package -Description: Learn how to install a package in Vanilla OS -PublicationDate: 2023-01-13 - -Authors: - - MonsterObserver - ---- -``` - -- Add your GitHub username with the co-author's username(s) in the author's field to have working links when the post is published. -- Ensure images are in **WebP format** and placed in a dedicated directory under the `assets/uploads` directory with a descriptive name for future reference. - -**_Tip_**: We suggest using [**cwebp**](https://developers.google.com/speed/webp/docs/cwebp) for converting the images to WebP. - -## Style Guide - -Headings should follow a proper hierarchy. - -Links must be in bold, commands in bold and backticks. - -For example:- - -```md -[**example**](https://example.com/) -[**`apx`**](https://github.com/Vanilla-OS/apx) -``` - -Which will have the following outputs:- [**example**](https://example.com/), [**`apx`**](https://github.com/Vanilla-OS/apx) - -Buttons in applications can be highlighted using double quotes (""). For example, the Install button gets highlighted as the "Install" button. - -Menus, command names and directories must be enclosed with backticks (`). - -For displaying commands, we suggest code blocks with the correct shell or programming language. - -For example:- - -```md -- To update your Vanilla OS system now, run the following command:- - -"```bash -sudo vso trigger-update --now -```" -(Note: " isn't required, and is used for quoting the syntax here) -``` - -The code block will have the following output:- - -```bash -sudo vso trigger-update --now -``` - -Some terms like "Note:" and "Tip:" should be highlighted with bold and italics. For example:- `**_Note_**:-`. - -## Testing the guide locally using Jekyll, Bundler - -You can install **Jekyll** from [**this page**](https://jekyllrb.com/docs/installation/) and **Bundler** can be installed from [**this page**](https://bundler.io). Or you can follow these steps in [**Vanilla OS**](/2023/01/23/install-jekyll-and-bundler.html). - -Clone your forked repository using `git` or `gh`. - -Add the guide to the correct destination in the cloned directory. - -Run `jekyll build` to build the page to `./_site` once. Then you can either test the pages manually or use the `jekyll serve` command. - -Run `jekyll serve` to build your site any time a source file changes and serve it locally. - -Navigate to `http://127.0.0.1:4000/` or `http://localhost:4000/` in your browser to preview and test the page. - -Now, commit the changes using `git` and create a PR in GitHub. - -**_Tip_**:- - -You can test your pages on your phone using `jekyll serve --host=`. - -Using `0.0.0.0` instead of a specific IP binds port 4000 to any interface, which is prone to be blocked by your routers firewalls. That's why we recommended using a particular IP address with the `--host` flag. After executing the command in any browser on your phone, go to this address `:4000`. - -For example, if the IP you used is `192.168.0.123`, you will need to visit `192.168.0.123:4000` on your mobile. - -## Embedding GitHub Gists - -GitHub gists are allowed for referencing custom mods and scripts in posts. - -For example, embedding this `` will have the following output:- - - - -## Archiving guides - -Removing guides and images from the repository isn't advised. - -For outdated articles and posts, we suggest changing the publishing status to `false` in the header, which removes it from the Glossary's listing and RSS feed. - -For outdated images, it is recommended to move them to the [**handbook-archive**](https://github.com/Vanilla-OS/handbook-archive) repository to prevent space. - -## Discussions - -For discussions regarding the handbook, go to the [**`#docs-writing`**](https://discord.com/channels/1023243680829681704/1035287786330263703) channel in the [**official Discord server**](https://discord.gg/3cD2Q7Ht3S). For Discussions regarding translations go to the [**`#translations`**](https://discord.com/channels/1023243680829681704/1037028192583692358) channel. Alternatively, you can collaborate with the docs team on our [**Matrix room**](https://matrix.to/#/#vanillaos-docs:matrix.org). diff --git a/articles/en/first-setup.md b/articles/en/first-setup.md deleted file mode 100644 index 1728555..0000000 --- a/articles/en/first-setup.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -Title: First Setup -Description: Set up Vanilla OS after installation. -PublicationDate: 2022-11-18 -Authors: - - kra-mo - - kbdharun ---- - -> This guide is for Kinetic (22.10), not Orchid. The documentation for Orchid is still being written. - -## Introduction - -Congratulations, you have successfully installed Vanilla OS. -This guide will help you set your system up for the first time. - -## First Setup app - -After booting into Vanilla OS for the first time, you will be presented with a First Setup app. This section will guide you through each step in detail. - -![Welcome](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/First_Setup/first-setup-welcome.webp) - -### Color Scheme - -Your preferred color scheme. Default meaning that apps decide for themselves or Dark. This can be changed later in the Settings app. - -![Color Scheme](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/First_Setup/first-setup-color-scheme.webp) - -### Package Manager - -Choose your preferred package managers. These are the ways you will be able to install applications. If unsure, leave it on the default "Flatpak". You can install the required dependencies for each one later if you change your mind. - -![Package Manager](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/First_Setup/first-setup-package-managers.webp) - -## Applications - -Choose which applications you need to install in your Vanilla OS Installation. There are various categories for installing applications. - -![Install Applications](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/First_Setup/first-setup-applications.webp) - -![Install Core Applications Flatpak](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/First_Setup/first-setup-applications-flatpak-core.webp) - -### Restricted Codecs - -This will install popular patented codecs and fonts, that Vanilla OS cannot ship for copyright reasons. **Recommended for most users.** - -![Restricted Codecs](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/First_Setup/first-setup-restricted-codecs.webp) - -### Extra Settings - -Extra system settings for automatic crash detection and bug reporting. If unsure, it is recommended to leave it disabled. - -![Extra Settings](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/First_Setup/first-setup-extra-settings.webp) - -### NVIDIA® Drivers - -If you have an NVIDIA® graphics card, you will be prompted to install proprietary drivers for your card to improve compatibility and performance. **Recommended for most users.** - -![NVIDIA® Drivers](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/First_Setup/first-setup-nvidia-drivers.webp) - -### Open VM Tools - -If you are running Vanilla OS inside a virtual machine, you will be prompted to install Open VM Tools to use with VMWare applications. If unsure, it is recommended to skip this step. - -![Open VM Tools](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/First_Setup/first-setup-open-vm-tools.webp) - -## Other Settings - -You can find other options in Settings, Vanilla OS Control Center or tweak your graphical environment in GNOME Tweaks. - -We hope you will have a great time using Vanilla OS! diff --git a/articles/en/install-additional-drivers.md b/articles/en/install-additional-drivers.md deleted file mode 100644 index 4500e28..0000000 --- a/articles/en/install-additional-drivers.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -Title: Install additional drivers in Vanilla OS -Description: Learn how to install Additional drivers in Vanilla OS. -PublicationDate: 2022-12-10 -Authors: - - mirkobrombin - - kbdharun - - mrunix00 ---- - -> This guide is for Kinetic (22.10), not Orchid. The documentation for Orchid is still being written. - -Drivers are software components that allow the operating system to communicate with hardware devices. - -In Vanilla OS, primary drivers are installed automatically during the first setup, but some devices may need additional drivers to work ideally. You can install them using two methods:- - -- **Vanilla Drivers Utility** -- **Manual installation in the transactional shell.** - -## Vanilla Drivers Utility - -**Vanilla Drivers Utility** is a graphical tool that allows you to install additional drivers. Launch it from the "About" section in Settings, then click on "Additional Drivers". - -![Settings](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/Miscellaneous/gnome-settings.webp) - -Here you can see a list of all the drivers available, organized by category. To install a driver, click on it, then press the "Apply Changes" button in -the top-right corner. - -![Drivers Utility](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/Miscellaneous/drivers-utility.webp) - -Once the installation is complete, you will be requested to reboot the system. - -## Manual installation - -### APT Package - -If you prefer to install drivers manually, you can do so using the transactional shell. Open the terminal and run the following command:- - -```bash -sudo abroot exec apt install -``` - -Where `` is the package name that offers the driver you want to -install. For example, installing the NVIDIA driver at version 525 can be done by executing the following command:- - -```bash -sudo abroot exec apt install nvidia-driver-525 -``` - -After installation, exit the shell using the `exit` command and wait for the changes to be applied, then reboot once the installation is complete. - -### DEBs - -You can install drivers present as DEB files through ABRoot using the following steps:- - -In a non-privileged terminal, you can copy the DEB file to `/tmp` using the following command:- - -```bash -cp /tmp -``` - -Now, Enter ABRoot Shell using the following command and `cd` to the required directory:- - -```bash -sudo abroot shell -cd /tmp -``` - -Now, you can install DEBs using `apt`:- - -```bash -sudo apt install ./.deb -``` - -(This will automatically install the required dependencies.) - -Alternatively, you can install DEBs using `dpkg`:- - -```bash -sudo dpkg -i .deb -sudo apt-get install -f -``` - -**_Note_**:- `sudo apt-get install -f` is required to fix broken or missing dependencies. - -After installing the drivers, exit the shell using the `exit` command and wait for the changes to apply. Reboot your system for the transaction to take place. - -Congratulations, You have successfully installed the necessary drivers. diff --git a/articles/en/install-and-manage-applications.md b/articles/en/install-and-manage-applications.md deleted file mode 100644 index 4676f67..0000000 --- a/articles/en/install-and-manage-applications.md +++ /dev/null @@ -1,237 +0,0 @@ ---- -Title: Install and manage Applications -Description: Learn how to install and manage applications on Vanilla OS -PublicationDate: 2023-01-11 -Authors: - - kbdharun - - MonsterObserver ---- - -> This guide is for Kinetic (22.10), not Orchid. The documentation for Orchid is still being written. - -## Introduction - -Vanilla OS allows installing packages and software from various sources. This guide will discuss them in detail. - -Vanilla OS comes with the option to enable Flatpak and AppImage in the initial setup. It also allows the installation of native packages using the `apx` package manager. - -## Terminologies - -- **Flatpak**:- Flatpak is a popular packaging format allowing the installation of Desktop applications in a sandboxed environment isolated from the system with shared libraries between them. Flatpak provides developers with a unified way to distribute apps for most GNU/Linux distributions. Flatpak supports adding various remote repositories, the most popular repository being Flathub. - -- **Flathub**:- Flathub is the largest repository of Flatpak applications spanning various categories. - -- **AppImage**:- AppImage is a format for distributing portable software or executables on Linux without needing superuser permissions to install the application. - -- **GNOME Software**:- GNOME Software allows you to find, install and remove new applications and system extensions. It showcases screenshots, metadata and user reviews of various applications. In Vanilla OS, it supports installing Flatpaks and Vanilla OS (Apx) meta packages. GNOME Software is the Linux equivalent of the Microsoft Store, Play Store and App Store. - -- **Package Manager**:- A package manager or package-management system is a utility with a collection of software tools that automates installing, upgrading, configuring, and removing applications or packages. -`apx` is the package manager which comes with Vanilla OS. It is the equivalent command for Winget on Windows. - -- **APX**:- `apx` is the default package manager in Vanilla OS. It allows installing applications from multiple sources in managed containers. - -- **APT**:- `apt` is an Advanced Package Tool which allows installing and managing software on Debian and Debian-based systems like Ubuntu. - -- **DNF**:- `dnf` (Dandified YUM) is the successor to YUM. It is a powerful package manager for installing and managing applications on rpm-based distributions. - -- **AUR**:- `aur` (Arch User Repository) is the largest community-maintained repository with thousands of native packages for Arch Linux and its derivatives. - -- **APK**:- `apk` (Alpine Linux package keeper) is a package manager which allows installing and managing applications on Alpine Linux. - -- **ZYPPER**:- `zypper` is a package manager on openSUSE for installing, updating and removing packages, and also for managing repositories. - -- **XBPS**:- `xbps` (X Binary Package System) is a fast package manager on Void Linux that has been designed and implemented from scratch for efficiently managing your packages. - -- **NIX**:- `nix` is a powerful package manager for Linux and other Unix systems that makes package management reliable and reproducible. - -- **DEB**:- `deb` (Debian Packages) is a file format for installing and managing applications on Debian-based systems. It's an equivalent file extension to `.exe` in Windows and `.rpm` in GNU/Linux. - -- **RPM**:- `rpm` (Red Hat package manager) is a file format for installing and managing applications on RHEL-based systems. It's an equivalent file extension to `.exe` in Windows and `.deb` in GNU/Linux. - -## Managing Applications through GNOME Software - -### Installing Applications - -Flatpaks can be installed with ease using GNOME Software. It is the recommended method for installing packages. - -![GNOME Software](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/Applications_Post/gnome-software-43.webp) - -### Searching Applications - -You can search for applications in GNOME Software by clicking on the Search icon in the top left corner. - -If the application you searched for exists, it will be displayed, and you can proceed with the installation. - -If the application you searched for does not exist, you can use an alternative method suggested below in this guide to install it. - -### Updating Applications - -Updates are visible in the `Updates` panel in GNOME Software. In Vanilla OS, Updates are available for Flatpaks and System Packages in GNOME Software. - -Automatic Updates are configured in the `Update Preferences` tab located in the burger menu in the top right corner. - -![GNOME Software Update Proferences](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/Applications_Post/gnome-software-update-preferences.webp) - -### Removing Applications - -You can remove installed Flatpaks from the `Installed` panel. - -(**_Note_**: Some native applications installed on the host cannot be removed using this method, but applications installed through the meta plugin can be removed through the panel.) - -## Manage AppImages - -### Installing AppImages - -You can download AppImages from project pages on GitHub. Another source for AppImages is [**AppImageHub**](https://www.appimagehub.com/). - -Once downloaded, they won't have to be installed since they are executable binaries. - -### Running AppImages - -If you have enabled AppImage in the first setup, you can run AppImages graphically by following these steps:- - -- Right-click on the file, then click on **Properties**. - -![AppImages Properties](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/Applications_Post/appimages-nautilus-properties.webp) - -- Enable the **Executable as Program** option. - -You can now run the AppImage by right-clicking it and pressing run or by pressing enter/return key on your keyboard. - -Alternatively, you can open AppImages from the terminal with the following commands:- - -```bash -cd -chmod +x .appimage -./.appimage -``` - -**_Note_**:- `chmod +x .AppImage` makes the file executable. - -## Managing Flatpaks through CLI - -If you enabled Flatpak in the First Setup, you won't have to do anything. If you have disabled Flatpak in the First Setup, follow the guide [**here**](/2022/12/09/install-flatpaks.html). - -### Installing Flatpaks - -You can install Flatpaks with the following command:- - -```bash -flatpak install -``` - -### Running Flatpaks - -You can run the Flatpaks using the desktop entry (icon) from the Application menu. - -You can alternatively run Flatpaks in the terminal with the following command:- - -```bash -flatpak run -``` - -### Removing Flatpaks - -You can remove installed Flatpaks with the following command:- - -```bash -flatpak uninstall -``` - -You can remove unused Flatpak dependencies with the following command:- - -```bash -flatpak uninstall --unused -``` - -You can remove leftover data of Flatpaks with the following command (**_Disclaimer_**: Proceed with caution, since this removes all application data):- - -```bash -flatpak uninstall --delete-data -``` - -## Managing Applications through Apx - -`Apx` allows installing applications from various Linux distributions. These applications are tightly integrated with the host and can access the host's hardware. - -In the commands below, `` will be a placeholder. It can be replaced by the following options:- - -- `apt` -- `dnf` -- `aur` -- `apk` -- `zypper` -- `xbps` -- `nix` - -### Creating a Container - -You can create a container with the following command:- - -```bash -apx init -- -``` - -You can also initialize the containers graphically by clicking on the `+` icon in the Vanilla Control Center. (Vanilla Control Center allows you to enter the apx container graphically.) - -![Vanilla Control Center - Sub System](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/Applications_Post/vanilla-control-center-subsystem.webp) - -After initialization, you can enter the container graphically by clicking on the `terminal` icon. - -![Vanilla Control Center - Sub System post initialization](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/Applications_Post/vanilla-control-center-subsystem-example.webp) - -### Installing Applications with Apx - -You can install applications with the following command:- - -```bash -apx install -- -``` - -This command will automatically detect the desktop file entry in the package and add it to the Application menu and Vanilla Control Center. - -You can install DEB packages with the following command:- - -```bash -apx install --sideload -``` - -You can install RPM packages with the following command:- - -```bash -apx install --dnf --sideload -``` - -If your application's desktop entry isn't detected automatically, you can export it manually with the following command:- - -```bash -apx export -- -``` - -You can export binaries to run them without the `apx run` prefix with the following command:- - -```bash -apx export -- --bin -``` - -### Uninstalling Applications with Apx - -You can uninstall applications with the following command:- - -```bash -apx remove -``` - -This command will automatically detect and remove the desktop file entry. - -If your application's desktop entry is not automatically removed, you can unexport it manually with the following command:- - -```bash -apx unexport -- -``` - -You can unexport binaries with the following command:- - -```bash -apx unexport -- --bin -``` diff --git a/articles/en/install-distrobox.md b/articles/en/install-distrobox.md deleted file mode 100644 index 21f5632..0000000 --- a/articles/en/install-distrobox.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -Title: Install Distrobox -Description: Learn how to install Distrobox on Vanilla OS. -PublicationDate: 2023-01-02 -Authors: - - mirkobrombin ---- - -> This guide is for Kinetic (22.10), not Orchid. The documentation for Orchid is still being written. - -## What is Distrobox? - -[**Distrobox**](https://github.com/89luca89/distrobox) is a utility that allows you to run multiple Linux distributions in your system without the need to dual boot or install them in a virtual machine. It enables backward and forward compatibility with software and provides freedom to use whatever distribution you need. - -It uses Podman or Docker to create containers using the Linux distribution of your choice. The container created will be tightly integrated with the host, which allows sharing the `/home` directory of the user, hardware (like external storage, pen drives, speakers) and graphical apps (X11/Wayland). - -## Install Distrobox - -The recommended way to install Distrobox is via the official script. To do so, open a terminal and run the following command: - -```bash -curl -s https://raw.githubusercontent.com/89luca89/distrobox/main/install | sh -s -- --next --prefix ~/.local -``` - -In this way, Distrobox will be installed in the `~/.local` directory, which is already in the PATH variable for Vanilla OS. - -**_Note_**: We are going to install Distrobox in your `home` directory to avoid altering the root file system. - -## Uninstall Distrobox - -To uninstall Distrobox, run the following command: - -```bash -curl -s https://raw.githubusercontent.com/89luca89/distrobox/main/uninstall | sudo sh -s -- --prefix ~/.local -``` diff --git a/articles/en/install-docker.md b/articles/en/install-docker.md deleted file mode 100644 index f0c1b92..0000000 --- a/articles/en/install-docker.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -Title: Installing Docker Engine and Docker Desktop -Description: Learn how to Install and set up Docker Engine and Docker Desktop in Vanilla OS. -PublicationDate: 2022-02-05 -Authors: - - kbdharun - - zedtux ---- - -> This guide is for Kinetic (22.10), not Orchid. The documentation for Orchid is still being written. - -## Introduction - -[**Docker**](https://www.docker.com/) is an open platform for developing, shipping, and running applications in containerized environments. This guide provides the steps to install the Docker engine and Docker desktop in Vanilla OS. - -This guide is for advanced users. If your workflow doesn't require Docker, use [**Podman**](https://podman.io/) instead. - -## Installing Docker Engine - -You can install the Docker engine using the following steps:- - -First, enter the transactional shell using the following command:- - -```bash -sudo abroot shell -``` - -Then execute the following commands to install the required packages:- - -```bash -sudo apt update -sudo apt install \ - ca-certificates \ - curl \ - gnupg \ - lsb-release -``` - -Add Docker's GPG key using the following command:- - -```bash -sudo mkdir -p /etc/apt/keyrings -curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /etc/apt/keyrings/docker.gpg -``` - -Setup the repository using the following commands:- - -```bash -echo \ "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/ubuntu \ $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null -``` - -Then run `sudo apt update` after its completion. After the update is complete, execute the following command:- - -```bash -sudo apt install docker-ce docker-ce-cli containerd.io docker-compose-plugin -``` - -Now, `exit` the transactional shell and `reboot` your system. - -After the reboot, type `sudo docker run hello-world` in your terminal window. It will pull the image locally and display a message meaning the installation is successful. - -**_Notes_**:- - -- Add the `docker` group to your user's groups to allow running the `docker` command without `sudo` using the command `sudo usermod -aG docker $USER`. -- Set the location for saved Images and Containers to `/home` to avoid filling up the root partition. - -## Installing Docker Desktop - -You can install the Docker Desktop application using the following steps:- - -First, download the DEB file from [**here**](https://docs.docker.com/desktop/install/ubuntu/). - -Then copy the file to `/tmp` (Temporary files in `/tmp` get removed after a reboot) using the command `cp -r docker-desktop--.deb /tmp` (Note:- `<>` is a placeholder, replace it with the correct details) in an unprivileged terminal session. - -Then enter the transactional shell using the `sudo abroot shell` command. - -Install the application using the following command:- - -```bash -sudo apt install ./docker-desktop--.deb -``` - -**_Note_**:- `<>` is a placeholder. Replace it with the details of the package. - -`exit` the transactional shell and `reboot` your system to see Docker Desktop. - -![Docker Desktop](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/Miscellaneous/Docker-Desktop.webp) - -Now, sign up and proceed with the setup. diff --git a/articles/en/install-flatpaks.md b/articles/en/install-flatpaks.md deleted file mode 100644 index 1e3a3c2..0000000 --- a/articles/en/install-flatpaks.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -Title: Install Flatpak(s) in Vanilla OS -Description: Learn how to install Flatpak packages in Vanilla OS. -PublicationDate: 2022-12-09 -Authors: - - mirkobrombin ---- - -> This guide is for Kinetic (22.10), not Orchid. The documentation for Orchid is still being written. - -Flatpak is a universal package format for Linux desktop applications. It works on most Linux distributions, Vanilla OS included. Flatpak applications get distributed as bundles, similar to native packages, but they are sandboxed and can be updated independently from the host system. - -## Install Flatpak - -The preferred way to install Flatpak is to toggle it in the **First Setup** -wizard. If you didn't toggle it, you can install it manually using the transactional shell: - -```bash -sudo abroot exec apt install flatpak gnome-software-plugin-flatpak -``` - -Reboot once the installation is complete. - -Alternatively, you can install Flatpak inside a managed container using `apx`: - -```bash -apx install flatpak -``` - -In this case, you will always need to run Flatpak commands inside the `apx` container: - -```bash -apx run flatpak install flathub org.gnome.gedit -``` - -## Configure Flathub - -Flatpak needs to know where to look for applications. The default and most popular repository for installing Flatpaks is Flathub, which you can add using the following command: - -```bash -flatpak remote-add --if-not-exists --user flathub https://flathub.org/repo/flathub.flatpakrepo -``` - -**_NOTE_**: The `--user` flag, which tells Flatpak to install applications only for the current user, is needed because the root partitions in Vanilla OS are small-sized and must get updated in a transactional way only. - -## Install an application - -There are two ways to install a Flatpak applications: using GNOME Software or through the command line. - -### GNOME Software - -Open GNOME Software, search for the application you want to install and click on the "Install" button. - -![GNOME Software](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/Miscellaneous/flatpak-gnome-software.webp) - -### Command line - -You can also install Flatpak applications using the command line. For example, to install Steam, run the following command: - -```bash -flatpak install flathub com.valvesoftware.Steam -``` - -## Run an application - -Installed applications are available in the "Applications" menu, or you can -run them from the command line: - -```bash -flatpak run com.valvesoftware.Steam -``` diff --git a/articles/en/install-heroic-games-launcher.md b/articles/en/install-heroic-games-launcher.md deleted file mode 100644 index 8b22e1f..0000000 --- a/articles/en/install-heroic-games-launcher.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -Title: Install Heroic Games Launcher -Description: Learn how to install Heroic games Launcher on Vanilla OS. -PublicationDate: 2023-01-28 -Authors: - - mirkobrombin ---- - -> This guide is for Kinetic (22.10), not Orchid. The documentation for Orchid is still being written. - -## What is Heroic Games Launcher? - -[**Heroic Games Launcher**](https://heroicgameslauncher.com/) is an open source game launcher for Linux. It allows you to download and play games from the Epic Games Store and the GOG Galaxy client through a user-friendly interface. - -## Installation - -The recommended way to install Heroic Games Launcher is through [**Flatpak**](https://flatpak.org/), but it is also available as an AppImage. - -### Flatpak - -If you chose to install Flatpak during [**First Setup**](https://handbook.vanillaos.org/2022/11/18/first-setup.html), you could install applications directly from GNOME Software, as explained [**here**](https://handbook.vanillaos.org/2022/12/09/install-flatpaks.html#title3). - -You can also install the Heroic Games Launcher Flatpak from the terminal using the following command: - -```bash -flatpak install flathub com.heroicgameslauncher.hgl -``` - -### AppImage - -You can download the latest AppImage from the [**official website**](https://heroicgameslauncher.com/downloads). - -If you chose to install AppImage during [**First Setup**](https://handbook.vanillaos.org/2022/11/18/first-setup.html), you will be able to run the AppImage just by double-clicking on it. If you didn't, you could install the required dependencies using an ABRoot transaction using the following command: - -```bash -sudo abroot exec apt install -y fuse3 libfuse2 appimagelauncher -``` - -Then reboot your system. You can now run the AppImage by setting it as executable from Properties and double-clicking on it. Alternatively, you can make it executable using the following command: - -```bash -chmod +x Heroic-*.AppImage -``` - -## Troubleshooting - -In this section, we will show you how to fix some common issues you may encounter when using Heroic Games Launcher. - -### Poor performance - -If you are experiencing poor performance, ensure that you have the latest graphics drivers installed. To do so, refer to the [**Install additional drivers in Vanilla OS**](https://handbook.vanillaos.org/2022/12/10/install-additional-drivers.html) page. - -Also, check the game's system requirements and ensure that your system meets them. - -### Epic Games Store Login doesn't work - -If you are unable to login to the Epic Games Store, you can try to log in using the [**alternative login method**](https://github.com/Heroic-Games-Launcher/HeroicGamesLauncher/wiki/How-To:-Epic-Alternative-Login). - -### Other issues - -If you are experiencing other issues, you can refer to the [**official troubleshooting page**](https://github.com/Heroic-Games-Launcher/HeroicGamesLauncher/wiki/Troubleshooting) or open an [**issue**](https://github.com/Heroic-Games-Launcher/HeroicGamesLauncher/issues) on GitHub. diff --git a/articles/en/install-homebrew.md b/articles/en/install-homebrew.md deleted file mode 100644 index 96c4476..0000000 --- a/articles/en/install-homebrew.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -Title: Installing Homebrew in Vanilla OS -Description: Learn how to Install and setup Homebrew in Vanilla OS. -PublicationDate: 2022-01-26 -Authors: - - kbdharun ---- - -> This guide is for Kinetic (22.10), not Orchid. The documentation for Orchid is still being written. - -## Terminologies - -- **Package Manager**:- A package manager or package-management system is a utility with a collection of software tools that automates installing, upgrading, configuring, and removing applications or packages. - -`apx` is the package manager which comes with Vanilla OS. - -- **Homebrew**:- Homebrew is a popular package manager for installing and managing packages in Mac and Linux. It contains thousands of packages and comes built-in with powerful tools and functionality. It supports installing packages in the `home` directory and is fully compatible with Vanilla OS. - -## Installing Git - -`git` is an essential dependency for installing Homebrew. -Run the `git` command in your terminal to check if it exists already. If `git` doesn't exist in your system, you can install it using the following command:- - -```bash -sudo abroot exec apt install git -``` - -After executing the above command, reboot your system to proceed with the guide below. - -## Installing Homebrew - -Once `git` is present in your system, you can install Homebrew in the terminal without any superuser privileges using the following command:- - -```bash -/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" -``` - -Once installation is complete, you will see this message:- - -![Homebrew Post Installation message](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/Miscellaneous/homebrew-post-installation-message.webp) - -Now, execute the commands the message gives you to add Homebrew to your `$PATH`. To see if everything worked correctly, install a test package (`brew install hello`), then check the installation by typing `hello` in your terminal. diff --git a/articles/en/install-in-vm.md b/articles/en/install-in-vm.md deleted file mode 100644 index 9a9eb24..0000000 --- a/articles/en/install-in-vm.md +++ /dev/null @@ -1,428 +0,0 @@ ---- -Title: Install Vanilla OS in a VM -Description: Learn how to install Vanilla OS in a VM. -PublicationDate: 2023-01-21 -Authors: - - MonsterObserver - - kbdharun - - johnaaron-git ---- - -> This guide is for Kinetic (22.10), not Orchid. The documentation for Orchid is still being written. - -## Introduction - -If you are interested in Vanilla OS, it's a good idea to try it out in a VM before using it on your hardware to get used to the Vanilla OS components. This guide will guide you through installing Vanilla OS with various VM software. - -## Install Vanilla OS in Gnome Boxes - -### Prerequisites - -- Check whether Flatpak is installed. If it isn't present, you can check out how to install it [**here**](https://handbook.vanillaos.org/2022/12/09/install-flatpaks.html). - -- Install "Gnome Boxes" from the "Gnome Software" application. Alternatively, you can install it with the following command:- - -```bash -flatpak install flathub org.gnome.Boxes -``` - -- Install the Vanilla OS ISO from [**here**](https://github.com/Vanilla-OS/os/releases/latest). - -### Installation - -Launch Gnome Boxes from the App Grid. Alternatively, you can run it with the following command:- - -```bash -flatpak run org.gnome.Boxes -``` - -Click on the "+" icon. - -![Gnome Boxes 1](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Boxes/vm-boxes1.webp) - -Click on "Create virtual machine from file". - -![Gnome Boxes 2](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Boxes/vm-boxes2.webp) - -Choose the Vanilla OS ISO from the file picker and click on "Open". - -![Gnome Boxes 3](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Boxes/vm-boxes3.webp) - -Leave the Template on "Unknown OS" and click on "Next". - -![Gnome Boxes 4](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Boxes/vm-boxes4.webp) - -We recommend you use a minimum of 4GB Memory to ensure good performance. You're also required to use a minimum of 50GB Storage for ABRoot. Now click on "Create". - -![Gnome Boxes 5](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Boxes/vm-boxes5.webp) - -Vanilla OS will now boot. - -![Gnome Boxes 6](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Boxes/vm-boxes6.webp) - -For the installation steps, refer to [**this guide**](https://handbook.vanillaos.org/2022/11/05/installation.html#title7). - -## Install Vanilla OS in VMWare Workstation Player - -- A VMWare Workstation Player Installation from [**here**](https://www.vmware.com/products/workstation-player/workstation-player-evaluation.html). - -- Install the Vanilla OS ISO [**here**](https://github.com/Vanilla-OS/os/releases/latest). - -### Installation - -Open VMWare Workstation Player. - -Click on "Create a New Virtual Machine". - -![VMWare Workstation Player 1](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/VMWare/VMWare_1.webp) - -Select the ISO and click "Next". - -![VMWare Workstation Player 2](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/VMWare/VMWare_2.webp) - -Select the Guest operating system as "Linux" with Version "Ubuntu 64-bit" and click on "Next". - -![VMWare Workstation Player 3](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/VMWare/VMWare_3.webp) - -Specify the name of your virtual machine and the location to store its files. Then click on "Next". - -![VMWare Workstation Player 4](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/VMWare/VMWare_4.webp) - -Select a minimum of 50GB for Vanilla OS, this is required for ABRoot. - -![VMWare Workstation Player 5](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/VMWare/VMWare_5.webp) - -Confirm your configuration, then click on "Finish". If required, select "Customize Hardware..." then go to "Display" and disable/untick "Accelerate 3D graphics". - -![VMWare Workstation Player 6](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/VMWare/VMWare_6.webp) - -![VMWare Workstation Player 7](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/VMWare/VMWare_7.webp) - -Now, click on the "Start" (Play) button. - -![VMWare Workstation Player 8](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/VMWare/VMWare_8.webp) - -Inside the live session, click on the top right corner and click on the "Settings" icon. Alternatively, you can press on the windows/super key to open the "Activities overview" and then type "Settings" to access it. Now, Navigate to "Displays", under "Resolution" select a different resolution to adjust the window size initially. - -![VMWare Workstation Player 9](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/VMWare/VMWare_9.webp) - -Now, proceed with the Vanilla OS Installation. - -For additional installation steps, refer to [**this guide**](https://handbook.vanillaos.org/2022/11/05/installation.html#title7). - -In the first setup, click "Install" on the Open VM Tools page to install the necessary packages for clipboard sharing, custom resolution, etc. - -![VMWare Workstation Player 10](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/VMWare/VMWare_10.webp) - -## Install Vanilla OS in Virtual Machine Manager - -### Prerequisites - -- A Virtual Machine Manager Installation from [**here**](https://virt-manager.org/). - -- The necessary QEMU dependencies installed. - -- Install the Vanilla OS ISO from [**here**](https://github.com/Vanilla-OS/os/releases/latest). - -### Installation - -Launch Virtual Machine Manager from the App Grid. Alternatively, you can run it with the following command from the terminal:- - -```bash -virt-manager -``` - -Click on the "Create a new virtual machine" button in the left corner below the top bar. - -![Virt manager 1](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Virt-Manager/virt_manager_1.webp) - -Click "Local install media" and confirm the architecture as x86_64. Then, click on "Forward". - -![Virt manager 2](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Virt-Manager/virt_manager_2.webp) - -Select the ISO location of Vanilla OS and choose "Generic Linux " as the operating system. Now click on "Forward". - -**_Note_**:- `` is a placeholder meaning select the most recent year. - -![Virt manager 3](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Virt-Manager/virt_manager_3.webp) - -Allocate the required Memory and CPUs and click on "Forward". - -![Virt manager 4](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Virt-Manager/virt_manager_4.webp) - -Create a disk image for a minimum of 50 GB and then click "Forward". - -![Virt manager 5](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Virt-Manager/virt_manager_5.webp) - -Specify the name of your virtual machine and confirm other options and click on "Finish". - -![Virt manager 6](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Virt-Manager/virt_manager_6.webp) - -Now, wait for the virtual machine to get created. - -![Virt manager 7](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Virt-Manager/virt_manager_7.webp) - -![Virt manager 8](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Virt-Manager/virt_manager_8.webp) - -Now, "Open" the virtual machine in the Graphical console. - -When the VM is opened, proceed with the Vanilla OS Installation. - -For additional installation steps, refer to [**this guide**](https://handbook.vanillaos.org/2022/11/05/installation.html#title7). - -**_Optionally_**:- You can enable "Auto resize VM with window" under the "Scale Display" menu in the "View" tab. - -![Virt manager 9](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Virt-Manager/virt_manager_9.webp) - -## Install Vanilla OS in Parallels Desktop - -### Prerequisites - -- A licensed copy of [Parallels Desktop](https://www.parallels.com/products/desktop/). - -- Install the Vanilla OS ISO from [**here**](https://github.com/Vanilla-OS/os/releases/latest). - -### Installation - -Open Parallels Desktop and follow the on-screen prompts. Skip installing Windows 11 (for now) if this is your first time using Parallels software. - -![Parallels 0](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Parallels/vanilla-parallels-install-0.webp) - -Navigate to the Parallels Desktop Control Center, and select the "+" button to add a new virtual machine. - -![Parallels 1](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Parallels/vanilla-parallels-install-1.webp) - -From the Installation Assistant, select "Install Windows or another OS from a DVD or image file". - -![Parallels 2](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Parallels/vanilla-parallels-install-2.webp) - -Select "Choose Manually". - -![Parallels 3](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Parallels/vanilla-parallels-install-3.webp) - -Click the "select a file..." hyperlink, or drag the `VanillaOS-.iso` file to the Installation Assistant window. - -![Parallels 4](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Parallels/vanilla-parallels-install-4.webp) - -Select the `VanillaOS-.iso` file. - -**_Note_**:- The content inside `<>` is a placeholder. - -![Parallels 5](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Parallels/vanilla-parallels-install-5.webp) - -Parallels is unable to automatically detect the operating system inside of our `VanillaOS-.iso`. This is normal, click "Continue". - -![Parallels 6](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Parallels/vanilla-parallels-install-6.webp) - -Change "Windows" to "Ubuntu Linux" from the drop-down menu that appears (Vanilla OS benefits from Ubuntu-centric Parallels features). - -![Parallels 7](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Parallels/vanilla-parallels-install-7.webp) - -Rename your virtual machine to Vanilla OS (or whatever you like!). - -![Parallels 8](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Parallels/vanilla-parallels-install-8.webp) - -Select the "Customize settings before installation" checkbox. This is important because we need to change one important system setting. - -![Parallels 9](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Parallels/vanilla-parallels-install-9.webp) - -Selecting "Create" will open the "Vanilla OS" Configuration window. Select the "Hardware" tab. - -![Parallels 10](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Parallels/vanilla-parallels-install-10.webp) - -Scroll the left-side menu until you see "Boot Order". - -![Parallels 11](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Parallels/vanilla-parallels-install-11.webp) - -From the "Boot Order" tab, click the "Advanced..." button - -![Parallels 12](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Parallels/vanilla-parallels-install-12.webp) - -Change "BIOS: Legacy BIOS" to "EFI 64-bit". - -![Parallels 13](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Parallels/vanilla-parallels-install-13.webp) - -Confirm the changes and close the configuration window. - -![Parallels 14](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Parallels/vanilla-parallels-install-14.webp) - -Finish virtual machine creation by selecting "Continue". - -![Parallels 15](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Parallels/vanilla-parallels-install-15.webp) - -Vanilla OS virtual machine will now boot successfully. - -![Parallels 16](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Parallels/vanilla-parallels-install-16.webp) - -Follow the Vanilla OS on-screen prompts. (For additional details, refer to [**this guide**](https://handbook.vanillaos.org/2022/11/05/installation.html#title7). - -![Parallels 17](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Parallels/vanilla-parallels-install-17.webp) - -From the Vanilla OS GNOME desktop, select "Activities" - -![Parallels 18](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Parallels/vanilla-parallels-install-18.webp) - -Search for "Console". Open the Console application. - -![Parallels 19](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Parallels/vanilla-parallels-install-19.webp) - -Type `sudo abroot shell` into the Console, and press enter to open up the transactional shell. The transactional shell allows you to install drivers and essential packages onto the immutable filesystem. Type `y` and press enter to proceed. - -![Parallels 20](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Parallels/vanilla-parallels-install-20.webp) - -Type `sudo apt-get install dkms libelf-dev linux-headers-$(uname -r) build-essential`, press enter to install Parallels Tools system dependencies. Type `Y` and press enter to confirm the installation. - -![Parallels 21](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Parallels/vanilla-parallels-install-21.webp) - -Once the system dependencies has been installed, type `exit` and press enter to leave the elevated transactional shell. - -![Parallels 22](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Parallels/vanilla-parallels-install-22.webp) - -Type `reboot` and press enter to reboot your Vanilla OS virtual machine. - -![Parallels 23](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Parallels/vanilla-parallels-install-23.webp) - -In the top-right corner of the Vanilla OS virtual machine window, there should be a triangle warning icon. Click it. - -![Parallels 24](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Parallels/vanilla-parallels-install-24.webp) - -If you can't see the warning icon, or you have installed Parallels Tools previously, navigate to the MacOS menu bar and select "Actions -> Install Parallels Tools...". - -![Parallels 25](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Parallels/vanilla-parallels-install-25.webp) - -Read the Parallels Tools installation pop up window and click "Continue". - -![Parallels 26](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Parallels/vanilla-parallels-install-26.webp) - -Inside Vanilla OS, open the Files app and navigate to the Parallels Tools disc image folder in the left-side menu. Right-click inside the Parallels Tools folder and select "Open in Console". - -![Parallels 27](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Parallels/vanilla-parallels-install-27.webp) - -Type `cd ../` and press enter to move up one directory in the Linux filesystem. Type `cp -r 'Parallels Tools' /tmp/copy` and press enter to copy the Parallels Tools disc image folder to a temporary directory (Temporary files in `/tmp` get removed after a reboot). Vanilla OS will not execute this mounted virtual image by default, so we must copy the folder and its contents to a safe temporary directory. - -![Parallels 28](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Parallels/vanilla-parallels-install-28.webp) - -Type `sudo abroot shell` and press enter to open up the transactional shell again. - -Type `cd /tmp/copy` and press enter to instruct the Console to navigate to the new temporary directory. Type `sudo ./install` and press enter to begin installing Parallels Tools. - -![Parallels 30](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Parallels/vanilla-parallels-install-29-30.webp) - -The Console app background should turn blue with a grey Parallels Tools Installer text window. Press the spacebar to select the "Next >" option. - -![Parallels 31](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Parallels/vanilla-parallels-install-31.webp) - -Confirm installation by pressing the spacebar to select "Next >" again. - -![Parallels 32](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Parallels/vanilla-parallels-install-32.webp) - -Wait for the installation to finish. Press the tab, and then press the spacebar to exit. We will reboot later once we have exited the transactional shell. - -![Parallels 33](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Parallels/vanilla-parallels-install-33.webp) - -Type `exit` and press enter. - -![Parallels 34](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Parallels/vanilla-parallels-install-34.webp) - -Type `reboot` and press enter. You have successfully configured your VM! - -You can change more virtual machine performance/sharing/integration options using the Parallels settings menu in the Control Center. Please refer to the [Parallels Knowledge Base](https://kb.parallels.com) for details. - -![Parallels 35](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Parallels/vanilla-parallels-install-35.webp) - -## Install Vanilla OS in VirtualBox - -### Prerequisites - -- A Virtualbox Installation from [**here**](https://www.virtualbox.org/). - -- Install the Vanilla OS ISO from [**here**](https://github.com/Vanilla-OS/os/releases/latest). - -### Installation - -Launch VirtualBox from the App Grid. Alternatively, you can run it with the following command from the terminal:- - -```bash -virtualbox -``` - -Click on "New". (This will open the "Create Virtual Machine" Popup) - -![VirtualBox 5](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Virtualbox/VirtualBox_5.webp) - -Specify the name of your Virtual Machine and Installation folder, then select the Vanilla OS ISO image you downloaded earlier. Click on "Next". - -![VirtualBox 1](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Virtualbox/VirtualBox_1.webp) - -Allocate the base memory and the number of processors shared with your VM. Click the checkbox for "Enable EFI (special OSes only)", now click on "Next". - -![VirtualBox 2](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Virtualbox/VirtualBox_2.webp) - -Allocate at least 50 GB of space for your VM, this is required for ABRoot. Now click on "Next". - -![VirtualBox 3](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Virtualbox/VirtualBox_3.webp) - -Confirm the options you selected in the "Summary" and click on the "Finish" button. - -![VirtualBox 4](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Virtualbox/VirtualBox_4.webp) - -Click on "Settings", navigate to "System", and change the boot order to **Harddisk -> Optical -> Floppy**. Go to "Display" and increase the Video memory fully (128 MB here). - -![VirtualBox 5](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Virtualbox/VirtualBox_5.webp) - -| ![VirtualBox 6](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Virtualbox/VirtualBox_6.webp) | ![VirtualBox 7](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Virtualbox/VirtualBox_7.webp) | -|:---------------------------------------------------------------------: |:---------------------------------------------------------------------: | -| **Default order** | **Recommended order** | - -![VirtualBox 8](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Virtualbox/VirtualBox_8.webp) - -If you intend on using a Microphone with your VM, go to "Audio" and click on "Enable Audio Input". With all the changes done, click on "Ok". - -![VirtualBox 9](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Virtualbox/VirtualBox_9.webp) - -Now, click the "Start" button to start your VM. - -![VirtualBox 10](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Virtualbox/VirtualBox_10.webp) - -Inside the live session, Click on the top right corner and click on the "Settings" icon. Alternatively, you can press on Windows or the Super key to open the "Activities overview" and then type "Settings" to access it. Now, Navigate to "Displays", and under "Resolution", select a different resolution. - -![VirtualBox 11](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Virtualbox/VirtualBox_11.webp) - -![VirtualBox 12](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Virtualbox/VirtualBox_12.webp) - -Now, proceed with the Vanilla OS Installation. - -For additional installation steps, refer to [**this guide**](https://handbook.vanillaos.org/2022/11/05/installation.html#title7). - -### Installing VirtualBox Guest Additions - -[Virtualbox Guest Additions](https://www.virtualbox.org/manual/ch04.html) offers enhanced features, between the virtual machine and host, like Clipboard sharing, Seamless Windows, etc. - -Due to the nature of ABRoot, the process of its installation is different. Follow this guide to install it in Vanilla OS. - -First, enter the transactional shell using the `sudo abroot shell` command, then execute the `sudo apt update` command. - -Now, install the required packages and dependencies using the following command:- - -```bash -sudo apt install -y build-essential linux-headers-$(uname -r) -``` - -`exit` the transaction shell and `reboot` your system. - -In VirtualBox, select "Insert Guest Additions CD image..." from the "Devices" menu at the top bar. - -After mounting the CD image, type `cp -r /media//Vbox_GAs_ /tmp/vbox` in your terminal. -(Temporary files in `/tmp` gets removed after a reboot) - -**_Note_**:- The content inside `<>` is a placeholder and must be replaced with the required details. - -Now, enter the transactional shell using `sudo abroot shell`, then run `cd /tmp/vbox` to change the current working directory. - -Now, execute `./VBoxLinuxAdditions.run`. After the successful execution, build the Kernel modules by typing `/sbin/rcvboxadd quicksetup all` in the terminal. - -`exit` the transaction shell and `reboot` your system. - -![VirtualBox 13](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/VM_Post/Virtualbox/VirtualBox_13.webp) - -Now, you have successfully installed VirtualBox Guest Additions. diff --git a/articles/en/install-jekyll-and-bundler.md b/articles/en/install-jekyll-and-bundler.md deleted file mode 100644 index 83621e3..0000000 --- a/articles/en/install-jekyll-and-bundler.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -Title: Installing Jekyll & Bundler -Description: Learn how to install Jekyll & Bundler on Vanilla OS. -PublicationDate: 2023-01-23 -Authors: - - gonzoknows - - kbdharun ---- - -> This guide is for Kinetic (22.10), not Orchid. The documentation for Orchid is still being written. - -## Introduction - -Jekyll is a popular static site generator for creating blogs, documentation, and personal websites. - -Bundler is a package manager for Ruby, which helps manage dependencies in Jekyll projects. - -This guide goes through the process of installing Jekyll and Bundler in Vanilla OS using apx. - -## Installing Jekyll and Bundler - -Open your preferred Terminal emulator/application, and follow the steps to install it in a specific container. - -### Ubuntu container - -Enter the container using the following command:- - -```bash -apx enter -``` - -Install the required prerequisite packages using the following command:- - -```bash -sudo apt-get install ruby-full build-essential zlib1g-dev -``` - -After installation, execute the following commands:- - -```bash -echo '# Install Ruby Gems to ~/gems' >> ~/.bashrc -echo 'export GEM_HOME="$HOME/gems"' >> ~/.bashrc -echo 'export PATH="$HOME/gems/bin:$PATH"' >> ~/.bashrc -source ~/.bashrc -``` - -Now, install Jekyll and Bundler using the following command:- - -```bash -gem install jekyll bundler -``` - -You have now successfully installed the packages. You can execute them using `apx run `, or directly by entering the container using `apx enter`. - -Optionally, you can export the binary to use it from the host directly without requiring the `apx run` command. You can do this by using the following commands:- - -```bash -apx export --bin jekyll -apx export --bin bundler -``` - -### Fedora container - -Enter the container using the following command:- - -```bash -apx enter --dnf -``` - -Install the required prerequisite packages using the following command:- - -```bash -sudo dnf install ruby ruby-devel make gcc g++ -``` - -Now, install Jekyll using the following command:- - -```bash -gem install jekyll -``` - -You have now successfully installed the packages. You can execute them using `apx run --dnf `, or directly by entering the container using `apx enter --dnf`. - -Optionally, you can export the binary to use it from the host directly without requiring the `apx run --dnf` command. You can do this by using the following commands:- - -```bash -apx export --dnf --bin jekyll -apx export --dnf --bin bundler -``` - -### Arch Linux container - -Enter the container using the following command:- - -```bash -apx enter --aur -``` - -Install the required prerequisite packages using the following command:- - -```bash -sudo pacman -S ruby base-devel -``` - -Now, install Jekyll using the following command:- - -```bash -gem install jekyll -``` - -You have now successfully installed the packages. You can execute them using `apx run --aur `, or directly by entering the container using `apx enter --aur`. - -Optionally, you can export the binary to use it with the host directly without requiring the `apx run --aur` command. You can do this by using the following commands:- - -```bash -apx export --aur --bin jekyll -apx export --aur --bin bundler -``` - -## Testing sites using Jekyll locally - -Navigate to the required directory for the site. - -Optionally, Run `bundler install` to install necessary packages (This step is required only once and doesn't require re-running it in future. You must have a Gemfile in the repository for this command to work). - -Run `jekyll build` or `bundler exec jekyll build` to build the page to `./_site` once. - -Then you can either test the pages manually or use `jekyll serve` or `bundler exec jekyll serve` command to build your site any time a source file changes and serve it locally. - -Navigate to `http://127.0.0.1:4000/` or `http://localhost:4000/` in your browser to preview and test the page. - -**_Tip_**:- - -You can test your pages on your phone using `bundler exec jekyll serve --host=`. - -Using `0.0.0.0` instead of a specific IP binds port 4000 to any interface, which is prone to be blocked by your routers firewalls. That's why we recommended using a particular IP address with the `--host` flag. After executing the command in any browser on your phone, go to this address `:4000`. - -For example, if the IP you used is `192.168.0.123`, you will need to visit `192.168.0.123:4000` on your mobile. - -## Conclusion - -You have now successfully installed Jekyll & Bundler via the command line and successfully served and tested your site locally. diff --git a/articles/en/install-lutris.md b/articles/en/install-lutris.md deleted file mode 100644 index c61df2e..0000000 --- a/articles/en/install-lutris.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -Title: Install Lutris -Description: Learn how to install Lutris on Vanilla OS. -PublicationDate: 2023-01-28 -Authors: - - mirkobrombin ---- - -> This guide is for Kinetic (22.10), not Orchid. The documentation for Orchid is still being written. - -## What is Lutris? - -[**Lutris**](https://lutris.net/) is an open-source game launcher for Linux that allows you to download and play games from various platforms such as the Epic Games Store, GOG Galaxy client, Origin, Humble Bundle and many others through a simple interface. - -## Installation - -The recommended way to install Lutris is through the official Debian package. But it is also available in many other formats. - -In Vanilla OS, you can install packages from other distributions using [**Apx**](https://vanillaos.org/2023/01/28/apx-the-unconventional-pkg-manager.html), the default package manager for Vanilla OS. In the following sections, we will show you how to install the Debian and Fedora packages of Lutris using Apx. - -### Debian package - -First, you need to download the latest version of the package from the [**official website**](https://lutris.net/downloads/) under the "Debian/Ubuntu" section. - -Once you have downloaded the package, you can install it using the command line. Open a console and navigate to the directory where you have downloaded the package. Then, use the following command to install the package: - -```bash -apx install --sideload lutris__all.deb -``` - -Make sure to replace `` with the version number of the package you have downloaded. - -### Fedora package - -The `lutris` package is also available in the Fedora repositories, so you can install it in Apx using the following command: - -```bash -apx install --dnf lutris -``` - -## Troubleshooting - -In this section, we will show you how to fix some common issues you may encounter when using Lutris. - -### Poor performance - -If you are experiencing poor performance, ensure that you have the latest graphics drivers installed. To do so, refer to the [**Install additional drivers in Vanilla OS**](https://handbook.vanillaos.org/2022/12/10/install-additional-drivers.html) page. - -Also, check the game's system requirements and ensure that your system meets them. - -### Game crashes - -Lutris suggests [**some steps**](https://lutris.net/faq#game-crash) to investigate the cause of a game crash in the FAQ. - -### NVIDIA GPU not being used - -On Optimus laptops, there are 2 GPUs: the integrated (Intel or AMD) and the dedicated (NVIDIA). By default, Lutris uses the integrated GPU, which can cause performance issues. - -You can fix this in Lutris by opening the game's configuration and toggling the "Enable NVIDIA Prime Render Offload" option. You can find it under the "System Options" tab. - -![Lutris Prime Render Offload](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/Gaming/lutris-prime-gpu.webp) - -### Other issues - -If you are experiencing other issues, you can refer to the [**official FAQ**](https://lutris.net/faq) or open an [**issue**](https://github.com/lutris/lutris/issues) on GitHub. diff --git a/articles/en/install-openrgb.md b/articles/en/install-openrgb.md deleted file mode 100644 index 3edb9dd..0000000 --- a/articles/en/install-openrgb.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -Title: Install OpenRGB -Description: Learn how to install OpenRGB on Vanilla OS. -PublicationDate: 2023-01-20 -Authors: - - MonsterObserver ---- - -> This guide is for Kinetic (22.10), not Orchid. The documentation for Orchid is still being written. - -## Introduction - -[**OpenRGB**](https://openrgb.org/) is an essential application for managing your RGB appliances. This guide will help you install the Flatpak and AppImage of OpenRGB correctly. - -## Flatpak - -### Prerequisites - -- Flatpak: You can find out how to install it [**here**](/2022/12/09/install-flatpaks.html). - -### Installing OpenRGB - -You can install OpenRGB from the "Gnome Software" application. Alternatively, you can install it from the command line with the following command:- - -```bash -flatpak install flathub org.openrgb.OpenRGB -``` - -## AppImage - -### Prerequisites - -AppImage Support: If you have enabled AppImage in the "First Setup" when installing Vanilla OS, this step isn't necessary. - -If you haven't enabled AppImages, run the following command:- - -```bash -sudo abroot exec apt install libfuse2 -``` - -After the successful installation, reboot your system. You can do this by typing `reboot`. - -### Installing OpenRGB - -Install "Linux 64-bit" from the "Linux Binaries (AppImage)" section [**here**](https://gitlab.com/CalcProgrammer1/OpenRGB/-/releases/permalink/latest#Linux-64-bit). - -Go to the directory where the AppImage is installed and make it an executable with the following commands:- - -```bash -cd ~/Downloads/ -chmod +x -``` - -## Setting Up UDEV Rules - -For the application to function, add UDEV rules to your system. - -First, install the UDEV rules by clicking [**here**](https://gitlab.com/CalcProgrammer1/OpenRGB/-/jobs/artifacts/master/raw/60-openrgb.rules?job=Linux+64+AppImage&inline=false). - -After downloading the UDEV rules, you need to move them to the correct directory with the following command:- - -```bash -sudo mv ~/Downloads/60-openrgb.rules /etc/udev/rules.d/ -``` - -After moving the UDEV rules, you need to reload the rules by running the following command:- - -```bash -sudo udevadm control --reload-rules && sudo udevadm trigger -``` - -After reloading the rules, OpenRGB works correctly. diff --git a/articles/en/install-steam.md b/articles/en/install-steam.md deleted file mode 100644 index dde6042..0000000 --- a/articles/en/install-steam.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -Title: Install Steam -Description: Learn how to install Steam on Vanilla OS. -PublicationDate: 2023-01-07 -Authors: - - mirkobrombin ---- - -> This guide is for Kinetic (22.10), not Orchid. The documentation for Orchid is still being written. - -## What is Steam? - -[**Steam**](https://steampowered.com) is the most popular gaming platform. It allows you to download and play a vast library of games. It's client is available natively on Linux. - -On 21 August 2018, Steam introduced the [**Proton**](https://github.com/ValveSoftware/Proton) project, which allows you to run Windows games on Linux. It is an essential tool for Linux gamers as it extends the number of games available on the platform. Check out [**ProtonDB**](https://www.protondb.com) to see how well your favourite games work with Proton. - -## Install Steam - -In Vanilla OS there are many ways to install Steam. The easiest way is to use -[**Flatpak**](https://flatpak.org), which is a universal package manager for Linux. -But it is also possible to install Steam using [**apx**](https://documentation.vanillaos.org/docs/apx/) -the default package manager of Vanilla OS. - -### Flatpak - -If you chose to install Flatpak during [**First Setup**](/2022/11/18/first-setup.html), -you will be able to install applications directly from GNOME Software, as -explained [**here**](/2022/12/09/install-flatpaks.html#title3). - -You can also install the Steam Flatpak from the terminal using the following command: - -```bash -flatpak install flathub com.valvesoftware.Steam -``` - -### Apx - -**apx** is a package manager which installs software in containers thanks to -[**Distrobox**](https://github.com/89luca89/distrobox). In our tests, Fedora is the best distro to run Steam in a container. We highly recommend using it to install Steam. - -#### Fedora container - -First, we need to install the RPM Fusion repository, which contains the rpm packages we need to install Steam using the following commands: - -```bash -apx --dnf enter -sudo dnf install https://mirrors.rpmfusion.org/free/fedora/rpmfusion-free-release-$(rpm -E %fedora).noarch.rpm https://mirrors.rpmfusion.org/nonfree/fedora/rpmfusion-nonfree-release-$(rpm -E %fedora).noarch.rpm -exit -``` - -We also need to install the drivers for our graphics card: - -**NVIDIA** - -```bash -apx --dnf install xorg-x11-drv-nvidia-libs.i686 akmod-nvidia -``` - -**AMD** - -```bash -apx --dnf install xorg-x11-drv-amdgpu mesa-libGL.i686 mesa-dri-drivers.i686 -``` - -**Intel** - -```bash -apx --dnf xorg-x11-drv-intel mesa-libGL.i686 mesa-dri-drivers.i686 -``` - -We can now install Steam using the following command: - -```bash -apx --dnf install steam -``` - -##### Run Steam - -To run Steam, you can use the icon from the applications menu or issue the command `apx --dnf run steam`. - -If the icon doesn't appear in the applications menu, you can add it manually using the following command: - -```bash -apx --dnf export steam -``` - -#### Ubuntu container - -On Ubuntu, we need to add the `multiverse` repository to our sources list using the following command: - -```bash -apx --apt enter -sudo apt install software-properties-common -sudo add-apt-repository multiverse -exit -``` - -We also need to install the drivers for our graphics card. - -**NVIDIA**:- - -First, we need to check the version for the host drivers: - -```bash -nvidia-smi --query-gpu=driver_version --format=csv | tail -n +2 -``` - -which is `525.60.11` in my case. Then we need to install the drivers for the container: - -```bash -apx install nvidia-driver-525 -``` - -**AMD/Intel**:- - -```bash -apx --apt install mesa-utils mesa-utils-extra -``` - -We can now install Steam using the following command: - -```bash -apx --apt install steam-launcher -``` - -##### Run Steam - -To run Steam, you can use the icon from the applications menu or issue the -command `apx run steam`. - -If the icon doesn't appear in the applications menu, you can add it manually using the following command: - -```bash -apx export steam -``` - -## Run Windows games (Steam Play - Proton) - -Steam comes with Proton preconfigured to run all the supported Windows games. - -You may want to enable the Steam Play feature to also run games that are not officially supported. - -![Steam Play](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/Gaming/steam-play.webp) - -To do so, open Steam and go to `Steam` > `Settings` > `Steam Play`. Then enable the `Enable Steam Play for all other titles` option. diff --git a/articles/en/install-vpn-from-file.md b/articles/en/install-vpn-from-file.md deleted file mode 100644 index 245ce57..0000000 --- a/articles/en/install-vpn-from-file.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -Title: Installing an OpenVPN File without using Terminal -Description: Learn how to install an OpenVPN File graphically. -PublicationDate: 2023-01-11 -Authors: - - gonzoknows ---- - -> This guide is for Kinetic (22.10), not Orchid. The documentation for Orchid is still being written. - -## Introduction - -This guide provides a step-by-step process for installing an OpenVPN file graphically without using the terminal. It helps users who may be uncomfortable with command-line interfaces or who prefer a more user-friendly approach. - -## Navigating to Network Settings - -Press the Windows/Super key. - -Search for "VPN" or "vpn" in the search. - -![Search for vpn](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/OpenVPN/install-openvpn-from-file-search.webp) - -Select "Network" from the Settings search result. - -This will bring you to the "Network" panel interface. - -Alternatively, you can directly navigate to the "Network" panel by opening Settings from the Control Center in the top right corner. - -## Importing the OpenVPN file - -Once you have navigated to the Network panel, click on the plus (`+`) button beside the VPN. - -![Plus Button beside VPN](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/OpenVPN/install-openvpn-from-file-vpn-add.webp) - -Various options will be displayed in the menu, select "**Import from file...**" - -This will open a Files dialogue box to select the file to import. - -Select the **`.ovpn`** config file downloaded from your VPN provider. - -This will install the OpenVPN profile on your computer. - -_**Note**_: You may be prompted to enter login credentials after installing the OpenVPN configuration file. - -## Conclusion - -You can now successfully connect to the OpenVPN profile seamlessly. diff --git a/articles/en/installation.md b/articles/en/installation.md deleted file mode 100644 index ce3f760..0000000 --- a/articles/en/installation.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -Title: Vanilla OS Installation -Description: Learn how to install Vanilla OS to your device. -PublicationDate: 2022-11-05 -Authors: - - 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 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**. - -### 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/). - -#### Installing Etcher - -To flash the disk image to your USB stick, download and install [**balenaEtcher**](https://www.balena.io/etcher/). - -If you wish, you can also use different software that you are familiar with, such as [**Ventoy**](https://www.ventoy.net/) or [**Rufus**](https://rufus.ie/). - -#### Flashing the image - -**Warning**: this will erase **all data** on your USB flash drive. Make sure to back up all your important data before proceeding! - -Open Etcher, select the downloaded disk image and your USB flash drive, then click "Flash!". - -![Flashing](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/Installation/installation-flashing.webp) - -When the process is done, you will have a bootable USB stick with Vanilla OS on it. - -### Booting from the USB flash drive - -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. - -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. - -### Types of installation - -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. - -This guide will help you with the following types of installation: - -- [Installing only Vanilla OS](/2022/11/05/installation.html#title10) -- [~~Advanced installation~~ (Disabled currently)](/2022/11/05/installation.html#title11) - -### 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! - -Select the disk you want to install Vanilla OS to, click "Configure", select "Use Entire Disk", click "Apply" and review your changes. - -![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. - -![Confirming the installation](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/Installation/installer-confirm-installation.webp) - -## Booting into Vanilla OS - -### If you only have Vanilla OS installed - -After the installer finishes, all you need to do is reboot and remove the USB stick. Vanilla OS will be waiting for you. - -### If you dual- or multiboot - -#### On the same drive - -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. - -#### On different drives - -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. - -You can configure the default boot order in your device's firmware settings. - -## First Setup - -After installing Vanilla OS, you can follow the [**First Setup guide**](/2022/11/18/first-setup.html) to set up your system. diff --git a/articles/en/updates.md b/articles/en/updates.md deleted file mode 100644 index 12132b2..0000000 --- a/articles/en/updates.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -Title: Update and Upgrade Vanilla OS -Description: Learn how to update the operating system. -PublicationDate: 2022-12-10 -Authors: - - mirkobrombin - - kbdharun ---- - -> This guide is for Kinetic (22.10), not Orchid. The documentation for Orchid is still being written. - -Vanilla OS is a point release distribution that receives two new releases annually with security updates and bug fixes for system components distributed between releases, usually without any new features introduced. - -## Difference between Update and Upgrade - -"Updates" refers to newer versions of packages that bring minor improvements, bug fixes, and security updates. They get installed in the background and do not make any noticeable changes to the system. - -With "Upgrade" instead, we refer to the transition from one release of -Vanilla OS to another, for example, from 22.10 to 23.04. In addition to the usual bug fixes and security updates, there are new features and potential changes to the system. - -## Update Vanilla OS - -Updates in Vanilla OS are handled by VSO (Vanilla System Operator), which manages the operating system. VSO performs weekly or monthly updates in the background without any user intervention. Since Vanilla OS is a transactional system, the updates are applied only after a reboot. - -### Configure VSO - -VSO is flexible and allows configurations to suit your needs. The following are the available options: - -- **Smart UpPublicationDate:** If enabled, VSO will check whether the system is in an ideal state to perform an update without hindering the user experience. It is done by performing multiple checks, such as the connection, memory, CPU and battery status. When the system is not ideal for performing an update, VSO will skip it and try again later. If disabled, VSO will perform the update without any further checks. -- **Schedule:** VSO allows configurations for performing automatic updates at fixed intervals, such as weekly or monthly. The default setting performs automatic updates at weekly intervals. - -#### Configure via Control Center - -VSO allows managing updates and configurations via the **Vanilla Control Center**. To do so, open the **Vanilla Control Center** -from the Applications menu, click on the "Updates" tab and configure the options as you wish or check for an update. - -![Control Center - Updates](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/Updates_and_Upgrade//vanilla-control-center-vso.webp) - -#### Configure via Console - -To configure VSO via the console, use the following commands: - -```bash -# check the current configuration -sudo vso config show - -# check a specific option -sudo vso config get update.smart - -# update a specific option -sudo vso config set update.smart true -``` - -## Update - -### Check for an update - -If you want to check for an update without installing it, you can do so using the following command: - -```bash -sudo vso update-check -``` - -### Force an update - -If you want to force an update, you can do so by acting as the system operator, -using the following command: - -```bash -sudo vso trigger-update --now -``` - -## Upgrade to a new release - -Vanilla OS checks for a new release in the background and then displays a -dialogue to the user when a new one is available. - -![Upgrade dialog](https://raw.githubusercontent.com/Vanilla-OS/handbook/main/assets/uploads/Updates_and_Upgrade//vanilla-upgrade.webp) - -The user can then select to upgrade or postpone it to the next boot.