From 58f836b4d40b847fd485d42697722a1b18226b64 Mon Sep 17 00:00:00 2001 From: tiyn Date: Fri, 3 Apr 2026 10:17:26 +0200 Subject: [PATCH] Restructuring: Fixed spelling and tables --- wiki/*arr.md | 23 +-- wiki/android.md | 2 +- wiki/android/droidcam.md | 2 +- wiki/android/fairemail.md | 4 +- wiki/android/gadgetbridge.md | 18 +- wiki/android/ip_webcam.md | 2 +- wiki/android/tasker.md | 2 +- wiki/anki.md | 2 +- wiki/audio.md | 10 +- wiki/betterdiscord.md | 2 +- wiki/bind.md | 2 +- wiki/calibre.md | 16 +- wiki/cups.md | 42 +++-- wiki/discord.md | 2 +- wiki/docker/actualbudget_-actual-server.md | 4 + .../alexjustesen_-_speedtest-tracker.md | 8 +- wiki/docker/alexta69_-_metube.md | 4 + wiki/docker/ankitects_-_syncserver.md | 6 + .../awesometechnologies_-_synapse-admin.md | 2 + wiki/docker/axhilrex_-_podgrab.md | 6 + wiki/docker/b4bz_-_homer.md | 4 + wiki/docker/bbilly1_-_tubearchivist.md | 32 ++-- wiki/docker/benbusby_-_whoogle-search.md | 4 + wiki/docker/bilde2910_-_hauk.md | 8 +- wiki/docker/chocobozzz_-_peertube.md | 4 + wiki/docker/cloudrac3r_-_bibliogram.md | 4 + wiki/docker/coturn_-_coturn.md | 2 + wiki/docker/dperson_-_torproxy.md | 4 + wiki/docker/dyonr_-_jackettvpn.md | 6 +- wiki/docker/dyonr_-_qbittorrentvpn.md | 16 +- wiki/docker/gitea_-_gitea.md | 10 + wiki/docker/gramps-project_-_grampsweb.md | 14 +- wiki/docker/grimsi_-_gameyfin.md | 7 +- wiki/docker/haugene_-_transmission-openvpn.md | 18 +- .../henrywhitaker3_-_speedtest-tracker.md | 6 + wiki/docker/homeassistant_-_home-assistant.md | 6 +- wiki/docker/immich-app_-_immich-server.md | 4 + wiki/docker/itzg_-_minecraft-server.md | 10 +- wiki/docker/iv-org_-_invidious.md | 4 + wiki/docker/jkarlos_-_git-server-docker.md | 4 + wiki/docker/johnktims_-_folding-at-home.md | 4 + .../docker/jonohill_-_docker-openvpn-proxy.md | 14 +- wiki/docker/kiwix_-_kiwix-serve.md | 4 + wiki/docker/kylemanna_-_openvpn.md | 8 +- .../docker/linuxserver_-_airsonic-advanced.md | 6 + wiki/docker/linuxserver_-_airsonic.md | 6 + wiki/docker/linuxserver_-_freshrss.md | 6 + wiki/docker/linuxserver_-_jellyfin.md | 6 + wiki/docker/linuxserver_-_lidarr.md | 6 + wiki/docker/linuxserver_-_radarr.md | 6 + wiki/docker/linuxserver_-_sonarr.md | 6 + wiki/docker/linuxserver_-_syncthing.md | 6 + wiki/docker/linuxserver_-_tvheadend.md | 13 +- wiki/docker/linuxserver_-_wireguard.md | 8 + wiki/docker/mailserver_-_docker-mailserver.md | 4 +- wiki/docker/mariadb.md | 6 +- wiki/docker/massivedecks_-_client.md | 4 + wiki/docker/matrixdotorg_-_synapse.md | 6 + wiki/docker/mikenye_-_picard.md | 6 + wiki/docker/mysql.md | 6 +- wiki/docker/nextcloud.md | 4 + wiki/docker/nginx.md | 4 + wiki/docker/olbat_-_cupsd.md | 4 + wiki/docker/ollama_-_ollama.md | 4 + wiki/docker/open-webui_-_open-webui.md | 4 + wiki/docker/owncloud.md | 4 + wiki/docker/oznu_-_docker-cloudflare-ddns.md | 2 + wiki/docker/oznu_-_onedrive.md | 4 + wiki/docker/portainer_-_agent.md | 4 + wiki/docker/portainer_-_portainer.md | 4 + wiki/docker/postgres.md | 6 +- wiki/docker/prologic_-_golinks.md | 4 + wiki/docker/prologic_-_gopherproxy.md | 4 + wiki/docker/prologic_-_todo.md | 4 + wiki/docker/rblsb_-_synctube.md | 4 + wiki/docker/redis.md | 4 +- wiki/docker/rlister_-_hastebin.md | 6 + wiki/docker/samba.md | 6 + wiki/docker/searx_-_searx.md | 4 + wiki/docker/sinusbot_-_docker.md | 9 +- wiki/docker/sissbrueckner_-_linkding.md | 8 +- wiki/docker/spikecodes_-_libreddit.md | 2 + wiki/docker/teamspeak.md | 6 + wiki/docker/tetricz_-_mordhau-server.md | 7 + wiki/docker/tombursch_-_kitchenowl.md | 4 + wiki/docker/tomsquest_-_docker-radicale.md | 6 + wiki/docker/traefik.md | 6 + wiki/docker/vabene1111_-_recipes.md | 4 + wiki/docker/vectorim_-_riot-web.md | 4 + wiki/docker/ventz_-_bind.md | 6 + wiki/docker/viperproject_-_viperserver.md | 4 +- wiki/docker/wabayang_-_jelu.md | 4 + wiki/docker/wallabag_-_wallabag.md | 6 + wiki/docker/xy2z_-_pinedocs.md | 4 + wiki/docker/yourls.md | 6 + wiki/docker/zedeus_-_nitter.md | 4 + wiki/electron.md | 4 +- wiki/emulator/citra.md | 11 +- wiki/emulator/dolphin.md | 2 +- wiki/emulator/melonds.md | 12 +- wiki/emulator/mgba.md | 2 +- wiki/emulator/nestopia.md | 2 +- wiki/emulator/pcsx2.md | 6 +- wiki/emulator/ppsspp.md | 2 +- wiki/emulator/simple64.md | 8 +- wiki/emulator/snes9x.md | 2 +- wiki/emulator/yuzu.md | 2 +- wiki/firefox.md | 2 +- wiki/game.md | 2 +- wiki/game/guild_wars_2.md | 4 +- wiki/game/lutris.md | 124 ++++++------- wiki/game/magic:_the_gathering.md | 88 ++++----- wiki/game/minecraft.md | 172 +++++++++--------- wiki/game/steam_deck.md | 4 +- wiki/git_(general).md | 2 +- wiki/gitea.md | 2 +- wiki/globalprotect.md | 2 +- wiki/handbrake.md | 2 +- wiki/inkscape.md | 2 +- wiki/jackett.md | 3 +- wiki/jellyfin.md | 8 +- wiki/libreoffice.md | 2 +- wiki/linux/arch-linux.md | 6 +- wiki/linux/arch-linux/installation.md | 6 +- wiki/linux/bluez.md | 20 +- wiki/linux/debian.md | 4 +- wiki/linux/display_managers.md | 2 +- wiki/linux/dm-crypt.md | 102 ++++++++--- wiki/linux/easyeffects.md | 2 +- wiki/linux/ffmpeg.md | 2 +- wiki/linux/font_configuration.md | 4 +- wiki/linux/fwupd.md | 11 +- wiki/linux/git_(package).md | 6 +- wiki/linux/gnirehtet.md | 8 +- wiki/linux/gpg.md | 6 +- wiki/linux/hardware_(linux).md | 2 +- wiki/linux/lemurs.md | 2 +- wiki/linux/lightdm.md | 4 +- wiki/linux/lvm.md | 13 +- wiki/linux/ly.md | 2 +- wiki/linux/mdadm.md | 50 +++-- wiki/linux/mkinitcpio.md | 8 +- wiki/linux/netplan.md | 2 +- wiki/linux/networkmanager.md | 14 +- wiki/linux/openssh.md | 18 +- wiki/linux/package_manager/apt.md | 2 +- wiki/linux/package_manager/pacman_and_aur.md | 6 +- wiki/linux/papis.md | 8 +- wiki/linux/pipewire.md | 15 +- wiki/linux/plymouth.md | 4 +- wiki/linux/proxmox.md | 6 +- wiki/linux/qt.md | 6 +- wiki/linux/shell.md | 6 +- wiki/linux/shntool.md | 2 +- wiki/linux/suckless.md | 25 ++- wiki/linux/swayidle.md | 2 +- wiki/linux/systemd.md | 2 +- wiki/linux/tlp.md | 2 +- wiki/linux/v4l2.md | 2 +- wiki/linux/vifm.md | 2 +- wiki/linux/watson.md | 6 +- wiki/linux/wpa_supplicant.md | 4 +- wiki/linux/x_window_system.md | 4 +- wiki/love.md | 4 +- wiki/ltex.md | 4 +- wiki/matrix.md | 12 +- wiki/microcontroller.md | 4 +- wiki/mpv.md | 2 +- wiki/nativefier.md | 4 +- wiki/obs.md | 4 +- wiki/office_suite.md | 22 +-- wiki/open_webui.md | 4 +- wiki/openvpn.md | 2 +- wiki/picard.md | 10 +- wiki/postgresql.md | 8 +- wiki/programming_language/python.md | 16 +- wiki/programming_language/viper.md | 8 +- wiki/scrcpy.md | 2 +- wiki/teamspeak.md | 2 +- wiki/traefik.md | 12 +- wiki/tvheadend.md | 7 +- wiki/ublock_origin.md | 2 +- wiki/ventoy.md | 2 +- wiki/video.md | 3 +- wiki/webcam.md | 17 +- wiki/windows/wsl.md | 4 +- wiki/wireguard.md | 9 +- 187 files changed, 1039 insertions(+), 622 deletions(-) diff --git a/wiki/*arr.md b/wiki/*arr.md index 540efda..3d3e24f 100644 --- a/wiki/*arr.md +++ b/wiki/*arr.md @@ -1,30 +1,25 @@ # \*ARR -\*ARR application is a class of applications made as personal video recorders in -the usenet and [BitTorrent](/wiki/bittorrent.md) domain. -These applications include but are not limited to -[Sonarr](https://github.com/Sonarr/Sonarr) for -[TV shows](/wiki/video.md), -[Radarr](https://github.com/Radarr/Radarr) for -[movies](/wiki/video.md) and -[Lidarr](https://github.com/Lidarr/Lidarr) for [music](/wiki/audio.md). +\*ARR application is a class of applications made as personal video recorders in the usenet and +[BitTorrent](/wiki/bittorrent.md) domain. +These applications include but are not limited to [Sonarr](https://github.com/Sonarr/Sonarr) for +[TV shows](/wiki/video.md), [Radarr](https://github.com/Radarr/Radarr) for [movies](/wiki/video.md) +and [Lidarr](https://github.com/Lidarr/Lidarr) for [music](/wiki/audio.md). ## Setup -For the different applications there are different [Docker](/wiki/docker.md) -containers for setup: -[Linuxservers Sonarr image](/wiki/docker/linuxserver_-_sonarr.md), +For the different applications there are different [Docker](/wiki/docker.md) containers for setup. +These are [Linuxservers Sonarr image](/wiki/docker/linuxserver_-_sonarr.md), [Linuxservers Radarr image](/wiki/docker/linuxserver_-_radarr.md) and [Linuxservers Lidarr image](/wiki/docker/linuxserver_-_lidarr.md). ### Initial Configuration For the initial configuration navigate to `System` and `Status`. -Afterwards check if there are any messages. +Afterward, check if there are any messages. There are probably a few steps that need to be taken to complete the setup. Set the `Download Clients` under `Settings`. -For this an instance of a [BitTorrent Client](/wiki/bittorrent.md#clients) can -be used. +For this an instance of a [BitTorrent Client](/wiki/bittorrent.md#clients) can be used. Next an indexer needs to be added. For this [Jackett](/wiki/jackett.md) can be used. A guide to add Jackett indexers is featured in diff --git a/wiki/android.md b/wiki/android.md index 44550c2..e9957c0 100644 --- a/wiki/android.md +++ b/wiki/android.md @@ -14,7 +14,7 @@ A list of open-source software options is also available on Alberto Mosconis [Github](/wiki/git_%28general%29.md#server-with-web-interface) repository [foss apps](https://github.com/albertomosconi/foss-apps/tree/main). -Additionally open-source apps can be installed from source using +Additionally, open-source apps can be installed from source using [Obtainium](https://github.com/ImranR98/Obtainium). ### Useful Applications diff --git a/wiki/android/droidcam.md b/wiki/android/droidcam.md index 4d92fb1..38640e2 100644 --- a/wiki/android/droidcam.md +++ b/wiki/android/droidcam.md @@ -29,6 +29,6 @@ program. After pressing `Connect` the link will be established. The [video feed](/wiki/webcam.md) can then be used in other programs such as Discord or [Matrix](/wiki/matrix.md). -Additionally it can be piped into [OBS](/wiki/obs.md) to edit it more or create a scene. +Additionally, it can be piped into [OBS](/wiki/obs.md) to edit it more or create a scene. Despite the option the separate app [DroidCam OBS](https://www.dev47apps.com/obs/) is not necessarily needed. diff --git a/wiki/android/fairemail.md b/wiki/android/fairemail.md index 7abf89c..728af06 100644 --- a/wiki/android/fairemail.md +++ b/wiki/android/fairemail.md @@ -7,7 +7,7 @@ On [Android](/wiki/android.md) FairEmail is available on [F-Droid](/wiki/android/f-droid.md) in a package called [FairEmail](https://f-droid.org/en/packages/eu.faircode.email/). -Additionally it is available on the[Google Play store](/wiki/android.md#app-store) in a package +Additionally, it is available on the[Google Play store](/wiki/android.md#app-store) in a package called [FairEmail](https://play.google.com/store/apps/details?id=eu.faircode.email&hl=de). ## Usage @@ -28,6 +28,6 @@ After this is done outgoing mails can be encrypted by signed or encrypted by sel Decryption can be done by clicking on the padlock when inside an email that is encrypted. -Additionally in the settings under `Encryption` the signing (`Sign by default`), encryption +Additionally, in the settings under `Encryption` the signing (`Sign by default`), encryption (`Sign and encrypt by default`), decryption (`Auomatically decrypt messages`) and validation (`Automatically verify signed messages`) can be set to occurr automatically. diff --git a/wiki/android/gadgetbridge.md b/wiki/android/gadgetbridge.md index 5b7c04b..f5c5349 100644 --- a/wiki/android/gadgetbridge.md +++ b/wiki/android/gadgetbridge.md @@ -19,25 +19,25 @@ Gadgetbridge. ### Configuration of Devices Devices can be added to Gadgetbridge by clicking on the `+` in the main screen. -Afterwards the device can simply be paired. +Afterward, the device can simply be paired. A special pairing procedure is needed for Amazfit or Xiaomi devices. The following describes the steps that need to be done. - Download the - [Zepp app](https://play.google.com/store/apps/details?id=com.huami.watch.hmwatchmanager). + [Zepp app](https://play.google.com/store/apps/details?id=com.huami.watch.hmwatchmanager). - Pair the device with the Zepp app. - Use [huami-token](https://codeberg.org/argrento/huami-token/) to obtain the auth key by using the - command `python3 huami_token.py --method amazfit --email my_email --password password --bt_keys` - with adjusted values. + command `python3 huami_token.py --method amazfit --email my_email --password password --bt_keys` + with adjusted values. - Uninstall the Zepp app and unpair the device from inside the bluetooth settings of the smart - phone. + phone. - Inside the Gadgetbridge app click on the `+`, find the device and enter the auth key by long - pressing on the devices name. - Afterwards navigate back to the scanning list. + pressing on the devices name. + Afterward, navigate back to the scanning list. - Pair the device by clicking on the device name. -Afterwards the device will be paired and connected. +Afterward, the device will be paired and connected. ### Add Weather Function @@ -49,7 +49,7 @@ An example for this is the [Breezy Weather app](https://github.com/breezy-weathe which is available on the F-Droid store. Install and configure it to your needs. Then check the Gadgetbridge option insdie the Breezy Weather app. -Afterwards the weather function will be working. +Afterward, the weather function will be working. In the past an application named [Weather Notification](https://f-droid.org/en/packages/ru.gelin.android.weather.notification/) diff --git a/wiki/android/ip_webcam.md b/wiki/android/ip_webcam.md index c255a25..1bf8f4a 100644 --- a/wiki/android/ip_webcam.md +++ b/wiki/android/ip_webcam.md @@ -28,7 +28,7 @@ An example link will look like the following. http://192.168.178.66:8080 ``` -Additionally it can be piped into [OBS](/wiki/obs.md) to edit it or into +Additionally, it can be piped into [OBS](/wiki/obs.md) to edit it or into [ffmpeg](/wiki/linux/ffmpeg.md) on [Linux](/wiki/linux.md) systems to create a virtual webcam device as explained in the [ffmpeg entry](/wiki/linux/ffmpeg.md#create-a-virtual-camera-using-an-ip-video-stream). diff --git a/wiki/android/tasker.md b/wiki/android/tasker.md index 12a07b9..ab4dc50 100644 --- a/wiki/android/tasker.md +++ b/wiki/android/tasker.md @@ -9,7 +9,7 @@ On [Android](/wiki/android.md) /name/ is available on the [Google Play store](/wiki/android.md#app-store) in a package called [Tasker](https://play.google.com/store/apps/details?id=net.dinglisch.android.taskerm). -Additionally the installation of [Tasker Settings](https://github.com/joaomgcd/TaskerSettings) is +Additionally, the installation of [Tasker Settings](https://github.com/joaomgcd/TaskerSettings) is recommended. Please note that on the [Github releases page](https://github.com/joaomgcd/TaskerSettings/releases) there are different versions to be used with Xiaomi-phones. diff --git a/wiki/anki.md b/wiki/anki.md index a2056d7..bc12794 100644 --- a/wiki/anki.md +++ b/wiki/anki.md @@ -39,7 +39,7 @@ This guide assumes the default Anki client is used. To change this select `Browse` and then navigate to the `Note Type` the deck to add backwards cards uses. Right click the note type and select `Cards`. -Afterwards the cards for backwards learning can be added by `Options` and `Add Card Types...`. +Afterward, the cards for backwards learning can be added by `Options` and `Add Card Types...`. You can confirm the fields have been setup correctly by clicking through the card types and verifying it. diff --git a/wiki/audio.md b/wiki/audio.md index 419cd94..05c6a17 100644 --- a/wiki/audio.md +++ b/wiki/audio.md @@ -57,13 +57,11 @@ Following is a list of often used formats: - dts is a compressed lossy codec usually found in DVDs Music files can either be encoded lossy or lossless. -Lossless formats can be converted from and to each other without loosing -information. -Lossless formats can also be converted to lossy formats to make the files -smaller and save space. +Lossless formats can be converted from and to each other without loosing information. +Lossless formats can also be converted to lossy formats to make the files smaller and save space. Files should not be converted to lossy formats more than once. -Additionally lossy formats should not be converted to lossless formats as it -increases the file size without adding any audio information. +Additionally, lossy formats should not be converted to lossless formats as it increases the file +size without adding any audio information. These not recommended conversions are called bad conversions. ### Cue Files diff --git a/wiki/betterdiscord.md b/wiki/betterdiscord.md index 04f1e33..f5537b1 100644 --- a/wiki/betterdiscord.md +++ b/wiki/betterdiscord.md @@ -18,7 +18,7 @@ converted to BetterDiscord. betterdiscordctl install ``` -Afterwards BetterDiscord can be kept up to date with the following command. +Afterward, BetterDiscord can be kept up to date with the following command. ```sh betterdiscordctl self-upgrade diff --git a/wiki/bind.md b/wiki/bind.md index 84111e5..4f848bb 100644 --- a/wiki/bind.md +++ b/wiki/bind.md @@ -162,7 +162,7 @@ $TTL 1D IN PTR ... ``` -Additionally add all domain names in front of the first `(` that have been added in the +Additionally, add all domain names in front of the first `(` that have been added in the `zone..` file as an [A record](/wiki/dns.md#a-record). Note that all these have to be followed by a `.` just like `...` is. For all these records add a PTR record too. diff --git a/wiki/calibre.md b/wiki/calibre.md index 2c4314a..a8eebcd 100644 --- a/wiki/calibre.md +++ b/wiki/calibre.md @@ -53,7 +53,7 @@ Then press `Recalculate all author sort values` for the change to take effect. titles. Setting `title_series_sorting = 'strictly_alphabetic'` will use the standard title and wont make articles of titles suffixes. -Afterwards select all books, right-click and select `Edit metadata in bulk` +Afterward, select all books, right-click and select `Edit metadata in bulk` under `Edit metadata`. Then check the box `update title sort` and press `Ok` to update all sort titles. @@ -80,15 +80,15 @@ After a while calibre should recognize the device which will be apparent by the additional buttons on the top menu like the `Send to device`- and the `Device`-Button. First make sure only the formats you want will be transfered. This can be done by selecting `Device`, `File formats` and checking the formats as needed. -Afterwards select the books and press `Send to device` to start the process of transfering the +Afterward, select the books and press `Send to device` to start the process of transfering the devices. Alternatively only specific formats of the books can be send to the device by selecting `Send specific format to` and `Main memory` under the `Send to device` menu. If there are books that contain series metadata make sure to disconnect the e-reader once and reconnect it. -Afterwards select `Update cached metadata on device` under `Device` to update the metadata +Afterward, select `Update cached metadata on device` under `Device` to update the metadata including the series. -Finally disconnect the device. +Finally, disconnect the device. ## KEPUB Format @@ -98,10 +98,10 @@ It is recommended to convert `.mobi` and `.epub` files to a `.kepub` file before [transfering it to a Kobo device](#transfer-books-to-a-device). For this the Plugin `KePub Output` by Joel Goguen [can be added](#adding-a-plugin) can be installed. -Afterwards books can be converted the normal way, but now the output format `.kepub` is available. -Additionally the `Kobo Touch Extended` plugin is recommended to use since it makes sending books to -Kobo e-readers easier. -Finally `KePub Metadata Reader` and `KePub Metadata Reader` make it possible to read and write +Afterward, books can be converted the normal way, but now the output format `.kepub` is available. +Additionally, the `Kobo Touch Extended` plugin is recommended to use since it makes sending books +to Kobo e-readers easier. +Finally, `KePub Metadata Reader` and `KePub Metadata Reader` make it possible to read and write metadata to `.kepub` files which is especially useful. ## Exporting and Importing Settings and Libraries diff --git a/wiki/cups.md b/wiki/cups.md index b6f76c3..64fc450 100644 --- a/wiki/cups.md +++ b/wiki/cups.md @@ -7,19 +7,37 @@ unix and unix-like systems. The software can be setup via [Docker](/wiki/docker.md) with the [linuxserver image](/wiki/docker/linuxserver_-_airsonic.md). -Additionally to this a client is needed on the system that need access to the server software. +Additionally, to this a client is needed on the system that need access to the server software. ### Client To use CUPS an additional client software is needed. For Linux computers follow these instructions: +First install the CUPS-client package (in Arch Linux it is included in `cups`). +Then edit `/etc/cups/client.conf` and insert the following line. -- Install the CUPS-client package (in Arch Linux it is included in `cups`) -- Edit `/etc/cups/client.conf` and insert `ServerName :631` -- Restart the CUPS service: `systemctl restart cups` -- Test connectivity: `lpstat -r` -- Check the detected printers with: `lpstat -v` +```txt +ServerName :631 +``` + +Restart the CUPS service. + +```ssh +systemctl restart cups +``` + +Then test the connectivity. + +```sh +lpstat -r` +``` + +Finally, check the detected printers with the following command. + +```sh +lpstat -v +``` ## Usage @@ -43,7 +61,7 @@ This is done by appending it the the mentioned connection string and will look l The examples using the Brother printer are taken from a [dwaves article](https://dwaves.de/2022/07/13/gnu-linux-debian-11-how-to-setup-brother-ql-600-labelprinter/). -### Custom Formats For Brother Printers +### Custom Formats For Brother Printers This section is based on an entry in the [german FAQ on the brother website](https://support.brother.com/g/b/faqend.aspx?c=de&lang=de&prod=lpql1110nwbeuk&faqid=faqp00100409_000). @@ -58,7 +76,7 @@ package called `brother-ql600`. To then set up a new custom format run the following command. -```sh +```sh brpapertoollpr_ -P -n -w -h ``` @@ -67,23 +85,23 @@ in the previous sentence. `` and `` are the name of the printer already set up and given in CUPS and the name chosen for the new format. And `` and `` are width and height of the new format both given in millimeters. -A complete command could look something like the following. +A complete command could look something like the following. -```sh +```sh brpapertoollpr_ql600 -P Brother_QL-600 -n "62mmx12mm" -w 62 -h 12 ``` The command to delete a custom format is the following. It uses the same variables and names as the command above. -```sh +```sh brpapertoollpr_ql600 -P -d ``` The usage of this command could look similar to the following example. -```sh +```sh brpapertoollpr_ql600 -P Brother_QL-600 -d "62mmx12mm" ``` diff --git a/wiki/discord.md b/wiki/discord.md index 611a18e..02f9a42 100644 --- a/wiki/discord.md +++ b/wiki/discord.md @@ -2,7 +2,7 @@ [Discord](https://discord.com/) is an social platform that combines voice and video conferences as well as instant messaging chats. -Additionally to the default website Discord also features a desktop client in the form of an +Additionally, to the default website Discord also features a desktop client in the form of an [Electron-based app](/wiki/electron.md). ## Alternatives diff --git a/wiki/docker/actualbudget_-actual-server.md b/wiki/docker/actualbudget_-actual-server.md index 4fc16a7..c4ec4b8 100644 --- a/wiki/docker/actualbudget_-actual-server.md +++ b/wiki/docker/actualbudget_-actual-server.md @@ -15,18 +15,22 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards. Set the following ports in the `ports:` section. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | --------- | ------------- | | `5006` | `5006` | TCP | WebUI | + ### Volumes Set the following volumes with the -v tag. + | Outside mount/volume name | Container mount | Description | | ------------------------- | --------------- | ------------------ | | `actual` | `/data` | Actual Budget data | + ### rebuild.sh ```sh diff --git a/wiki/docker/alexjustesen_-_speedtest-tracker.md b/wiki/docker/alexjustesen_-_speedtest-tracker.md index f23a14b..12d1bb3 100644 --- a/wiki/docker/alexjustesen_-_speedtest-tracker.md +++ b/wiki/docker/alexjustesen_-_speedtest-tracker.md @@ -16,6 +16,7 @@ It is important to set a correct app key as described in Set the following variables with the -e tag. + | Name | Usage | Default | | -------------------- | -------------------------------------------------------------------------------------------------- | --------------- | | `APP_KEY` | This is used for encryption and can be generated by `echo -n 'base64:'; openssl rand -base64 32;` | | @@ -26,23 +27,28 @@ Set the following variables with the -e tag. | `DISPLAY_TIMEZONE` | Timezone of the display | `Europe/London` | | `SPEEDTEST_SCHEDULE` | Cron-formatted schedule for speedtest (`6 */6 * * *`: 6 minutes after every 6th hour) | | + ### Volumes Set the following volumes with the -v tag. + | Outside mount/volume name | Container mount | Description | | ------------------------- | --------------- | -------------------- | | `speedtest_config` | `/config` | storage for config | | `speedtest_keys` | `/config/keys` | storage for ssl keys | + ### Ports Set the following ports with the -p tag. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ------------------------- | | `80` | `8765` | TCP | WebUI | -| `443` | `` | TCP | SSL-encrypted WebUI | +| `443` | | TCP | SSL-encrypted WebUI | + ### rebuild.sh diff --git a/wiki/docker/alexta69_-_metube.md b/wiki/docker/alexta69_-_metube.md index 035526f..edd7080 100644 --- a/wiki/docker/alexta69_-_metube.md +++ b/wiki/docker/alexta69_-_metube.md @@ -15,18 +15,22 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards. Set the following volumes in the `volumes:` section of the docker-compose file. + | Outside mount/volume name | Container mount | Description | | ------------------------- | --------------- | ------------------------------------ | | `downloads` | `/downloads` | folder to download data to | + ### Ports Set the following ports in the `ports:` section. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ----------- | | `8881` | `8081` | TCP | WebUI | + ### rebuild.sh ```sh diff --git a/wiki/docker/ankitects_-_syncserver.md b/wiki/docker/ankitects_-_syncserver.md index 6e1bb80..bb64873 100644 --- a/wiki/docker/ankitects_-_syncserver.md +++ b/wiki/docker/ankitects_-_syncserver.md @@ -22,26 +22,32 @@ Especially set the `` (for example `24.11`) aswell as the `` and Set the following variables with the -e tag. + | Name | Usage | Default | | -------------- | -------------------------------------------------------- | ------- | | `SYNC_USER1` | contains the `` and `` of the first user | | + ## Ports Set the following ports in the `ports:` section. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | --------- | ------------- | | `27701` | `8080` | TCP | Default port | + ## Volumes Set the following volumes with the -v tag. + | Outside mount/volume name | Container mount | Description | | ------------------------- | --------------- | ------------- | | `akni-sync-server-data` | `/anki-data` | Data storage | + ## rebuild.sh ```sh diff --git a/wiki/docker/awesometechnologies_-_synapse-admin.md b/wiki/docker/awesometechnologies_-_synapse-admin.md index dfd73fc..ac474dd 100644 --- a/wiki/docker/awesometechnologies_-_synapse-admin.md +++ b/wiki/docker/awesometechnologies_-_synapse-admin.md @@ -15,10 +15,12 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards. Set the following ports in the `ports:` section. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ----------- | | `80` | `80` | TCP | WebUI | + ### rebuild.sh ```sh diff --git a/wiki/docker/axhilrex_-_podgrab.md b/wiki/docker/axhilrex_-_podgrab.md index c5a8bf3..c9a392a 100644 --- a/wiki/docker/axhilrex_-_podgrab.md +++ b/wiki/docker/axhilrex_-_podgrab.md @@ -14,27 +14,33 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards. Set the following variables with the -e tag. + | Name | Usage | Default | | ---------- | ----------------------------- | ------- | | `PASSWORD` | Password for `podgrab` user | | + ### Volumes Set the following volumes with the -v tag. + | Outside mount/volume name | Container mount | Description | | ------------------------- | --------------- | ----------------------- | | `podgrab_config` | `/config` | Configuration files | | `media_podcasts` | `/assets` | location for podcasts | + ### Ports Set the following ports with the -p tag. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ----------- | | `8080` | `8080` | TCP | WebUI | + ### rebuild.sh ```sh diff --git a/wiki/docker/b4bz_-_homer.md b/wiki/docker/b4bz_-_homer.md index a29cf8e..1039c8e 100644 --- a/wiki/docker/b4bz_-_homer.md +++ b/wiki/docker/b4bz_-_homer.md @@ -15,18 +15,22 @@ After that rerun `./rebuild.sh` to make update your config. Set the following volumes with the -v tag. + | Outside mount/volume name | Container mount | Description | | ------------------------- | --------------- | ---------------------- | | `homer` | `/www/assets` | storage for icons, etc | + ### Ports Set the following ports with the -p tag. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ----------- | | `8080` | `8080` | TCP | WebUI | + ### rebuild.sh ```sh diff --git a/wiki/docker/bbilly1_-_tubearchivist.md b/wiki/docker/bbilly1_-_tubearchivist.md index 783aef5..e5f6591 100644 --- a/wiki/docker/bbilly1_-_tubearchivist.md +++ b/wiki/docker/bbilly1_-_tubearchivist.md @@ -17,24 +17,28 @@ docker-compose file. The following table lists the environment variables for the image `bbilly1/tubearchivist`. + | Name | Usage | Default | | -------------------| ------------------------------------------- | ------- | -| `ES_URL` | Network address for elastic search instance | `` | -| `REDIS_HOST` | Redis broker URL | `` | -| `HOST_UID` | User ID of Host | `` | -| `HOST_GID` | Group ID of Host | `` | -| `TA_HOST` | Domain name for TubeArchivist | `` | -| `TA_USERNAME` | User name for TubeArchivist | `` | -| `TA_PASSWORD` | Password for TubeArchivist | `` | -| `ELASTIC_PASSWORD` | Password for Elasticsearch | `` | -| `TZ` | Timezone | `` | +| `ES_URL` | Network address for elastic search instance | | +| `REDIS_HOST` | Redis broker URL | | +| `HOST_UID` | User ID of Host | | +| `HOST_GID` | Group ID of Host | | +| `TA_HOST` | Domain name for TubeArchivist | | +| `TA_USERNAME` | User name for TubeArchivist | | +| `TA_PASSWORD` | Password for TubeArchivist | | +| `ELASTIC_PASSWORD` | Password for Elasticsearch | | +| `TZ` | Timezone | | + The following table lists the environment variables for the image `bbilly1/tubearchivist-es`. + | Name | Usage | Default | | -------------------| ------------------------------------------- | ------- | -| `ELASTIC_PASSWORD` | Password for Elasticsearch | `` | -| `ES_JAVA_OPTS` | Additional Java options | `` | +| `ELASTIC_PASSWORD` | Password for Elasticsearch | | +| `ES_JAVA_OPTS` | Additional Java options | | + ### Volumes @@ -42,25 +46,31 @@ Set the following volumes in the `volumes:` section of the docker-compose file. The following table lists the environment variables for the image `bbilly1/tubearchivist`. + | Outside mount/volume name | Container mount | Description | | ------------------------- | ------------------------ | --------------------------- | | `media` | `/youtube` | storage for media | | `cache` | `/cache` | storage for cache | + The following table lists the environment variables for the image `bbilly1/tubearchivist-es`. + | Outside mount/volume name | Container mount | Description | | ------------------------- | ------------------------------- | --------------------------- | | `es` | `/usr/share/elasticsearch/data` | storage for elasticsearch | + ### Ports Set the following ports in the `ports:` section. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ----------- | | `8000` | `8881` | TCP | WebUI | + ### rebuild.sh ```sh diff --git a/wiki/docker/benbusby_-_whoogle-search.md b/wiki/docker/benbusby_-_whoogle-search.md index 9fc5e9e..13d042b 100644 --- a/wiki/docker/benbusby_-_whoogle-search.md +++ b/wiki/docker/benbusby_-_whoogle-search.md @@ -18,18 +18,22 @@ Set the variables, volumes and ports according and run the `rebuild.sh`. Set the following volumes with the -v tag. + | Outside mount/volume name | Container mount | Description | | ------------------------- | ---------------- | ---------------- | | `searx_config` | `/config` | configurations | + ### Ports Set the following ports with the -p tag. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ----------- | | `5000` | `8000` | TCP | WebUI | + ### rebuild.sh ```sh diff --git a/wiki/docker/bilde2910_-_hauk.md b/wiki/docker/bilde2910_-_hauk.md index aa69fbd..f9981c8 100644 --- a/wiki/docker/bilde2910_-_hauk.md +++ b/wiki/docker/bilde2910_-_hauk.md @@ -5,7 +5,7 @@ This is a docker container for a [Hauk](/wiki/hauk.md). ## Set-up Create the files `rebuild.sh` and `docker-compose.yml` at the same place. -Additionally create a `config.php` file based on the +Additionally, create a `config.php` file based on the [config-sample](https://github.com/bilde2910/Hauk/blob/master/backend-php/include/config-sample.php) at the location specified in your `docker-compose.yml` (in this example it's `./config/hauk`). @@ -21,24 +21,28 @@ htpasswd -cBC 10 /etc/hauk/users.htpasswd htpasswd -BC 10 /etc/hauk/users.htpasswd ``` -Finally run `./rebuild.sh`. +Finally, run `./rebuild.sh`. ### Volumes Set the following volumes in the `volumes:` section of the docker-compose file. + | Outside mount/volume name | Container mount | Description | | ------------------------- | ------------------ | ------------------------------ | | `./config/hauk` | `/etc/hauk` | config and password location | + ### Ports Set the following ports in the `ports:` section. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ---------------------- | | `80` | `80` | TCP | Basic service | + ### rebuild.sh ```sh diff --git a/wiki/docker/chocobozzz_-_peertube.md b/wiki/docker/chocobozzz_-_peertube.md index a575551..d46e876 100644 --- a/wiki/docker/chocobozzz_-_peertube.md +++ b/wiki/docker/chocobozzz_-_peertube.md @@ -17,20 +17,24 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards. Set the following ports in the `ports:` section. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ----------- | | `9000` | `9000` | TCP | WebUI | + ### Volumes Set the following volumes with the -v tag. + | Outside mount/volume name | Container mount | Description | | ------------------------- | -------------------------- | ---------------------- | | `assets` | `/app/client/dist` | storage for icons, etc | | `config` | `/config` | configuration data | | `data` | `/data` | further data storage | + ### rebuild.sh ```sh diff --git a/wiki/docker/cloudrac3r_-_bibliogram.md b/wiki/docker/cloudrac3r_-_bibliogram.md index af4c1dc..d728b98 100755 --- a/wiki/docker/cloudrac3r_-_bibliogram.md +++ b/wiki/docker/cloudrac3r_-_bibliogram.md @@ -18,18 +18,22 @@ Set the variables, volumes and ports according and run the `rebuild.sh`. Set the following volumes with the -v tag. + | Outside mount/volume name | Container mount | Description | | ------------------------- | --------------- | ----------------------------------- | | `db` | `/app/db` | storage for the bibliogram database | + ### Ports Set the following ports in the `ports:` section. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ----------- | | `10407` | `10407` | TCP | WebUI | + ### rebuild.sh ```sh diff --git a/wiki/docker/coturn_-_coturn.md b/wiki/docker/coturn_-_coturn.md index 9d020fd..d2a6e36 100644 --- a/wiki/docker/coturn_-_coturn.md +++ b/wiki/docker/coturn_-_coturn.md @@ -24,12 +24,14 @@ For the public IP the command `curl api.ipify.org` can be used. Set the following ports in the `ports:` section. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ----------- | | `3478` | `3478` | TCP/UDP | TURN/STUN | | `5349` | `5349` | TCP/UDP | TURN/STUN | | `49152-65535` | `49152-65535` | UDP | TURN/STUN | + ### rebuild.sh ```sh diff --git a/wiki/docker/dperson_-_torproxy.md b/wiki/docker/dperson_-_torproxy.md index 96072f8..9e28a83 100644 --- a/wiki/docker/dperson_-_torproxy.md +++ b/wiki/docker/dperson_-_torproxy.md @@ -12,20 +12,24 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards. Set the following volumes with the -v tag. + | Outside mount/volume name | Container mount | Description | | ------------------------- | --------------- | -------------------------- | | `tor_var` | `/var/lib/tor` | Location for various files | | `tor_etc` | `/etc/tor` | Various other config | + ### Ports Set the following ports with the -p tag. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | -------------------- | | `8118` | `8118` | HTTP | privoxy web proxy | | `9050` | `9050` | SOCKS | socks protocol proxy | + ### rebuild.sh ```sh diff --git a/wiki/docker/dyonr_-_jackettvpn.md b/wiki/docker/dyonr_-_jackettvpn.md index 6547349..364e247 100644 --- a/wiki/docker/dyonr_-_jackettvpn.md +++ b/wiki/docker/dyonr_-_jackettvpn.md @@ -9,7 +9,7 @@ The official container and documentation was made by Create the file `rebuild.sh` and set `` and `` according to your openvpn. -Additionally change the `LAN_NETWORK` if it differs for your local area network. +Additionally, change the `LAN_NETWORK` if it differs for your local area network. Run `./rebuild.sh` afterwards to create the volumes. Place the openvpn certificate in the `jacket_config` docker volume inside the `openvpn` folder. @@ -19,19 +19,23 @@ After that rerun `./rebuild.sh` to make update your config. Set the following volumes with the -v tag. + | Outside mount/volume name | Container mount | Description | | ------------------------- | --------------- | ---------------------- | | `jackett_config` | `/config` | storage for configs | | `jackett_blackhole` | `/blackhole` | storage for magnets | + ### Ports Set the following ports with the -p tag. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ----------- | | `9117` | `9117` | TCP | WebUI | + ### rebuild.sh ```sh diff --git a/wiki/docker/dyonr_-_qbittorrentvpn.md b/wiki/docker/dyonr_-_qbittorrentvpn.md index 6011b5f..f4c3d91 100644 --- a/wiki/docker/dyonr_-_qbittorrentvpn.md +++ b/wiki/docker/dyonr_-_qbittorrentvpn.md @@ -18,40 +18,48 @@ Both can be changed in the web interface after setup. Set the following variables with the -e tag. + | Name | Usage | Default | | ------------------- | --------------------------- | ------- | -| `VPN_ENABLE` | Enable VPN | ` ` | -| `VPN_USERNAME` | Username for OpenVPN | ` ` | -| `VPN_PASSWORD` | Password for OpenVPN | ` ` | -| `LAN_NETWORK` | Subnet of the local network | ` ` | +| `VPN_ENABLE` | Enable VPN | | +| `VPN_USERNAME` | Username for OpenVPN | | +| `VPN_PASSWORD` | Password for OpenVPN | | +| `LAN_NETWORK` | Subnet of the local network | | + ### Volumes Set the following volumes with the -v tag. + | Outside mount/volume name | Container mount | Description | | ------------------------- | ------------------- | ----------------------- | | `qbittorrentvpn_config` | `/config` | Configuration files | | `qbittorrentvpn_data` | `/downloads` | Storage for data | + ### Ports Set the following ports with the -p tag. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ----------- | | `9091` | `8080` | TCP | WebUI | + ### Additional There are some special variables to set. + | Flag | Usage | | ----------- | ---------------------- | | `--cap-add` | add linux capabilities | | `--device` | connect devices | | `--sysctl` | configure systemctl | + ### rebuild.sh ```sh diff --git a/wiki/docker/gitea_-_gitea.md b/wiki/docker/gitea_-_gitea.md index 58a80f4..4287db2 100644 --- a/wiki/docker/gitea_-_gitea.md +++ b/wiki/docker/gitea_-_gitea.md @@ -15,6 +15,7 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards. Set the following environment-variables in the `environment:` section of the docker-compose file. + | Name | Usage | Default | | ----------- | ------------------------------ | ------- | | `USER_UID` | User userid to run gitea | | @@ -25,42 +26,51 @@ docker-compose file. | `DB_USER` | Username for the database | | | `DB_PASSWD` | Password for the database | | + ### Volumes Set the following volumes in the `volumes:` section of the docker-compose file. + | Outside mount/volume name | Container mount | Description | | ------------------------- | ------------------ | ------------------------------ | | `data` | `/data` | storage for data of git server | | `/etc/timezone` | `/etc/timezone:ro` | link timezone | | `/etc/localtime` | `/etc/localtime` | link localtime | + ### Ports Set the following ports in the `ports:` section. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ---------------------- | | `3000` | `3000` | TCP | WebUI | | `22` | `222` | TCP | ssh port of git server | + ### Networks Set the following networks in the `networks:` section of the docker-compose file. + | Name | Usage | | ------- | --------------------- | | `gitea` | connect db with gitea | + ### Dependencies Set the following dependencies in the `depends_on:` section of the docker-compose file. + | Name | Usage | | ---- | -------------------- | | `db` | Ensure db is running | + ### rebuild.sh ```sh diff --git a/wiki/docker/gramps-project_-_grampsweb.md b/wiki/docker/gramps-project_-_grampsweb.md index 926f2fc..f068e84 100644 --- a/wiki/docker/gramps-project_-_grampsweb.md +++ b/wiki/docker/gramps-project_-_grampsweb.md @@ -15,17 +15,20 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards. Set the following environment-variables in the `environment:` section of the docker-compose file. + | Name | Usage | Default | | ----------------------------------------- | ------------------------------------ | ------- | -| `GRAMPSWEB_TREE` | Will create a new tree if not exists | `` | -| `GRAMPSWEB_CELERY_CONFIG__broker_url` | Redis broker URL | `` | -| `GRAMPSWEB_CELERY_CONFIG__result_backend` | Redis backend URL | `` | -| `GRAMPSWEB_RATELIMIT_STORAGE_URI` | Storage URI | `` | +| `GRAMPSWEB_TREE` | Will create a new tree if not exists | | +| `GRAMPSWEB_CELERY_CONFIG__broker_url` | Redis broker URL | | +| `GRAMPSWEB_CELERY_CONFIG__result_backend` | Redis backend URL | | +| `GRAMPSWEB_RATELIMIT_STORAGE_URI` | Storage URI | | + ### Volumes Set the following volumes in the `volumes:` section of the docker-compose file. + | Outside mount/volume name | Container mount | Description | | ------------------------- | ------------------------ | --------------------------- | | `gramps_users` | `/app/users` | storage for users | @@ -37,14 +40,17 @@ Set the following volumes in the `volumes:` section of the docker-compose file. | `gramps_media` | `/app/media` | storage for media | | `gramps_tmp` | `/tmp` | storage for temporary files | + ### Ports Set the following ports in the `ports:` section. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ----------- | | `5000` | `80` | TCP | WebUI | + ### rebuild.sh ```sh diff --git a/wiki/docker/grimsi_-_gameyfin.md b/wiki/docker/grimsi_-_gameyfin.md index d8694db..07f8634 100644 --- a/wiki/docker/grimsi_-_gameyfin.md +++ b/wiki/docker/grimsi_-_gameyfin.md @@ -9,13 +9,14 @@ Change the settings according to your needs. Create the volume for the configuration files by running the command `docker volume create gameyfin_config`. Make sure to run the following command on the config volume `chown -R 1000:root gameyfin_config`. -Afterwards run `./rebuild.sh`. +Afterward, run `./rebuild.sh`. ### Environment-variables Set the following environment-variables in the `environment:` section of the docker-compose file. + | Name | Usage | Default | | --------------------------------- | --------------------------------------- | ------- | | `GAMEYFIN_USER` | user name for gameyfin | | @@ -23,18 +24,22 @@ docker-compose file. | `GAMEYFIN_IGDB_API_CLIENT_ID` | id of twitch internet game database | | | `GAMEYFIN_IGDB_API_CLIENT_SECRET` | secret of twitch internet game database | | + ### Volumes Set the following volumes in the `volumes:` section of the docker-compose file. + | Outside mount/volume name | Container mount | Description | | ------------------------- | ----------------------- | ------------------------------ | | `media_games` | `/opt/gameyfin-library` | storage for games and configs | + ### Ports Set the following ports in the `ports:` section. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ---------------------- | | `8080` | `8093` | TCP | WebUI | diff --git a/wiki/docker/haugene_-_transmission-openvpn.md b/wiki/docker/haugene_-_transmission-openvpn.md index f8ef5e3..1ccb1d1 100644 --- a/wiki/docker/haugene_-_transmission-openvpn.md +++ b/wiki/docker/haugene_-_transmission-openvpn.md @@ -17,33 +17,39 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards. Set the following variables with the -e tag. + | Name | Usage | Default | | ------------------- | --------------------------- | ------- | -| `OPENVPN_PROVIDER` | Provider for OpenVPN | ` ` | -| `OPENVPN_USERNAME` | Username for OpenVPN | ` ` | -| `OPENVPN_PASSWORD` | Password for OpenVPN | ` ` | -| `LOCAL_NETWORK` | Subnet of the local network | ` ` | -| `CREATE_TUN_DEVICE` | Use a tunnel device | ` ` | -| `WEBPROXY_ENABLES` | Use a webproxy | ` ` | +| `OPENVPN_PROVIDER` | Provider for OpenVPN | | +| `OPENVPN_USERNAME` | Username for OpenVPN | | +| `OPENVPN_PASSWORD` | Password for OpenVPN | | +| `LOCAL_NETWORK` | Subnet of the local network | | +| `CREATE_TUN_DEVICE` | Use a tunnel device | | +| `WEBPROXY_ENABLES` | Use a webproxy | | + ### Volumes Set the following volumes with the -v tag. + | Outside mount/volume name | Container mount | Description | | ------------------------- | --------------- | ----------------------- | | `transmission_config` | `/config` | Configuration files | | `transmission data` | `/data` | Storage for data | | `/etc/localtime` | `/etc/localtime:ro` | Link to the systemtime | + ### Ports Set the following ports with the -p tag. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ----------- | | `9091` | `9091` | TCP | WebUI | + ### rebuild.sh ```sh diff --git a/wiki/docker/henrywhitaker3_-_speedtest-tracker.md b/wiki/docker/henrywhitaker3_-_speedtest-tracker.md index afbfd8c..c26713c 100644 --- a/wiki/docker/henrywhitaker3_-_speedtest-tracker.md +++ b/wiki/docker/henrywhitaker3_-_speedtest-tracker.md @@ -14,27 +14,33 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards. Set the following variables with the -e tag. + | Name | Usage | Default | | ----------------- | ----------------------------- | ------- | | `OOKLA_EULA_GDPR` | set to `true` to accept EULA | | | `AUTH` | set to `true` to enable login | | + ### Volumes Set the following volumes with the -v tag. + | Outside mount/volume name | Container mount | Description | | ------------------------- | --------------- | ------------------ | | `speedtest` | `/config` | storage for config | + ### Ports Set the following ports with the -p tag. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ----------- | | `80` | `8765` | TCP | WebUI | + ### rebuild.sh ```sh diff --git a/wiki/docker/homeassistant_-_home-assistant.md b/wiki/docker/homeassistant_-_home-assistant.md index b595537..f0735fd 100644 --- a/wiki/docker/homeassistant_-_home-assistant.md +++ b/wiki/docker/homeassistant_-_home-assistant.md @@ -14,18 +14,22 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards. Set the following volumes with the -v tag. + | Outside mount/volume name | Container mount | Description | | ------------------------- | --------------- | ------------------------------- | | `homeassistant_data` | `/config` | configuration for devices, etc | + ### Environment-variables Set the following environment-variables in the `environment:` section of the docker-compose file. + | Name | Usage | Default | | --------------------- | --------------------------- | ----------------------- | -| `TZ` | specify the timezone | `` | +| `TZ` | specify the timezone | | + ### Additional diff --git a/wiki/docker/immich-app_-_immich-server.md b/wiki/docker/immich-app_-_immich-server.md index 8ff8c33..ebf1a59 100644 --- a/wiki/docker/immich-app_-_immich-server.md +++ b/wiki/docker/immich-app_-_immich-server.md @@ -24,19 +24,23 @@ The environment variables are set via the `.env` file and listed in the Set the following ports in the `ports:` section. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | --------- | ------------- | | `2283` | `3001` | TCP | WebUI | + ### Volumes Set the following volumes with the -v tag. + | Outside mount/volume name | Container mount | Description | | ------------------------- | --------------------- | ------------- | | `immich_library` | `/usr/src/app/upload` | Library | | `/etc/timezone` | `/etc/timezone:ro` | Timezone | + ### rebuild.sh ```sh #!/bin/sh diff --git a/wiki/docker/itzg_-_minecraft-server.md b/wiki/docker/itzg_-_minecraft-server.md index 8ce81d8..fec5f79 100755 --- a/wiki/docker/itzg_-_minecraft-server.md +++ b/wiki/docker/itzg_-_minecraft-server.md @@ -8,12 +8,13 @@ The container and documentation was made by ## Set-up Create the file `rebuild.sh`. -Change the settings according to your needs and run `./rebuild.sh` afterwards. +Change the settings according to your needs and run `./rebuild.sh` afterward. ### Environment-variables Set the following variables with the -e tag. + | Name | Usage | Default | | ------------- | -------------------------------------------------------------- | -------------------------------------------- | | `EULA` | Accept the EULA | | @@ -24,22 +25,27 @@ Set the following variables with the -e tag. | `ICON` | Link the Icon of the Server | | | `MOTD` | Set the Message of the day | "A Paper Minecraft Server powered by Docker" | + ### Volumes Set the following volumes with the -v tag. + | Outside mount/volume name | Container mount | Description | | ------------------------- | --------------- | ------------------------------ | | `minecraft` | `/data` | location for all relevant data | + ### Ports Set the following ports with the -p tag. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | --------- | ------------------ | | `25565` | `25565` | Minecraft | Port for Minecraft | + ### rebuild.sh ```sh @@ -74,7 +80,7 @@ For this set the server type by using the `-e TYPE=` flag. Most notably this value could be `FABRIC` or `FORGE`. After this the mods (as `.jar` files) can be placed in the `mods` directory of the [Docker](/wiki/docker.md) volume. -Afterwards run the [`rebuild.sh`](#rebuildsh) to restart the server with loaded mods. +Afterward, run the [`rebuild.sh`](#rebuildsh) to restart the server with loaded mods. #### Installing Datapacks diff --git a/wiki/docker/iv-org_-_invidious.md b/wiki/docker/iv-org_-_invidious.md index f8b8da6..fa32cbd 100755 --- a/wiki/docker/iv-org_-_invidious.md +++ b/wiki/docker/iv-org_-_invidious.md @@ -21,6 +21,7 @@ Set the variables, volumes and ports according and run the `rebuild.sh`. Set the following environment-variables in the `environment:` section of the docker-compose file. + | Name | Usage | Default | | ---------------------- | ---------------------------------------------------------- | ------- | | `channel_threads` | numer of threads to use for refreshing channels | `1` | @@ -38,14 +39,17 @@ docker-compose file. | `popular_enabled` | enable the popular section | `true` | | `registration_enabled` | enable registration for new users | `true` | + ### Ports Set the following ports in the `ports:` section. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ----------- | | `3000` | `3000` | TCP | WebUI | + ### rebuild.sh ```sh diff --git a/wiki/docker/jkarlos_-_git-server-docker.md b/wiki/docker/jkarlos_-_git-server-docker.md index 87d078b..a853a05 100644 --- a/wiki/docker/jkarlos_-_git-server-docker.md +++ b/wiki/docker/jkarlos_-_git-server-docker.md @@ -13,19 +13,23 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards. Set the following volumes with the -v tag. + | Outside mount/volume name | Container mount | Description | | ------------------------- | ------------------- | ------------------------- | | `git-server_repos` | `/git-server/repos` | storage for git repos | | `git-server_keys` | `/git-server/keys` | storage for user ssh keys | + ### Ports Set the following ports with the -p tag. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ------------------------------------- | | `22` | `2222` | TCP | ssh port for accessing the git server | + ### rebuild.sh ```sh diff --git a/wiki/docker/johnktims_-_folding-at-home.md b/wiki/docker/johnktims_-_folding-at-home.md index eb1d0ce..7d6649f 100644 --- a/wiki/docker/johnktims_-_folding-at-home.md +++ b/wiki/docker/johnktims_-_folding-at-home.md @@ -14,20 +14,24 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards. Set the following ports with the -p tag. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ----------- | | `7396` | `7396` | TCP | WebUI | + ### Additional There are some special variables to set. + | Flag | Usage | | --------- | ------------------------------------- | | `--user` | set your username | | `--power` | set the default power to fold at home | | `--team` | set your teamid to contribute points | + ### rebuild.sh ```sh diff --git a/wiki/docker/jonohill_-_docker-openvpn-proxy.md b/wiki/docker/jonohill_-_docker-openvpn-proxy.md index 176c6ba..2290339 100644 --- a/wiki/docker/jonohill_-_docker-openvpn-proxy.md +++ b/wiki/docker/jonohill_-_docker-openvpn-proxy.md @@ -14,38 +14,46 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards. Set the following volumes with the -v tag. + | Outside mount/volume name | Container mount | Description | | ------------------------- | --------------- | ------------------------ | | `ovpn-proxy` | `/config` | storage for openvpn data | + ### Ports Set the following ports with the -p tag. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ------------ | | `9050` | `8080` | HTTP | proxy port | + ### Environment-Variables Set the following variables with the -e tag. + | Name | Usage | Default | | ------------------- | --------------------------- | ------- | -| `LOCAL_NETWORK` | Set local network subnet | ` ` | -| `OPENVPN_USERNAME` | username for OpenVPN | ` ` | -| `OPENVPN_PASSWORD` | password for OpenVPN | ` ` | +| `LOCAL_NETWORK` | Set local network subnet | | +| `OPENVPN_USERNAME` | username for OpenVPN | | +| `OPENVPN_PASSWORD` | password for OpenVPN | | + ### Additional There are some special variables to set. + | Flag | Usage | | ----------- | ---------------------- | | `--cap-add` | add linux capabilities | | `--device` | connect devices | | `--sysctl` | configure systemctl | + ### rebuild.sh ```sh diff --git a/wiki/docker/kiwix_-_kiwix-serve.md b/wiki/docker/kiwix_-_kiwix-serve.md index bb2c674..e19aedf 100644 --- a/wiki/docker/kiwix_-_kiwix-serve.md +++ b/wiki/docker/kiwix_-_kiwix-serve.md @@ -14,18 +14,22 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards. Set the following ports in the `ports:` section. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | --------- | ------------- | | `80` | `80` | TCP | WebUI | + ## Volumes Set the following volumes with the -v tag. + | Outside mount/volume name | Container mount | Description | | ------------------------- | --------------- | -------------- | | `kiwix_data` | `/data` | Data directory | + ## rebuild.sh ```sh diff --git a/wiki/docker/kylemanna_-_openvpn.md b/wiki/docker/kylemanna_-_openvpn.md index 73b8b64..adf417f 100644 --- a/wiki/docker/kylemanna_-_openvpn.md +++ b/wiki/docker/kylemanna_-_openvpn.md @@ -20,32 +20,38 @@ docker run -v openvpn:/etc/openvpn --rm kylemanna/openvpn ovpn_genconfig -u udp: docker run -v openvpn:/etc/openvpn --rm -it kylemanna/openvpn ovpn_initpki ``` -Afterwards run `./rebuild.sh`. +Afterward, run `./rebuild.sh`. ### Volumes Set the following volumes with the -v tag. + | Outside mount/volume name | Container mount | Description | | ------------------------- | --------------- | ------------------------ | | `ovpn` | `/etc/openvpn` | storage for openvpn data | + ### Ports Set the following ports with the -p tag. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ------------ | | `1194` | `1194` | UDP | openvpn port | + ### Additional There are some special variables to set. + | Flag | Usage | | ----------- | ---------------------- | | `--cap-add` | add linux capabilities | + ### rebuild.sh ```sh diff --git a/wiki/docker/linuxserver_-_airsonic-advanced.md b/wiki/docker/linuxserver_-_airsonic-advanced.md index 74791a0..f367ac7 100644 --- a/wiki/docker/linuxserver_-_airsonic-advanced.md +++ b/wiki/docker/linuxserver_-_airsonic-advanced.md @@ -14,16 +14,19 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards. Set the following variables with the -e tag. + | Name | Usage | Default | | ------ | -------- | ------- | | `PUID` | UserID | | | `PGID` | GroupID | | | `TZ` | Timezone | | + ### Volumes Set the following volumes with the -v tag. + | Outside mount/volume name | Container mount | Description | | ------------------------- | --------------- | ----------------------- | | `airsonicadv_config` | `/config` | Configuration files | @@ -33,14 +36,17 @@ Set the following volumes with the -v tag. | `media_audiobooks` | `/audiobooks` | Location for audiobooks | | `media_podcasts` | `/podcasts` | location for podcasts | + ### Ports Set the following ports with the -p tag. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ----------- | | `4040` | `4040` | TCP | WebUI | + ### rebuild.sh ```sh diff --git a/wiki/docker/linuxserver_-_airsonic.md b/wiki/docker/linuxserver_-_airsonic.md index fc5dd7c..0d4054d 100644 --- a/wiki/docker/linuxserver_-_airsonic.md +++ b/wiki/docker/linuxserver_-_airsonic.md @@ -14,16 +14,19 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards. Set the following variables with the -e tag. + | Name | Usage | Default | | ------ | -------- | ------- | | `PUID` | UserID | | | `PGID` | GroupID | | | `TZ` | Timezone | | + ### Volumes Set the following volumes with the -v tag. + | Outside mount/volume name | Container mount | Description | | ------------------------- | --------------- | ----------------------- | | `airsonic_config` | `/config` | Configuration files | @@ -33,14 +36,17 @@ Set the following volumes with the -v tag. | `media_audiobooks` | `/audiobooks` | Location for audiobooks | | `media_podcasts` | `/podcasts` | location for podcasts | + ### Ports Set the following ports with the -p tag. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ----------- | | `4040` | `4040` | TCP | WebUI | + ### rebuild.sh ```sh diff --git a/wiki/docker/linuxserver_-_freshrss.md b/wiki/docker/linuxserver_-_freshrss.md index d01e97f..9eb61b1 100644 --- a/wiki/docker/linuxserver_-_freshrss.md +++ b/wiki/docker/linuxserver_-_freshrss.md @@ -16,28 +16,34 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards. Set the following environment-variables in the `environment:` section of the docker-compose file. + | Name | Usage | Default | | ------ | ---------------------------- | ------- | | `PUID` | Userid to run the container | | | `PGID` | Groupid to run the container | | | `TZ` | specify the timezone | | + ### Volumes Set the following volumes in the `volumes:` section of the docker-compose file. + | Outside mount/volume name | Container mount | Description | | ------------------------- | --------------- | ------------------------------------ | | `config` | `/config` | storage for config files of jellyfin | + ### Ports Set the following ports in the `ports:` section. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ----------- | | `7008` | `80` | TCP | WebUI | + ### rebuild.sh ```sh diff --git a/wiki/docker/linuxserver_-_jellyfin.md b/wiki/docker/linuxserver_-_jellyfin.md index c5ed05d..8fddcd3 100644 --- a/wiki/docker/linuxserver_-_jellyfin.md +++ b/wiki/docker/linuxserver_-_jellyfin.md @@ -16,16 +16,19 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards. Set the following environment-variables in the `environment:` section of the docker-compose file. + | Name | Usage | Default | | ------ | ---------------------------- | ------- | | `PUID` | Userid to run the container | | | `PGID` | Groupid to run the container | | | `TZ` | specify the timezone | | + ### Volumes Set the following volumes in the `volumes:` section of the docker-compose file. + | Outside mount/volume name | Container mount | Description | | ------------------------- | --------------- | ------------------------------------ | | `config` | `/config` | storage for config files of jellyfin | @@ -33,6 +36,7 @@ Set the following volumes in the `volumes:` section of the docker-compose file. | `media_tvshows` | `/data/tvshows` | storage for tvshows | | `transcode` | `/transcode` | tmp storage to transcode | + Because it is useful to have the possibility to use the `media_movies` and `media_tvshows` in multiple containers, it is recommended to use them as external volumes (volumes section: @@ -44,10 +48,12 @@ To use the rebuild the volumes have to exist before creating the container Set the following ports in the `ports:` section. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ----------- | | `8096` | `8096` | TCP | WebUI | + ### rebuild.sh ```sh diff --git a/wiki/docker/linuxserver_-_lidarr.md b/wiki/docker/linuxserver_-_lidarr.md index c2662bc..d3fbd68 100644 --- a/wiki/docker/linuxserver_-_lidarr.md +++ b/wiki/docker/linuxserver_-_lidarr.md @@ -26,29 +26,35 @@ This namely causes the following line in the Set the following environment-variables in the `environment:` section of the docker-compose file. + | Name | Usage | Default | | --------------------- | --------------------------- | ----------------------- | | `PUID` | user id for container user | `1000` | | `PGID` | group id for container user | `1000` | | `TZ` | specify the timezone | `Etc/UTC` | + ### Volumes Set the following volumes in the `volumes:` section of the docker-compose file. + | Outside mount/volume name | Container mount | Description | | ------------------------- | ----------------- | --------------------------------- | | `config` | `/config` | directory for config | | `complete` | `/music` | directory for music | + ### Ports Set the following ports in the `ports:` section. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ------------ | | `8686` | `8686` | TCP | webUI | + ### rebuild.sh ```sh diff --git a/wiki/docker/linuxserver_-_radarr.md b/wiki/docker/linuxserver_-_radarr.md index 60d6f24..7080432 100644 --- a/wiki/docker/linuxserver_-_radarr.md +++ b/wiki/docker/linuxserver_-_radarr.md @@ -26,29 +26,35 @@ This namely causes the following line in the Set the following environment-variables in the `environment:` section of the docker-compose file. + | Name | Usage | Default | | --------------------- | --------------------------- | ----------------------- | | `PUID` | user id for container user | `1000` | | `PGID` | group id for container user | `1000` | | `TZ` | specify the timezone | `Etc/UTC` | + ### Volumes Set the following volumes in the `volumes:` section of the docker-compose file. + | Outside mount/volume name | Container mount | Description | | ------------------------- | ----------------- | --------------------------------- | | `config` | `/config` | directory for config | | `complete` | `/movies` | directory for music | + ### Ports Set the following ports in the `ports:` section. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ------------ | | `7878` | `7878` | TCP | webUI | + ### rebuild.sh ```sh diff --git a/wiki/docker/linuxserver_-_sonarr.md b/wiki/docker/linuxserver_-_sonarr.md index ba1710f..3b6d2b0 100644 --- a/wiki/docker/linuxserver_-_sonarr.md +++ b/wiki/docker/linuxserver_-_sonarr.md @@ -26,29 +26,35 @@ This namely causes the following line in the Set the following environment-variables in the `environment:` section of the docker-compose file. + | Name | Usage | Default | | --------------------- | --------------------------- | ----------------------- | | `PUID` | user id for container user | `1000` | | `PGID` | group id for container user | `1000` | | `TZ` | specify the timezone | `Etc/UTC` | + ### Volumes Set the following volumes in the `volumes:` section of the docker-compose file. + | Outside mount/volume name | Container mount | Description | | ------------------------- | ----------------- | --------------------------------- | | `config` | `/config` | directory for config | | `complete` | `/tv` | directory for music | + ### Ports Set the following ports in the `ports:` section. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ------------ | | `8989` | `8989` | TCP | webUI | + ### rebuild.sh ```sh diff --git a/wiki/docker/linuxserver_-_syncthing.md b/wiki/docker/linuxserver_-_syncthing.md index 787c131..081e47d 100644 --- a/wiki/docker/linuxserver_-_syncthing.md +++ b/wiki/docker/linuxserver_-_syncthing.md @@ -14,6 +14,7 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards. Set the following variables with the -e tag. + | Name | Usage | Default | | ----------- | ---------------- | ------- | | `PUID` | UserID | | @@ -21,24 +22,29 @@ Set the following variables with the -e tag. | `TZ` | Timezone | | | `UMASK_SET` | setting usermask | | + ### Volumes Set the following volumes with the -v tag. + | Volume-Name | Container mount | Description | | ------------------ | --------------- | ----------------------------------------------- | | `syncthing_config` | `/config` | storage for config and possible downloaded data | + ### Ports Set the following ports with the -p tag. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ------------------ | | `8384` | `8384` | TCP | WebUI | | `22000` | `22000` | TCP | Syncthing internal | | `21027` | `21027` | UDP | Syncthing internal | + ### rebuild.sh ```sh diff --git a/wiki/docker/linuxserver_-_tvheadend.md b/wiki/docker/linuxserver_-_tvheadend.md index 455f356..53d9de9 100644 --- a/wiki/docker/linuxserver_-_tvheadend.md +++ b/wiki/docker/linuxserver_-_tvheadend.md @@ -8,37 +8,42 @@ The official container and documentation was made by ## Set-up Create the files `rebuild.sh` and `docker-compose.yml` at the same place. -Change the settings according to your needs and run `./rebuild.sh` afterwards. +Change the settings according to your needs and run `./rebuild.sh` afterward. ### Environment-variables Set the following environment-variables in the `environment:` section of the docker-compose file. + | Name | Usage | Default | | --------------------- | --------------------------- | ----------------------- | | `PUID` | user id for container user | `1000` | | `PGID` | group id for container user | `1000` | | `TZ` | specify the timezone | `Europe/London` | -| `RUN_OPTS` | specify the timezone | ` ` | +| `RUN_OPTS` | specify the timezone | | ### Volumes Set the following volumes in the `volumes:` section of the docker-compose file. + | Outside mount/volume name | Container mount | Description | | ------------------------- | --------------- | --------------------------------- | | `config` | `/config` | directory for config | | `tvdvr` | `/recordings` | directory for storage | + ### Ports Set the following ports in the `ports:` section. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ------------ | -| `9981` | ` ` | TCP | webUI | -| `9982` | ` ` | TCP | HTSP port | +| `9981` | | TCP | webUI | +| `9982` | | TCP | HTSP port | + ## rebuild.sh diff --git a/wiki/docker/linuxserver_-_wireguard.md b/wiki/docker/linuxserver_-_wireguard.md index 3f9e9ad..65a4f5f 100644 --- a/wiki/docker/linuxserver_-_wireguard.md +++ b/wiki/docker/linuxserver_-_wireguard.md @@ -22,6 +22,7 @@ Then run `./rebuild.sh` Set the following variables with the -e tag. + | Name | Usage | Default | | ----------- | --------------- | ------- | | `PUID` | UserID | | @@ -30,30 +31,37 @@ Set the following variables with the -e tag. | `SERVERURL` | URL of server | | | `PEERS` | Number of peers | | + ### Volumes Set the following volumes with the -v tag. + | Outside mount/volume name | Container mount | Description | | ------------------------- | --------------- | ----------------------- | | `wireguard` | `/config` | Configuration files | + ### Ports Set the following ports with the -p tag. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ----------- | | `51820` | `51820` | UDP | VPN port | + ### Additional There are some special variables to set. + | Flag | Usage | | ----------- | ---------------------- | | `--cap-add` | add linux capabilities | + ### rebuild.sh ```sh diff --git a/wiki/docker/mailserver_-_docker-mailserver.md b/wiki/docker/mailserver_-_docker-mailserver.md index 24e9dc1..b02f0b9 100644 --- a/wiki/docker/mailserver_-_docker-mailserver.md +++ b/wiki/docker/mailserver_-_docker-mailserver.md @@ -32,10 +32,10 @@ And finally generate the DCIM keys and rebuild once again. `./setup.sh config dkim` -Finally if a reverse proxy is used check the +Finally, if a reverse proxy is used check the [traefik entry](/wiki/docker/traefik.md#setup-mailserver) or the [nginx entry](/wiki/nginx.md). -Afterwards you're ready to go by once again running the `rebuild.sh` file. +Afterward, you're ready to go by once again running the `rebuild.sh` file. If setting up this mailserver with [Traefik](/wiki/traefik.md) as a reverse proxy some additional steps should be taken. diff --git a/wiki/docker/mariadb.md b/wiki/docker/mariadb.md index 4e9a5f1..ddbc1ed 100644 --- a/wiki/docker/mariadb.md +++ b/wiki/docker/mariadb.md @@ -7,7 +7,7 @@ To achieve this in the easiest way use a docker-compose file. ## Set-Up -The mariadb Docker container is dependent on another container most of the time. +The mariadb Docker container is dependent on another container most of the time. The exact setup will be described in the regarding entry. Nevertheless both environment variables and volumes are listed in the sections below. Nevertheless both environment variables and volumes and networks are listed in the sections below. @@ -18,6 +18,7 @@ These are needed most often. Set the following environment-variables in the `environment:` section of the docker-compose file. + | Name | Usage | Default | | --------------------- | ----------------------------- | ------- | | `MYSQL_ROOT_PASSWORD` | set the mysql admin password | | @@ -25,14 +26,17 @@ docker-compose file. | `MYSQL_PASSWORD` | set the mysql user password | | | `MYSQL_Database` | specify mysql database to use | | + ### Volumes Set the following volumes in the `volumes:` section of the docker-compose file. + | Outside mount/volume name | Container mount | Description | | ------------------------- | ---------------- | ------------------------- | | `mysql` | `/var/lib/mysql` | storage for owncloud data | + ### Networks You can set networks in the `networks:` part of a docker-compose file to connect diff --git a/wiki/docker/massivedecks_-_client.md b/wiki/docker/massivedecks_-_client.md index 1f8ae56..b6d0987 100644 --- a/wiki/docker/massivedecks_-_client.md +++ b/wiki/docker/massivedecks_-_client.md @@ -20,19 +20,23 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards. Set the following ports in the `ports:` section. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ----------- | | `8080` | `8080` | TCP | WebUI | + ### Environment-variables Set the following environment-variables in the `environment:` section of the docker-compose file. + | Name | Usage | Default | | ----------- | ----------------------- | ----------------- | | `NODE_ENV` | Setting the environment | `production` | + ### rebuild.sh ```sh diff --git a/wiki/docker/matrixdotorg_-_synapse.md b/wiki/docker/matrixdotorg_-_synapse.md index d6dc88c..5464d01 100644 --- a/wiki/docker/matrixdotorg_-_synapse.md +++ b/wiki/docker/matrixdotorg_-_synapse.md @@ -16,6 +16,7 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards. Set the following environment-variables in the `environment:` section of the docker-compose file. + | Name | Usage | Default | | --------------------- | ------------------------- | ----------------------- | | `SYNAPSE_CONFIG_DIR` | config directory | `/data` | @@ -24,22 +25,27 @@ docker-compose file. | `GID` | group id for synapse user | `1000` | | `TZ` | specify the timezone | `Europe/London` | + ### Volumes Set the following volumes in the `volumes:` section of the docker-compose file. + | Outside mount/volume name | Container mount | Description | | ------------------------- | --------------- | --------------------------------- | | `synapse` | `/data` | directory for storage and configs | + ### Ports Set the following ports in the `ports:` section. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ---------------------- | | `8008` | `443` | TCP | matrix homeserver port | + ### rebuild.sh ```sh diff --git a/wiki/docker/mikenye_-_picard.md b/wiki/docker/mikenye_-_picard.md index ac1c163..23b8613 100644 --- a/wiki/docker/mikenye_-_picard.md +++ b/wiki/docker/mikenye_-_picard.md @@ -15,6 +15,7 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards. Set the following variables with the -e tag. + | Name | Usage | Default | | ---------------- | ------------------- | ------- | | `USER_ID` | UserID | `1000` | @@ -22,25 +23,30 @@ Set the following variables with the -e tag. | `DISPLAY_WIDTH` | Width of software | `1280` | | `DISPLAY_HEIGHT` | Height of software | `768` | + ### Volumes Set the following volumes with the -v tag. + | Outside mount/volume name | Container mount | Description | | ------------------------- | --------------- | ------------------------- | | `config` | `/config` | Configuration files | | `media_music` | `/storage` | Location for audio files | + ### Ports Set the following ports with the -p tag. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | -------------------------- | | `5800` | `5800` | TCP | WebUI | | `5900` | `5900` | TCP | VNC | | `8000` | `8000` | TCP | Picard browser integration | + ### rebuild.sh ```sh diff --git a/wiki/docker/mysql.md b/wiki/docker/mysql.md index d9265b1..d678584 100644 --- a/wiki/docker/mysql.md +++ b/wiki/docker/mysql.md @@ -8,7 +8,7 @@ To achieve this in the easiest way use a docker-compose file ## Set-Up -The mysql Docker container is dependent on another container most of the time. +The mysql Docker container is dependent on another container most of the time. The exact setup will be described in the regarding entry. Nevertheless both environment variables and volumes and networks are listed in the sections below. These are needed most often. @@ -18,6 +18,7 @@ These are needed most often. Set the following environment-variables in the `environment:` section of the docker-compose file. + | Name | Usage | Default | | --------------------- | ----------------------------- | ------- | | `MYSQL_ROOT_PASSWORD` | set the mysql admin password | | @@ -25,14 +26,17 @@ docker-compose file. | `MYSQL_PASSWORD` | set the mysql user password | | | `MYSQL_Database` | specify mysql database to use | | + ### Volumes Set the following volumes in the `volumes:` section of the docker-compose file. + | Outside mount/volume name | Container mount | Description | | ------------------------- | ---------------- | ------------------------- | | `mysql` | `/var/lib/mysql` | storage for owncloud data | + ### Networks You can set networks in the `networks:` part of a docker-compose file to connect diff --git a/wiki/docker/nextcloud.md b/wiki/docker/nextcloud.md index 49cc5f7..e34cf6a 100644 --- a/wiki/docker/nextcloud.md +++ b/wiki/docker/nextcloud.md @@ -27,18 +27,22 @@ Updating has to be done manually so nothing breaks. Set the following volumes in the `volumes:` section of the docker-compose file. + | Outside mount/volume name | Container mount | Description | | ------------------------- | --------------- | ---------------------------------------- | | `nextcloud` | `/var/www/html` | storage for nextcloud plugins and config | + ### Ports Set the following ports in the `ports:` section. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ----------- | | `80` | `80` | TCP | WebUI | + ### rebuild.sh ```sh diff --git a/wiki/docker/nginx.md b/wiki/docker/nginx.md index 10c0060..7c2fbf3 100644 --- a/wiki/docker/nginx.md +++ b/wiki/docker/nginx.md @@ -15,19 +15,23 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards. Set the following volumes in the `volumes:` section of the docker-compose file. + | Outside mount/volume name | Container mount | Description | | ------------------------- | -------------------- | --------------------------- | | `nginx` | `/etc/nginx/conf.d/` | directory for nginx configs | + ### Ports Set the following ports in the `ports:` section. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ----------- | | `80` | `80` | TCP | http port | | `443` | `443` | TCP | https port | + ### rebuild.sh ```sh diff --git a/wiki/docker/olbat_-_cupsd.md b/wiki/docker/olbat_-_cupsd.md index 70229aa..3c858d8 100644 --- a/wiki/docker/olbat_-_cupsd.md +++ b/wiki/docker/olbat_-_cupsd.md @@ -13,19 +13,23 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards. Set the following volumes with the -v tag. + | Outside mount/volume name | Container mount | Description | | ------------------------- | --------------- | ------------------------------- | | `cups` | `/etc/cups` | configuration for printers, etc | | `/var/run/dbus` | `/var/run/dbus` | connection to host dbus | + ### Ports Set the following ports with the -p tag. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ----------------- | | `631` | `631` | TCP | cups server webui | + ### Additional The default username is `print`, the default password is `print`. diff --git a/wiki/docker/ollama_-_ollama.md b/wiki/docker/ollama_-_ollama.md index 477b110..a0fb4a8 100644 --- a/wiki/docker/ollama_-_ollama.md +++ b/wiki/docker/ollama_-_ollama.md @@ -13,18 +13,22 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards. Set the following ports in the `ports:` section. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | --------- | ------------------- | | `11434` | `11434` | TCP | Communications port | + ## Volumes Set the following volumes with the -v tag. + | Outside mount/volume name | Container mount | Description | | ------------------------- | --------------- | ------------- | | `ollama` | `/root/.ollama` | Ollama data | + ## rebuild.sh ```sh diff --git a/wiki/docker/open-webui_-_open-webui.md b/wiki/docker/open-webui_-_open-webui.md index 8995c93..044e961 100644 --- a/wiki/docker/open-webui_-_open-webui.md +++ b/wiki/docker/open-webui_-_open-webui.md @@ -13,18 +13,22 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards. Set the following ports in the `ports:` section. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | --------- | ------------- | | `11434` | `8080` | TCP | WebUI | + ## Volumes Set the following volumes with the -v tag. + | Outside mount/volume name | Container mount | Description | | ------------------------- | ------------------- | --------------- | | `open-webui` | `/app/backend/data` | Open WebUI data | + ## rebuild.sh ```sh diff --git a/wiki/docker/owncloud.md b/wiki/docker/owncloud.md index 6342dcf..2fc7697 100644 --- a/wiki/docker/owncloud.md +++ b/wiki/docker/owncloud.md @@ -16,19 +16,23 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards. Set the following volumes in the `volumes:` section of the docker-compose file. + | Outside mount/volume name | Container mount | Description | | ------------------------- | ---------------------- | ---------------------------- | | `owncloud` | `/var/www/html` | storage for ownCloud plugins | | `config` | `/var/www/html/config` | storage for ownCloud config | + ### Ports Set the following ports in the `ports:` section. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ----------- | | `80` | `80` | TCP | WebUI | + ### rebuild.sh ```sh diff --git a/wiki/docker/oznu_-_docker-cloudflare-ddns.md b/wiki/docker/oznu_-_docker-cloudflare-ddns.md index 9a90f10..5831726 100644 --- a/wiki/docker/oznu_-_docker-cloudflare-ddns.md +++ b/wiki/docker/oznu_-_docker-cloudflare-ddns.md @@ -14,12 +14,14 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards. Set the following variables with the -e tag. + | Variable name | Description | | ------------- | ------------------------------------------------------ | | `API_KEY=` | append your API key that you retrieved from cloudflare | | `ZONE=` | append your domain (for example `main.com`) | | `SUBDOMAIN` | append your subdomain (for example `dynamic`) | + ### rebuild.sh ```sh diff --git a/wiki/docker/oznu_-_onedrive.md b/wiki/docker/oznu_-_onedrive.md index 08ed8bb..32942c7 100644 --- a/wiki/docker/oznu_-_onedrive.md +++ b/wiki/docker/oznu_-_onedrive.md @@ -12,20 +12,24 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards. Set the following variables with the -e tag. + | Name | Usage | Default | | ------ | ------- | ------- | | `PUID` | UserID | | | `PGID` | GroupID | | + ### Volumes Set the following volumes with the -v tag. + | Outside mount/volume name | Container mount | Description | | ------------------------- | --------------- | ----------------------------------------------- | | `onedrive_config` | `/config` | configuration storage for the server connection | | `onedrive_doc` | `/documents` | storage for downloaded documents | + ### rebuild.sh ```sh diff --git a/wiki/docker/portainer_-_agent.md b/wiki/docker/portainer_-_agent.md index 9eddf56..44fafe5 100644 --- a/wiki/docker/portainer_-_agent.md +++ b/wiki/docker/portainer_-_agent.md @@ -14,19 +14,23 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards. Set the following volumes with the -v tag. + | Outside mount/volume name | Container mount | Description | | ------------------------- | ------------------------- | -------------------------------------- | | `/var/run/docker.sock` | `/var/run/docker.sock` | connect your running docker containers | | `/var/lib/docker/volumes` | `/var/lib/docker/volumes` | connect running docker volumes | + ### Ports Set the following ports with the -p tag. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | -------------------- | | `9001` | `9001` | TCP | Portainer agent port | + ### rebuild.sh ```sh diff --git a/wiki/docker/portainer_-_portainer.md b/wiki/docker/portainer_-_portainer.md index d65cefc..058b7cc 100644 --- a/wiki/docker/portainer_-_portainer.md +++ b/wiki/docker/portainer_-_portainer.md @@ -14,19 +14,23 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards. Set the following volumes with the -v tag. + | Outside mount/volume name | Container mount | Description | | ------------------------- | ---------------------- | ------------------------------------------------- | | `portainer` | `/data` | configuration directory | | `/var/run/docker.sock` | `/var/run/docker.sock` | connection to local docker containers and volumes | + ### Ports Set the following ports with the -p tag. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ----------- | | `9000` | `9000` | TCP | WebUI | + ### rebuild.sh ```sh diff --git a/wiki/docker/postgres.md b/wiki/docker/postgres.md index 7c91452..42fe435 100644 --- a/wiki/docker/postgres.md +++ b/wiki/docker/postgres.md @@ -8,7 +8,7 @@ To achieve this in the easiest way use a docker-compose file ## Set-Up -The postgres Docker container is dependent on another container most of the time. +The postgres Docker container is dependent on another container most of the time. The exact setup will be described in the regarding entry. Nevertheless both environment variables and volumes are listed in the sections below. Nevertheless both environment variables and volumes and networks are listed in the sections below. @@ -19,6 +19,7 @@ These are needed most often. Set the following environment-variables in the `environment:` section of the docker-compose file. + | Name | Usage | Default | | ------------------------ | -------------------------------- | ------- | | `POSTGRES_ROOT_PASSWORD` | set the postgres admin password | | @@ -26,15 +27,18 @@ docker-compose file. | `POSTGRES_PASSWORD` | set the postgres user password | | | `POSTGRES_DB` | specify postgres database to use | | + ### Volumes Set the following volumes in the `volumes:` section of the docker-compose file. + | Outside mount/volume name | Container mount | Description | | ------------------------- | -------------------------- | ---------------------------- | | `postgres` | `/var/lib/postgresql/data` | storage for owncloud data | | `postgres_config` | `/config/sql` | initial sql setup and config | + ### Networks You can set networks in the `networks:` part of a docker-compose file to connect diff --git a/wiki/docker/prologic_-_golinks.md b/wiki/docker/prologic_-_golinks.md index be24f57..0b518bb 100644 --- a/wiki/docker/prologic_-_golinks.md +++ b/wiki/docker/prologic_-_golinks.md @@ -14,18 +14,22 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards. Set the following volumes with the -v tag. + | Outside mount/volume name | Container mount | Description | | ------------------------- | --------------- | -------------------------- | | `golinks` | `/search.db` | database with all commands | + ### Ports Set the following ports with the -p tag. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ----------- | | `8000` | `8000` | TCP | WebUI | + ### rebuild.sh ```sh diff --git a/wiki/docker/prologic_-_gopherproxy.md b/wiki/docker/prologic_-_gopherproxy.md index 642bcdd..14ef716 100644 --- a/wiki/docker/prologic_-_gopherproxy.md +++ b/wiki/docker/prologic_-_gopherproxy.md @@ -13,18 +13,22 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards. Set the following ports with the -p tag. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ---------------------------------------- | | `8000` | `8000` | TCP | port to proxy the gopher site as http to | + ### Additional There are some special variables to set. + | Flag | Usage | | ------ | ------------------------------------------------------------- | | `-uri` | define the gopher site to proxy (just 'domain.tld' is enough) | + ### rebuild.sh ```sh diff --git a/wiki/docker/prologic_-_todo.md b/wiki/docker/prologic_-_todo.md index f6922a9..89f410a 100644 --- a/wiki/docker/prologic_-_todo.md +++ b/wiki/docker/prologic_-_todo.md @@ -13,18 +13,22 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards. Set the following volumes with the -v tag. + | Outside mount/volume name | Container mount | Description | | ------------------------- | ---------------------- | ---------------------- | | `todo` | `/go/src/todo/todo.db` | Database for todo list | + ### Ports Set the following ports with the -p tag. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ----------- | | `8000` | `8000` | TCP | WebUI | + ### rebuild.sh ```sh diff --git a/wiki/docker/rblsb_-_synctube.md b/wiki/docker/rblsb_-_synctube.md index 55d49a0..791b99f 100644 --- a/wiki/docker/rblsb_-_synctube.md +++ b/wiki/docker/rblsb_-_synctube.md @@ -19,18 +19,22 @@ Set the variables, volumes and ports according and run the `rebuild.sh`. Set the following volumes with the -v tag. + | Outside mount/volume name | Container mount | Description | | ------------------------- | ------------------- | ------------------- | | `synctube` | `/usr/src/app/user` | Configuration files | + ### Ports Set the following ports with the -p tag. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ----------- | | `4200` | `4200` | TCP | WebUI | + ### rebuild.sh ```sh diff --git a/wiki/docker/redis.md b/wiki/docker/redis.md index 7e93a3e..0788ef2 100644 --- a/wiki/docker/redis.md +++ b/wiki/docker/redis.md @@ -8,7 +8,7 @@ To achieve this in the easiest way use a docker-compose file. ## Set-Up -The redis Docker container is dependent on another container most of the time. +The redis Docker container is dependent on another container most of the time. The exact setup will be described in the regarding entry. Nevertheless both volumes and networks are listed in the sections below. These are needed most often. @@ -18,10 +18,12 @@ These are needed most often. Set the following volumes in the `volumes:` section of the docker-compose file. + | Outside mount/volume name | Container mount | Description | | ------------------------- | --------------- | -------------------- | | `redis` | `/data` | storage for all data | + ### Networks You can set networks in the `networks:` part of a docker-compose file to connect diff --git a/wiki/docker/rlister_-_hastebin.md b/wiki/docker/rlister_-_hastebin.md index 2f27c47..9121196 100644 --- a/wiki/docker/rlister_-_hastebin.md +++ b/wiki/docker/rlister_-_hastebin.md @@ -13,26 +13,32 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards. Set the following variables with the -e tag. + | Name | Usage | Default | | -------------- | ----------------------- | ------- | | `STORAGE_TYPE` | Type to store the datas | `file` | + ### Volumes Set the following volumes with the -v tag. + | Outside mount/volume name | Container mount | Description | | ------------------------- | --------------- | -------------------------- | | `hastebin` | `/app/data` | storage directory for data | + ### Ports Set the following ports with the -p tag. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ----------- | | `7777` | `7777` | TCP | WebUI | + ### rebuild.sh ```sh diff --git a/wiki/docker/samba.md b/wiki/docker/samba.md index 3e66bd1..5dd0c68 100644 --- a/wiki/docker/samba.md +++ b/wiki/docker/samba.md @@ -14,6 +14,7 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards. Set the following volumes with the -v tag. + | Outside mount/volume name | Container mount | Description | | ------------------------- | ------------------ | ----------------------------- | | `samba_nas` | `/nas` | storage for samba data | @@ -23,25 +24,30 @@ Set the following volumes with the -v tag. | `samba_etc` | `/etc` | etc directory of samba server | | `samba_log` | `/var/log/samba` | storage for samba logs | + ### Ports Set the following ports with the -p tag. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | -------------- | | `139` | `139` | TCP | Samba internal | | `445` | `445` | TCP | Samba internal | + ### Additional There are some special variables to set. + | Flag | Usage | | ------------------------------------------------------------------------- | ---------------- | | `-u \(;ID;group;GID)` | define user | | `-w \` | define workgroup | | `-s \(;browse;readonly;guest;users;admins;writelist;comment)` | define shares | + ### rebuild.sh ```sh diff --git a/wiki/docker/searx_-_searx.md b/wiki/docker/searx_-_searx.md index 38ad1ca..f4886b9 100644 --- a/wiki/docker/searx_-_searx.md +++ b/wiki/docker/searx_-_searx.md @@ -14,19 +14,23 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards. Set the following volumes with the -v tag. + | Outside mount/volume name | Container mount | Description | | ------------------------- | ---------------- | ---------------- | | `searx_etc` | `/etc/searx` | storage for etc | | `searx_log` | `/var/log/uwsgi` | storage for logs | + ### Ports Set the following ports with the -p tag. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ----------- | | `8080` | `8080` | TCP | WebUI | + ### rebuild.sh ```sh diff --git a/wiki/docker/sinusbot_-_docker.md b/wiki/docker/sinusbot_-_docker.md index 220a9ff..42c6bdf 100644 --- a/wiki/docker/sinusbot_-_docker.md +++ b/wiki/docker/sinusbot_-_docker.md @@ -31,7 +31,7 @@ networks: external: true ``` -Finally make sure to create the external network `teamspeak` before starting the containers. +Finally, make sure to create the external network `teamspeak` before starting the containers. This can be done by running the following command. ```sh @@ -47,32 +47,39 @@ Change the other settings according to your needs and run `./rebuild.sh` afterwa Set the following environment-variables in the `environment:` section of the docker-compose file. + | Name | Usage | Default | | ----------- | ------------------------------ | ------- | | `UID` | User userid to run gitea | | | `GID` | User groupid to run gitea | | + ### Volumes Set the following volumes in the `volumes:` section of the docker-compose file. + | Outside mount/volume name | Container mount | Description | | ------------------------- | ----------------------- | ------------------------------------- | | `sinusbot_scripts` | `/opt/sinusbot/scripts` | storage for the sinusbot scripts | | `sinusbot_data` | `/opt/sinusbot/data` | storage for the most of sinusbot data | + ### Ports Set the following ports in the `ports:` section. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ---------------------- | | `8087` | `8087` | TCP | WebUI | + ### Networks Set the following networks in the `networks:` section of the docker-compose file. + | Name | Usage | | ----------- | ---------------------------- | | `teamspeak` | connect with local teamspeak | diff --git a/wiki/docker/sissbrueckner_-_linkding.md b/wiki/docker/sissbrueckner_-_linkding.md index c7731bd..245ebf2 100644 --- a/wiki/docker/sissbrueckner_-_linkding.md +++ b/wiki/docker/sissbrueckner_-_linkding.md @@ -8,8 +8,8 @@ The official container and documentation was made by ## Set-up Create the file `rebuild.sh`. -Change the settings according to your needs and run `./rebuild.sh` afterwards. -Afterwards you need to create a user. +Change the settings according to your needs and run `./rebuild.sh` afterward. +Afterward, you need to create a user. This can be done by running the following line with changed credentials: ```sh @@ -22,18 +22,22 @@ You will be asked for a password via the commandline. Set the following volumes with the -v tag. + | Outside mount/volume name | Container mount | Description | | ------------------------- | ---------------------- | --------------------------- | | `linkding` | `/etc/linkding/data` | storage for persistent data | + ### Ports Set the following ports with the -p tag. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ----------- | | `9090` | `9090` | TCP | WebUI | + ### rebuild.sh ```sh diff --git a/wiki/docker/spikecodes_-_libreddit.md b/wiki/docker/spikecodes_-_libreddit.md index 4942ae7..5653ed8 100755 --- a/wiki/docker/spikecodes_-_libreddit.md +++ b/wiki/docker/spikecodes_-_libreddit.md @@ -14,10 +14,12 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards. Set the following ports with the -p tag. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ----------- | | `8080` | `8080` | TCP | WebUI | + ### rebuild.sh ```sh diff --git a/wiki/docker/teamspeak.md b/wiki/docker/teamspeak.md index 553d7bc..b581d3e 100644 --- a/wiki/docker/teamspeak.md +++ b/wiki/docker/teamspeak.md @@ -14,28 +14,34 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards. Set the following variables with the -e tag. + | Name | Usage | Default | | ------------------- | ---------------------------- | ------- | | `TS3SERVER_LICENSE` | accept the license agreement | | + ### Volumes Set the following volumes with the -v tag. + | Outside mount/volume name | Container mount | Description | | ------------------------- | ---------------- | --------------------------- | | `teamspeak3` | `/var/ts3server` | storage for ts3-server data | + ### Ports Set the following ports with the -p tag. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ----------- | | `9987` | `9987` | UDP | ts3-intern | | `10011` | `10011` | TCP | ts3-intern | | `30033` | `30033` | TCP | ts3-intern | + ### rebuild.sh ```sh diff --git a/wiki/docker/tetricz_-_mordhau-server.md b/wiki/docker/tetricz_-_mordhau-server.md index 22d3c87..da110d3 100644 --- a/wiki/docker/tetricz_-_mordhau-server.md +++ b/wiki/docker/tetricz_-_mordhau-server.md @@ -15,6 +15,8 @@ With `stop.sh` you can stop it. Set the following variables with the -e tag. + + | Name | Usage | Default | | ----------------- | ------------------------------------------- | ------- | | `QUERYPORT` | port for query mordhau | | @@ -30,24 +32,29 @@ Set the following variables with the -e tag. | `SERVER_PASSWORD` | set a password | | | `ADMIN_PASSWORD` | set an admin password | | + ### Volumes Set the following volumes with the -v tag. + | Outside mount/volume name | Container mount | Description | | ------------------------- | ---------------------- | ---------------------------------------- | | `mordhau` | `/serverdata/mordhau` | storage for mordhau server relevant data | | `mordhau_steamcmd` | `/serverdata/steamcmd` | storage for steam related data | + ### Ports Set the following ports with the -p tag. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ----------------- | | `7777` | `7777` | UDP | mordhau internal | | `15000` | `15000` | UDP | mordhau internal | | `27015` | `27015` | UDP | mordhau internal | + ### start.sh ```sh diff --git a/wiki/docker/tombursch_-_kitchenowl.md b/wiki/docker/tombursch_-_kitchenowl.md index c885c04..409a931 100644 --- a/wiki/docker/tombursch_-_kitchenowl.md +++ b/wiki/docker/tombursch_-_kitchenowl.md @@ -18,18 +18,22 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards. Set the following ports in the `ports:` section. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ----------- | | `7890` | `80` | TCP | WebUI | + ### Volumes Set the following volumes with the -v tag. + | Outside mount/volume name | Container mount | Description | | ------------------------- | -------------------------- | ------------------------ | | `kitchenowl_data` | `/data` | storage for all data | + ### rebuild.sh ```sh diff --git a/wiki/docker/tomsquest_-_docker-radicale.md b/wiki/docker/tomsquest_-_docker-radicale.md index 5429b21..65d8da2 100644 --- a/wiki/docker/tomsquest_-_docker-radicale.md +++ b/wiki/docker/tomsquest_-_docker-radicale.md @@ -18,27 +18,33 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards. Set the following volumes with the -v tag. + | Outside mount/volume name | Container mount | Description | | ------------------------- | --------------- | --------------------------- | | `radicale_data` | `/data` | storage for caldav | | `radicale_config` | `/config` | storage for radicale config | + ### Ports Set the following ports with the -p tag. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ------------- | | `5232` | `5232` | TCP | WebUI, caldav | + ### Additional There are some special variables to set. + | Flag | Usage | | ------------- | ---------------------------------------------------------------------- | | `--read-only` | make Radicale read-only, caldav can still be changed and used normally | + ### rebuild.sh ```sh diff --git a/wiki/docker/traefik.md b/wiki/docker/traefik.md index a9bdea3..e486aba 100644 --- a/wiki/docker/traefik.md +++ b/wiki/docker/traefik.md @@ -19,6 +19,7 @@ the [Traefik wiki entry](/wiki/traefik.md#usage). Set the following volumes in the `volumes:` section of the docker-compose file. + | Outside mount/volume name | Container mount | Description | | ------------------------- | ------------------------- | --------------------------------------- | | `/etc/localtime` | `/etc/localtime:ro` | get the system time | @@ -27,23 +28,28 @@ Set the following volumes in the `volumes:` section of the docker-compose file. | `./data/acme.json` | `/acme.json` | place to store certificates for https | | `./data/config` | `/configurations` | place for dynamically changable configs | + ### Ports Set the following ports in the `ports:` section. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ----------- | | `80` | `80` | TCP | http | | `443` | `443` | TCP | https | + ### Networks Set the following networks in the `networks:` section of the docker-compose file. + | Name | Usage | | ------- | -------------------------------------- | | `proxy` | network to expose http and https ports | + ### Labels Set the following labels in the `labels:` section. diff --git a/wiki/docker/vabene1111_-_recipes.md b/wiki/docker/vabene1111_-_recipes.md index 314d664..db7b4dd 100644 --- a/wiki/docker/vabene1111_-_recipes.md +++ b/wiki/docker/vabene1111_-_recipes.md @@ -19,19 +19,23 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards. Set the following ports in the `ports:` section. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ----------- | | `8083` | `8080` | TCP | WebUI | + ### Volumes Set the following volumes with the -v tag. + | Outside mount/volume name | Container mount | Description | | ------------------------- | -------------------------- | ------------------------ | | `staticfiles` | `/opt/recipes/staticfiles` | storage for static files | | `mediafiles` | `/opt/recipes/mediafiles` | storage for media files | + ### rebuild.sh ```sh diff --git a/wiki/docker/vectorim_-_riot-web.md b/wiki/docker/vectorim_-_riot-web.md index 03bdadd..c6160c5 100644 --- a/wiki/docker/vectorim_-_riot-web.md +++ b/wiki/docker/vectorim_-_riot-web.md @@ -15,18 +15,22 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards. Set the following volumes in the `volumes:` section of the docker-compose file. + | Outside mount/volume name | Container mount | Description | | ------------------------- | --------------------- | ----------- | | `./config.json` | `/app/config.json:ro` | config file | + ### Ports Set the following ports in the `ports:` section. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ----------- | | `80` | `80` | TCP | WebUI | + ### rebuild.sh ```sh diff --git a/wiki/docker/ventz_-_bind.md b/wiki/docker/ventz_-_bind.md index 917efac..b2d0e48 100644 --- a/wiki/docker/ventz_-_bind.md +++ b/wiki/docker/ventz_-_bind.md @@ -14,28 +14,34 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards. Set the following volumes with the -v tag. + | Outside mount/volume name | Container mount | Description | | ------------------------- | ----------------- | --------------------- | | `bind_cache` | `/var/cache/bind` | cache for DNS | | `bind_etc` | `/etc/bind` | configuration for DNS | + ### Ports Set the following ports with the -p tag. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ----------------- | | `53` | `53` | TCP | DNS protocol port | | `53` | `53` | UDP | DNS protocol port | + ### Additional There are some special variables to set. + | Flag | Usage | | ------- | ------------------------------------------------------- | | `--dns` | set two of these flags for specific DNS forward servers | + ### rebuild.sh ```sh diff --git a/wiki/docker/viperproject_-_viperserver.md b/wiki/docker/viperproject_-_viperserver.md index 8a83730..cd0f32d 100644 --- a/wiki/docker/viperproject_-_viperserver.md +++ b/wiki/docker/viperproject_-_viperserver.md @@ -14,7 +14,7 @@ Due to this container being used to build the Silicon and Carbon verifiers it is started in interactive mode as demonstrated in the [rebuild section](#rebuildsh). Make sure to substitute `` and ``. If only one of them is to be built, omit the other. -Additionally the version of viperproject has to be added for ``. +Additionally, the version of viperproject has to be added for ``. It also depends on the Z3 version which will be used later. For example the version `v4_z3_4.8.7` is working for Z3 versions `4.8.7` and later. @@ -22,11 +22,13 @@ For example the version `v4_z3_4.8.7` is working for Z3 versions `4.8.7` and lat Set the following volumes with the -v tag. + | Outside mount/volume name | Container mount | Description | | ------------------------- | --------------- | ----------------------------------------- | | `` | `/mnt/silicon` | (optional) mount Silicon for installation | | `` | `/mnt/carbon` | (optional) mount Carbon for installation | + ## rebuild.sh ```sh diff --git a/wiki/docker/wabayang_-_jelu.md b/wiki/docker/wabayang_-_jelu.md index 0f80583..cc891f9 100644 --- a/wiki/docker/wabayang_-_jelu.md +++ b/wiki/docker/wabayang_-_jelu.md @@ -19,14 +19,17 @@ The environment variables are set via the `.env` file and listed in the Set the following ports in the `ports:` section. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | --------- | ------------- | | `11111` | `11111` | TCP | WebUI | + ### Volumes Set the following volumes with the -v tag. + | Outside mount/volume name | Container mount | Description | | ------------------------- | ------------------ | ------------------- | | `config` | `/config` | configuration files | @@ -35,6 +38,7 @@ Set the following volumes with the -v tag. | `files_imports` | `/files/imports` | path for imports | | `/etc/timezone` | `/etc/timezone:ro` | Timezone | + ### rebuild.sh ```sh diff --git a/wiki/docker/wallabag_-_wallabag.md b/wiki/docker/wallabag_-_wallabag.md index 622a972..f404608 100644 --- a/wiki/docker/wallabag_-_wallabag.md +++ b/wiki/docker/wallabag_-_wallabag.md @@ -16,6 +16,7 @@ Change the settings according to your needs and run `./rebuild.sh` afterward. Set the following environment-variables in the `environment:` section of the docker-compose file. + | Name | Usage | Default | | --------------------------------- | ---------------------------------------- | ---------------------------------------- | | `MYSQL_ROOT_PASSWORD` | Password for the mySQL root user | | @@ -33,22 +34,27 @@ docker-compose file. | `SYMFONY__ENV__DOMAIN_NAME` | URL to wallabag instance | `https://your-wallabag-url-instance.com` | | `SYMFONY__ENV__SERVER_NAME` | Name for the wallabag server | `Your wallabag instance` | + ### Volumes Set the following volumes in the `volumes:` section of the docker-compose file. + | Outside mount/volume name | Container mount | Description | | ------------------------- | ------------------------------------- | -------------------------------- | | `wallabag_wallabag` | `/var/www/wallabag/web/assets/images` | storage for wallabag config data | + ### Ports Set the following ports in the `ports:` section. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ----------- | | `80` | `80` | TCP | WebUI | + ### rebuild.sh ```sh diff --git a/wiki/docker/xy2z_-_pinedocs.md b/wiki/docker/xy2z_-_pinedocs.md index c98b0da..2145aa7 100644 --- a/wiki/docker/xy2z_-_pinedocs.md +++ b/wiki/docker/xy2z_-_pinedocs.md @@ -13,18 +13,22 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards. Set the following volumes with the -v tag. + | Outside mount/volume name | Container mount | Description | | ------------------------- | --------------- | -------------------- | | `pinedocs` | `/data` | storage for pinedocs | + ### Ports Set the following ports with the -p tag. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ----------- | | `80` | `80` | TCP | WebUI | + ### rebuild.sh ```sh diff --git a/wiki/docker/yourls.md b/wiki/docker/yourls.md index 921e6a2..81ad132 100644 --- a/wiki/docker/yourls.md +++ b/wiki/docker/yourls.md @@ -14,6 +14,7 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards. Set the following variables with the -e tag. + | Name | Usage | Default | | ---------------- | -------------------------- | ------- | | `YOURLS_DB_PASS` | database password | | @@ -21,22 +22,27 @@ Set the following variables with the -e tag. | `YOURLS_USER` | username for YOURLS admin | | | `YOURLS_PASS` | password for YOURLS admin | | + ### Volumes Set the following volumes with the -v tag. + | Outside mount/volume name | Container mount | Description | | ------------------------- | --------------- | -------------------- | | `yourls` | `/var/www/html` | YOURLS specific HTML | + ### Ports Set the following ports with the -p tag. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ----------------- | | `80` | `80` | TCP | dns protocol port | + ### rebuild.sh ```sh diff --git a/wiki/docker/zedeus_-_nitter.md b/wiki/docker/zedeus_-_nitter.md index 6dff296..08d269f 100755 --- a/wiki/docker/zedeus_-_nitter.md +++ b/wiki/docker/zedeus_-_nitter.md @@ -15,18 +15,22 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards. Set the following volumes with the -v tag. + | Outside mount/volume name | Container mount | Description | | ------------------------- | --------------- | ------------------------- | | `nitter` | `/data` | storage for all of nitter | + ### Ports Set the following ports with the -p tag. + | Container Port | Recommended outside port | Protocol | Description | | -------------- | ------------------------ | -------- | ----------- | | `8080` | `8080` | TCP | WebUI | + ### rebuild.sh ```sh diff --git a/wiki/electron.md b/wiki/electron.md index 5ed7422..526eda2 100644 --- a/wiki/electron.md +++ b/wiki/electron.md @@ -29,14 +29,14 @@ For the Gnome Keyring install the [packages](/wiki/linux/package_manager.md) `li `gnome-keyring`. The name may differ slightly depending on the [package manager](/wiki/linux/package_manager.md) used. -Afterwards make sure to run the service and enable it if not already done. +Afterward, make sure to run the service and enable it if not already done. An example for this is shown in the following command ```sh eval $(/usr/bin/gnome-keyring-daemon --start) ``` -Finally the Electron app `` can be started. +Finally, the Electron app `` can be started. For the secure credential storage to be reachable the environment variable `XDG_CURRENT_DESKTOP` has to be set. Due to this environment variable being possibly relevant for the system-wide settings it is diff --git a/wiki/emulator/citra.md b/wiki/emulator/citra.md index af485c4..dc0862c 100644 --- a/wiki/emulator/citra.md +++ b/wiki/emulator/citra.md @@ -1,11 +1,10 @@ # Citra -[Citra](https://citra-emu.org/) is a [Nintendo 3DS](/wiki/game.md) -[emulator](/wiki/emulator.md). +[Citra](https://citra-emu.org/) is a [Nintendo 3DS](/wiki/game.md) [emulator](/wiki/emulator.md). ## Setup -Citra can be installed on different systems, a list for this can be found on -the [Citra website](https://citra-emu.org/download). -Additionally it can be installed using [Flatpak](/wiki/linux/flatpak.md) where the -package is called `org.citra_emu.citra`. +Citra can be installed on different systems, a list for this can be found on the +[Citra website](https://citra-emu.org/download). +Additionally, it can be installed using [Flatpak](/wiki/linux/flatpak.md) where the package is +called `org.citra_emu.citra`. diff --git a/wiki/emulator/dolphin.md b/wiki/emulator/dolphin.md index d6afdd4..afab0fa 100644 --- a/wiki/emulator/dolphin.md +++ b/wiki/emulator/dolphin.md @@ -7,7 +7,7 @@ Dolphin can be installed on different systems, a list for this can be found on the [Dolphin website](https://dolphin-emu.org/download/). -Additionally it can be installed using [Flatpak](/wiki/linux/flatpak.md) where the +Additionally, it can be installed using [Flatpak](/wiki/linux/flatpak.md) where the package is called `org.DolphinEmu.dolphin-emu`. ## Usage diff --git a/wiki/emulator/melonds.md b/wiki/emulator/melonds.md index eddd2cd..5b2565f 100644 --- a/wiki/emulator/melonds.md +++ b/wiki/emulator/melonds.md @@ -5,10 +5,10 @@ ## Setup -melonDS can be installed on different systems, a list for this can be found on -the [melonDS website](https://melonds.kuribo64.net/downloads.php). -Additionally it can be installed using [Flatpak](/wiki/linux/flatpak.md) where the -package is called `net.kuribo64.melonDS`. +melonDS can be installed on different systems, a list for this can be found on the +[melonDS website](https://melonds.kuribo64.net/downloads.php). +Additionally, it can be installed using [Flatpak](/wiki/linux/flatpak.md) where the package is +called `net.kuribo64.melonDS`. ## Usage @@ -17,8 +17,8 @@ and usage of Dolphin. ### Start Emulated Game in Fullscreen Mode -In different scenarios it can be useful to start directly into a game in fullscreen mode. +In different scenarios it can be useful to start directly into a game in full screen mode. One example would be using the [Steam Deck](/wiki/game/steam_deck.md) to [set up a game in the Steam UI](/wiki/game/steam_deck.md#running-a-game-directly-through-the-interface) so it can be run directly without switching to the desktop mode. -For this add the `-f` flag for fullscreen mode. +For this add the `-f` flag for full screen mode. diff --git a/wiki/emulator/mgba.md b/wiki/emulator/mgba.md index 42f4c36..acd50f9 100644 --- a/wiki/emulator/mgba.md +++ b/wiki/emulator/mgba.md @@ -8,7 +8,7 @@ mGBA can be installed on different systems, a list for this can be found on the [mGBA website](https://mgba.io/downloads.html). -Additionally it can be installed using [Flatpak](/wiki/linux/flatpak.md) where the +Additionally, it can be installed using [Flatpak](/wiki/linux/flatpak.md) where the package is called `io.mgba.mgba`. ## Usage diff --git a/wiki/emulator/nestopia.md b/wiki/emulator/nestopia.md index 874dbf7..69b4cb0 100644 --- a/wiki/emulator/nestopia.md +++ b/wiki/emulator/nestopia.md @@ -7,5 +7,5 @@ Nestopia can be installed on different systems, a list for this can be found on the [Nestopia website](http://0ldsk00l.ca/nestopia/). -Additionally it can be installed using [Flatpak](/wiki/linux/flatpak.md) where the +Additionally, it can be installed using [Flatpak](/wiki/linux/flatpak.md) where the package is called `ca._0ldsk00l.Nestopia`. diff --git a/wiki/emulator/pcsx2.md b/wiki/emulator/pcsx2.md index 0711f9a..dae2979 100644 --- a/wiki/emulator/pcsx2.md +++ b/wiki/emulator/pcsx2.md @@ -5,7 +5,7 @@ ## Setup -PCSX2 can be installed on different systems, a list for this can be found on -the [PCSX2 website](https://pcsx2.net/downloads). -Additionally it can be installed using [Flatpak](/wiki/linux/flatpak.md) where the +PCSX2 can be installed on different systems, a list for this can be found on the +[PCSX2 website](https://pcsx2.net/downloads). +Additionally, it can be installed using [Flatpak](/wiki/linux/flatpak.md) where the package is called `net.pcsx2.PCSX2`. diff --git a/wiki/emulator/ppsspp.md b/wiki/emulator/ppsspp.md index 7b47ecd..7b0393c 100644 --- a/wiki/emulator/ppsspp.md +++ b/wiki/emulator/ppsspp.md @@ -7,7 +7,7 @@ PPSSPP can be installed on different systems, a list for this can be found on the [PPSSPP website](https://ppsspp.org/downloads.html). -Additionally it can be installed using [Flatpak](/wiki/linux/flatpak.md) where the +Additionally, it can be installed using [Flatpak](/wiki/linux/flatpak.md) where the package is called `org.ppsspp.PPSSPP`. ## Usage diff --git a/wiki/emulator/simple64.md b/wiki/emulator/simple64.md index f8efe3f..6bcaee0 100644 --- a/wiki/emulator/simple64.md +++ b/wiki/emulator/simple64.md @@ -5,7 +5,7 @@ ## Setup -simple64 can be installed on different systems, a list for this can be found on -the [simple64 website](https://simple64.github.io/). -Additionally it can be installed using [Flatpak](/wiki/linux/flatpak.md) where the -package is called `https://flathub.org/apps/io.github.simple64.simple64`. +simple64 can be installed on different systems, a list for this can be found on the +[simple64 website](https://simple64.github.io/). +Additionally, it can be installed using [Flatpak](/wiki/linux/flatpak.md) where the package is +called `https://flathub.org/apps/io.github.simple64.simple64`. diff --git a/wiki/emulator/snes9x.md b/wiki/emulator/snes9x.md index d0b970e..9273d0f 100644 --- a/wiki/emulator/snes9x.md +++ b/wiki/emulator/snes9x.md @@ -7,5 +7,5 @@ Snes9x can be installed on different systems, a list for this can be found on the [Snes9x website](http://www.snes9x.com/). -Additionally it can be installed using [Flatpak](/wiki/linux/flatpak.md) where the +Additionally, it can be installed using [Flatpak](/wiki/linux/flatpak.md) where the package is called `com.snes9x.Snes9x`. diff --git a/wiki/emulator/yuzu.md b/wiki/emulator/yuzu.md index a461f9c..de5ee29 100644 --- a/wiki/emulator/yuzu.md +++ b/wiki/emulator/yuzu.md @@ -7,7 +7,7 @@ yuzu can be installed on different systems, a list for this can be found on the [yuzu website](https://yuzu-emu.org/downloads/#windows). -Additionally it can be installed using [Flatpak](/wiki/linux/flatpak.md) where the +Additionally, it can be installed using [Flatpak](/wiki/linux/flatpak.md) where the package is called `org.yuzu_emu.yuzu`. After installation keys need to be added. diff --git a/wiki/firefox.md b/wiki/firefox.md index 9fe3123..ff95465 100644 --- a/wiki/firefox.md +++ b/wiki/firefox.md @@ -317,7 +317,7 @@ censoring tool set the following config. security.family_safety.mode = 0 ``` -Additionally check [the telemetry section](#telemetry) and +Additionally, check [the telemetry section](#telemetry) and [the sponsoring section](#sponsorings). ## Troubleshooting diff --git a/wiki/game.md b/wiki/game.md index 01e562d..8b58390 100644 --- a/wiki/game.md +++ b/wiki/game.md @@ -45,7 +45,7 @@ First set up Syncthing as described in the If a system with only user access - like the [Steam Deck](/wiki/game/steam_deck.md) - is used the [user space configuration](/wiki/syncthing.md#user-space-configuration-for-linux) is recommended. -Afterwards move the game saves to the directory set up by Syncthing and create +Afterward, move the game saves to the directory set up by Syncthing and create [symbolic links](/wiki/linux/shell.md#symbolic-links-using-ln) to link them back to the original place. diff --git a/wiki/game/guild_wars_2.md b/wiki/game/guild_wars_2.md index dd489a9..339db94 100644 --- a/wiki/game/guild_wars_2.md +++ b/wiki/game/guild_wars_2.md @@ -26,7 +26,7 @@ The second group provides guides and builds. - [Snow Crows](https://snowcrows.com/builds) is a guild that provides guides and builds that are especially well suited for instanced PvE content. -Finally the this group provides various guides and gives information on in-game mechanics. +Finally, the this group provides various guides and gives information on in-game mechanics. - [\[fast\] Farming Community](https://fast.farming-community.eu/) is a guild that provides many useful trackers for items, dailies and more. @@ -41,7 +41,7 @@ Guild Wars 2 features a large add-on community. All add-ons described in this guide will assume [gw2-add-on-loader](#gw2-add-on-loader) is already installed. It has to be set up first if not already done. -Additionally this guide assumes the usage of DX11 rendering which is enabled by +Additionally, this guide assumes the usage of DX11 rendering which is enabled by default. Many of the following add-ons are on the [Approved-Addons list by gw2-addon-loader](https://github.com/gw2-addon-loader/Approved-Addons). diff --git a/wiki/game/lutris.md b/wiki/game/lutris.md index e8054e6..e782845 100644 --- a/wiki/game/lutris.md +++ b/wiki/game/lutris.md @@ -3,16 +3,13 @@ [Lutris](https://lutris.net/) is a free and open source video [game](/wiki/game.md) platform for [Linux](/wiki/linux.md) systems. It features compatibility with [GOG](https://www.gog.com/), -[Humble Bundle](https://humblebundle.com/), -[Epic Games](https://www.epicgames.com/), [Steam](/wiki/game/steam.md) and many -other [Windows](/wiki/windows.md) games via its own installer that uses -[WINE](/wiki/linux/wine.md). Lutris can also use [Proton](/wiki/game/proton.md) -- a patched version of WINE developed by +[Humble Bundle](https://humblebundle.com/), [Epic Games](https://www.epicgames.com/), +[Steam](/wiki/game/steam.md) and many other [Windows](/wiki/windows.md) games via its own installer +that uses [WINE](/wiki/linux/wine.md). +Lutris can also use [Proton](/wiki/game/proton.md) - a patched version of WINE developed by [Valve](https://www.valvesoftware.com/). -Additionally to that Lutris supports many different -[emulators](/wiki/emulator.md). -For running both Windows applications aswell as games -[Bottles](/wiki/game/bottles.md) can be used. +Additionally, to that Lutris supports many different [emulators](/wiki/emulator.md). +For running both Windows applications aswell as games [Bottles](/wiki/game/bottles.md) can be used. ## Usage @@ -20,48 +17,41 @@ The following section describes the usage of Lutris. ### Manually Add a Game -By clicking on the `+` in the left upper corner of the Lutris application a new -game can be manually added. +By clicking on the `+` in the left upper corner of the Lutris application a new game can be +manually added. Mount `.iso` files as explained in the [ISO image entry](/wiki/linux/iso_image.md#mounting). Some installations require the swapping of discs during the installation. -An easy way around this is to mount the [ISO image](/wiki/linux/iso_image.md#mounting) and copy them -into another directory. +An easy way around this is to mount the [ISO image](/wiki/linux/iso_image.md#mounting) and copy +them into another directory. This way the files from two discs can be put in one folder. -Afterwards follow the installation as usual. +Afterward, follow the installation as usual. If a setup executable is available select `Install a Windows game from media`. Then select the setup executable from the mounted path. And proceed with the installation. -Lutris will automatically pick the correct executable to start the game after -setup. +Lutris will automatically pick the correct executable to start the game after setup. -For non-setup `.exe` files of completely downloaded games select -`Add locally installed game`. -Make sure to select the runner [WINE](/wiki/linux/wine.md) for the game in the -following window. +For non-setup `.exe` files of completely downloaded games select `Add locally installed game`. +Make sure to select the runner [WINE](/wiki/linux/wine.md) for the game in the following window. Make sure to set the `Wine prefix` to the desired location. Select the `Working directory` to be the location of the downloaded game. -For cleanup afterwards the game can be moved into the WINE prefix folder as if -it was installed inside Windows. -If so make sure to point the `Executable` after right-clicking the game and -selecting `Configure` to the right location and remove the `Working directory` -entry as it is not needed if the executable is inside the WINE prefix. +For cleanup afterward the game can be moved into the WINE prefix folder as if it was installed +inside Windows. +If so make sure to point the `Executable` after right-clicking the game and selecting `Configure` +to the right location and remove the `Working directory` entry as it is not needed if the +executable is inside the WINE prefix. ### Setting Environment Variables Environment variables can be set globally or on a per game basis. To set them globally navigate to the `Global options` tab in the `Preferences`. -There the `Environment variables` can be added and removed by selecting the -corresponding buttons. -To set the environment variables for a single game right-click the game and -select `Configure`. -Navigate to the `System options` tab where the `Environment variables` can be -found. +There the `Environment variables` can be added and removed by selecting the corresponding buttons. +To set the environment variables for a single game right-click the game and select `Configure`. +Navigate to the `System options` tab where the `Environment variables` can be found. -An environment variable has two parts. -The key and the value. +An environment variable has two parts, the key and the value. This guide uses the notation `key=value` for better readability. The following is an example of an environment variable in this notation. @@ -73,8 +63,7 @@ __GL_SHADER_DISK_CACHE=1 This section is based on a [piece of documentation by Lutris](https://github.com/lutris/docs/blob/master/Performance-Tweaks.md#nvidia-gpu-only-optimization) -regarding performance optimization for systems with [Nvidia](/wiki/nvidia.md) -GPUs. +regarding performance optimization for systems with [Nvidia](/wiki/nvidia.md) GPUs. For Nvidia GPUs the shader cache is set to have a softlimit of 128MB. This can be easily reached by some games and will cause performance limitations. @@ -83,26 +72,23 @@ For this set `__GL_SHADER_DISK_CACHE_SKIP_CLEANUP` to `1` as explained in the [section regarding environment variables](#setting-environment-variables). By default Lutris uses a cache location for all games. -For better trouble shooting capabilities a unique shader location for each game -can be set. +For better trouble shooting capabilities a unique shader location for each game can be set. This can be done with the [environment variable](#setting-environment-variables) -`__GL_SHADER_DISK_CACHE_PATH=` that has to be set as a per -game variable and adapted with a path of your choosing. +`__GL_SHADER_DISK_CACHE_PATH=` that has to be set as a per game variable and +adapted with a path of your choosing. ### Performance Tweaks -This section addresses ways of increasing the performance of games when run by -Lutris. +This section addresses ways of increasing the performance of games when run by Lutris. An easy way to increase the performance of games is to install and enable [Feral GameMode](https://github.com/FeralInteractive/gamemode) as recommended in the [documentation of Lutris](https://github.com/lutris/docs/blob/master/Performance-Tweaks.md#enable-game-mode). -It is important to install both the 64-bit and the 32-bit version to ensure full -functionality. -Check the package manager of your distribution for packages with the names -`gamemode` and `lib32-gamemode` or similar names or install it manually via git. -Afterwards check in Lutris `Preferences` if `Enable Feral GameMode` is checked -under the `Global options` tab. +It is important to install both the 64-bit and the 32-bit version to ensure full functionality. +Check the package manager of your distribution for packages with the names `gamemode` and +`lib32-gamemode` or similar names or install it manually via git. +Afterward, check in Lutris `Preferences` if `Enable Feral GameMode` is checked under the +`Global options` tab. Another way to increase the performance is to increase the [Nvidia Shader Cache](#nvidia-shader-cache-settings) limit. @@ -110,22 +96,18 @@ Another way to increase the performance is to increase the ### Installing Windows DLLs Select the game in the `Games` tab of the library. -Then select the upwards arrow next to the [WINE](/wiki/linux/wine.md) symbol in -the bar at the lower screen. -Select `Winetricks` and `Select the default wineprefix` in the window -afterwards. -After selecting `Install a Windows DLL or component` the package to install can -be selected. +Then select the upwards arrow next to the [WINE](/wiki/linux/wine.md) symbol in the bar at the +lower screen. +Select `Winetricks` and `Select the default wineprefix` in the window afterward. +After selecting `Install a Windows DLL or component` the package to install can be selected. ### Change WINE/Proton Version -[Windows](/wiki/windows.md) games are handled by -[WINE](/wiki/linux/wine.md). -After right-clicking a game and selecting `Configure` the `Wine version` can be -changed under the `Runner options` tab. -There are many different versions of WINE, WINE-fshack and various -[Proton](/wiki/game/proton.md) and -[Proton GE versions](/wiki/game/proton.md#ge-version) to select. +[Windows](/wiki/windows.md) games are handled by [WINE](/wiki/linux/wine.md). +After right-clicking a game and selecting `Configure` the `Wine version` can be changed under the +`Runner options` tab. +There are many different versions of WINE, WINE-fshack and various [Proton](/wiki/game/proton.md) +and [Proton GE versions](/wiki/game/proton.md#ge-version) to select. Using the default runner of [Bottles](/wiki/game/bottles.md) - called [Caffe](/wiki/game/bottles.md#caffe) - is also possible. @@ -136,7 +118,7 @@ For disabling networking for a command the program In Lutris after the installation of firejail right-click the game to disable networking on. Select `Configure` and navigate to `System Options`. Enable `Advanced` and insert `firejail --net=none --noprofile` into the `command prefix` field. -Afterwards all networking of the selected game is disabled. +Afterward, all networking of the selected game is disabled. ### Adding and Removing Runners and Sources @@ -162,18 +144,16 @@ This section addresses various errors that can happen when using Lutris. ### DX12/DX13 is not Supported on Your System -This section handles a fix if the game is not able to run due to the system not -supporting DX12 or DX13. -This can be easily fixed by inserting `-dx11` in `Arguments` under the -`Game options` tab that pops up after selecting `Configure` for a selected game. +This section handles a fix if the game is not able to run due to the system not supporting DX12 or +DX13. +This can be easily fixed by inserting `-dx11` in `Arguments` under the `Game options` tab that pops +up after selecting `Configure` for a selected game. ### Crashes for Windows Games -When it comes to crashes for [Windows](/wiki/windows.md) games that get -handled by [WINE](/wiki/linux/wine.md) one point of failure is the selected -WINE version. -Change the version used as explained in -[the regarding section](#change-wineproton-version). -Especially trying [Proton GE versions](/wiki/game/proton.md#ge-version) or -WINE fshack versions can lead to successful running of the game. +When it comes to crashes for [Windows](/wiki/windows.md) games that get handled by +[WINE](/wiki/linux/wine.md) one point of failure is the selected WINE version. +Change the version used as explained in [the regarding section](#change-wineproton-version). +Especially trying [Proton GE versions](/wiki/game/proton.md#ge-version) or WINE fshack versions can +lead to successful running of the game. Specific games also benefit from running [Caffe](/wiki/game/bottles.md#caffe). diff --git a/wiki/game/magic:_the_gathering.md b/wiki/game/magic:_the_gathering.md index be82737..0f8003c 100644 --- a/wiki/game/magic:_the_gathering.md +++ b/wiki/game/magic:_the_gathering.md @@ -39,102 +39,102 @@ functionality. Many of them also feature public decks. - [Archidekt](https://archidekt.com/) is another popular deck building site. - With the option to build commander decks based on a specific commander. - It additionally features the display of public decks. + With the option to build commander decks based on a specific commander. + It additionally, features the display of public decks. - [deckbox](https://deckbox.org/) is a very clean deck builder website. - [deckstats.net](https://deckstats.net/) gives the option to build and analyze MTG(A) decks. - [Delver Lens](https://www.delverlab.com/) is an [Android](/wiki/android.md) application for - scanning cards and displaying its price. - Following scanning the cards can be exported to a CSV file. + scanning cards and displaying its price. + Following scanning the cards can be exported to a CSV file. - [Dragon Shield MTG Card Manager](https://mtg.dragonshield.com/) is a collection and deck manager - available both as an apple and [Android](/wiki/android.md) app and as a website. - It features a card scanner for easy population of the collection + available both as an apple and [Android](/wiki/android.md) app and as a website. + It features a card scanner for easy population of the collection - [MTG Collection Builder](https://mtgcollectionbuilder.com/) is a website to organize and analyze - your magic cards. - It was specially made for collectors rather than players. + your magic cards. + It was specially made for collectors rather than players. - [MTG Desktop Companion](https://www.mtgcompanion.org/) is a collection manager for MTG that - includes prices, stats and a deck builder, aswell as the option to import and export to most of - the used MTG deck formats. - It is free and open-source. - Its source code can be looked at on their - [GitHub Page](https://github.com/nicho92/MtgDesktopCompanion). + includes prices, stats and a deck builder, aswell as the option to import and export to most of + the used MTG deck formats. + It is free and open-source. + Its source code can be looked at on their + [GitHub Page](https://github.com/nicho92/MtgDesktopCompanion). - [Moxfield](https://www.moxfield.com/) is a popular deck building site. - It also displays public decks. - If a deck is entered into Moxfield tokens that are needed to play the deck can be displayed. + It also displays public decks. + If a deck is entered into Moxfield tokens that are needed to play the deck can be displayed. - [MTG CSV Helper](https://stepkie.github.io/MtgCsvHelper/) is a CSV format conversion tool to - convert between the different formats used by collection managers. + convert between the different formats used by collection managers. The second group is about giving resources for building decks. This can be done by providing public decks or showing which decks or cards are popular in which format. - [CubeCobra](https://cubecobra.com/explore) is a website that is based around the creation of - draft cubes. - For booster box alternatives cassete cases can be used. + draft cubes. + For booster box alternatives cassete cases can be used. - [Tapped Out](https://tappedout.net/) is a website that among other things can suggest decks based - on owned cards. + on owned cards. - [MTGGoldFish](https://www.mtggoldfish.com/) is a website for different topics regarding MTG. - It features various decks including budget variants of it. - Additionally it lists tournaments with decks played which can be a useful resource to understand - the metagame. + It features various decks including budget variants of it. + Additionally, it lists tournaments with decks played which can be a useful resource to + understand the metagame. The following websites provide useful information on cards or rulings of MTG. - [EDHREC](https://edhrec.com/) is a website that can recommend cards based on an already existing - commander or improve existing commander decks. + commander or improve existing commander decks. - [Hyperlinked Magic](https://yawgatog.com/resources/magic-rules/) is a website that features a - hyperlinked HTML-version of MTG rules. + hyperlinked HTML-version of MTG rules. - [Scryfall](https://scryfall.com/) is a website to search and display Magic cards in specific - printings. - Scryfall can query advanced patterns using - [their specific syntax](https://scryfall.com/docs/syntax). - Among others this site can be used to check for cards that create tokens. - An example for this is running a search with the term `o:create o:golem` to find cards that - create a golem token. - For other advan + printings. + Scryfall can query advanced patterns using + [their specific syntax](https://scryfall.com/docs/syntax). + Among others this site can be used to check for cards that create tokens. + An example for this is running a search with the term `o:create o:golem` to find cards that + create a golem token. + For other advan - [What's in Standard?](https://whatsinstandard.com/) lists the sets that are currently legal in - the standard format. + the standard format. - [Magic Judges](https://chat.magicjudges.org/mtgrules/) is a live chat with judges to clarify the - rules. + rules. This group of resources is used to organize and join MTG tabletop, MTGA and MTGO tournaments. - [Melee](https://melee.gg/) is a website that allows organization and joining of MTG and MTGA - tournaments. + tournaments. - [Magic: The Gathering Companion](https://magic.wizards.com/de/products/companion-app) is a mobile - app that is officially made by Wizards. - It features a tool to join tabletop tournaments in licensed stores and locations. + app that is officially made by Wizards. + It features a tool to join tabletop tournaments in licensed stores and locations. The following sites are focussed on analyzing decks and strategies for MTG Arena. - [17Lands](https://www.17lands.com/faq) is a website focused on improving the draft of players in - MTGA. + MTGA. - [Untapped.gg](https://mtga.untapped.gg/) is a website and desktop app that analyzes MTGA decks and - strategies. + strategies. This group of resources are websites on which MTG cards and supply can be bought. - [Card Kingdom](https://www.cardkingdom.com/) is a website to shop MTG cards and supply. - It ships from the united states of america. + It ships from the united states of america. - [cardmarket](https://www.cardmarket.com/) is a trading post for tabletop cards based in europe. - [TCGPlayer](https://www.tcgplayer.com) is a trading post for tabletop cards that is used - world-wide. + world-wide. The following websites can be used to design or obtain images for proxies or print them. - [Printers Studio](https://www.printerstudio.de/machen/komplett-individualisierbare-spielkarten-geschenke.html) - can be used to print custom proxies. + can be used to print custom proxies. - [Card Conjurer](https://cardconjurer.onrender.com/) is a website to design custom MTG-style - cards. + cards. - [MPC Fill](https://mpcfill.com/) can be used to obtain front and back images for non-custom proxy - cards. + cards. The following sites sell MTGO tix and sell or rent cards. - [Cardhoarder](https://www.cardhoarder.com/) is a MTGO card selling site with renting service. - [Goatbots](https://www.goatbots.com) is an MTGO website that sells cards and tix. - [Mana Traders](https://www.manatraders.com/) is a renting service for MTGO cards, aswell as a way - to buy tix. + to buy tix. Lastly [decklist.org](https://decklist.org/) can be used to neatly print out deck lists. diff --git a/wiki/game/minecraft.md b/wiki/game/minecraft.md index 5608ad0..4e14f3c 100644 --- a/wiki/game/minecraft.md +++ b/wiki/game/minecraft.md @@ -23,6 +23,8 @@ There are different Minecraft Clients available: ### Usage +This section addresses the usage of Minecraft. + #### Link Minecraft to a Subdomain To link Minecraft to one of your subdomains you need to add a [DNS](/wiki/dns.md) @@ -96,23 +98,23 @@ in the corresponding sections. The following resources have been used to find and select modifications and resource packs. - [The UsefulMods list](https://github.com/TheUsefulLists/UsefulMods/blob/main/Performance/Performance121.md) - is a list of useful performance mods for the 1.21.x. - Newer and older versions could be found in the file browser on the left side of the website. + is a list of useful performance mods for the 1.21.x. + Newer and older versions could be found in the file browser on the left side of the website. - [Vanilla Tweaks](https://vanillatweaks.net/) is a website that provides various resource packs - to improve the quality of life in minecraft. - Goal of these is a slight change of the vanilla experience. + to improve the quality of life in minecraft. + Goal of these is a slight change of the vanilla experience. The first category that will be discussed are the server mods. The following changes are recommended to install server-side to improve performance. - "Concurrent Chunk Management Engine" is a mod that introduces a concurrently working chunk - management engine. + management engine. - "Clumps" is a mod that groups together experience orbs that are close to another. - "Get It Together, Drops!" is a mod that groups together items that are close to another. - "FerriteCore" is a mod that reduces memory usage. - "Krypton" is a mod that optimizes minecrafts networking stack. - "Let Me Despawn" is a mod that enables mods with a picked up or equipped item to despawn to - reduce entity lag. + reduce entity lag. - "Lithium" is a mod that introduces various general optimizations. - "ModernFix" is a mod that introduces more general optimizations. - "Noisium" is a mod that speeds up the world generation function. @@ -124,49 +126,49 @@ gameplay. The following changes are recommended to install on the server for gameplay reasons. - "Anti Enderman Grief" is a datapack that stops the endermen from picking up and setting down any - blocks. + blocks. - "Audarki Cart Engine (Fast Minecarts)" is a mod that enables the operators of a server to change - the minecarts speed. - This can be done for different types of minecarts (player, non-player, etc). + the minecarts speed. + This can be done for different types of minecarts (player, non-player, etc). - "Sit!" is a mod that enables players to sit on specific blocks. - The key to use can be changed on a per user basis by installing the mod client-side. + The key to use can be changed on a per user basis by installing the mod client-side. - "Cycle Paintings" is a mod that lets player cycle through the motifs of a painting by - right-clicking it with another painting. + right-clicking it with another painting. - "NetherPortalFix" is a mod that fixes some behaviour for Nether Portals that overlap. - "Beautified Chat (Server)" is a mod that changes style and color of the chat. - "AfkPlus" is a mod that adds AFK functionality that allows ignoring AFK players in the sleep - percentage. + percentage. - "Scaffolding Drops Nearby" is a mod that makes all scaffolding be dropped on the place of the - broken scaffolding. + broken scaffolding. - "Glowing Eyeblossom" is a mod that makes eyeblossoms glow. - "Glowing Torchflower" is a mod that makes torchflowers glow. -Finally for the server-side mods the following ones are focussed on graphical changes. +Finally, for the server-side mods the following ones are focussed on graphical changes. - "Skin Shuffle" is a mod that allows players to instantly change the skin they use. - Please note that the same mod needs to be installed on the client too. + Please note that the same mod needs to be installed on the client too. The client-side mods are now being discussed. The following modifications are recommended client-side performance mods. - "Concurrent Chunk Management Engine" is a mod that introduces a concurrently working chunk - management engine. + management engine. - "Dynamic FPS" is a mod that reduces the FPS when the program is running in the background. - "EntityCulling" is a mod that disables the rendering of hidden entities. - "FerriteCore" is a mod that reduces memory usage. - "ImmediatelyFast" is a mod that optimizes rendering. - "Lithium" is a mod that introduces various general optimizations. - "Sodium" is a mod that optimizes the rendering engine. This is a common and with newer versions more popular - alternative to OptiFine. + alternative to OptiFine. - "Sodium Extra" is a mod that introduces an extension to Sodiums optimizations. - "Reese's Sodium Options" is a (sub-)mod for Sodium that adds functions to the video options like - a search bar. - A similar mod to this is "Xander's Sodium Options". + a search bar. + A similar mod to this is "Xander's Sodium Options". - "Xander's Sodium Options" is a (sub-)mod for Sodium that adds functions to the video options - like a search bar. - Additionally it changes the look of the video options to be more in line with Minecrafts other - options. - A similar mod to this is "Reese's Sodium Options". + like a search bar. + Additionally, it changes the look of the video options to be more in line with Minecrafts other + options. + A similar mod to this is "Reese's Sodium Options". - "More Culling" is a mod that introduces more culling. The following are recommended client-side graphical mods. @@ -174,104 +176,104 @@ The following are recommended client-side graphical mods. - "3d-Skin-Layers" is a mod that makes the outer layers of skins look more 3-dimensional. - "Blur+" is a mod that adds blur to the background when opening a chest. - "Bobby" is a mod that caches chunks to increase the render distance beyond the maximum server - distance of servers. + distance of servers. - "Chat Heads" is a mod that adds an image of the players head to chat messages. - "Dark Loading Screen" is a mod that changes the mojang loading screen into dark mode. - "Make Bubbles Pop" is a mod that lets water bubbles - like the ones above soulsand - pop at the - surface. + surface. - "Visuality" is a mod that adds various particles to entities. - "Better Hoppers" is a resource pack that adds arrows to hoppers. - "Blobs Enchant Icons" is a resource pack that adds small icons to the tooltip of enchanted - icons. + icons. - "Consistent Blank Decorated Pot" from Vanilla Tweaks is a resource pack that fixes the decorated - pot skin to use the decoration on all sides. + pot skin to use the decoration on all sides. - "Consistent Buckets" from Vanilla Tweaks is a resource pack that fixes the bucket icon to be in - line for filled and empty buckets. + line for filled and empty buckets. - "Directional Dispensers" from Vanilla Tweaks is a resource pack that adds arrows to dispensers. - "Directional Observers" from Vanilla Tweaks is a resource pack that adds arrows to observers. - "Double Slab Fix" from Vanilla Tweaks is a resource pack that fixes the double slabs look to - look like two slabs in contrast to a normal block. + look like two slabs in contrast to a normal block. - "Even Better Enchants" is a resource pack that changes the look of enchanted books to be more - unique and easily recognizable. + unique and easily recognizable. - "Groovy Levers" from Vanilla Tweaks is a resource pack that adds a groove to indicate the state - to levers. + to levers. - "Lower Shield" from Vanilla Tweaks is a resource pack that lowers the shield to increase the - players vision. + players vision. - "Mob Crates" is a resource pack that changes the icon of spawn eggs. - "Nautilus 3D" is a resource pack that completely retextures all blocks in the game. - "No More Christmas Chests" is a resource pack that disables the christmas chests. - "No Java Subtitle" from Vanilla Tweaks is a resource pack that hides the Java Version-Subtitle - in the title screen. + in the title screen. - "Pumpkin or Melon" is a resource pack that makes the stem of melons and pumpkins easily - distinguishable. + distinguishable. - "Redstone Power Levels" from Vanilla Tweaks is a resource pack that displays the level of - redstone signal on the dust. + redstone signal on the dust. - "Rethoughted Infested Stones" is a resource pack that slightly changes the skin of infested - stones. + stones. - "Slightly Improved Font" is a resource pack that makes the font a bit smoother. - "Sticky Piston Sides" is a resource pack that makes the slime on sticky pistons visible from the - side. + side. - "Subtle Suspicious Sand and Gravel" is a resource pack that slightly changes the skin of - suspicious sand and gravel. + suspicious sand and gravel. - "White Enchantment Glint" from Vanilla Tweaks is a resource pack that changes the default - enchantment glint to a white one. + enchantment glint to a white one. - "Alternative Bedrock" from Vanilla Tweaks is a resource pack that changes the look of bedrock. - "Circular Log Tops" from Vanilla Tweaks is a resource pack that changes the look of logs to be - more circular. + more circular. - "Golden Crown" from Vanilla Tweaks is a resource pack that changes the look of golden helmets to - crowns. + crowns. - "Moss Carpet Overhang" from Vanilla Tweaks is a resource pack that changes the look of moss - carpets slightly so that they overhang a bit on the sides. + carpets slightly so that they overhang a bit on the sides. - "Skin Shuffle" is a mod that allows you to change your skin in-game. - Please note that for this mod to work on servers the same mod needs to be installed on the server - too, otherwise you will need to log out and reconnect. + Please note that for this mod to work on servers the same mod needs to be installed on the server + too, otherwise you will need to log out and reconnect. - "Visible Powdered Snow" slightly changes the texture of powdered snow to distinguish between it - and normal snow. + and normal snow. - "Variants-CIT" is a mod that allows to change the look of variants of the same item like potions - or enchanted books. - This mod needs corresponding resource packs that can be found on the mod page to download. + or enchanted books. + This mod needs corresponding resource packs that can be found on the mod page to download. - "3D Crops Revamped" is a resource pack that changes the look of crops to be more 3 dimensional. - It is similar to "Florescent" but focusses only on crops. + It is similar to "Florescent" but focusses only on crops. - "Florescent" is a resource pack that changes the look of flowers, crops and mushrooms to be more - 3 dimensional. - It is similar to "3D Crops Revamped" which only includes crops. + 3 dimensional. + It is similar to "3D Crops Revamped" which only includes crops. - "Continuity" is a mod that enables connected textures like glass without borders and more. - "Better Statistics Screen" is a mod that changes the look and feel of the statistics screen to - make it more intuitive. + make it more intuitive. - "Remove Reloading Screen" is a mod that removes the loading screen and instead display only the - additional loading bar. + additional loading bar. - "More Heart Types" is a mod that changes the heart style based on the type of damage the player - is taking. + is taking. - "Endless End Rods" from Vanilla Tweaks is a resource pack that removes the base off of end rods. - "Brighter Nether" from Vanilla Tweaks is a resource pack that increases the brightness of the - nether blocks. + nether blocks. - "Variated Villagers" from Vanilla Tweaks is a resource pack that changes the skin of villagers - depending on the biome. + depending on the biome. - "Quieter Villagers" from Vanilla Tweaks is a resource pack that sets the volume of villagers - much lower. + much lower. - "Quieter Cows" from Vanilla Tweaks is a resource pack that sets the volume of cows much lower. - "Quieter chicken" from Vanilla Tweaks is a resource pack that sets the volume of chicken much - lower. + lower. - "Clear Banner Patterns" from Vanilla Tweaks is a resource pack that changes the appearance of - banner patterns to be more clear. + banner patterns to be more clear. - "Music Disc Redstone Level Preview" from Vanilla Tweaks is a resource pack that displays the - redstone level of a music disc in game. + redstone level of a music disc in game. - "Rename 'Stem' to 'Log'" from Vanilla Tweaks is a resource pack that changes the Nether woods to - use 'Stem' instead of 'Log'. + use 'Stem' instead of 'Log'. - "Icons" is a resource pack that adds icons into the menu and game. - Additionally "Icons Advertisement Removal" removes the logo of the "Icons" resource pack. + Additionally, "Icons Advertisement Removal" removes the logo of the "Icons" resource pack. - "Hoffen's Minimal Armor" is a resource pack that minimizes the look of armor. - "Vertical Nuggets" is a resource pack that flips all nuggets to be vertical. - "Colorful Canines" is a resource pack that makes dog armor more colorful. - "Colorful Sheared Sheep" is a resource pack that makes the color of sheep wool visible even - after the shearing. + after the shearing. - "Real Arrrow Tip" is a resource pack that makes the look of arrows correct ingame. The following are recommended client-side audio mods. - "No Cave Ambience" is a resource pack that disables the ambience sounds in caves. - "Quieter Dispensers" from Vanilla Tweaks is a resource pack that reduces the volume of - dispensers. + dispensers. - "Quieter Minecarts" from Vanilla Tweaks is a resource pack that reduces the volume of minecarts. - "Quieter Pistons" from Vanilla Tweaks is a resource pack that reduces the volume of pistons. @@ -281,37 +283,37 @@ The following are recommended client-side HUD and other UI modifications - "BetterF3" is a mod that makes the F3-menu more customizable and more easily readable. - "Bundle Inventory" is a mod that improves the usability of bundles. - "Durability Tooltip" is a mod that adds a durability number to the tooltip of items. - It is similar to "Durability Plus" but doesn't feature color. + It is similar to "Durability Plus" but doesn't feature color. - "Durability Plus" is a mod that shows the durability as a number. - It is similar to "Durability Tooltip" but has color. + It is similar to "Durability Tooltip" but has color. - "FPS Display" is a mod that displays the FPS on the screen. - When using "Sodium" this mod is not needed as it adds the same functionality. + When using "Sodium" this mod is not needed as it adds the same functionality. - "Inventory Profiles Next" is a mod that adds inventory profiles and allows to lock specific item - slots. - It also replaces placed blocks in the inventory or replaces used tools. + slots. + It also replaces placed blocks in the inventory or replaces used tools. - "MiniHUD" is a mod that adds the possibility to show various information on screen or render - chunks, light levels, etc in game. + chunks, light levels, etc in game. - "Show Durability" is a mod that shows the durability as a number additionally to the bar. - It is similar to "Till It Breaks" but is more lightweight and has less options. + It is similar to "Till It Breaks" but is more lightweight and has less options. - "Till It Breaks" is a mod that shows the durability as a number. - It is similar to "Show Durability" but has more features like color, the displaying of the number - of arrows or the option to hide of the durability bar. + It is similar to "Show Durability" but has more features like color, the displaying of the number + of arrows or the option to hide of the durability bar. - "Shulker Box Tooltip" is a mod that more easily shows the contents of a shulker box. - "Simple armor hud" is a mod that adds a HUD to show the durability and type of armor that the - player wears. + player wears. - "Status Effect Bars" is a mod that adds status effect bars to the screen. - "Better Boss Bars" is a resource pack that improves the look of boss bars. - "NH-Just a numbered hotbar" is a resource pack that shows numbers on the hotbar. - "Boss Crosshair" is a collection of resource packs that changes the look of the crosshair. - "GUI Perfected" is a resource pack that changes the look of the buttons aswell as crafting - tables, anvils and more to be more unique. - It is similar to "Colorful Containers GUI" but doesn't include chests, etc. + tables, anvils and more to be more unique. + It is similar to "Colorful Containers GUI" but doesn't include chests, etc. - "Colorful Containers GUI" is a resource pack that changes the look of the buttons aswell as crafting - tables, anvils and more to be more unique. - This also has a dark mode named "Colourful Containers Dark Mode GUI". - It is similar to "GUI Perfected" but also includes chests, etc. + tables, anvils and more to be more unique. + This also has a dark mode named "Colourful Containers Dark Mode GUI". + It is similar to "GUI Perfected" but also includes chests, etc. - "Scribble" is a mod that makes editing books easier by adding buttons for color, bold font and - more. + more. - "Chat Patches" is a mod that extends the chat history and adds some more tweaks. - "Armor Chroma for Fabric" is a resource pack that shows the type of armor in the bar. - "Colorful Ping" is a resource pack that shows the ping symbol in color. @@ -322,7 +324,7 @@ Please note that these can possibly lead to a ban on a server depending on the p that server. - "Bridging Mod" is a mod that allows to place blocks under, next to and above a block despite not - seeing this side of the block. + seeing this side of the block. - "Freecam" is a mod that allows to move the cam freely similar to the spectator mode. - "Fullbright" is a mod that increases brightness at night or in caves. - "Mob Health Indicators" is a mod that displays the health of mobs above their head. @@ -330,10 +332,10 @@ that server. - "Xaero's Minimap" is a mod that adds a minimap to the screen. - "Xaero's World Map" is a mod that adds a map to the game that can be viewed at any time. - "Brewing Guide" from Vanilla Tweaks is a resource pack that adds an easy brewing guide to the UI - of the brewing stand. - It is similar to "GUIdes" but is only made for brewing. + of the brewing stand. + It is similar to "GUIdes" but is only made for brewing. - "GUIdes" is a mod resource similar to "Brewing Guide" that adds guides to many menus like - brewing menus and more. - It is similar to "Brewing Guid" and "Smelting Guide" but is adds guides for more tools. + brewing menus and more. + It is similar to "Brewing Guid" and "Smelting Guide" but is adds guides for more tools. - "Smelting Guide" is a resource pack that adds a guide to all types of furnaces that shows the - usability of items as fuel. + usability of items as fuel. diff --git a/wiki/game/steam_deck.md b/wiki/game/steam_deck.md index ce8b832..d2602cb 100644 --- a/wiki/game/steam_deck.md +++ b/wiki/game/steam_deck.md @@ -32,7 +32,7 @@ appended to the command used for starting the emulator needed for it. This should be made in quotation marks as it could contain characters that need to be escaped. -Afterwards the icons and banners of it can be set using +Afterward, the icons and banners of it can be set using [SteamGridDB](/wiki/game/steam.md#setting-icons-and-banners-for-games). ### Plugin Manager Decky @@ -42,7 +42,7 @@ Some of these options can be accessed by installing [the plugin manager Decky](https://github.com/SteamDeckHomebrew/decky-loader). To install it download the setup file from the [GitHub page](https://github.com/SteamDeckHomebrew/decky-loader) and run it. -Afterwards the plugin manager will be available after pressing the `...` button on the Deck and +Afterward, the plugin manager will be available after pressing the `...` button on the Deck and navigating to the bottom of the menu. There plugins can be installed and removed aswell as managed. diff --git a/wiki/git_(general).md b/wiki/git_(general).md index fbac39e..cda5828 100644 --- a/wiki/git_(general).md +++ b/wiki/git_(general).md @@ -23,7 +23,7 @@ A distinction can be made between #### Server with web interface Web interfaces for git are quite useful for easily showing code to other people. -Additionally it is easy to collaborate together. +Additionally, it is easy to collaborate together. - [Gitea](gitea.md) is an open-source and selfhosted git instance which can be dockerized. - [GitHub](https://github.com) is a popular git server. diff --git a/wiki/gitea.md b/wiki/gitea.md index 3ef2e56..044e2c7 100644 --- a/wiki/gitea.md +++ b/wiki/gitea.md @@ -12,7 +12,7 @@ Gitea as a [Git](/wiki/git_%28general%29.md) service consists of a [client](#cli The software can be setup via [Docker](/wiki/docker.md) with the [gitea image](/wiki/docker/gitea_-_gitea.md). -Additionally to this a client is needed on the system that need access to the +Additionally, to this a client is needed on the system that need access to the server software. ### Client diff --git a/wiki/globalprotect.md b/wiki/globalprotect.md index bcb5240..9906c8e 100644 --- a/wiki/globalprotect.md +++ b/wiki/globalprotect.md @@ -14,7 +14,7 @@ command is called `gpclient` which can sometimes lead to confusion. 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. +Afterward, the client will connect. The standard command to connect to a [VPN](/wiki/vpn.md) server is the following where `` is the domain of the server (for example `vpn.abc.de`). diff --git a/wiki/handbrake.md b/wiki/handbrake.md index 334814b..8032863 100644 --- a/wiki/handbrake.md +++ b/wiki/handbrake.md @@ -12,7 +12,7 @@ Various ways to set up HandBrake can be found on On [Windows](/wiki/windows.md) and Mac the program can be started by clicking the icon. This way is also possible on [Linux based operating systems](/wiki/linux.md). -Additionally the command `ghb` can be called in the [Terminal](/wiki/linux/shell.md). +Additionally, the command `ghb` can be called in the [Terminal](/wiki/linux/shell.md). ### Presets diff --git a/wiki/inkscape.md b/wiki/inkscape.md index c1f2b7b..2f270ec 100644 --- a/wiki/inkscape.md +++ b/wiki/inkscape.md @@ -28,7 +28,7 @@ To convert handwriting to a vector graphic an image of the writing should first Inkscape. First the levels of black and white can be changed by using `Extensions > Raster > Levels` and changing the values for white and black points. -Afterwards the bitmap should be traced. +Afterward, the bitmap should be traced. For this select `Path > Trace Bitmap` and change the values in the Detection mode `Brightness cutoff` until it matches your expectations. After this the image has been converted to a bitmap, but most of the times it is not smooth and has diff --git a/wiki/jackett.md b/wiki/jackett.md index 45382cb..9f0d42d 100644 --- a/wiki/jackett.md +++ b/wiki/jackett.md @@ -26,7 +26,6 @@ Paste this in the \*ARR application under `Settings`, `Indexers`, `Add`, `Torznab` and `Custom` in the `URL` field. Also copy and paste the Jackett API key into the corresponding field in the \*ARR application. -Afterwards check and configure the correct category IDs via the `Categories` -option. +Afterward, check and configure the correct category IDs via the `Categories` option. The list of supported categories can be found in the Jackett indexer configuration (the wrench in the corresponding index list entry). diff --git a/wiki/jellyfin.md b/wiki/jellyfin.md index 7c0a0f0..655c85c 100644 --- a/wiki/jellyfin.md +++ b/wiki/jellyfin.md @@ -35,7 +35,7 @@ In the [TVHeadend entry](/wiki/tvheadend.md) a guide to run an instance is given In the admin dashboard install the [TVHeadend plugin](https://jellyfin.org/docs/general/server/plugins/tvheadend/) and restart the server. -Afterwards create a user with a username in TVHeadend under +Afterward, create a user with a username in TVHeadend under `Go to Configuration > Users > Access Entries > Add`. Check the `Change Parameters` `Rights`, `Channel number range`, `Channel tags`, `DVR configurations`, @@ -49,15 +49,15 @@ Select `Basic`, `Advanced` and `HTSP` under `Streaming` and `Basic`, `HTSP` and Save the user. Create a password via `Configuration > Users > Passwords > Add`. Check `Enabled`, select the according `Username` and fill in the `Password`. -Afterwards save. +Afterward, save. Now in Jellyfin under `Go to Dashboard > Plugins > TVHeadend > Settings` set the `TVHeadend Hostname or IP Address`, the `HTTP Port` and `HTSP Port`, the `Username` and the `Password` set in the previous step. -Finally run `Refresh Guide Data` under `Dashboard > Live TV > Live TV` to load +Finally, run `Refresh Guide Data` under `Dashboard > Live TV > Live TV` to load the guide data for the next 7 days aswell as to refresh the TV channels. -Afterwards the channels [mapped in TVHeadend](/wiki/tvheadend.md#adding-channels) +Afterward, the channels [mapped in TVHeadend](/wiki/tvheadend.md#adding-channels) should appear in the `Live TV` Library. ### Client diff --git a/wiki/libreoffice.md b/wiki/libreoffice.md index 2b3725f..097559e 100644 --- a/wiki/libreoffice.md +++ b/wiki/libreoffice.md @@ -31,4 +31,4 @@ When first starting LibreOffice may appear not to start. This is because problems with hardware acceleration can occur on some systems. It can starting the software in safe mode, navigate to the `Settings` by the `Tools` tab. Then select `LibreOffice` and `View` and remove the check in `Use hardware acceleration`. -Afterwards LibreOffice can be closed and reopened without selecting the safe mode. +Afterward, LibreOffice can be closed and reopened without selecting the safe mode. diff --git a/wiki/linux/arch-linux.md b/wiki/linux/arch-linux.md index 8b30356..6c8c05a 100644 --- a/wiki/linux/arch-linux.md +++ b/wiki/linux/arch-linux.md @@ -78,14 +78,14 @@ To access the files of the system an Arch Linux boot stick has to be created as [a previous section](#create-installation-medium). After booting into it set your keymap layout using the `loadkeys` setup similar to [the installation preparation](/wiki/linux/arch-linux/installation.md#1-preparation). -Afterwards [mount](/wiki/linux/disk-management.md#mounting) the partition that contains the root +Afterward, [mount](/wiki/linux/disk-management.md#mounting) the partition that contains the root file system to the `/mnt` directory. It is possible that LUKS encrypted file systems need to be [opened](/wiki/linux/dm-crypt.md#openclose-an-encrypted-volume) and then mounted using the `/dev/mapper` symbolic link. On some systems there are home or boot file system that have to be mounted on `/mnt/boot` or `/mnt/home` after mounting the root file system. -Afterwards use `arch-chroot /mnt` to get into the not bootable system. +Afterward, use `arch-chroot /mnt` to get into the not bootable system. Now the command line of the system can be accessed for troubleshooting. After troubleshooting `exit` the system and [unmount](/wiki/linux/disk-management.md#mounting) all previously mounted file systems and try to boot back into the system. @@ -94,7 +94,7 @@ If the system broke during an update then the easiest way to fix it, is by runni command again. The used command can be found in `/var/log/pacman.log`. Make sure to run exactly this command. -Afterwards try to reboot into the system. +Afterward, try to reboot into the system. Another common source for not bootable systems is [the initial ramdisk](#problems-with-the-initial-ramdisk). diff --git a/wiki/linux/arch-linux/installation.md b/wiki/linux/arch-linux/installation.md index 8e9d7f7..94e2f29 100644 --- a/wiki/linux/arch-linux/installation.md +++ b/wiki/linux/arch-linux/installation.md @@ -87,7 +87,7 @@ For this guide this partition is assumed to be `/dev/sda2`. ```sh cryptsetup -c aes-xts-plain -s 512 -y -v luksFormat /dev/sda2 ``` -Afterwards confirm with `YES`. +Afterward, confirm with `YES`. Now you can assign a passphrase. The passphrase has to be entered at boot to decrypt the system. Recovering of this passphrase is **not** possible. @@ -125,7 +125,7 @@ Now the created filesystems will be mounted for the installation. Now you need a working internet connection. If a wireless internet connection is needed start `iwctl`, scan (`station wlan0 scan`) and connect to the router (`station wlan0 connect `). -Afterwards the internet connection will be established. +Afterward, the internet connection will be established. Exit `iwctl`. - `pacstrap /mnt base base-devel dosfstools gptfdisk lvm2 linux linux-firmware vim networkmanager ntp` @@ -246,7 +246,7 @@ In some cases the Arch keyring needs to be repopulated. This is discussed in [the package manager entry](/wiki/linux/package_manager/pacman_and_aur.md#error-during-updating-is-marginal-trust). -Additionally if you have a NVidia Graphics Cards you should read +Additionally, if you have a NVidia Graphics Cards you should read [the NVidia article](/wiki/linux/nvidia.md) too. If you are interested in automatic decryption of the dm-crypt encrypted diff --git a/wiki/linux/bluez.md b/wiki/linux/bluez.md index 55e9ca7..78105fd 100644 --- a/wiki/linux/bluez.md +++ b/wiki/linux/bluez.md @@ -7,9 +7,9 @@ This entry features the BlueZ package and all software that is based on it. ## Setup On most [Linux](/wiki/linux.md) distributions BlueZ can be installed with the `bluez` package. -Additionally the `bluez-utils` package needs to be installed. +Additionally, the `bluez-utils` package needs to be installed. To load the kernel module `modprobe btusb` needs to be run. -Afterwards the +Afterward, the [service](/wiki/linux/systemd.md#startstopenabledisable-a-service) can be started and enabled by running the following commands. @@ -27,14 +27,14 @@ This section addresses the usage of Bluez. The Bluetooth features can be managed by different types of front-ends. - `bluetoothctl` is a command-line interface included in the `bluez-utils` - package + package - `bluetuith` can be used as a bluetooth manager with a - [terminal](/wiki/linux/system_console.md) user interface. - It is included in a package of the same name, that needs to be installed - before usage. - Using `bluetuith` the [Bluetooth](/wiki/bluetooth.md) can be turned on (or off) by pressing `o`, - devices can be searched for by pressing `s`, a selected device can be paired by pressing `p` and - finally connected by pressing `c` before `bluetuith` can be left with `Q`. + [terminal](/wiki/linux/system_console.md) user interface. + It is included in a package of the same name, that needs to be installed + before usage. + Using `bluetuith` the [Bluetooth](/wiki/bluetooth.md) can be turned on (or off) by pressing `o`, + devices can be searched for by pressing `s`, a selected device can be paired by pressing `p` and + finally connected by pressing `c` before `bluetuith` can be left with `Q`. ## Troubleshooting @@ -73,6 +73,6 @@ For this run the following command where `` is the name of th rfkill unblock ``` -Afterwards the adapter will probably be recognized again but a restart of service +Afterward, the adapter will probably be recognized again but a restart of service `bluetooth.service` eventually has to be restarted as described in the [systemd entry](/wiki/linux/systemd.md#startstopenabledisable-a-service-and-retrieve-its-logs). diff --git a/wiki/linux/debian.md b/wiki/linux/debian.md index d882c1b..667ede5 100644 --- a/wiki/linux/debian.md +++ b/wiki/linux/debian.md @@ -30,7 +30,7 @@ For this reason the following command has to be run first. apt-mark hold docker-ce docker-ce-cli containerd.io ``` -Afterward the packages of the current major release version have to be +Afterward, the packages of the current major release version have to be [upgrading](/wiki/linux/package_manager/apt.md#updating-upgrading) using APTs `full-upgrade` option. Then a reboot is recommended. @@ -52,7 +52,7 @@ Sometimes this process asks if the user wants to replace the local configuration ones. It is generally recommended to select `N` and reject these new configurations. -Finally another reboot is needed and the version number can be +Finally, another reboot is needed and the version number can be [checked again](#retrieve-debian-version) confirming that the major version upgrade was successfully performed. diff --git a/wiki/linux/display_managers.md b/wiki/linux/display_managers.md index ccc0e61..00cacfe 100644 --- a/wiki/linux/display_managers.md +++ b/wiki/linux/display_managers.md @@ -26,4 +26,4 @@ chmod +x ~/.xinitrc ln -s ~/.xsession ~/.xinitrc ``` -Afterwards the session will start like the `xinitrc` +Afterward, the session will start like the `xinitrc` diff --git a/wiki/linux/dm-crypt.md b/wiki/linux/dm-crypt.md index 307d168..0a11fc5 100644 --- a/wiki/linux/dm-crypt.md +++ b/wiki/linux/dm-crypt.md @@ -6,8 +6,12 @@ DM-Crypt can create and manage encrypted devices. ### Creating an Encrypted Devices -To create a encrypted device simply run: -`cryptsetup -c aes-xts-plain -s 512 -y -v luksFormat /dev/sda2`. +To create a encrypted device simply run the following command. + +```sh +cryptsetup -c aes-xts-plain -s 512 -y -v luksFormat /dev/sda2 +``` + Where `/dev/sda2` is the device to be created. ### Create/Add a Key File to an encrypted volume @@ -25,22 +29,32 @@ dd bs=512 count=4 if=/dev/random of= It is possible to increase the length to get a stronger key file. Alternatively strong LUKS keys can be created using [OpenSSL](/wiki/linux/openssl.md) -using a bitlength of 4096: -`openssl genrsa -out 4096`. +using a bitlength of 4096 using the following command. + +```sh +openssl genrsa -out 4096 +``` + The key file will then be saved to ``. -Finally the key file can be added to an opened LUKS encrypted volume by running -the following command: -`cryptsetup luksAddKey `. +Finally, the key file can be added to an opened LUKS encrypted volume by running the following +command. + +```sh +cryptsetup luksAddKey +``` `` is the encrypted device (for example `/dev/sda2`) and `` is the location of the key file. ### Resize a LUKS Encrypted Volume -If volume groups on the encrypted volume are opened make sure to close them -with the following command modified to the present needs: -`vgchange -a n ` +If volume groups on the encrypted volume are opened make sure to close them with the following +command modified to the present needs. + +```sh +vgchange -a n +``` Open the encrypted volume: `cryptsetup luksOpen `. @@ -51,7 +65,10 @@ Now resize the encrypted volume to all available space of the partition. If the encrypted volume should not be extended to the whole partition or the partition is too small for its intended purposes, make sure to resize the partition first accordingly (see [disk management](/wiki/linux/disk-management.md)). -`cryptsetup resize crypt-volume` + +```sh +cryptsetup resize crypt-volume +``` ### Open/Close an Encrypted Volume @@ -64,11 +81,15 @@ Using `secret` as a `` the opened drive is available at Alternatively an encrypted volume can be decrypted using [a key file](#createadd-a-key-file-to-an-encrypted-volume) if set up for it. -This can be achieved by running: -`cryptsetup luksOpen crypt-volume --key-file=`. +This can be achieved by running the following command. + +```sh +cryptsetup luksOpen crypt-volume --key-file= +``` + `` is the encrypted device (for example `/dev/sda2`). -Afterwards it can be closed by running `cryptsetup close /dev/mapper/crypt0`. +Afterward, it can be closed by running `cryptsetup close /dev/mapper/crypt0`. ### Creating/Add a USB Decryption Key @@ -84,15 +105,24 @@ This guide will assume its address is `/dev/sde`. Fill in the first sectors (in this case 94, make sure this number is bigger than skip sector count and size sector count combined) stick with a random -sequence: -`dd if=/dev/urandom of=/dev/sde bs=512 seek=1 count=94`. -Save the key to a keyfile (with offset 14848 = 29 x 512 and -keysize 2048 = 4 x 512): -`dd if=/dev/sde bs=512 skip=29 count=4 > key.bin`. +sequence. + +```sh +dd if=/dev/urandom of=/dev/sde bs=512 seek=1 count=94 +``` + +Save the key to a keyfile (with offset 14848 = 29 x 512 and keysize 2048 = 4 x 512): + +```sh +dd if=/dev/sde bs=512 skip=29 count=4 > key.bin +``` Add the keyfile to the encrypted partition (assuming the dm-crypted device is -called `/dev/sda2`): -`cryptsetup luksAddKey /dev/sda2 key.bin`. +called `/dev/sda2`). + +```sh +cryptsetup luksAddKey /dev/sda2 key.bin +``` Next it has to be made sure that the decryption key, is available at the same position every time. @@ -115,8 +145,11 @@ Assuming the `serial` is `14AB0000000096`. SUBSYSTEMS=="usb", ATTRS{serial}=="14AB0000000096", KERNEL=="sd*", SYMLINK+="usbkey%n" ``` -Then reload the udev rules by running: -`udevadm control --reload-rules`. +Then reload the udev rules by running the following command. + +```sh +udevadm control --reload-rules +``` Unplug the stick and plug it back in. It should be available under `dev/usbkey`. @@ -140,10 +173,18 @@ Then modify `/boot/loader/entries/arch.conf` and add `cryptkey=/dev/usbkey:14848:2048` to the end of the `options` line. -Finally run: -`mkinitcpio -p linux`. +Finally, run the following command. + +```sh +mkinitcpio -p linux +``` + +Then reboot the system. + +```sh +reboot +``` -Reboot the system with `reboot`. Make sure the USB key for decryption is plugged in. If so the encrypted partition should be decrypted automatically. @@ -161,7 +202,7 @@ First adapt and insert the following lines into `/etc/fstab`: `` is a freely choosable identificator and while the `` is an existing directory for the volume to be mounted on. -Additionally the following lines has to be adapted and added to the file +Additionally, the following lines has to be adapted and added to the file `/etc/crypttab`: ```txt @@ -208,5 +249,10 @@ options cryptdevice=UUID=3c306b1b-49a5-48c1-b93f-a619b96d6855:lvm:allow-discard options rd.luks.name=3c306b1b-49a5-48c1-b93f-a619b96d6855=lvm rd.luks.options=discard,fido2-device=auto root=/dev/mapper/main-root resume=/dev/mapper/main-swap rw quiet splash ``` -Finally rebuild the initramfs `sudo mkinitcpio -p linux` and `reboot`. +Finally, rebuild the Initramfs and reboot. Make sure to touch FIDO2-key during boot to make it work. + +```sh +sudo mkinitcpio -p linux +reboot +``` diff --git a/wiki/linux/easyeffects.md b/wiki/linux/easyeffects.md index e2dd68b..8d416cb 100644 --- a/wiki/linux/easyeffects.md +++ b/wiki/linux/easyeffects.md @@ -43,7 +43,7 @@ Run the following command to edit the configuration file for the newly created E systemctl --user edit --force -full easyeffects.service ``` -Afterward set the contents of this file to the following. +Afterward, set the contents of this file to the following. Due to EasyEffect working together with [Pipewire and Wireplumber](/wiki/linux/pipewire.md) some precautions have to be taken to start it before these two. diff --git a/wiki/linux/ffmpeg.md b/wiki/linux/ffmpeg.md index a721878..00fcf47 100644 --- a/wiki/linux/ffmpeg.md +++ b/wiki/linux/ffmpeg.md @@ -59,7 +59,7 @@ An explanation of this was given by [aergistal on Stack Overflow](https://stackoverflow.com/questions/29082422/ffmpeg-video-compression-specific-file-size). This can easily be done with the calculation `bitrate = target size / duration` in Bits/Second. -Afterwards the encoding can be done by using Two-Pass Encoding as explained in +Afterward, the encoding can be done by using Two-Pass Encoding as explained in [a previous section](#two-pass-encoding). Note that the bitrate for videos is split amongst a bitrate for video and a bitrate for audio. diff --git a/wiki/linux/font_configuration.md b/wiki/linux/font_configuration.md index cf03736..36c31a8 100644 --- a/wiki/linux/font_configuration.md +++ b/wiki/linux/font_configuration.md @@ -76,8 +76,8 @@ fontforge arial.ttf A font can be added to the local users fonts using a `.ttf` file. The file has to be copied into the local fonts directory `~/.local/share/fonts`. -Afterwards the [cache should be reloaded](#reload-the-cache). -Finally the font can be [found](#list-or-find-font-family). +Afterward, the [cache should be reloaded](#reload-the-cache). +Finally, the font can be [found](#list-or-find-font-family). ### Reload the Cache diff --git a/wiki/linux/fwupd.md b/wiki/linux/fwupd.md index 0860b26..64fe5ed 100644 --- a/wiki/linux/fwupd.md +++ b/wiki/linux/fwupd.md @@ -1,13 +1,12 @@ # fwupd -[fwupd](https://fwupd.org/) is a daemon for managing and installing firmware -updates on Linux based operating systems. +[fwupd](https://fwupd.org/) is a daemon for managing and installing firmware updates on Linux based +operating systems. It is mainly used for UEFI firmware and supported devices. ## Setup -fwupd can be installed on most distributions by installing the -`fwupd` package. +fwupd can be installed on most distributions by installing the `fwupd` package. ## Usage @@ -20,7 +19,7 @@ First the devices updatable by fwupd can be checked. fwupdmgr get-devices ``` -Afterwards the latest metadata can be downloaded by the following command. +Afterward, the latest metadata can be downloaded by the following command. ```sh fwupdmgr refresh @@ -32,7 +31,7 @@ The updates can the be listed. fwupdmgr get-updates ``` -Finally the updates can be installed. +Finally, the updates can be installed. ```sh fwupdmgr update diff --git a/wiki/linux/git_(package).md b/wiki/linux/git_(package).md index d81f8fc..b9fbdd7 100644 --- a/wiki/linux/git_(package).md +++ b/wiki/linux/git_(package).md @@ -107,7 +107,7 @@ The following sections assumes using a [Linux-based system](/wiki/linux.md) usin For this a [SSH certificate has to be created](/wiki/linux/openssh.md#generate-new-keys) and [added to the authentication agent](/wiki/linux/openssh.md#adding-keys-to-authentication-agent). -Afterwards it the public SSH key to be added to the git server. +Afterward, it the public SSH key to be added to the git server. For GitHub there is [a guide on that topic](https://docs.github.com/en/get-started/getting-started-with-git/why-is-git-always-asking-for-my-password). @@ -144,7 +144,7 @@ A more or less complete overview of the options was performed in an [delta](https://github.com/dandavison/delta) first needs to be installed. Most [package managers](/wiki/linux/package_manager.md) package it in the package `git-delta`. -Afterwards it needs to be enabled. +Afterward, it needs to be enabled. To do this globally add the following lines to the configuration file of git, which can be found in `~/.gitconfig`. Depending on the system settings and preferences the dark-mode (`dark`) and the side-by-side view @@ -170,7 +170,7 @@ Depending on the system settings and preferences the dark-mode (`dark`) and the `git diff` look. It can be installed via most [package managers](/wiki/linux/package_manager.md) using the `diff-so-fancy` package. -Afterwards the following lines need to be run to complete the configuration. +Afterward, the following lines need to be run to complete the configuration. ```sh # switch to diff-so-fancy diff --git a/wiki/linux/gnirehtet.md b/wiki/linux/gnirehtet.md index 13395d5..c4665cf 100644 --- a/wiki/linux/gnirehtet.md +++ b/wiki/linux/gnirehtet.md @@ -15,10 +15,10 @@ This section addresses the usage of Gnirehtet. ## Setting Up and Running Reverse Tethering The following command can be used to setup the reverse tethering and also run it. -For it to work the [Android](/wiki/android.md) device has to enable `USB Debugging` so Gnirehtet can automatically be -installed (which is internally done using `adb`). -Additionally `Use USB for` has to be set to `File Transfer` and not to -`USB Tethering` as this would start the normal tethering process and resolving internet access from +For it to work the [Android](/wiki/android.md) device has to enable `USB Debugging` so Gnirehtet +can automatically be installed (which is internally done using `adb`). +Additionally, `Use USB for` has to be set to `File Transfer` and not to `USB Tethering` as this +would start the normal tethering process and resolving internet access from the [Linux](/wiki/linux.md) system to the Android device and not the other way around. The initiating of the reverse tethering can be done by using the following command. diff --git a/wiki/linux/gpg.md b/wiki/linux/gpg.md index dbb8ea5..9e1df3a 100644 --- a/wiki/linux/gpg.md +++ b/wiki/linux/gpg.md @@ -61,7 +61,7 @@ gpg --import-ownertrust ownertrust.txt Again the first command can be run individually to import single public keys that are not owned. -Afterwards the following commands can be run to set the ultimate trust level to the key pair. +Afterward, the following commands can be run to set the ultimate trust level to the key pair. Caution is advised. ```sh @@ -125,9 +125,9 @@ e-mail to. gpg --edit-key ``` -Afterwards a console will open. +Afterward, a console will open. Using `adduid` another user can be added by following the on-screen instructions. -Afterwards `save` will save the progress and exit from the console. +Afterward, `save` will save the progress and exit from the console. To delete an existing user and e-mail also open the edit-console. Then list the existing users using the command `uid` and select the user id of the key to delete diff --git a/wiki/linux/hardware_(linux).md b/wiki/linux/hardware_(linux).md index a4f81b3..5321e60 100644 --- a/wiki/linux/hardware_(linux).md +++ b/wiki/linux/hardware_(linux).md @@ -25,7 +25,7 @@ command. upower -e ``` -Afterward different values like the state, voltage, percentage and much other can be displayed. +Afterward, different values like the state, voltage, percentage and much other can be displayed. Additionally, it will show the original capacity (`energy-full-design`) and the current capacity (`energy-full`), which can be used to determine the health of the battery. The following is an example command where `` is the name of the batter returned from diff --git a/wiki/linux/lemurs.md b/wiki/linux/lemurs.md index 38f7cd6..c2229a3 100644 --- a/wiki/linux/lemurs.md +++ b/wiki/linux/lemurs.md @@ -22,7 +22,7 @@ This can be done by using one or both of the following commands. systemctl start lemurs.service ``` -Finally the [SystemD](/wiki/linux/systemd.md) lightdm service needs to be enabled and reboot the +Finally, the [SystemD](/wiki/linux/systemd.md) lightdm service needs to be enabled and reboot the system. ```sh diff --git a/wiki/linux/lightdm.md b/wiki/linux/lightdm.md index c4d4bfe..61d2610 100644 --- a/wiki/linux/lightdm.md +++ b/wiki/linux/lightdm.md @@ -7,7 +7,7 @@ It is available for both [X](/wiki/linux/x_window_system.md) and Wayland. ## Setup On most linux distributions LightDM can be installed with the `lightdm` package. -Additionally `lightdm-gtk-greeter` and `xorg-server-xephyr` are recommended. +Additionally, `lightdm-gtk-greeter` and `xorg-server-xephyr` are recommended. This setup will work with [LightDM-GTK-Greeter](#lightdm-gtk-greeter) which is the default greeter. If another greeter is to be chosen `lightdm-gtk-greeter` does not have to be installed, but an alternative for it. @@ -37,7 +37,7 @@ lightdm --test-mode --debug systemctl start lightdm.service ``` -Finally the [SystemD](/wiki/linux/systemd.md) lightdm service needs to be enabled and reboot the +Finally, the [SystemD](/wiki/linux/systemd.md) lightdm service needs to be enabled and reboot the system. ```sh diff --git a/wiki/linux/lvm.md b/wiki/linux/lvm.md index 13c36cf..5fe1a32 100644 --- a/wiki/linux/lvm.md +++ b/wiki/linux/lvm.md @@ -57,7 +57,12 @@ To resize the physical volume to the size of the containing volume run: To increase the size of the logical volume you have to have free space in the according volume group. -You can check that by running: `vgdisplay`. +You can check that by running the following command. + +```sh +vgdisplay +``` + If you don't have enough space you have to resize the physical volume as described in this article. Then run the following command. @@ -90,7 +95,7 @@ If the volume to shrink is the root volume it has to be done offline. For that a simple installation stick is enough. [The Arch Linux entry](/wiki/linux/arch-linux.md#installation-medium) describes the creation of such a boot stick. -Afterwards the operating system has to be booted from the just created stick or a comparable +Afterward, the operating system has to be booted from the just created stick or a comparable device. For non-root volumes this extra step can be skipped. @@ -141,7 +146,7 @@ sudo pvmove `` is the physical volume that will get emptied and later removed from the logical volume. -Afterwards the physical volume is emptied and can be removed from the logical volume by running the +Afterward, the physical volume is emptied and can be removed from the logical volume by running the following command. ```sh @@ -154,6 +159,6 @@ After this command the physical volume is no longer a part of it. If no longer used the empty physical volume can then be removed as described in the [according section](#remove-physical-volume). -Afterwards the file system can be matched to the logical volume so it takes up the full new size. +Afterward, the file system can be matched to the logical volume so it takes up the full new size. This is explained in the :wq[entry about disk management](/wiki/linux/disk-management.md#growing-a-file-system). diff --git a/wiki/linux/ly.md b/wiki/linux/ly.md index e3f5015..8a775ec 100644 --- a/wiki/linux/ly.md +++ b/wiki/linux/ly.md @@ -17,7 +17,7 @@ This can be done by using one or both of the following commands. systemctl start ly.service ``` -Finally the [SystemD](/wiki/linux/systemd.md) Ly service needs to be enabled and reboot the +Finally, the [SystemD](/wiki/linux/systemd.md) Ly service needs to be enabled and reboot the system. ```sh diff --git a/wiki/linux/mdadm.md b/wiki/linux/mdadm.md index 0907331..9d9a4f3 100644 --- a/wiki/linux/mdadm.md +++ b/wiki/linux/mdadm.md @@ -7,14 +7,13 @@ For the rest of this entry `n` is the number of drives inside a raid device. ### Get Information About a Raid -To get an info for a running raid (assuming it is `/dev/md0`) run -`mdadm -D /dev/md0`. +To get an info for a running raid (assuming it is `/dev/md0`) run `mdadm -D /dev/md0`. ### Add Disk/Partition to Raid Device You can add a disk or partition to a raid device by running the following. -It is assumed you are adding a partition called `/dev/sdd1` but it could also -be a whole drive and the mdadm drive is called `/dev/md0`. +It is assumed you are adding a partition called `/dev/sdd1` but it could also be a whole drive and +the MDADM drive is called `/dev/md0`. `mdadm --add /dev/md0 /dev/sdd1` @@ -36,18 +35,17 @@ mdadm --grow --raid-disks=5 /dev/md0 `5` is the number of disks that should be active. For adding disks view the [previous section](#add-diskpartition-to-raid-device). -In the [following section](#changing-reshape-speed) methods are described that -can be tried to affect the performance of the reshaping of a Raid array. +In the [following section](#changing-reshape-speed) methods are described that can be tried to +affect the performance of the reshaping of a Raid array. ### Changing Reshape Speed Reshaping can take a long time. -It can be useful to increase or decrease the speed of it depending on the usage -of the raid array while resizing. +It can be useful to increase or decrease the speed of it depending on the usage of the raid array +while resizing. The following section is based on a guide by [nixCraft](https://www.cyberciti.biz/tips/linux-raid-increase-resync-rebuild-speed.html) -and addresses the temporary change of speed of the reshape process of a raid -array. +and addresses the temporary change of speed of the reshape process of a raid array. There are two values that can be temporarily changed to limit the reshape speed. Those are `dev.raid.speed_limit_min` which defaults to `1000` and @@ -79,8 +77,7 @@ It can be changed with the following command which sets it to `32 MiB`. echo 32768 > /sys/block/md3/md/stripe_cache_size ``` -However make sure not to set it too large, as this can result in a -"out of memory" condition. +However make sure not to set it too large, as this can result in a `out of memory` condition. The memory consumed can be calculated with the following formula. ```txt @@ -92,7 +89,7 @@ memory_consumed = system_page_size * nr_disks * stripe_cache_size Raid 1 creates a mirror with even amount of drives. For `n=2` [raid 5](#raid-5) and raid 1 are basically the same. The space efficiency is `1/n` and the fault tolerance is `n-1` drive failure. -The read perfromance is `n` and the write performance `1`. +The read performance is `n` and write performance `1`. #### Create Raid 1 Device @@ -110,25 +107,20 @@ Note that mostly raid 1 devices consisting of 2 drives should be converted to [raid 5](#raid-5). - Remove all drives but 2 (if there are more drives than that) by running - `mdadm /dev/md0 --fail /dev/sda1` and `mdadm /dev/md0 --remove /dev/sda1` - where `sda1` is the drive to remove -- Make sure your raid 1 array has only 2 active drives by running - `mdadm --grow /dev/md0 -n 2` + `mdadm /dev/md0 --fail /dev/sda1` and `mdadm /dev/md0 --remove /dev/sda1` + where `sda1` is the drive to remove +- Make sure your raid 1 array has only 2 active drives by running `mdadm --grow /dev/md0 -n 2` - Now convert your raid 1 to a raid 5 device with `mdadm --grow /dev/md0 -l5` -- Add the disks you removed back to the raid with - `mdadm /dev/md0 --add /dev/sda1` -- Finally grow the active drive number to your needs (in this example 4) - `mdadm --grow /dev/md0 -n4` -- MDADM now reshapes the raid. You can monitor it by running - `watch cat /proc/mdstat` +- Add the disks you removed back to the raid with `mdadm /dev/md0 --add /dev/sda1` +- Finally, grow the active drive number to your needs (in this example 4) + `mdadm --grow /dev/md0 -n4` +- MDADM now reshapes the raid. You can monitor it by running `watch cat /proc/mdstat` ### Raid 5 -Raid 5 creates a raid device with distributed parity and is set to have at least -3 drives. +Raid 5 creates a raid device with distributed parity and is set to have at least 3 drives. The space efficiency is `1-(1/n)` and the fault tolerance is `1` drive failure. -The read perfromance is `n` and the write performance `1/4` for single sector -and `n-1` for full stripe. +The read performance is `n` and write performance `1/4` for single sector and `n-1` for full +stripe. -In the special case of 2 drives in a raid 5 it is functionally the same as -[raid 1](#raid-1). +In the special case of 2 drives in a raid 5 it is functionally the same as [raid 1](#raid-1). diff --git a/wiki/linux/mkinitcpio.md b/wiki/linux/mkinitcpio.md index bbbcd79..3f2826b 100644 --- a/wiki/linux/mkinitcpio.md +++ b/wiki/linux/mkinitcpio.md @@ -24,7 +24,7 @@ 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. +Afterward, open the file `boot/loader/entries/arch.conf` and change the following lines. ```txt linux /vmlinuz-linux @@ -40,7 +40,7 @@ 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. +Afterward, the system should be rebooted for the change to take effect. ## Usage @@ -62,7 +62,7 @@ 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). +Afterward, the initial ramdisk has to be [rebuild](#manually-generate-initial-ramdisk). ### Manually Generate Initial Ramdisk @@ -85,7 +85,7 @@ mkinitcpio -P 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=`. +Additionally, compression options can be set under `COMPRESSION_OPTIONS=`. An easily usable example for this is the following line. ```txt diff --git a/wiki/linux/netplan.md b/wiki/linux/netplan.md index 5d013b2..eb02850 100644 --- a/wiki/linux/netplan.md +++ b/wiki/linux/netplan.md @@ -32,5 +32,5 @@ network: version: 2 ``` -Afterwards netplan has to be restarted by running `sudo netplan apply`. +Afterward, netplan has to be restarted by running `sudo netplan apply`. The addresses then are assigned to the system. diff --git a/wiki/linux/networkmanager.md b/wiki/linux/networkmanager.md index 9db6926..91973d1 100644 --- a/wiki/linux/networkmanager.md +++ b/wiki/linux/networkmanager.md @@ -6,12 +6,10 @@ It is used to set up [Wi-Fi](/wiki/linux/hardware_%28linux%29.md#wi-fi). ## Setup -NetworkManager can be installed with the `networkmanager` package on most linux -distributions which provides daemon aswell as `nmcli` a command line interface -and `nmtui` a [terminal](/wiki/linux/system_console.md) user interface for -configuration. -Additionally `nm-connection-editor` can be installed for a graphical user -interface. +NetworkManager can be installed with the `networkmanager` package on most linux distributions which +provides daemon aswell as `nmcli` a command line interface and `nmtui` a +[terminal](/wiki/linux/system_console.md) user interface for configuration. +Additionally, `nm-connection-editor` can be installed for a graphical user interface. ## Usage @@ -21,12 +19,12 @@ After installation `networkmanager.service` has to be enabled by the used ### OpenVPN Integration -NetworkManager needs a plugin to work with openvpn configurations. +NetworkManager needs a plugin to work with OpenVPN configurations. This plugin can be installed with the `networkmanager-openvpn` package. OpenVPNs `.ovpn` files can then be imported by running `nmcli connection import type openvpn file `. -Afterwards they can be modified accordingly. +Afterward, they can be modified accordingly. ### Prioritize Connections diff --git a/wiki/linux/openssh.md b/wiki/linux/openssh.md index 9606940..1557100 100644 --- a/wiki/linux/openssh.md +++ b/wiki/linux/openssh.md @@ -59,7 +59,7 @@ It functions similar to the first and uses the following command. ssh-copy-id -f -i ``` -The `-f` flag can alos be omittet to check if the key is already installed. +The `-f` flag can also be omitted to check if the key is already installed. For being very safe is important, a dry run can be performed using the `-n` flag. ### Mount Directory With SSHFS @@ -107,15 +107,15 @@ X-forwarding is enabled by editing a line to look like the following. ```txt X11Forwarding yes ``` - -Make sure to restart the SSH daemon afterwards by running the following command. +f +Make sure to restart the SSH daemon afterward by running the following command. ```sh service sshd restart ``` -Afterwards X-forwarding should be enabled on the server. -For full functionality install the `x11-apps` package aswell. +Afterward, X-forwarding should be enabled on the server. +For full functionality install the `x11-apps` package as well. #### Enabling X-Forwarding on a Client @@ -148,7 +148,7 @@ A specific port can be tunneled from a remote host to a client via SSH. This could be especially useful when coding remotely and wanting to access a database like PostgreSQL or other services. For the forwarding of a port run the following command. -`` (for example `localhost`) and `` (for example `63333`) are the +`` (for example `localhost`) and `` (for example `63333`) are the target (and most of the time local) address and port to tunnel the service to. `
` (for example `joe@foo.com` or an alias) specifies the address and username of the server that hosts the service and `` (for example `5432`) describes the port @@ -166,7 +166,7 @@ the process. ps aux | grep "ssh -f -N -L " ``` -Afterwards it can be killed by running the follwing command where `` is the id of the +Afterward, it can be killed by running the following command where `` is the ID of the process found with the previous command. ```sh @@ -174,14 +174,14 @@ kill ``` Files that are based on a remote server can be mounted as described in -[the corresponding section](#mount-directory-with-sshfs) to setup complete remote development. +[the corresponding section](#mount-directory-with-sshfs) to set up complete remote development. ### Specify Key Exchange Algorithms It can be useful to specify the key exchange algorithms in the OpenSSH config file `~/.ssh/config`. Some key exchange algorithms are more secure regarding post-quantum attacks. The following configuration prefers and enforces hybrid post-quantum–resistant key exchange -algorithms (`mlkem768x25519-sha256` and `sntrup761x25519-sha512`). +algorithms (`mlkem768x25519-sha256` and `sntrup761x25519-sha512`). A modern classical fallback (`curve25519-sha256`) is included for compatibility. This can be considered a form on [system hardening](/wiki/linux/system-hardening.md#specific-steps-to-harden-a-system). diff --git a/wiki/linux/package_manager/apt.md b/wiki/linux/package_manager/apt.md index a7ec6c9..684b4c3 100644 --- a/wiki/linux/package_manager/apt.md +++ b/wiki/linux/package_manager/apt.md @@ -17,7 +17,7 @@ command. apt update ``` -Afterwards there are two possible update types without changing the major release version. +Afterward, there are two possible update types without changing the major release version. The following command - `upgrade` - updates the packages only if no new or previously removed dependencies are needed. diff --git a/wiki/linux/package_manager/pacman_and_aur.md b/wiki/linux/package_manager/pacman_and_aur.md index c172395..c906ac1 100644 --- a/wiki/linux/package_manager/pacman_and_aur.md +++ b/wiki/linux/package_manager/pacman_and_aur.md @@ -53,7 +53,7 @@ This works like the following assuming the package `v4l2loopback-dmks` needs to sudo downgrade v4l2loopback-dmks ``` -Afterwards the target version can be selected and the downgrading process will conclude. +Afterward, 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). @@ -67,7 +67,7 @@ Using the `makepkg` command it can be installed like the following command shows makepkg -sirc ``` -Afterwards it is installed on the system and can be further managed (especially uninstalled) by the +Afterward, it is installed on the system and can be further managed (especially uninstalled) by the Pacman package manager. ### Installing an AUR Program with a Specific Version @@ -77,7 +77,7 @@ For this navigate to the AUR page of the program to install. On the right-hand side click on `View Changes` and select the version you want to install in the commit list. Next to `download` a `.tar.gz` file can be downloaded which includes a `PKGBUILD` file. -Afterwards it needs to be [uncompressed](/wiki/linux/tar.md#uncompressing-a-tar-archive). +Afterward, it needs to be [uncompressed](/wiki/linux/tar.md#uncompressing-a-tar-archive). ### Clear Cache diff --git a/wiki/linux/papis.md b/wiki/linux/papis.md index 43e8ced..04f9ebb 100644 --- a/wiki/linux/papis.md +++ b/wiki/linux/papis.md @@ -58,7 +58,7 @@ papis add https://arxiv.org/abs/1712.03134 ``` To remove an entry the following command can be run. -Afterwards the entry that should be removed can be easily selected via the terminal user interface. +Afterward, the entry that should be removed can be easily selected via the terminal user interface. ```sh papis rm @@ -112,13 +112,13 @@ inside the folder `tmp-db`. papis bibtex read mylib.bib import -a -o tmp-db ``` -Afterwards the contents of the temporary database should be checked to be correctly imported. +Afterward, the contents of the temporary database should be checked to be correctly imported. ```sh papis -l tmp-db edit ``` -Afterwards the contents of the temporary library should be moved to the actualy directory where +Afterward, the contents of the temporary library should be moved to the actualy directory where papis stores its entries. The path for that can be found in the [config file](#configuration). @@ -126,7 +126,7 @@ The path for that can be found in the [config file](#configuration). mv tmp-db/* /path/to/your/library/folder/ ``` -Finally the cache needs to be cleared +Finally, the cache needs to be cleared [as described in the corresponding section](#clearing-the-cache) for Papis to display the new entries correctly. diff --git a/wiki/linux/pipewire.md b/wiki/linux/pipewire.md index 251f7ef..9bd2bef 100644 --- a/wiki/linux/pipewire.md +++ b/wiki/linux/pipewire.md @@ -5,12 +5,11 @@ ## Setup -For clients that use the [PulseAudio](/wiki/linux/pulseaudio.md) API -`pipewire-pulse` (on Arch-based distros or according -packages on other distros) can be installed. +For clients that use the [PulseAudio](/wiki/linux/pulseaudio.md) API `pipewire-pulse` (on +Arch-based distros or according packages on other distros) can be installed. It will automatically remove unneeded and conflicting PulseAudio packages. -Additionally `pipewire-alsa` and `pipewire-jack` for JACK and Alsa clients are -available and recommended to install for full compatibility with most software. +Additionally, `pipewire-alsa` and `pipewire-jack` for JACK and Alsa clients are available. +They are recommended to be installed for full compatibility with most software. Make sure to restart to be sure everything is running correctly. ### Configuration @@ -41,7 +40,7 @@ used as a simple mixer. ### Routing -This section focusses on graph-based interfaces also called patchbays. +This section focuses on graph-based interfaces also called patchbays. For more advanced routing [qpwgraph](https://github.com/rncbc/qpwgraph) can be used, but the GTK-based [Helvum](https://gitlab.freedesktop.org/pipewire/helvum) is also available. The third available option is [Patchance](https://github.com/Houston4444/Patchance) - this is the @@ -88,8 +87,8 @@ pw-loopback -C ### Virtual Devices -This section focusses on the temporary and permanent creation and removal of virtual devices like -virtual sinks and sources aswell as coupled nodes like loopbacks. +This section focuses on the temporary and permanent creation and removal of virtual devices like +virtual sinks and sources as well as coupled nodes like loopbacks. Please note that problems may occur if [EasyEffects](/wiki/linux/easyeffects.md) is used in combination with virtual devices. diff --git a/wiki/linux/plymouth.md b/wiki/linux/plymouth.md index 6d38945..f63cda0 100644 --- a/wiki/linux/plymouth.md +++ b/wiki/linux/plymouth.md @@ -8,7 +8,7 @@ It can change the native resolution early in the boot process and display splash On most linux distributions LightDM can be installed with the `plymouth` package. -Afterwards the kernel options need to be changed. +Afterward, the kernel options need to be changed. On [Arch Linux](/wiki/linux/arch-linux.md) systems this can be done by editing the file located at `/boot/loader/entries/arch.conf`. In the options line append `quiet` if you want to use the quiet-mode and `splash` if you want to @@ -27,7 +27,7 @@ The listing of installed themes is featured in a [latter section](#list-availabl Then inside the file `/etc/mkinitcpio.conf` add the hook under the `HOOKS` section. Add `plymouth` after `systemd` (if available) and before `encrypt` and `lvm2` (if available.) -Finally regenerate the initial ramdisk as described +Finally, regenerate the initial ramdisk as described [in the mkinitcpio entry](/wiki/linux/mkinitcpio.md#manually-generate-initial-ramdisk). For this run the following command. diff --git a/wiki/linux/proxmox.md b/wiki/linux/proxmox.md index eb642ec..99a98d0 100644 --- a/wiki/linux/proxmox.md +++ b/wiki/linux/proxmox.md @@ -85,7 +85,7 @@ Sometimes this process asks if the user wants to replace the local configuration ones. It is generally recommended to select `N` and reject these new configurations. -Finally another reboot is needed and the version number can be +Finally, another reboot is needed and the version number can be [checked again](#retrieve-pve-version) confirming that the major version upgrade was successfully performed. @@ -125,7 +125,7 @@ For example if you want to the disk 100 by 100G (100GibiByte): qm resize 100 ide0 +100G ``` -Afterwards the partition of the VM needs to be enlarged. +Afterward, the partition of the VM needs to be enlarged. For that [the disk management article](/wiki/linux/disk-management.md#grow-non-lvm-partition) can be used for non-LVM paritions. @@ -140,7 +140,7 @@ First remove `local-lvm` with `lvremove /dev/pve/data`. Then remove `local-lvm` in the proxmox gui via `Datacenter/Storage/Remove`. Change the `Content` of the remaining storage according to your needs. Add the free storage to the remaining storage with `lvresize -rl +100%FREE /dev/pve/root`. -Finally extend the filesystem `resize2fs /dev/mapper/pve-root`. +Finally, extend the filesystem `resize2fs /dev/mapper/pve-root`. ### USB Passthrough diff --git a/wiki/linux/qt.md b/wiki/linux/qt.md index 8675a41..d543436 100644 --- a/wiki/linux/qt.md +++ b/wiki/linux/qt.md @@ -16,7 +16,7 @@ qt5ct is officially archived and qt6ct is the recommended program to use and wil discussed in this article. These programs can sometimes be found as [package](/wiki/linux/package_manager.md) of the same name. -Afterwards `qt6ct` can be run to get a graphical user interface to set the theme and icons of Qt +Afterward, `qt6ct` can be run to get a graphical user interface to set the theme and icons of Qt applications. This will create or edit a configuration file located at `~/.config/qt6ct/qt6ct.conf`. To make this config apply for all Qt applications the following line needs to be inserted into the @@ -26,7 +26,7 @@ To make this config apply for all Qt applications the following line needs to be export QT_QPA_PLATFORMTHEME="qt6ct" ``` -Afterwards `qt6ct` can be used to enable the dark mode or change other configurations. +Afterward, `qt6ct` can be used to enable the dark mode or change other configurations. #### Achieving a System-Wide Uniform Look @@ -56,5 +56,5 @@ When updating the system it is possible that the theme will not work correctly a Often the error `The libqt6ct.so plugin is compiled against incompatible Qt version` is responsible for this. To fix it most of the time it is enough to recompile the `qt6ct` package. -Afterwards a reboot might be needed for the theme to be displayed correctly again. +Afterward, a reboot might be needed for the theme to be displayed correctly again. diff --git a/wiki/linux/shell.md b/wiki/linux/shell.md index 7b74cca..1b6b5a2 100644 --- a/wiki/linux/shell.md +++ b/wiki/linux/shell.md @@ -72,7 +72,7 @@ In the following example the string `string1` will be substituted by `string2` f rename 's/string1/string2/g' file.ext ``` -Additionally `find` can be used to recursively substitute substrings in all files inside a folder +Additionally, `find` can be used to recursively substitute substrings in all files inside a folder `folder` (including subfolders). ```sh @@ -161,7 +161,7 @@ yay -S dash sudo ln -sfT /bin/dash /bin/sh ``` -Afterwards create the file `/usr/share/libalpm/hooks/bash-update.hook` and fill +Afterward, create the file `/usr/share/libalpm/hooks/bash-update.hook` and fill it with the following text. ```txt @@ -229,7 +229,7 @@ find -type f -exec sed -i "s///g" {} \; ANSI-Colors can easily be used in the shell by using the control sequences as described by [techstop](https://techstop.github.io/bash-script-colors). Each color has an own sequence and can be combined to affect the background. -Additionally the font can also be changed using these control sequences. +Additionally, the font can also be changed using these control sequences. The following tables display these sequences. diff --git a/wiki/linux/shntool.md b/wiki/linux/shntool.md index ff97bd9..d01819b 100644 --- a/wiki/linux/shntool.md +++ b/wiki/linux/shntool.md @@ -58,7 +58,7 @@ On Ubuntu systems the repository first has to be added by running the following add-apt-repository -y ppa:flacon ``` -Afterwards `flacon` can be installed like a normal package. +Afterward, `flacon` can be installed like a normal package. ## Troubleshooting diff --git a/wiki/linux/suckless.md b/wiki/linux/suckless.md index f3e898f..b073aad 100644 --- a/wiki/linux/suckless.md +++ b/wiki/linux/suckless.md @@ -9,11 +9,11 @@ Notable works of Suckless are the following. - [slock](https://tools.suckless.org/slock/) is a screen locker - [st](https://st.suckless.org/) is a [terminal](/wiki/linux/system_console.md) - [dwl](https://codeberg.org/dwl/dwl) is a window manager similar to dwm that can be used on - [Wayland](/wiki/linux/wayland.md) systems. - For the IPC-patch [dwlmsg](https://codeberg.org/notchoc/dwlmsg) can also be used. + [Wayland](/wiki/linux/wayland.md) systems. + For the IPC-patch [dwlmsg](https://codeberg.org/notchoc/dwlmsg) can also be used. -Additionally to this Suckless maintains a list of free and open-source software that is endorsed by -Suckless. +Additionally, to this Suckless maintains a list of free and open-source software that is endorsed +by Suckless. This list can be found on [Suckless' Website](https://suckless.org/rocks/). ## Setup @@ -28,22 +28,21 @@ Expressions in `<>` may need replacement. - Download the default version of the suckless program you want to patch - Add and commit all the files in the `base` branch - Clean the master branch -with `make clean & rm -f config.h & git reset --hard origin/base` + with `make clean & rm -f config.h & git reset --hard origin/base` - Apply patches (this has to be done only once for each branch (except updates)) - Create and switch to a new branch for the patch with `git branch ` - Download the `.diff` file of the according feature into your directory - Apply the patch to the current directory with `git apply .diff` - Add and commit all the files in the `` branch - Merge all branches into master branch (sometimes you can skip already merged -ones) + ones) - Merge each branch (except the new feature) into master with `git merge ` - (maybe you have to manually merge some errors) - If you have a `config` branch merge `config` into `master` before adding the new `feature` -- Finally update the `config` branch +- Finally, update the `config` branch - If not created already create a `config` branch from the `base` branch - - Get the `config.def.h` of `master` into `config` with - `git checkout master config.def.h` + - Get the `config.def.h` of `master` into `config` with `git checkout master config.def.h` ## Troubleshooting @@ -51,12 +50,10 @@ This section addresses various errors that can happen when using suckless progra ### Suckless Program Crashes Or Struggles With Colored Emojis -Suckless programs especially `st` and `dmenu` can not display colored -emojis. +Suckless programs especially `st` and `dmenu` can not display colored emojis. This is because of problems with libxft. libxft is the client side font rendering library to display anti-aliased text. -To change this [libxft-bgra](https://github.com/uditkarode/libxft-bgra) needs -to be installed. +To change this [libxft-bgra](https://github.com/uditkarode/libxft-bgra) needs to be installed. This is a patched version especially for running with the suckless programs. ### Display Manager Problems with Full Screen Windows @@ -65,6 +62,6 @@ Using `dwm` or its [Wayland](/wiki/linux/wayland.md) counterpart `dwl` there may with full screen programs. Some of these programs (especially [Steam](/wiki/game/steam.md) [Games](/wiki/game.md)) might apparently freeze. -However, this may be not the case as they may be only displaying a freeze frame. +However, this may be not the case as they may be only displaying a freeze-frame. This can sometimes be fixed by navigating out of the window managers full screen, then making it a floating window and then setting it to be full screen again. diff --git a/wiki/linux/swayidle.md b/wiki/linux/swayidle.md index 0911923..d37a8ec 100644 --- a/wiki/linux/swayidle.md +++ b/wiki/linux/swayidle.md @@ -12,7 +12,7 @@ To run swayidle it has to be called - preferably after the boot process. An example of this will look like the following. This will [suspend-then-hibernate](/wiki/linux/systemd.md#change-suspend-and-hibernate-behavior) the system after 30 seconds. -Additionally a program [xss-lock](/wiki/linux/xss-lock.md) has to be used to let swayidle know to +Additionally, a program [xss-lock](/wiki/linux/xss-lock.md) has to be used to let swayidle know to use a specific lock command. ```sh diff --git a/wiki/linux/systemd.md b/wiki/linux/systemd.md index e621e77..fb46c0f 100644 --- a/wiki/linux/systemd.md +++ b/wiki/linux/systemd.md @@ -108,7 +108,7 @@ HandleLidSwitchExternalPower=ignore HandleLidSwitchDocked=ignore ``` -Afterwards the logind service has to be restarted +Afterward, the logind service has to be restarted [as described on a later section](#startstopenabledisable-a-service-and-retrieve-its-logs). ```sh diff --git a/wiki/linux/tlp.md b/wiki/linux/tlp.md index 451e5a1..541085c 100644 --- a/wiki/linux/tlp.md +++ b/wiki/linux/tlp.md @@ -9,7 +9,7 @@ optimizing battery life. TLP can be installed on most distributions by installing the `tlp` package. Additionally, the installation of `tlp-rdw` is recommended, which is used to get better control over radio devices. -Afterward the TLP [service](/wiki/linux/systemd.md#startstopenabledisable-a-service) needs to be +Afterward, the TLP [service](/wiki/linux/systemd.md#startstopenabledisable-a-service) needs to be started and enabled. In contrast to other [SystemD services](/wiki/linux/systemd.md#startstopenabledisable-a-service) this diff --git a/wiki/linux/v4l2.md b/wiki/linux/v4l2.md index 4babb46..b4572fd 100644 --- a/wiki/linux/v4l2.md +++ b/wiki/linux/v4l2.md @@ -69,7 +69,7 @@ Note the line starting with `ExecStart=/bin/` is the same line described in the [above section](#create-temporary-v4l2-devices). Make sure to change it if needed. -Afterwards enable the service to start at every boot process aswell as running it by using the +Afterward, enable the service to start at every boot process aswell as running it by using the following command: ```sh diff --git a/wiki/linux/vifm.md b/wiki/linux/vifm.md index 0a82ff1..95fc4fc 100644 --- a/wiki/linux/vifm.md +++ b/wiki/linux/vifm.md @@ -118,7 +118,7 @@ main() { main "$@" ``` -Additionally the following lines can be inserted into the configuration of vifm +Additionally, the following lines can be inserted into the configuration of vifm `~/.config/vifm/vifmrc` as needed. They provide previews for various possible types of file extensions. diff --git a/wiki/linux/watson.md b/wiki/linux/watson.md index 9d18b64..425d1c3 100644 --- a/wiki/linux/watson.md +++ b/wiki/linux/watson.md @@ -6,7 +6,7 @@ ## Setup On most Linux distributions Watson can be installed with the `watson` package. -Additionally Watson can be installed using Pythons pip package manager. +Additionally, Watson can be installed using Pythons pip package manager. The pip package is called `td-watson`. Alternatively it can be installed via [GitHub](https://github.com/TailorDev/Watson). @@ -37,7 +37,7 @@ The tracking of the time can be stopped by running the following command. watson stop ``` -Afterwards the summary of the tracked time can be displayed by running the following command. +Afterward, the summary of the tracked time can be displayed by running the following command. ```sh watson report @@ -50,7 +50,7 @@ forgotten at that time. For this the following command can be run. It works similarly to starting a time frame as explained in the [section above](#tracking-time-and-displaying-tracked-time). -Additionally the start and stop time are specified with the `--from` and `--to` flags. +Additionally, the start and stop time are specified with the `--from` and `--to` flags. ```sh watson add --from "2018-03-20 12:00:00" --to "2018-03-20 13:00:00" programming +addfeature diff --git a/wiki/linux/wpa_supplicant.md b/wiki/linux/wpa_supplicant.md index 42f4894..398423d 100644 --- a/wiki/linux/wpa_supplicant.md +++ b/wiki/linux/wpa_supplicant.md @@ -32,6 +32,6 @@ Most of the problems regarding WPA Supplicant can be fixed by restarting the systemctl restart wpa_supplicant ``` -Afterwards - if the error still persists - it may be useful to reenable the Wi-Fi device as -explained in the +Afterward, if the error still persists - it may be useful to reenable the Wi-Fi device as explained +in the [section of the NetworkManager entry](/wiki/linux/networkmanager.md#restarting-and-reenabling-wi-fi). diff --git a/wiki/linux/x_window_system.md b/wiki/linux/x_window_system.md index f38e301..b3b0b8f 100644 --- a/wiki/linux/x_window_system.md +++ b/wiki/linux/x_window_system.md @@ -125,7 +125,7 @@ setxkbmap -layout -option compose: #### Display This section describes the handling of displays by X. -Additionally to the guides in this section that are independent of the used graphics unit special +Additionally, to the guides in this section that are independent of the used graphics unit special configuration for [Nvidia](/wiki/linux/nvidia.md) and [Intel](/wiki/linux/intel.md) can be found in their respective entries in this wiki. @@ -180,7 +180,7 @@ The DPI number should be adjusted as needed. Xft.dpi: 100 ``` -Afterwards `~/.config/xorg/xpcspec` needs to be sourced in the `~/.xinitrc` file. +Afterward, `~/.config/xorg/xpcspec` needs to be sourced in the `~/.xinitrc` file. For this to work the following line needs to be added into the `~/.xinitrc` file . ```sh diff --git a/wiki/love.md b/wiki/love.md index 923726a..3084fdc 100644 --- a/wiki/love.md +++ b/wiki/love.md @@ -29,7 +29,7 @@ love For building the game, the game directory has to be compressed first, then compiled and finally the permissions has to be changed to make the compiled file runnable. -Afterwards the game can be compiled using the following command, where `` is the +Afterward, the game can be compiled using the following command, where `` is the path to the game directory and `` is the name the compiled file should be called. ```sh @@ -38,7 +38,7 @@ cat /usr/bin/love .love > chmod a+x ``` -Afterwards the compiled file can simply be run using the usual [Shell](/wiki/linux/shell.md) +Afterward, the compiled file can simply be run using the usual [Shell](/wiki/linux/shell.md) command. ```sh diff --git a/wiki/ltex.md b/wiki/ltex.md index f821913..1525295 100644 --- a/wiki/ltex.md +++ b/wiki/ltex.md @@ -61,7 +61,7 @@ following command. \usepackage[]{babel} ``` -Additionally the following command can be used to change the language from that place onwards. +Additionally, the following command can be used to change the language from that place onwards. ```tex \selectlanguage{} @@ -74,7 +74,7 @@ Using the following command the language can be changed just for the text that i \foreignlanguage{}{} ``` -Finally an otherlanguage environment can be used to achieve the same as shown in the following +Finally, an otherlanguage environment can be used to achieve the same as shown in the following example. ```tex diff --git a/wiki/matrix.md b/wiki/matrix.md index 3e1557e..5095a57 100644 --- a/wiki/matrix.md +++ b/wiki/matrix.md @@ -23,8 +23,8 @@ jitsi, [a web client using a self-hosted Element server](#element-web-client) an You will need to create some [DNS](/wiki/dns.md) entries in order for synapse to function correctly. -Additionally you will need 2 subdomains (this guide will assume you use the -domain `example.com` with the subdomains `matrix` and `synapse`). +Additionally, you will need 2 subdomains (this guide will assume you use the domain `example.com` +with the subdomains `matrix` and `synapse`). Create the following DNS records. @@ -101,7 +101,7 @@ and add the following line either set to `true` or `false`. enable_registration: true ``` -Additionally create the following lines. +Additionally, create the following lines. ``` federation_ip_range_blacklist: @@ -127,7 +127,7 @@ If this is not the case please check your configuration. Create an admin user in the docker containers shell with the command: `register_new_matrix_user -c /data/homeserver.yaml https://synapse.example.com` -Finally shut down the container using `docker-compose down` to be able to keep +Finally, shut down the container using `docker-compose down` to be able to keep following the guide (this applies to any following step). ### Nginx @@ -413,7 +413,7 @@ Change `matrix.example.com` to match the value of `realm` in `data/matrix/coturn Do the same for `turn_shared_secret` with the value of `static-auth-secret` in `data/matrix/coturn/turnserver.conf`. -Finally add the following lines in the `service` section to your `docker-compose.yml`. +Finally, add the following lines in the `service` section to your `docker-compose.yml`. ```yml coturn: @@ -427,4 +427,4 @@ Finally add the following lines in the `service` section to your `docker-compose - "5349:5349" ``` -Afterwards if not done already restart the Matrix server and all its services. +Afterward, if not done already restart the Matrix server and all its services. diff --git a/wiki/microcontroller.md b/wiki/microcontroller.md index 511ef22..03df14d 100644 --- a/wiki/microcontroller.md +++ b/wiki/microcontroller.md @@ -23,7 +23,7 @@ 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`. +Afterward, install the board manager `esp32`. ### Flash Firmware on the ESP32 @@ -52,7 +52,7 @@ If it is not in programming mode it will show up as port but will encounter `Wri when trying to flash programs or firmware onto it. To put the ESP32 in the programming mode press and hold the Boot-Button (usually labeled `B`). Then press and release the Reset-Button (usually labeled `R`). -Afterwards release the Boot-Button. +Afterward, release the Boot-Button. The board now should be in programming mode and it should be possible to upload and flash programs or firmware onto it. This section is based on a Reddit diff --git a/wiki/mpv.md b/wiki/mpv.md index e82525c..3e569f9 100644 --- a/wiki/mpv.md +++ b/wiki/mpv.md @@ -31,7 +31,7 @@ make cp mpv_thumbnail_script_client_osc.lua mpv_thumbnail_script_server.lua ~/.config/mpv/scripts ``` -Afterwards create the file `~/.config/mpv/script-opts/mpv_thumbnail_script.conf` with the following +Afterward, create the file `~/.config/mpv/script-opts/mpv_thumbnail_script.conf` with the following text. ```txt diff --git a/wiki/nativefier.md b/wiki/nativefier.md index 2a79d17..3628dfe 100644 --- a/wiki/nativefier.md +++ b/wiki/nativefier.md @@ -9,7 +9,7 @@ Nativefier creates [Electron-based web-apps](/wiki/electron.md). ## Setup Nativefier is available on [GitHub](https://github.com/nativefier/nativefier). -Additionally for some [Linux distributions](/wiki/linux.md#distributions) like +Additionally, for some [Linux distributions](/wiki/linux.md#distributions) like [Arch Linux' AUR](/wiki/linux/package_manager.md#arch-linux-pacman-and-yay) it is available via a package often called `nodejs-nativefier`. @@ -52,7 +52,7 @@ nativefier --name Mastodon \ --single-instance https://mastodon.technology ``` -Afterwards if a [Linux](/wiki/linux.md)-based system is used the created app can be added to the +Afterward, if a [Linux](/wiki/linux.md)-based system is used the created app can be added to the path. An example for this is the following command which [links](/wiki/linux/shell.md#symbolic-links-using-ln) the applicatoin to a specifically created diff --git a/wiki/obs.md b/wiki/obs.md index 4589e77..b44a428 100644 --- a/wiki/obs.md +++ b/wiki/obs.md @@ -22,7 +22,7 @@ camera. First of all [V4L2](/wiki/linux/v4l2.md) needs to be set up. This guide assumes it is set up according to the section in the [V4L2 entry](/wiki/linux/v4l2.md#v4l2loopback). -Afterwards the virtual camera can be started. +Afterward, the virtual camera can be started. ### Background Removal @@ -35,7 +35,7 @@ Made by royshil [the GitHub page](https://github.com/royshil/obs-backgroundremov various possibilities to install the background removal for OBS on different systems. On Linux systems background removal is often contained in a package named `obs-backgroundremoval` or similarly. -Afterwards the background removal can be added as a filter on a input source. +Afterward, the background removal can be added as a filter on a input source. ## Troubleshooting diff --git a/wiki/office_suite.md b/wiki/office_suite.md index 02610db..1921af7 100644 --- a/wiki/office_suite.md +++ b/wiki/office_suite.md @@ -1,7 +1,7 @@ # Office Suite An office Suite are bundled programs that usually include productivity tools like word processing, -spreadsheet editing, presentations aswell as [email](/wiki/email.md) and calendar software. +spreadsheet editing, presentations as well as [email](/wiki/email.md) and calendar software. ## Programs @@ -9,17 +9,17 @@ There are various office suites. The following is a list of programs that are popular. - Microsofts Office is arguably the original office suite. - It includes Microsofts Excel, Word, Powerpoint and more for [Windows](/wiki/windows.md) + It includes Microsofts Excel, Word, PowerPoint and more for [Windows](/wiki/windows.md) - [LibreOffice](/wiki/libreoffice.md) is a free and open-source office suite for Windows and - Linux-based systems. - LibreOffice can have problems with hardware-acceleration. - If it doesn't start due to it being enabled, start LibreOffice in safe mode and disable it. -- [Apaches OpenOffice](https://www.openoffice.org/) is an open-source office suite for Windows - and [Linux](/wiki/linux.md). - Most of the time this suite is not used anymore in favor for LibreOffice due to lackluster - development. + Linux-based systems. + LibreOffice can have problems with hardware-acceleration. + If it doesn't start due to it being enabled, start LibreOffice in safe mode and disable it. +- [Apaches OpenOffice](https://www.openoffice.org/) is an open-source office suite for Windows and + [Linux](/wiki/linux.md). + Most of the time this suite is not used anymore in favor for LibreOffice due to lackluster + development. -Additionally to the full fledged office suites programs such as +Additionally, to the full-fledged office suites programs such as [email clients](/wiki/email.md#client) exist. Those are not part of the office suite category by definition but are at least adjacent and have to -be mentioned here aswell. +be mentioned here as well. diff --git a/wiki/open_webui.md b/wiki/open_webui.md index e261d2f..26c7040 100644 --- a/wiki/open_webui.md +++ b/wiki/open_webui.md @@ -8,7 +8,7 @@ allows different workflows and even offline operation. The software can be setup via [Docker](/wiki/docker.md) with the [open-webui image](/wiki/docker/open-webui_-_open-webui.md). -Additionally a provider for the artificial intelligence is needed. +Additionally, a provider for the artificial intelligence is needed. This can be done by using Ollama which can be setup via docker with the [ollama image](/wiki/docker/ollama_-_ollama.md). When using this option the address and port for Ollama has to be set in the admin settings of @@ -32,7 +32,7 @@ list available networks. ollama list ``` -Afterwards a model can be selected and pulled by using the following command. `` is the name +Afterward, a model can be selected and pulled by using the following command. `` is the name of the model obtained in the previous step (for example `deepseek-r1`). ```sh diff --git a/wiki/openvpn.md b/wiki/openvpn.md index 8de3f07..21d2bf3 100644 --- a/wiki/openvpn.md +++ b/wiki/openvpn.md @@ -10,7 +10,7 @@ In the following sections the different set ups of OpenVPN usages are described. The software can be set up via [Docker](/wiki/docker.md) with the [kylemanna image](/wiki/docker/kylemanna_-_openvpn.md). -Additionally to this a client is needed on the system that need access to the +Additionally, to this a client is needed on the system that need access to the server software. ### Client diff --git a/wiki/picard.md b/wiki/picard.md index a2ce67e..1742920 100644 --- a/wiki/picard.md +++ b/wiki/picard.md @@ -7,10 +7,10 @@ It is able to tag a wide range of [audio codecs](/wiki/audio.md#audio-codecs) ## Setup -Picard is available on the [official website](https://picard.musicbrainz.org/) -and [GitHub](https://github.com/metabrainz/picard). -Additionally for some [Linux distributions](/wiki/linux.md#distributions) -it is available via a package often called `picard`. +Picard is available on the [official website](https://picard.musicbrainz.org/) and +[GitHub](https://github.com/metabrainz/picard). +Additionally, for some [Linux distributions](/wiki/linux.md#distributions) it is available via a +package often called `picard`. Picard can also be virtualized and accessed over [VNC](/wiki/vnc.md) or [web browser](/wiki/web_browser.md). @@ -19,7 +19,7 @@ This can be setup via [docker](/wiki/docker.md) with the ## Usage -This section addresses various features of picard. +This section addresses various features of Picard. ### File naming diff --git a/wiki/postgresql.md b/wiki/postgresql.md index b4d5be8..0042883 100644 --- a/wiki/postgresql.md +++ b/wiki/postgresql.md @@ -25,13 +25,13 @@ psql -U -d ``` Alternatively the previous command can be run without the `-d` flag and the following command can -be run afterwards to change the current database. +be run afterward to change the current database. ```sh \c ``` -Afterwards the following command can be used to show all tables in the database. +Afterward, the following command can be used to show all tables in the database. ```sh \dt @@ -55,5 +55,5 @@ Here a `+` can also be appended to gain more information. \d+ ``` -Finally and most importantly classic SQL statements - for example `SELECT`-statements - can be used -too when being logged in to a database. +Finally, and most importantly classic SQL statements - for example `SELECT`-statements - can be +used too when being logged in to a database. diff --git a/wiki/programming_language/python.md b/wiki/programming_language/python.md index e1a1ba4..5ee388f 100644 --- a/wiki/programming_language/python.md +++ b/wiki/programming_language/python.md @@ -49,7 +49,7 @@ aswell. sudo apt install tk-dev tcl-dev ``` -Afterwards the python source code can be downloaded. +Afterward, the python source code can be downloaded. ```sh wget https://www.python.org/ftp/python/3.9.1/Python-3.9.1.tgz @@ -57,7 +57,7 @@ tar -xf Python-3.9.1.tgz cd Python-3.9.1 ``` -Afterwards if OpenSSL should be enabled for Python uncomment all the corresponding lines in +Afterward, if OpenSSL should be enabled for Python uncomment all the corresponding lines in `Modules/Setup`. This part of the guide is taken from a [StackOverflow post by Ironman](https://stackoverflow.com/questions/58309485/modulenotfounderror-no-module-named-ssl). @@ -70,7 +70,7 @@ make sudo make altinstall ``` -Afterwards you can check if the Pyhton version is installed using the following command. +Afterward, you can check if the Pyhton version is installed using the following command. ```sh python3.9 --version @@ -260,12 +260,12 @@ torch.cuda.is_available() The package for [Hailo chips](/wiki/hailo.md) has to be downloaded from the [official website](https://hailo.ai/developer-zone/software-downloads). -Additionally additional setup may be required as explained in the -[Hailo article](/wiki/hailo.md#setup) +Additionally, additional setup may be required as explained in the +[Hailo article](/wiki/hailo.md#setup). Hailo chips can be used to run converted [TensorFlow](#tensorflow) models. The conversion process is explained in the -[Hailo article](/wiki/hailo.md#preparing-tensorflow-models-for-the-ai-hat) +[Hailo article](/wiki/hailo.md#preparing-tensorflow-models-for-the-ai-hat). To run the inference using Python on ARM boards like the [Raspberry Pi AI Hat +](/wiki/linux/raspberry_pi.md#ai-hat) @@ -282,9 +282,9 @@ Tensorflos is a machine learning resource which is often used for The basic usage of TensorFlow is described in [the official guide](https://www.tensorflow.org/guide/keras/serialization_and_saving). -Additionally it is noted that the dataset may have to be shuffled manually as described in a +Additionally, it is noted that the dataset may have to be shuffled manually as described in a [comment by Y. Luo on StackOverflow](https://stackoverflow.com/questions/50184144/shuffle-in-the-model-fit-of-keras). -Finally +Finally, [a Medium blog post](https://medium.com/@danielonugha0/how-to-change-the-learning-rate-of-tensorflow-b5d854819050) describes how to easily change the learning rate. diff --git a/wiki/programming_language/viper.md b/wiki/programming_language/viper.md index 68a934f..5f7e16f 100644 --- a/wiki/programming_language/viper.md +++ b/wiki/programming_language/viper.md @@ -21,13 +21,13 @@ various [package managers](/wiki/linux/package_manager/pacman_and_aur.md). For Carbon Boogie has to be installed too. This is best done by installing a .NET SDK which is often packaged in a package called `dotnet-sdk` or a similar named one. -Afterwards boogie can be installed using the following command. +Afterward, boogie can be installed using the following command. ```sh dotnet tool install -g boogie ``` -Afterwards the building of Silicon and/or Carbon can follow. +Afterward, the building of Silicon and/or Carbon can follow. The easiest way to build one or both verifiers locally is creating a `.jar` file via [Docker](/wiki/docker.md) using the @@ -50,14 +50,14 @@ cd /mnt/carbon sbt assembly ``` -Afterwards leave the Docker container. +Afterward, leave the Docker container. It is no longer needed. The `.jar` files are now available in `/target/scala-/carbon.jar` or `/target/scala-2.13/silicon.jar` and are ready to be used outside the docker container from the host machine. -Afterwards Carbon and/or Silicon are ready to be [used](#usage). +Afterward, Carbon and/or Silicon are ready to be [used](#usage). ## Usage diff --git a/wiki/scrcpy.md b/wiki/scrcpy.md index 4bc2012..7996e74 100644 --- a/wiki/scrcpy.md +++ b/wiki/scrcpy.md @@ -16,5 +16,5 @@ Alternatively most [Linux systems](/wiki/linux/package_manager.md) feature a pac Connect the phone which is to be controlled with the computer via USB. Make sure USB debugging is enabled in the phones setting. -Afterwards start up scrcpy. +Afterward, start up scrcpy. It is possible that debugging has to be confirmed on the phone again after starting the application. diff --git a/wiki/teamspeak.md b/wiki/teamspeak.md index b336d2d..766ca1a 100644 --- a/wiki/teamspeak.md +++ b/wiki/teamspeak.md @@ -53,7 +53,7 @@ Sound packs can be found on the [myTeamSpeak website](https://www.myteamspeak.com/?search=&type=SOUNDPACK). They are often available as a `.ts3_soundpack` file. This file is similar to a `.zip` archive and can be unpacked the same way. -Afterwards the folder containing the audio files (`.wav` files) needs to be inserted into the sound +Afterward, the folder containing the audio files (`.wav` files) needs to be inserted into the sound folder of TeamSpeak. For TeamSpeak3 on [Linux](/wiki/linux.md) systems this folder can be found at `/opt/teamspeak3/sound`. diff --git a/wiki/traefik.md b/wiki/traefik.md index 3f7953b..079c31f 100644 --- a/wiki/traefik.md +++ b/wiki/traefik.md @@ -64,8 +64,8 @@ To always append a `www.` to the address the following redirection settings can replacement: "https://www.${1}" ``` -Additionally follow the setup regarding the service as explained in -[the general redirection sectino](#redirections-for-docker-service). +Additionally, follow the setup regarding the service as explained in +[the general redirection section](#redirections-for-docker-service). #### Docker Redirection: Removing a `www.` @@ -79,8 +79,8 @@ To always remove a `www.` from the address the following redirection settings ca replacement: "https://${1}" ``` -Additionally follow the setup regarding the service as explained in -[the general redirection sectino](#redirections-for-docker-service). +Additionally, follow the setup regarding the service as explained in +[the general redirection section](#redirections-for-docker-service). #### Docker Redirection: Redirect a Domain to Another @@ -97,8 +97,8 @@ example `123.xyz.eu`). replacement: "https://${1}" ``` -Additionally follow the setup regarding the service as explained in -[the general redirection sectino](#redirections-for-docker-service). +Additionally, follow the setup regarding the service as explained in +[the general redirection section](#redirections-for-docker-service). ### Reverse Proxies for Docker Service diff --git a/wiki/tvheadend.md b/wiki/tvheadend.md index 870a192..92b462d 100644 --- a/wiki/tvheadend.md +++ b/wiki/tvheadend.md @@ -14,10 +14,9 @@ the help of a plugin. The software can be setup via [Docker](/wiki/docker.md) with the [linuxserver image](/wiki/docker/linuxserver_-_tvheadend.md). -For different hardware there may be additional run options needed to get -TVHeadend working properly. -Additionally a solid [initial configuration](#initial-configuration) is -recommended. +For different hardware there may be additional run options needed to get TVHeadend working +properly. +Additionally, a solid [initial configuration](#initial-configuration) is recommended. This configuration includes the setup of different types of tuners. ### Fritzbox diff --git a/wiki/ublock_origin.md b/wiki/ublock_origin.md index 97ec875..d0d1d5d 100644 --- a/wiki/ublock_origin.md +++ b/wiki/ublock_origin.md @@ -26,5 +26,5 @@ Most of the times this can be fixed easily as explained in a [Reddit post by orestaras](https://www.reddit.com/r/firefox/comments/1hipkzh/ublock_origin_no_longer_works_on_youtube). Open the dashboard in the extension menu. Under the tab `Filter List`, extend `Built-in` and uncheck `uBlock filters - Quick fixes`. -Afterwards reload the page containing the YouTube video and it should load normally and without +Afterward, reload the page containing the YouTube video and it should load normally and without advertisements. diff --git a/wiki/ventoy.md b/wiki/ventoy.md index 3a82b49..c23e998 100644 --- a/wiki/ventoy.md +++ b/wiki/ventoy.md @@ -46,5 +46,5 @@ When the message `Error: Verification failed: (0x1A) Security Violation` is show Ventoy stick it can easily be fixed. For this press `OK`, then press any key to perform MOK management. Select `Enroll key from disk`, `VTOYEFI` and `ENROLL_THIS_KEY_IN_MOKMANAGER.cer`. -Afterwards select `Continue`, `Yes` and finally reboot by selecting `Reboot`. +Afterward, select `Continue`, `Yes` and finally reboot by selecting `Reboot`. After performing these steps the Ventoy key should work as usual. diff --git a/wiki/video.md b/wiki/video.md index 1b2f9f9..e677419 100644 --- a/wiki/video.md +++ b/wiki/video.md @@ -122,8 +122,7 @@ Lastly the file extension `.srt` is appended. The complete subtitle file look like this: `movie_(1234)_-_brd_uu.en.forced.srt`. -Additionally to indicate the encoding and source can be indicated before the -file extension. +Additionally, to indicate the encoding and source can be indicated before the file extension. `brd` for Blu-ray disc, `dvd` for digital versatile disc. This is followed by an encoding indicator starting with `u` and followed by your own scheme for encodings. diff --git a/wiki/webcam.md b/wiki/webcam.md index 99f4d45..45c36f3 100644 --- a/wiki/webcam.md +++ b/wiki/webcam.md @@ -1,15 +1,14 @@ # Webcams -Webcams are video cameras which are designed to be used with a computer for -streaming, video calls or similar usages. -This section lists and explains software for the handling of webcams under a -Linux operating system. +Webcams are video cameras which are designed to be used with a computer for streaming, video calls +or similar usages. +This section lists and explains software for the handling of webcams under a Linux operating +system. ## Editing Video Stream -The editing of a video stream provided by a webcam can be achieved by using -[OBS](/wiki/obs.md) together with the -[OBS Virtual Camera plugin](/wiki/obs.md#virtual-camera). +The editing of a video stream provided by a webcam can be achieved by using [OBS](/wiki/obs.md) +together with the [OBS Virtual Camera plugin](/wiki/obs.md#virtual-camera). This works on [Windows](/wiki/windows.md) aswell as [Linux](/wiki/linux.md) and can be used for any webcam available. @@ -18,8 +17,8 @@ webcam available. On Linux a webcam can be configured with [guvcview](https://guvcview.sourceforge.net/). This program provides a simple interface for capturing and viewing video from a [v4l2](/wiki/linux/v4l2.md) device and is thus dependent on v4l2. -Additionally guvcview provides an interface to configure various webcam settins -and enable a few effects on top of it. +Additionally, guvcview provides an interface to configure various webcam settins and enable a few +effects on top of it. ## Using a Smart Device as a Webcam diff --git a/wiki/windows/wsl.md b/wiki/windows/wsl.md index 8a94ab2..51eaa20 100644 --- a/wiki/windows/wsl.md +++ b/wiki/windows/wsl.md @@ -34,7 +34,7 @@ This can be done by running the following command. wsl.exe -l -o ``` -Afterwards install the distribution. +Afterward, install the distribution. `` is the name of the distribution obtained in the previous stepa. ```powershell @@ -54,7 +54,7 @@ For example Ubuntu file system images can be found wsl --import ``` -Afterwards the default distribution may have to be set. +Afterward, the default distribution may have to be set. Once again `` is the name of the distribution to make the new default. ```powershell diff --git a/wiki/wireguard.md b/wiki/wireguard.md index 355475a..2ea3f28 100644 --- a/wiki/wireguard.md +++ b/wiki/wireguard.md @@ -15,8 +15,7 @@ In the following sections the different set ups of WireGuard usages are describe The software can be set up via [Docker](/wiki/docker.md) with the [linuxserver image](/wiki/docker/linuxserver_-_wireguard.md). -Additionally to this a [client](#client-wg) is needed on the system that -accesses the server. +Additionally, to this a [client](#client-wg) is needed on the system that accesses the server. ### Client @@ -30,10 +29,8 @@ For most linux distributions there is a package called `wireguard-tools`. Wireguard clients connect to servers by using a `.conf` file. For mobile devices often times a QR-code can also be used. -In Linux based operating systems the `.conf` can be placed at -the path `/etc/wireguard/wg0.conf`. -Afterwards wireguard can be started and stopped by running the following -commands. +In Linux based operating systems the `.conf` can be placed at the path `/etc/wireguard/wg0.conf`. +Afterward, wireguard can be started and stopped by running the following commands. ``` wg-quick up wg0