diff --git a/templates/docker-compose.md b/templates/docker-compose.md index 8f5cb8a..fc68352 100644 --- a/templates/docker-compose.md +++ b/templates/docker-compose.md @@ -15,7 +15,7 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards. ### Environment-variables -Set the following variables with the -e tag. +Set the following variables in the `environment:` section. | Name | Usage | Default | | ---------- | ------------- | ------- | @@ -25,7 +25,7 @@ Set the following variables with the -e tag. - + ### Ports Set the following ports in the `ports:` section. @@ -47,11 +47,11 @@ Set the following volumes with the -v tag. ```sh ``` -### .env - -```sh -``` - + + + + + ### docker-compose.yml ```yml diff --git a/wiki/betterdiscord.md b/wiki/betterdiscord.md index 8407903..bbddebe 100644 --- a/wiki/betterdiscord.md +++ b/wiki/betterdiscord.md @@ -23,6 +23,32 @@ Afterwards BetterDiscord can be kept up to date with the following command. betterdiscordctl self-upgrade ``` +### Pacman Hook + +When using [Arch Linux](/wiki/linux/arch-linux.md) and its package managers +[Pacman and Yay](/wiki/linux/package_manager.md#arch-linux-pacman-and-yay) a hook can be set that +automatically updates the discord installation to setup betterdiscord using betterdiscordctl. +The following is a [pacman hook](/wiki/linux/package_manager.md#hooks) that can be used to update +betterdiscord automatically. +Make sure to change the three occurences of `` to the name of the user to install +betterdiscord for. + +```sh +[Trigger] +Type = Package +Operation = Install +Operation = Upgrade +Target = discord* + +[Action] +Description = Rebuild BetterDiscord after Discord update +When = PostTransaction +Exec = /usr/bin/sh -c 'sudo -u betterdiscordctl reinstall >/dev/null 2>&1; sudo -u xvfb-run -a discord --help >/dev/null 2>&1; sudo -u betterdiscordctl install >/dev/null 2>&1; true' +Depends = xorg-server-xvfb +Depends = betterdiscordctl +NeedsTargets +``` + ## Usage This section addresses the usage of BetterDiscord. diff --git a/wiki/firefox.md b/wiki/firefox.md index bd77ad7..3e5be3a 100644 --- a/wiki/firefox.md +++ b/wiki/firefox.md @@ -2,8 +2,10 @@ [Firefox](https://www.mozilla.org/en-US/Firefox) is a free and open-source web browser. -There are browsers that are based on Firefox and expand on its features like Zen browser. -For this the usage is mostly the same. +There are browsers that are based on Firefox and expand on its features like +[Zen browser](/wiki/zen_browser.md). +For this the usage is mostly the same except for the parts noted in the +[Zen Browser entry](/wiki/zen_browser.md). ## Usage @@ -109,7 +111,7 @@ The following add-ons provide translation options. The following add-ons add information to online shops. - [Fakespot](https://www.fakespot.com/) is an add-on made by Mozilla which displays additional - information on online shops, ebay and amazon. + information on online shops, ebay and amazon. It can give shops, vendors and products a trust score which can be used as an alternative to reviews, which might be fake. diff --git a/wiki/globalprotect.md b/wiki/globalprotect.md new file mode 100644 index 0000000..5327d9c --- /dev/null +++ b/wiki/globalprotect.md @@ -0,0 +1,21 @@ +# GlobalProtect + +[GlobalProtect](https://www.paloaltonetworks.de/resources/datasheets/globalprotect-datasheet) is a +cross-platform [VPN](/wiki/vpn.md). + +## Installation + +The GlobalProtect client is available for [Windows](/wiki/windows.md), MacOS, +[Linux](/wiki/linux.md), [Android](/wiki/android.md) aswell as iOs and iPadOS. +On some Linux distributions the package is called `globalprotect-openconnect` but the corresponding +command is called `gpclient` which can sometimes lead to confusion. + +## Usage + +The usage of the GlobalProtect client is pretty simple. +After starting the program the portal address has to be added and is followed by a login. +Afterwards the client will connect. + +GlobalProtect is usually used by bigger companies and universities like the +[University of Oldenburg](https://uol.de/it-services/services/campus-network) which wrote a proper +installation and usage guide for all the operating systems that are supported. diff --git a/wiki/linux/hardware.md b/wiki/linux/hardware.md index 481ca8b..abba914 100644 --- a/wiki/linux/hardware.md +++ b/wiki/linux/hardware.md @@ -30,3 +30,10 @@ Tools, programs and guides to manage the power usage and improve battery life ar The viewing of temperatures of coolers aswell as the selection of RGB-settings can be achieved by using [liquidctl](https://github.com/liquidctl/liquidctl). + +## Temperature + +To check the temperature the command `sensors` can be used which (on most distributions) is a part +of the `lm_sensors` package. +It will then display all the available temperature sensors available aswell as many other sensors +like the RPM for fans. diff --git a/wiki/linux/kernel.md b/wiki/linux/kernel.md deleted file mode 100644 index 922c55f..0000000 --- a/wiki/linux/kernel.md +++ /dev/null @@ -1,41 +0,0 @@ -# Kernel - -The [Linux](/wiki/linux.md) kernel is an open-source Unix-like computer operating system kernel. - -## Versions - -There are a few possible kernel version. - -### Stable-Version: `linux` - -The stable version of the [Linux](/wiki/linux.md) kernel can usually be found in a package called -`linux` and is usually installed from the start or in the recommended setup. - -### Zen-Version: `linux-zen` - -The zen kernel is a collaborative project of kernel hackers to provide the best -[Linux](/wiki/linux.md) kernel for everyday systems. -Especially the response time of the system under load -[is said to be better](https://github.com/zen-kernel/zen-kernel/wiki/Detailed-Feature-List#zen-kernel-improvements). -This will - for example - make the system less stuttery when something is compiled. -Desktop and gaming systems will benefit the most. - -To setup the zen kernel do the following. Firstly install the packages `linux-zen` and -`linux-zen-header`. -Afterwards open the file `boot/loader/entries/arch.conf` and change the following lines. - -```txt -linux /vmlinuz-linux -initrd /initramfs-linux.img -``` - -To look like the following lines. - -```txt -linux /vmlinuz-linux-zen -initrd /initramfs-linux-zen.img -``` - -If you want to switch the backup to Zen too, the backup file in `boot/loader/entries/` has to be -changed too. -Afterwards the system should be rebooted for the change to take effect. diff --git a/wiki/linux/mkinitcpio.md b/wiki/linux/mkinitcpio.md index b4ddc09..663bcb1 100644 --- a/wiki/linux/mkinitcpio.md +++ b/wiki/linux/mkinitcpio.md @@ -1,8 +1,68 @@ # mkinitcpio `mkinitcpio` is a script to create an initial ramdisk environment. +This environment provides the [Linux](/wiki/linux.md) kernel, containing essential drivers and +utilities required at boot. -## Usage +## Kernel Versions + +There are a few possible kernel version that can be used by `mkinitcpio`. + +### Stable-Version: `linux` + +The stable version of the [Linux](/wiki/linux.md) kernel can usually be found in a package called +`linux` and is usually installed from the start or in the recommended setup. + +### Zen-Version: `linux-zen` + +The zen kernel is a collaborative project of kernel hackers to provide the best +[Linux](/wiki/linux.md) kernel for everyday systems. +Especially the response time of the system under load +[is said to be better](https://github.com/zen-kernel/zen-kernel/wiki/Detailed-Feature-List#zen-kernel-improvements). +This will - for example - make the system less stuttery when something is compiled. +Desktop and gaming systems will benefit the most. + +To setup the zen kernel do the following. Firstly install the packages `linux-zen` and +`linux-zen-header`. +Afterwards open the file `boot/loader/entries/arch.conf` and change the following lines. + +```txt +linux /vmlinuz-linux +initrd /initramfs-linux.img +``` + +To look like the following lines. + +```txt +linux /vmlinuz-linux-zen +initrd /initramfs-linux-zen.img +``` + +If you want to switch the backup to Zen too, the backup file in `boot/loader/entries/` has to be +changed too. +Afterwards the system should be rebooted for the change to take effect. + +## Usage + +The following addresses various usage and configuration choices for mkinitcpio. + +### Default and Fallback Images + +It is recommended to have at least one default and one fallback version for kernels. +After the initial generation of the kernel the configuration file can be found in the +`/etc/mkinitcpio.d` directory. +For the [`linux`-kernel](#stable-version-linux) it would contain `linux.preset` and for the +[`linux-zen`-kernel](#zen-version-linux-zen) `linux-zen.preset`. +Inside these preset files the following line manages the generation of a default or fallback image. + +```txt +PRESETS=('default' 'fallback') +``` + +Notice that the options are separated only by a space. +To just build a fallback image remove `'default'` or vice versa. + +Afterwards the initial ramdisk has to be [rebuild](#manually-generate-initial-ramdisk). ### Manually Generate Initial Ramdisk @@ -20,6 +80,22 @@ But it is also possible to (re-)generate all available presets with the followin mkinitcpio -P ``` +### Enable/Disable Compression + +To save space on the boot partition the kernel images can be compressed. +To enable compression activate it in `/etc/mkinitcpio.conf` under `COMPRESSION=`. +In the configuration file some compression algorithms are recommended. +Additionally compression options can be set under `COMPRESSION_OPTIONS=`. +An easily usable example for this is the following line. + +```txt +COMPRESSION_OPTIONS=(-v -5 --long) +``` + +To disable compression remove the corresponding lines. +After enabling and disabling of the compression the initial ramdisk has to be +[rebuild](#manually-generate-initial-ramdisk). + ## Troubleshooting This section addresses various errors that can happen when using mkinitcpio. @@ -47,3 +123,9 @@ A simple table that shows firmware modules and corresponding [Arch Linux](/wiki/linux/arch-linux.md) packages is shown on the [Arch Linux wiki](https://wiki.archlinux.org/title/Mkinitcpio#Possibly_missing_firmware_for_module_XXXX). +### `No space left on device` + +If this error or one similar to this is shown the boot partition is filled up completely during the +generation of the initial ramdisk. +This can be fixed by either [compressing the image](#enabledisable-compression) or by +[disabling unused fallbacks](#default-and-fallback-images). diff --git a/wiki/linux/package_manager.md b/wiki/linux/package_manager.md index 90efe96..1c98c67 100644 --- a/wiki/linux/package_manager.md +++ b/wiki/linux/package_manager.md @@ -19,22 +19,36 @@ It features the same syntax. This section addresses various usages of the arch linux package managers. -#### Downgrading Packages +#### Ignoring Packages + +Packages can be ignored by adding the package in `/etc/pacman.conf` under `IgnorePkg`. +In the following example `waybar` is ignored from updates. +To add more packages just add them separated by spaces. + +```txt +IgnorePkg = waybar +``` + +To unignore the package from updates remove it from this line. + +#### Downgrading Packages Packages of the AUR can be downgraded by using the [Downgrade](https://github.com/archlinux-downgrade/downgrade) program. This program can then easily be used to an AUR package. This works like the following assuming the package `v4l2loopback-dmks` needs to be downgraded. -```sh +```sh sudo downgrade v4l2loopback-dmks ``` Afterwards the target version can be selected and the downgrading process will conclude. +After the downgrade of a package you will get asked if you want to +[ignore future updates](#ignoring-packages). #### Manual Installation of a `PKGBUILD` File -A `PKGBUILD` file is a [shell](/wiki/linux/shell.md) script that contains the installation +A `PKGBUILD` file is a [shell](/wiki/linux/shell.md) script that contains the installation information that is required by the Arch Linux. Using the `makepkg` command it can be installed like the following command shows. @@ -80,7 +94,7 @@ paccache -rvuk0 Since `yay` mirrors the usage of `pacman` it can be used the same way and will clean both caches. -```sh +```sh yay -Sc ``` @@ -295,3 +309,18 @@ This is especially the case on [Arch Linux-systems](/wiki/linux/arch-linux.md) b packages are also installed via [Pacman or Yay](#arch-linux-pacman-and-yay). In this case the global Version has to be changed to `system` or the package installed to the non-system Python version. + +#### Error `exists in filesystem` + +This section is based on a +[reddit post by 194668PT](https://www.reddit.com/r/archlinux/comments/17jempk/pacman_exists_in_filesystem_errors/). + +If an error shows up that describes that a file of a package `exists in filesystem` usually a +permission/owner error happened. +This can happen when running `pacman -Syyu`. +To update the package either way the following command can be used. +`` should be exchanged for the package that throws the error. + +```sh +sudo pacman -S --overwrite "*" +``` diff --git a/wiki/linux/papis.md b/wiki/linux/papis.md index c3ce0e4..1bf44e2 100644 --- a/wiki/linux/papis.md +++ b/wiki/linux/papis.md @@ -6,7 +6,10 @@ for LaTeX using the BibTeX format. ## Setup -Papis can be installed on most distributions by acquiring the `papis` package. +Papis can be installed on most [Linux](/wiki/linux.md) distributions by acquiring the `papis` +package. +On some distributions there may be problems installing this from the official repository. +Another option to install papis is to use [pip](/wiki/programming_languages/python.md). Alternatively it can be downloaded from [the GitHub page](https://github.com/papis/papis). ### Configuration diff --git a/wiki/linux/plymouth.md b/wiki/linux/plymouth.md index 47ab873..6d38945 100644 --- a/wiki/linux/plymouth.md +++ b/wiki/linux/plymouth.md @@ -48,11 +48,26 @@ plymouth-set-default-theme --list ``` One of the listed themes can then be installed like the following command does. +`` needs to be replaced with a theme that is included in the listed themes (like `fade-in`). ```sh -plymouth-set-default-theme fade-in +plymouth-set-default-theme +``` + +If this command is run the +[initramfs needs to be rebuild](/wiki/linux/mkinitcpio.md#manually-generate-initial-ramdisk). +A command that includes the rebuilding process is the following. + +```sh +plymouth-set-default-theme -R ``` Other themes can be found in online sources like the [AUR](/wiki/linux/arch-linux.md#package-manager-and-aur) or websites like [Gnome-Look.org](https://www.gnome-look.org/browse?cat=108). + +The following are recommended themes. + +- [Arch10](https://github.com/eromatiya/plymouth-theme-arch10) is a theme for + [Arch Linux](/wiki/linux/arch-linux.md) similar to the boot splash screen of + [Windows](/wiki/windows.md) 10. diff --git a/wiki/linux/shell.md b/wiki/linux/shell.md index 90fc4ce..01fd8ae 100644 --- a/wiki/linux/shell.md +++ b/wiki/linux/shell.md @@ -222,3 +222,12 @@ It is related to a terminal line setting problem. ```sh stty sane ``` + +### Error `cannot open shared object file: No such file or directory` + +This section is based on a +[Github issue by stephenson](https://github.com/rubygems/rubygems/issues/7523). +This error can occur for many different programs and with many different commands which is why it +is listed in the shell entry. +To fix it the most common and most effective way is to [reinstall](/wiki/linux/package_manager.md) +the program that throws the error. diff --git a/wiki/mail.md b/wiki/mail.md index febd742..74055f3 100644 --- a/wiki/mail.md +++ b/wiki/mail.md @@ -22,3 +22,6 @@ And even if you have it can be useful to keep your mails synced locally on your - [Neomutt](linux/neomutt.md) is a [terminal-based](/wiki/system_console.md) mail client for linux, that has a simple interface. +- [Thunderbird](/wiki/thunderbird.md) is a free and open source mail client which is cross + platform. + It also features, contact, todo and calendar management. diff --git a/wiki/microcontroller.md b/wiki/microcontroller.md index c09bba6..511ef22 100644 --- a/wiki/microcontroller.md +++ b/wiki/microcontroller.md @@ -10,10 +10,27 @@ It features Wi-Fi and [Bluetooth](/wiki/bluetooth.md). Some variants of this chip also include LoRa-capability and can be used to communicate via [Meshtastic](/wiki/meshtastic.md). +### Usage + +The following sections address various usages and setups of the ESP32. + +### Setup in Arduino IDE + +For the ESP32 to work correctly in the Arduino IDE some things have to be set up. +This section addresses the steps to take to use the ESP32 with the Arduino IDE. + +Under preferences set the following URL under `Additional boards manager URLs`. + +`https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json` + +Afterwards install the board manager `esp32`. + ### Flash Firmware on the ESP32 This section especially focusses on the ESP32S3 microcontroller. +Make sure that the ESP32 is in [programming mode](#programming-mode). For other microcontroller of the ESP32-xx family the process should be similar. +This following guide is written for [Windows](/wiki/windows.md). - Download [ESP RF Test Tool and Test Guide](https://www.espressif.com/en/support/download/other-tools) - Download [Firmware of ESP32S3](https://files.seeedstudio.com/wiki/SeeedStudio-XIAO-ESP32S3/res/XIAO-ESP32S3-firmware-20240814.zip) @@ -40,3 +57,16 @@ The board now should be in programming mode and it should be possible to upload or firmware onto it. This section is based on a Reddit [comment by cmatkin](https://www.reddit.com/r/esp32/comments/1g8gerg/getting_a_write_timeout_error_on_my_esp32s3/). + +### Troubleshooting + +The following sections address various errors that can occur when using the ESP32. + +#### Can Not Access the Microcontroller Under Linux + +Sometimes the rights to access the ESP32 are set wrong. +To fix this run the following command. + +```sh +sudo chmod 777 /dev/ttyACM0 +``` diff --git a/wiki/picard.md b/wiki/picard.md index 469cad7..172b442 100644 --- a/wiki/picard.md +++ b/wiki/picard.md @@ -25,6 +25,8 @@ This section addresses various features of picard. To enable the file renaming on saving check `Rename files when saving` in the preferences. +Alternatively the box under `Options` called `Rename Files` can be checked to produce the same +outcome. Under `Options` you can `Open file naming script editor` to change the script. The tags described used are based on the audio codec. In this section it is assumed the standard diff --git a/wiki/teamspeak.md b/wiki/teamspeak.md index 8e7aed4..182d31c 100644 --- a/wiki/teamspeak.md +++ b/wiki/teamspeak.md @@ -25,11 +25,7 @@ The server software can be setup via [Docker](/wiki/docker.md) with the [teamspeak image](./docker/teamspeak.md). This image can setup a Teamspeak3 server. -## Usage - -This section addresses various features of Teamspeak3. - -### Link Teamspeak3 to a subdomain +#### Link Teamspeak3 to a subdomain To link Teamspeak3 to one of your subdomains you need to add a [DNS SRV-record](./dns.md#srv-record): @@ -47,6 +43,10 @@ port: 9987 (or your teamspeak3 port) target: ts3.. ``` +## Usage + +This section addresses various features of Teamspeak3. + ### Installing a Sound Pack Sound packs can be found on the @@ -68,3 +68,13 @@ The following is a list of bots featured in this wiki that can do this. - [Sinusbot](/wiki/sinusbot.md) is a self-hosted bot for Teamspeak that can play music and sounds. It's closed-source and free of charge. It also features [Discord](/wiki/discord.md) support. + +### Channel Visibility + +As explained by +[guisinho_DBR on the Teamspeak forums](https://community.teamspeak.com/t/room-that-nobody-can-see-only-some-people-with-powers/20471) +there is no way to hide a channel completely from view. +It is however possible to set the subscription and description view power of a channel to a high +value. +This will permit only users with higher powers to see who is connected to the channel and view the +description of a channel. diff --git a/wiki/thunderbird.md b/wiki/thunderbird.md new file mode 100644 index 0000000..8b7e121 --- /dev/null +++ b/wiki/thunderbird.md @@ -0,0 +1,16 @@ +# Thunderbird + +[Thunderbird](https://www.thunderbird.net/en-US/) is a free and open-source program to manage +numerous e-mail addresses, calendars, todos and contacts. + +## Usage + +The following section addresses different uses and add-ons of Thunderbird. + +### Changing the (dark/light) Theme + +This section is based on a +[superuser comment by blnks](https://superuser.com/questions/1757333/how-can-i-view-thunderbird-in-full-dark-mode). +The dark theme can not be enabled from the default preferenes or settings. +To turn on the dark theme navigate to `Tools` and `Add-ons and Themes`. +There select `Enable` for the theme of your choice. diff --git a/wiki/vpn.md b/wiki/vpn.md index b05db49..368f36c 100644 --- a/wiki/vpn.md +++ b/wiki/vpn.md @@ -15,3 +15,5 @@ This section lists various VPN implementations. - [OpenVPN](/wiki/openvpn.md) is probably the most well known VPN implementation. - [WireGuard](/wiki/wireguard.md) is a modern, fast and secure implementation of the VPN protocol. It is free and open-source. +- [Global Protect](/wiki/global_protect.md) is a proprietary VPN that is mostly used by corporation + and learning facilities. diff --git a/wiki/zen_browser.md b/wiki/zen_browser.md new file mode 100644 index 0000000..f4e0e36 --- /dev/null +++ b/wiki/zen_browser.md @@ -0,0 +1,19 @@ +# Zen Browser + +[Zen Browser](https://zen-browser.app) is a free and open-source web browser that was split off of +[Firefox](/wiki/firefox.md) in 2024. +The settings and usage of this browser is largely the same as Firefox'. +This article only addresses things that differ from the normal usage - please refer to the +[Firefox entry](/wiki/firefox.md) for everything else. + +## Usage + +The following section addresses different uses and add-ons of Zen Browser. + +### Enabling Dark/Light Mode + +As explained in a +[reddit post by Nureddinn](https://www.reddit.com/r/zen_browser/comments/1m4jn3y/zen_browser_stuck_at_light_mode/) +the theme of Zen Browser can be changed by right-clicking the sidebar and selecting `Edit Theme`. +In the pop-up configuration window the dark theme can be enabled by clicking the moon, the light +theme by clicking the sun and the system default option by clicking the star.