From 7caf703e7d01b380e9132e8fbee0b3f3d7dfdcd1 Mon Sep 17 00:00:00 2001 From: Tastatur Date: Wed, 16 Aug 2023 23:13:16 +0200 Subject: [PATCH] Added a lot of pages --- .gitignore | 1 + .../Automatic-decryption.md | 7 +--- docs/void-desktop-setup/Bluetooth.md | 9 +---- .../Firmware-and-drivers.md | 33 ++++++++----------- docs/void-desktop-setup/Laptop-management.md | 9 +---- docs/void-desktop-setup/Linux-lts.md | 9 +---- docs/void-desktop-setup/Localtime.md | 9 +---- docs/void-desktop-setup/Logging.md | 9 +---- .../void-desktop-setup/Network-filesystems.md | 9 +---- docs/void-desktop-setup/Network.md | 9 +---- docs/void-desktop-setup/Post-install.md | 9 +---- docs/void-desktop-setup/Repositories.md | 9 +---- docs/void-desktop-setup/Secure-boot.md | 15 +++------ docs/void-desktop-setup/Session-manager.md | 9 +---- docs/void-desktop-setup/Users.md | 9 +---- docs/void-desktop-setup/Using-swap.md | 9 +---- mkdocs.yml | 15 +++++++++ 17 files changed, 46 insertions(+), 133 deletions(-) diff --git a/.gitignore b/.gitignore index 45ddf0a..cde88fe 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ site/ +*.swp diff --git a/docs/void-desktop-setup/Automatic-decryption.md b/docs/void-desktop-setup/Automatic-decryption.md index 42c7e04..f50186e 100644 --- a/docs/void-desktop-setup/Automatic-decryption.md +++ b/docs/void-desktop-setup/Automatic-decryption.md @@ -1,9 +1,4 @@ ---- -gitea: none -include_toc: false ---- - -### Automatic decryption (unfinished) +(unfinished) Using Clevis it's possible to automatically decrypt the system upon startup. But because we haven't been able to figure out how to create a functional template file for that we'll have to compile it ourselves. Note that you must use the `booster` initramfs. (A lot more information about the possibilities from clevis can be found on the [ArchWiki](https://wiki.archlinux.org/title/Clevis)) diff --git a/docs/void-desktop-setup/Bluetooth.md b/docs/void-desktop-setup/Bluetooth.md index 65bb3cc..86dbc8b 100644 --- a/docs/void-desktop-setup/Bluetooth.md +++ b/docs/void-desktop-setup/Bluetooth.md @@ -1,10 +1,3 @@ ---- -gitea: none -include_toc: false ---- - -### Bluetooth - Bluetooth functionality may be obtained by enabling `bluetoothd`. Its packages may be installed by: ``` @@ -27,4 +20,4 @@ To be able to use bluetooth the user needs to be in the bluetooth group. ``` # usermod -aG bluetooth -``` \ No newline at end of file +``` diff --git a/docs/void-desktop-setup/Firmware-and-drivers.md b/docs/void-desktop-setup/Firmware-and-drivers.md index a4a5fb4..6f3176f 100644 --- a/docs/void-desktop-setup/Firmware-and-drivers.md +++ b/docs/void-desktop-setup/Firmware-and-drivers.md @@ -1,61 +1,54 @@ ---- -gitea: none -include_toc: false ---- - -### Firmware and drivers - -#### GPU drivers +### GPU drivers It is necessary for a graphical enviroment to install GPU drivers. To install the drivers for your GPU use one of the following commands: -* For Intel +##### For Intel ``` # xbps-install -Sy linux-firmware-intel mesa mesa-dri vulkan-loader mesa-vulkan-intel intel-video-accel ``` -* For AMD +##### For AMD ``` # xbps-install -Sy linux-firmware-amd vulkan-loader mesa-vulkan-radeon amdvlk xf86-video-amdgpu mesa-vaapi mesa-vdpau mesa-dri ``` -* For Nvidia (*glibc only*) +##### For Nvidia (*glibc only*) ``` # xbps-install -Sy nvidia nvidia-opencl ``` -##### 32-bit drivers +#### 32-bit drivers (Only applicable to glibc as Void Linux musl only supports 64-bit) To run 32-bit applications like some videogames it will also be necessary to install the 32-bit drivers: -* For Intel +##### For Intel ``` # xbps-install -Sy mesa-32bit mesa-dri-32bit mesa-vulkan-intel-32bit vulkan-loader-32bit ``` -* For AMD +##### For AMD ``` # xbps-install -Sy vulkan-loader-32bit amdvlk-32bit mesa-32bit mesa-dri-32bit ``` -* For Nvidia +##### For Nvidia ``` # xbps-install -Sy nvidia-libs-32bit ``` -#### CPU firmware +### CPU firmware To keep the firmware of your CPU up to date it is necessary to install the correct microcode: -* For Intel +#### For Intel (The Intel microcode requires that you are using the nonfree repository) @@ -71,7 +64,7 @@ And regenerate the initramfs: -* For AMD +#### For AMD ``` # xbps-install -Sy linux-firmware-amd @@ -79,7 +72,7 @@ And regenerate the initramfs: -#### Nvidia + Wayland +### Nvidia + Wayland For Nvidia to work correctly with Wayfire you'll have to add the boot parameter to `/boot/loader/void-options.conf`. @@ -91,4 +84,4 @@ And reconfigure the kernel: ``` # xbps-reconfigure -f linux -``` \ No newline at end of file +``` diff --git a/docs/void-desktop-setup/Laptop-management.md b/docs/void-desktop-setup/Laptop-management.md index 3ab32a3..b633f20 100644 --- a/docs/void-desktop-setup/Laptop-management.md +++ b/docs/void-desktop-setup/Laptop-management.md @@ -1,10 +1,3 @@ ---- -gitea: none -include_toc: false ---- - -### Laptop management - To obtain enhanced battery lifespan, `tlp` and `tlpui` may be installed. The `tlpui` application may be used to monitor the general configuration of `tlp`. ``` @@ -23,4 +16,4 @@ The `tlp` service needs to be activated and also the `acpid` deamon is a necessi ``` # ln -s /etc/sv/tlp /var/service # ln -s /etc/sv/acpid /var/service -``` \ No newline at end of file +``` diff --git a/docs/void-desktop-setup/Linux-lts.md b/docs/void-desktop-setup/Linux-lts.md index 7007113..4e21273 100644 --- a/docs/void-desktop-setup/Linux-lts.md +++ b/docs/void-desktop-setup/Linux-lts.md @@ -1,10 +1,3 @@ ---- -gitea: none -include_toc: false ---- - -### Linux-lts - It might be desirable to install an LTS kernel for better stability. This can be done by: ``` @@ -21,4 +14,4 @@ And then removing the `linux` meta package and its dependecies: ``` # xbps-remove -Ry linux -``` \ No newline at end of file +``` diff --git a/docs/void-desktop-setup/Localtime.md b/docs/void-desktop-setup/Localtime.md index 7c0c095..1d271ca 100644 --- a/docs/void-desktop-setup/Localtime.md +++ b/docs/void-desktop-setup/Localtime.md @@ -1,10 +1,3 @@ ---- -gitea: none -include_toc: false ---- - -### Localtime - A "Network Time Protocol Daemon" (nptd for short) can sync the system clock with internet standard time servers. The `chrony` daemon is used as ntpd. Install it by: ``` @@ -27,4 +20,4 @@ And symlink the correct timezone to `/etc/localtime`: ``` # ln -sf /usr/share/zoneinfo/Europe/Amsterdam /etc/localtime -``` \ No newline at end of file +``` diff --git a/docs/void-desktop-setup/Logging.md b/docs/void-desktop-setup/Logging.md index 039b0f6..5c55292 100644 --- a/docs/void-desktop-setup/Logging.md +++ b/docs/void-desktop-setup/Logging.md @@ -1,10 +1,3 @@ ---- -gitea: none -include_toc: false ---- - -### Logging - Logging may be benificial to spot certain misbehaviours or errors in the system. The `socklog-void` package will be used as logging daemon. ``` @@ -19,4 +12,4 @@ To read the logs use: # svlogtail ``` -Or go to `/var/log/socklog`. \ No newline at end of file +Or go to `/var/log/socklog`. diff --git a/docs/void-desktop-setup/Network-filesystems.md b/docs/void-desktop-setup/Network-filesystems.md index f22d8f1..c3c6d07 100644 --- a/docs/void-desktop-setup/Network-filesystems.md +++ b/docs/void-desktop-setup/Network-filesystems.md @@ -1,10 +1,3 @@ ---- -gitea: none -include_toc: false ---- - -### Network filesystems - Network filesystems may be used for enhanced workflow between multiple devices and persistance of storage. #### Samba @@ -39,4 +32,4 @@ Finally mount the network filesystem. ``` # mount -a -``` \ No newline at end of file +``` diff --git a/docs/void-desktop-setup/Network.md b/docs/void-desktop-setup/Network.md index 72fa0cf..14c3aad 100644 --- a/docs/void-desktop-setup/Network.md +++ b/docs/void-desktop-setup/Network.md @@ -1,10 +1,3 @@ ---- -gitea: none -include_toc: false ---- - -### Network - NetworkManager will be used as Network daemon due to its versatility. The package was already installed with the installation, thereby it only needs to be symlinked to `/var/service` to function. ``` @@ -31,4 +24,4 @@ For the user to be able to modify connections on the system they'll have to be a ``` # usermod -aG network -``` \ No newline at end of file +``` diff --git a/docs/void-desktop-setup/Post-install.md b/docs/void-desktop-setup/Post-install.md index aca0683..240bd6a 100644 --- a/docs/void-desktop-setup/Post-install.md +++ b/docs/void-desktop-setup/Post-install.md @@ -1,10 +1,3 @@ ---- -gitea: none -include_toc: false ---- - -## Post installation - The post install section elaborates on the installation and configuration of certain applications. To simplify this and the subsequent sections, reference is made to pre-made configuration files with `{config-files-repo}`. A configuration files repository may be chosen to one's preference, by cloning them with the `git` command. It is recommended to do this once a user has been created. @@ -18,4 +11,4 @@ Some possible configuration files repositories. * [Luc's config-files](https://git.bijl.us/luc/void-desktop) * [Tastatur's config-files](https://git.bijl.us/tastatur/dotfiles-ding) -Note that a configuration files repository may not contain all the configuration files mentioned in this wiki. \ No newline at end of file +Note that a configuration files repository may not contain all the configuration files mentioned in this wiki. diff --git a/docs/void-desktop-setup/Repositories.md b/docs/void-desktop-setup/Repositories.md index a6bcd2c..93a2db0 100644 --- a/docs/void-desktop-setup/Repositories.md +++ b/docs/void-desktop-setup/Repositories.md @@ -1,10 +1,3 @@ ---- -gitea: none -include_toc: false ---- - -### Repositories - To install the official Void Linux 32-bit and nonfree repositories simply install their respective packages: * For glibc @@ -46,4 +39,4 @@ And refresh the repositories: ``` # xbps-install -S -``` \ No newline at end of file +``` diff --git a/docs/void-desktop-setup/Secure-boot.md b/docs/void-desktop-setup/Secure-boot.md index 87d36f6..7ac1ede 100644 --- a/docs/void-desktop-setup/Secure-boot.md +++ b/docs/void-desktop-setup/Secure-boot.md @@ -1,13 +1,6 @@ ---- -gitea: none -include_toc: false ---- - -### Secure boot - Secure boot is sometimes a necessity when working with a windows dual boot on laptops and also an extra layer of protection for your system. -#### - Linux secureboot +### Linux secureboot For linux to work with secureboot it's necessary to enroll keys using sbctl. @@ -35,9 +28,9 @@ Then to check if it worked. The kernels will now automatically be signed after an update thanks to the `sbsigntool` package. -Don't forget to turn on secureboot in your bios. +> Don't forget to turn on secureboot in your bios! -#### - Linux Windows dual boot +### Linux Windows dual boot To obtain secure boot for a device with both linux and windows partitions (dual boot), the `sbctl` package is required. It may be installed with. @@ -61,4 +54,4 @@ Then to check if it worked. # sbctl verify ``` -After every linux kernel update the new executables should be signed. \ No newline at end of file +After every linux kernel update the new executables should be signed. diff --git a/docs/void-desktop-setup/Session-manager.md b/docs/void-desktop-setup/Session-manager.md index e154c71..3672931 100644 --- a/docs/void-desktop-setup/Session-manager.md +++ b/docs/void-desktop-setup/Session-manager.md @@ -1,10 +1,3 @@ ---- -gitea: none -include_toc: false ---- - -### Session manager - To use a graphical enviroment it is necessary to start a seat and session manager. For a minimal install it is recommended to use `seatd`, `turnstile` and `polkit`. To install those run: ``` @@ -34,4 +27,4 @@ Make sure turnstile also creates a *Runtime Directory* by enabling it in `/etc/t ``` manage_rundir = yes -``` \ No newline at end of file +``` diff --git a/docs/void-desktop-setup/Users.md b/docs/void-desktop-setup/Users.md index 62be6cb..969fe0d 100644 --- a/docs/void-desktop-setup/Users.md +++ b/docs/void-desktop-setup/Users.md @@ -1,10 +1,3 @@ ---- -gitea: none -include_toc: false ---- - -### Users - A user should be added to improve security of the system. ``` @@ -89,4 +82,4 @@ Then to persist the modifications. ``` $ xdg-user-dirs-update -``` \ No newline at end of file +``` diff --git a/docs/void-desktop-setup/Using-swap.md b/docs/void-desktop-setup/Using-swap.md index d421fb4..d76fc85 100644 --- a/docs/void-desktop-setup/Using-swap.md +++ b/docs/void-desktop-setup/Using-swap.md @@ -1,10 +1,3 @@ ---- -gitea: none -include_toc: false ---- - -### Using swap - Swap can be utilised by the system to free up space in RAM. For most use cases it is recommend to create a swapfile that is one and a half times the size of your RAM. To create a swapfile of 8 GB use: @@ -33,4 +26,4 @@ And do not forget to reconfigure the kernel after updating`/etc/fstab`: ``` # xbps-reconfigure -f linux -``` \ No newline at end of file +``` diff --git a/mkdocs.yml b/mkdocs.yml index 7345e63..b259566 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -18,5 +18,20 @@ nav: - 'Installation': void-desktop-setup/Installation.md - 'Post installation': - 'Config files': void-desktop-setup/Post-install.md + - 'Users': void-desktop-setup/Users.md + - 'Network': void-desktop-setup/Network.md + - 'Linux-lts': void-desktop-setup/Linux-lts.md + - 'Date and time': void-desktop-setup/Localtime.md + - 'Using swap': void-desktop-setup/Using-swap.md + - 'Network filesystems': void-desktop-setup/Network-filesystems.md + - 'Logging': void-desktop-setup/Logging.md + - 'Repositories': void-desktop-setup/Repositories.md + - 'Firmware and drivers': void-desktop-setup/Firmware-and-drivers.md + - 'Secure boot': void-desktop-setup/Secure-boot.md + - 'Automatic decryption': void-desktop-setup/Automatic-decryption.md + - 'Laptop management': void-desktop-setup/Laptop-management.md + - 'Bluetooth': void-desktop-setup/Bluetooth.md + - 'Graphical session': + - 'Session manager': void-desktop-setup/Session-manager.md - 'Alpine Server setup': alpine-home.md - 'Xbps-Ample': ample-home.md