Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Add First Run section #179

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified modules/ROOT/assets/images/faw-manual-partition-complete.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 9 additions & 1 deletion modules/ROOT/pages/faq.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,20 @@ However, {variant-name} is specifically focused on workstation and desktop use c

== About using {variant-name}

[[how-can-i-play-more-videos-in-firefox-like-youtebe]]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
[[how-can-i-play-more-videos-in-firefox-like-youtebe]]
[[how-can-i-play-more-videos-in-firefox-like-youtube]]

=== How can I play more videos in Firefox, like YouTube?

Firefox is included in the OS image for now (see https://github.com/fedora-silverblue/issue-tracker/issues/288[issue#288] for progress on moving to Flatpak by default).
Until that changes, getting it to play videos works the same way as it does for the regular {variant-classic}: find a package with the needed codecs, and install it.
The one difference is that you use `rpm-ostree install` instead of `dnf install`.
An alternative solution is to install https://flathub.org/apps/details/org.mozilla.firefox[Firefox from Flathub].

An alternative solution is to install https://flathub.org/apps/details/org.mozilla.firefox[Firefox from Flathub] by running these commands:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We recommend hiding the default browser instead as that does not changes the image and the result is the same: https://docs.fedoraproject.org/en-US/fedora-silverblue/tips-and-tricks/#_hiding_the_default_browser_firefox

We also have a note about Flathub somewhere so we should link to that and to the Firefox page on Flathub instead of command lines ideally.


$ rpm-ostree override remove \
firefox \
firefox-langpacks \

$ flatpak install org.mozilla.firefox

=== How do I create a VPN connection?

Expand Down
31 changes: 30 additions & 1 deletion modules/ROOT/pages/installation.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,16 @@ However, if it isn't, or if you want to download it manually, an install image c
Once you have got your copy of {variant-name}, it can be installed in the usual manner.
We hope that you love it!

[[preparing-boot-media]]
== Preparing Boot Media

Fedora images are `Hybrid ISOs` and can be used to create installation media with both optical and USB disks, for booting on both BIOS and UEFI systems.
travier marked this conversation as resolved.
Show resolved Hide resolved

We recommend using Fedora Media Writer to make a bootable USB media to install {variant-name}. Other USB media creation software may work as well but are not regularly tested.

You can see https://docs.fedoraproject.org/en-US/fedora/latest/preparing-boot-media/#_fedora_media_writer[Fedora Media Writer] section to learn to use it.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
You can see https://docs.fedoraproject.org/en-US/fedora/latest/preparing-boot-media/#_fedora_media_writer[Fedora Media Writer] section to learn to use it.
See the https://docs.fedoraproject.org/en-US/fedora/latest/preparing-boot-media/#_fedora_media_writer[Fedora Media Writer] section to learn how to use it.



[[manual-partition]]
== Manual Partitioning

Expand All @@ -55,6 +65,7 @@ Automatic partitioning is recommended.
With {variant-name}, only certain mounts can be manually specified as partitions.
These include:

* `/boot/efi` (for the UEFI boot loaders)
* `/boot`
* `/var`
* Subdirectories under `/var`, including:
Expand All @@ -67,6 +78,24 @@ The Fedora installer is not aware of these restrictions and will accept custom p

image::faw-manual-partition-complete.png[title="Partitioning Complete"]

The above screenshot shows a typical configuration with manual partitioning, with partitions for `/boot`, `/`, `swap` and `/var/home`.
The above screenshot shows a typical configuration with manual partitioning in UEFI firmware, with partitions for `/boot`, `/boot/efi`, `/`, and `/var/home`.

Manual partitioning on {variant-name} can be done with `Btrfs`, https://en.wikipedia.org/wiki/Logical_Volume_Manager_%28Linux%29[LVM], as well as standard partitions or an `xfs` filesystem.

[[first-run]]
== First Run

On first startup you will be asked to enable third-party repositories, location services, and to create a new user. You can enable third-party repositories and location later, but you must create a new user by entering your desired name and password.

image::Fedora_40_new_user.png[title="Create New User"]

Once you have created the user you can start using {variant-name}.

Depending on different personal needs, there are several starting actions and installations that you could perform on newly installed {variant-name} for a customized user experience.

[IMPORTANT]
====
If you are new to {variant-name}, before installing software in your newly installed Fedora, Please read and understand the https://docs.fedoraproject.org/en-US/fedora-silverblue/getting-started/[Getting Started] section to consider the difference in software installation between: *Flatpak*, *Toolbox* e *Package layering* (rpm-ostree).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's try to be more gentle here:

Suggested change
If you are new to {variant-name}, before installing software in your newly installed Fedora, Please read and understand the https://docs.fedoraproject.org/en-US/fedora-silverblue/getting-started/[Getting Started] section to consider the difference in software installation between: *Flatpak*, *Toolbox* e *Package layering* (rpm-ostree).
If you are new to {variant-name} and before installing software in your newly installed Fedora, you should read the https://docs.fedoraproject.org/en-US/fedora-silverblue/getting-started/[Getting Started] section to learn about the difference between *Flatpak*, *Toolbox* and *package layering* (rpm-ostree).

====

For some tips about basic customization of {variant-name} see the xref:tips-and-tricks.adoc#_basic-customization[Basic Customization] section
88 changes: 87 additions & 1 deletion modules/ROOT/pages/tips-and-tricks.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ $ sudo cp /usr/share/applications/firefox.desktop /usr/local/share/applications/
$ sudo sed -i "2a\\NotShowIn=GNOME;KDE" /usr/local/share/applications/firefox.desktop
$ sudo update-desktop-database /usr/local/share/applications/
```

[[enabling_rpm_fusion_repos]]
== Enabling RPM Fusion repos

[CAUTION]
Expand Down Expand Up @@ -160,3 +160,89 @@ or setup shell `alias`es as needed to make them available to the CLI like so:
$ alias evince="flatpak run org.gnome.Evince"
# or alias evince="org.gnome.Evince"
$ evince

[[basic-customization]]
== Basic Customization

* Enable RPM Fusion: see the xref:tips-and-tricks.adoc#_enabling_rpm_fusion_repos[Enabling RPM Fusion repos] section
* Enable TRIM in encrypt installation: see the xref:tips-and-tricks.adoc#_enabling-trim-in-encrypt-installation[Enabling TRIM in encrypt installation] section
* Enable Intel GPU Acceleration: see the xref:tips-and-tricks.adoc#_enabling-intel-gpu-acceleration[Enabling Intel GPU Acceleration] section
* Using NVIDIA drivers: see the xref:troubleshooting.adoc#_using_nvidia_drivers[Using NVIDIA drivers] section
* Install GNOME Tweaks: run the command

$ rpm-ostree install gnome-tweak-tool

* Install Extension Manager: run the command

$ flatpak install flathub org.gnome.Extensions

* Install ffmpeg codecs: run the command

$ flatpak install org.freedesktop.Platform.ffmpeg-full

* Play more videos in Firefox: see xref:faq.adoc#_how-can-i-play-more-videos-in-firefox-like-youtebe[How can I play more videos in Firefox, like YouTube?] section

[[enabling-intel-gpu-acceleration]]
== Enabling Intel GPU Acceleration

Starting with Gen9 microarchitecture (Skylake), Intel GPUs include a Graphics micro Controller (GuC).

As explained from this https://cdrdv2-public.intel.com/793432/793432_Intel_Core_Ultra_Datasheet_Rev001.pdf[document in PDF format provided by Intel] there are power, performance and functionalities benefits from Gen9 (Skylake) GPUs and later, using the new GuC and HuC firmware.

[IMPORTANT]
====
Before installing Intel firmware, be sure to enable the RPM Fusion. See the xref:tips-and-tricks.adoc#_enabling_rpm_fusion_repos[Enabling RPM Fusion repos] section
====

To install the Intel firmwares run the command:

$ rpm-ostree override remove mesa-va-drivers \
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We'll have to link to the entry about RPM Fusion before those commands

--install mesa-va-drivers-freeworld \
--install intel-media-driver \

After installing Intel drivers, the firmwares are enabled by default for Gen11+ microarchitecture GPUs, for previous generation GPUs you can enable the firmwares with the command:

`$ rpm-ostree kargs --append=i915.enable_guc=2` +
for Gen9 microarchitecture: Skylake microprocessors

`$ rpm-ostree kargs --append=i915.enable_guc=3` +
for Gen9.5 microarchitecture: Kaby Lake, Coffee Lake, Comet Lake, and Goldmont Plus based microprocessors

[TIP]
====
`rpm-ostree kargs` means Modifying Kernel Arguments. To understand and learn more about the _kargs_ option see: https://docs.fedoraproject.org/en-US/fedora-coreos/kernel-args/
====

To check that the GuC and HuC firmwares are active on your Fedora Silverblue system, you can run the commands:

$ dmesg | grep "GuC"

$ dmesg | grep "HuC"

For more information about Intel GPUs Hardware acceleration in Linux see:

* https://fedoraproject.org/wiki/Firefox_Hardware_acceleration#Configure_VA-API_Video_decoding_on_Intel[VA-API Video decoding on Fedora Project wiki]
* https://github.com/intel/media-driver[The Intel(R) Media Driver for VAAPI Github]
* This topic on Fedora Discussion: https://discussion.fedoraproject.org/t/intel-graphics-best-practices-and-settings-for-hardware-acceleration/69944/44

[[enabling-trim-in-encrypt-installation]]
== Enabling TRIM in encrypt installation

If a fedora installation is performed using the disk encryption option, TRIM is not enabled by default.
This happens because although TRIM increases the performance of your SSD, it results in a loss of security in disk encryption.
At https://asalor.blogspot.com/2011/08/trim-dm-crypt-problems.html[this blog article] you can read the analysis of a cryptsetup developer. +
_If you consider the use of TRIM to be more important to you than security you can go ahead and enable it._

* Locates the luks partition where TRIM is not active:

$ lsblk --discard

* Enable TRIM (where _luks-xxx_ is your luks found with the previous command)

$ sudo cryptsetup --allow-discards --persistent refresh luks-xxx

* Verify that your partition has the _allow_discards_ flag with the command:

$ sudo dmsetup table

For further help see this topic in Fedora Discussion: https://discussion.fedoraproject.org/t/trim-for-ssd/82876
1 change: 1 addition & 0 deletions modules/ROOT/pages/troubleshooting.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ A partial https://github.com/projectatomic/rpm-ostree/pull/1795[solution] has be

This issue is tracked in https://github.com/coreos/rpm-ostree/issues/233[rpm-ostree#233].

[[using-nvidia-drivers]]
== Using NVIDIA drivers

You can install the official NVIDIA binary drivers from the RPM Fusion repositories.
Expand Down