1
0
mirror of https://github.com/tiyn/wiki.git synced 2026-08-25 17:51:37 +02:00

Compare commits

...

15 Commits

109 changed files with 1025 additions and 179 deletions

View File

@@ -7,7 +7,7 @@ This docker-rebuild is made up by a `docker-compose.yml` file.
In addition to the main container you need to connect a In addition to the main container you need to connect a
[/additional containers needed/]() to it. [/additional containers needed/]() to it.
## Set-up ## Setup
Create the files `rebuild.sh`, `.env` and `docker-compose.yml` at the same Create the files `rebuild.sh`, `.env` and `docker-compose.yml` at the same
place. place.

View File

@@ -4,7 +4,7 @@ This is a [Docker](/wiki/docker.md) container for a /service/ server.
The official container and documentation was made by The official container and documentation was made by
[/maintainer/](). [/maintainer/]().
## Set-up ## Setup
Create the file `rebuild.sh`. 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` afterwards.

20
wiki/digital_painting.md Normal file
View File

@@ -0,0 +1,20 @@
# Digital Painting
Digital Painting is the creation of artwork using a computer or tablet instead of traditional media
such as paper or canvas.
It is commonly used for illustrations, concept art or comics.
## Hardware
Digital painting is typically performed using a
[graphics tablet or a tablet computer](/wiki/smart_device.md#smartphones-and-tablet-computers) with
an active stylus that supports pressure sensitivity.
## Software
Many digital painting applications are available.
Popular options include the following.
- [Krita](/wiki/krita.md) is a free and open-source program for digital painting.
It is available for [Linux](/wiki/linux.md), [Windows](/wiki/windows.md) and
[Android](/wiki/android.md).

View File

@@ -94,6 +94,21 @@ volume belongs to.
docker inspect <container-name> docker inspect <container-name>
``` ```
### Remove Unused Data
Over time Docker accumulates unused images, stopped containers, unused networks and build cache.
These objects continue to consume disk space even though they are no longer needed.
To remove all unused resources, run the following command.
It removes, stopped containers, unused networks, Unused images, Dangling image layers and unused
build cache.
```sh
sudo docker system prune -a
```
Docker will ask for confirmation before deleting the resources.
## Troubleshooting ## Troubleshooting
This section will focus on errors and the fixing of errors of docker. This section will focus on errors and the fixing of errors of docker.

View File

@@ -5,7 +5,7 @@ The official container and documentation was made by
[actualbudget](https://actualbudget.org/docs/install/docker/). [actualbudget](https://actualbudget.org/docs/install/docker/).
This docker-rebuild is made up by a `docker-compose.yml` file. This docker-rebuild is made up by a `docker-compose.yml` file.
## Set-up ## Setup
Create the files `rebuild.sh`, `docker-compose.yml` at the same Create the files `rebuild.sh`, `docker-compose.yml` at the same
place. place.

View File

@@ -5,7 +5,7 @@ tracker.
The official container and documentation was made by The official container and documentation was made by
[alexjustesen](https://github.com/alexjustesen/speedtest-tracker). [alexjustesen](https://github.com/alexjustesen/speedtest-tracker).
## Set-up ## Setup
Create the file `rebuild.sh`. Create the file `rebuild.sh`.
Change the settings according to your needs and run `./rebuild.sh` afterward. Change the settings according to your needs and run `./rebuild.sh` afterward.

View File

@@ -6,7 +6,7 @@ The official container and documentation was made by
[alexta69](https://github.com/alexta69/metube). [alexta69](https://github.com/alexta69/metube).
This docker-rebuild is made up by a `docker-compose.yml` file. This docker-rebuild is made up by a `docker-compose.yml` file.
## Set-up ## Setup
Create the files `rebuild.sh` and `docker-compose.yml` at the same place. Create the files `rebuild.sh` and `docker-compose.yml` at the same place.
Change the settings according to your needs and run `./rebuild.sh` afterward. Change the settings according to your needs and run `./rebuild.sh` afterward.

View File

@@ -9,7 +9,7 @@ The syncserver can be installed to handle the syncing of data in a self-hosted w
It is described [on GitHub](https://github.com/ankitects/anki/tree/main/docs/syncserver) and can be It is described [on GitHub](https://github.com/ankitects/anki/tree/main/docs/syncserver) and can be
setup via [Docker](/wiki/docker.md). setup via [Docker](/wiki/docker.md).
## Set-up ## Setup
Due to the syncserver having to be set up manually first navigate to the Due to the syncserver having to be set up manually first navigate to the
[Anki syncserver GitHub subpage](/wiki/anki.md#setup-server). [Anki syncserver GitHub subpage](/wiki/anki.md#setup-server).

View File

@@ -6,7 +6,7 @@ The official container and documentation was made by
[awesometechnologies](https://hub.docker.com/awesometechnologies/synapse-admin). [awesometechnologies](https://hub.docker.com/awesometechnologies/synapse-admin).
This docker-rebuild is made up by a `docker-compose.yml` file. This docker-rebuild is made up by a `docker-compose.yml` file.
## Set-up ## Setup
Create the files `rebuild.sh` and `docker-compose.yml` at the same place. Create the files `rebuild.sh` and `docker-compose.yml` at the same place.
Change the settings according to your needs and run `./rebuild.sh` afterward. Change the settings according to your needs and run `./rebuild.sh` afterward.

View File

@@ -5,7 +5,7 @@ server.
The official container and documentation was made by The official container and documentation was made by
[axhilrex](https://github.com/akhilrex/podgrab). [axhilrex](https://github.com/akhilrex/podgrab).
## Set-up ## Setup
Create the file `rebuild.sh`. Create the file `rebuild.sh`.
Change the settings according to your needs and run `./rebuild.sh` afterward. Change the settings according to your needs and run `./rebuild.sh` afterward.

View File

@@ -3,7 +3,7 @@
This is a [Docker](/wiki/docker.md) container for a Homer static site. This is a [Docker](/wiki/docker.md) container for a Homer static site.
The official container and documentation was made by [b4bz](https://hub.docker.com/r/b4bz/homer). The official container and documentation was made by [b4bz](https://hub.docker.com/r/b4bz/homer).
## Set-up ## Setup
Create the file `rebuild.sh`. Create the file `rebuild.sh`.
Run `./rebuild.sh` afterward to create the volumes. Run `./rebuild.sh` afterward to create the volumes.

View File

@@ -5,7 +5,7 @@ server.
The Server consists of 3 Docker containers, one is the TubeArchivist main server, another is a The Server consists of 3 Docker containers, one is the TubeArchivist main server, another is a
TubeArchivist specific version of Elasticsearch and one a [redis](/wiki/docker/redis.md) instance. TubeArchivist specific version of Elasticsearch and one a [redis](/wiki/docker/redis.md) instance.
## Set-up ## Setup
Create the files `rebuild.sh` and `docker-compose.yml` at the same place. Create the files `rebuild.sh` and `docker-compose.yml` at the same place.
Change the settings according to your needs and run `./rebuild.sh` afterward. Change the settings according to your needs and run `./rebuild.sh` afterward.

View File

@@ -5,7 +5,7 @@ meta-search machine.
The official container and documentation was made by The official container and documentation was made by
[benbusby](https://github.com/benbusby/whoogle-search). [benbusby](https://github.com/benbusby/whoogle-search).
## Set-up ## Setup
First of all create a folder for your `rebuild.sh`. First of all create a folder for your `rebuild.sh`.
After that clone whoogle from After that clone whoogle from

View File

@@ -2,7 +2,7 @@
This is a docker container for a [Hauk](/wiki/hauk.md). This is a docker container for a [Hauk](/wiki/hauk.md).
## Set-up ## Setup
Create the files `rebuild.sh` and `docker-compose.yml` at the same place. 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

View File

@@ -7,7 +7,7 @@ This docker-rebuild is made up by a `docker-compose.yml` file.
In addition to the main container you need to connect a [redis container](/wiki/docker/redis.md) to In addition to the main container you need to connect a [redis container](/wiki/docker/redis.md) to
it. it.
## Set-up ## Setup
Create the files `rebuild.sh`, `.env` and `docker-compose.yml` at the same Create the files `rebuild.sh`, `.env` and `docker-compose.yml` at the same
place. place.

View File

@@ -6,7 +6,7 @@ The official container and documentation was made by
[cloudrac3r](https://github.com/cloudrac3r/bibliogram). [cloudrac3r](https://github.com/cloudrac3r/bibliogram).
This docker-rebuild is made up by a `docker-compose.yml` file. This docker-rebuild is made up by a `docker-compose.yml` file.
## Set-up ## Setup
First of all create a folder for your `rebuild.sh`. First of all create a folder for your `rebuild.sh`.
After that clone bibliogram from [sr.ht](https://sr.ht/~cadence/bibliogram/) into After that clone bibliogram from [sr.ht](https://sr.ht/~cadence/bibliogram/) into

View File

@@ -6,7 +6,7 @@ The official container and documentation was made by
[coturn](https://github.com/coturn/coturn). [coturn](https://github.com/coturn/coturn).
This docker-rebuild is made up by a `docker-compose.yml` file. This docker-rebuild is made up by a `docker-compose.yml` file.
## Set-up ## Setup
Create the files `rebuild.sh`, `data/matrix/coturn/turnserver.conf` and `docker-compose.yml` at the Create the files `rebuild.sh`, `data/matrix/coturn/turnserver.conf` and `docker-compose.yml` at the
same place. same place.

View File

@@ -3,7 +3,7 @@
This is a [Docker](/wiki/docker.md) container for a [Tor](/wiki/tor.md) proxy. This is a [Docker](/wiki/docker.md) container for a [Tor](/wiki/tor.md) proxy.
The container and documentation was made by [dperson](https://hub.docker.com/r/dperson/torproxy). The container and documentation was made by [dperson](https://hub.docker.com/r/dperson/torproxy).
## Set-up ## Setup
Create the file `rebuild.sh`. Create the file `rebuild.sh`.
Change the settings according to your needs and run `./rebuild.sh` afterward. Change the settings according to your needs and run `./rebuild.sh` afterward.

View File

@@ -5,7 +5,7 @@ protected [Jackett](/wiki/jackett.md) server.
The official container and documentation was made by The official container and documentation was made by
[dyonr](https://github.com/DyonR/docker-Jackettvpn). [dyonr](https://github.com/DyonR/docker-Jackettvpn).
## Set-up ## Setup
Create the file `rebuild.sh` and set `<username>` and `<password>` according to Create the file `rebuild.sh` and set `<username>` and `<password>` according to
your openvpn. your openvpn.

View File

@@ -6,12 +6,14 @@ an [openVPN tunnel](/wiki/openvpn.md).
The official container and documentation was made by The official container and documentation was made by
[dyonr](https://github.com/DyonR/docker-qbittorrentvpn). [dyonr](https://github.com/DyonR/docker-qbittorrentvpn).
## Set-up ## Setup
Create the file `rebuild.sh`. Create a `rebuild.sh` from the given examples either for [OpenVPN](#openvpn-rebuildsh) or
Change the settings according to your needs and run `./rebuild.sh` afterward. [Wireguard](#wireguard-rebuildsh), depending on the desired VPN protocol.
The default username of the web interface is `admin`. Change the settings according to your needs and run the corresponding script afterward.
The default password is `adminadmin`.
For both variants, the default username of the web interface is `admin` and the default password is
`adminadmin`.
Both can be changed in the web interface after setup. Both can be changed in the web interface after setup.
### Environment-variables ### Environment-variables
@@ -60,7 +62,7 @@ There are some special variables to set.
| `--sysctl` | configure systemctl | | `--sysctl` | configure systemctl |
### rebuild.sh ### openvpn-rebuild.sh
```sh ```sh
#!/bin/sh #!/bin/sh
@@ -74,11 +76,32 @@ docker run --name qbittorrentvpn \
-v qbittorrentvpn_data:/downloads \ -v qbittorrentvpn_data:/downloads \
-e "VPN_ENABLED=yes" \ -e "VPN_ENABLED=yes" \
-e "VPN_TYPE=openvpn" \ -e "VPN_TYPE=openvpn" \
-e "VPN_USERNAME=username" \ -e "VPN_USERNAME=<username>" \
-e "VPN_PASSWORD=password" \ -e "VPN_PASSWORD=<password>" \
-e "LAN_NETWORK=192.168.0.0/16" \ -e "LAN_NETWORK=192.168.0.0/16" \
--cap-add NET_ADMIN \ --cap-add NET_ADMIN \
--device /dev/net/tun \ --device /dev/net/tun \
--sysctl "net.ipv4.conf.all.src_valid_mark=1" \ --sysctl "net.ipv4.conf.all.src_valid_mark=1" \
-d dyonr/qbittorrentvpn -d dyonr/qbittorrentvpn
``` ```
### wireguard-rebuild.sh
```sh
#!/bin/sh
docker stop qbittorrentvpn
docker rm qbittorrentvpn
docker pull dyonr/qbittorrentvpn
docker run --name qbittorrentvpn \
--restart unless-stopped \
--cap-add NET_ADMIN \
--sysctl "net.ipv4.conf.all.src_valid_mark=1" \
--sysctl "net.ipv6.conf.all.disable_ipv6=0" \
-p 9091:8080 \
-v qbittorrentvpn_config:/config \
-v qbittorrentvpn_data:/downloads \
-e "VPN_ENABLED=yes" \
-e "VPN_TYPE=wireguard" \
-e "LAN_NETWORK=192.168.0.0/16" \
-d dyonr/qbittorrentvpn
```

View File

@@ -5,7 +5,7 @@ The Server consists of 2 Docker containers, one is the gitea main server and one
In addition to the main container you need to connect a [mySQL container](/wiki/docker/mysql.md) to In addition to the main container you need to connect a [mySQL container](/wiki/docker/mysql.md) to
it. it.
## Set-up ## Setup
Create the files `rebuild.sh` and `docker-compose.yml` at the same place. Create the files `rebuild.sh` and `docker-compose.yml` at the same place.
Change the settings according to your needs and run `./rebuild.sh` afterward. Change the settings according to your needs and run `./rebuild.sh` afterward.

View File

@@ -5,7 +5,7 @@ server.
The Server consists of 2 Docker containers, one is the gramps main server split into two The Server consists of 2 Docker containers, one is the gramps main server split into two
subcontainers and one a [redis instance](/wiki/docker/redis.md). subcontainers and one a [redis instance](/wiki/docker/redis.md).
## Set-up ## Setup
Create the files `rebuild.sh` and `docker-compose.yml` at the same place. Create the files `rebuild.sh` and `docker-compose.yml` at the same place.
Change the settings according to your needs and run `./rebuild.sh` afterward. Change the settings according to your needs and run `./rebuild.sh` afterward.

View File

@@ -2,7 +2,7 @@
This is a [Docker](/wiki/docker.md) container for a [Gameyfin](/wiki/game/gameyfin.md). This is a [Docker](/wiki/docker.md) container for a [Gameyfin](/wiki/game/gameyfin.md).
## Set-up ## Setup
Create the files `rebuild.sh` and `docker-compose.yml` at the same place. Create the files `rebuild.sh` and `docker-compose.yml` at the same place.
Change the settings according to your needs. Change the settings according to your needs.

View File

@@ -6,7 +6,7 @@ an [openVPN tunnel](/wiki/openvpn.md).
The official container and documentation was made by The official container and documentation was made by
[haugene](https://github.com/haugene/docker-transmission-openvpn). [haugene](https://github.com/haugene/docker-transmission-openvpn).
## Set-up ## Setup
Create the file `rebuild.sh`. Create the file `rebuild.sh`.
To see which providers are supported take a look at the To see which providers are supported take a look at the

View File

@@ -5,7 +5,7 @@ tracker.
The official container and documentation was made by The official container and documentation was made by
[henrywhitaker3](https://hub.docker.com/r/henrywhitaker3/speedtest-tracker). [henrywhitaker3](https://hub.docker.com/r/henrywhitaker3/speedtest-tracker).
## Set-up ## Setup
Create the file `rebuild.sh`. Create the file `rebuild.sh`.
Change the settings according to your needs and run `./rebuild.sh` afterward. Change the settings according to your needs and run `./rebuild.sh` afterward.

View File

@@ -5,7 +5,7 @@ server.
The official container and documentation was made by The official container and documentation was made by
[homeassistant](https://hub.docker.com/r/homeassistant/home-assistant). [homeassistant](https://hub.docker.com/r/homeassistant/home-assistant).
## Set-up ## Setup
Create the file `rebuild.sh`. Create the file `rebuild.sh`.
Change the settings according to your needs and run `./rebuild.sh` afterward. Change the settings according to your needs and run `./rebuild.sh` afterward.

View File

@@ -7,7 +7,7 @@ This docker-rebuild is made up by a `docker-compose.yml` file.
In addition to the main container you need to connect a In addition to the main container you need to connect a
[redis](/wiki/docker/redis.md) and a [postgres](/wiki/docker/postgres.md) container to it. [redis](/wiki/docker/redis.md) and a [postgres](/wiki/docker/postgres.md) container to it.
## Set-up ## Setup
Create the files `rebuild.sh`, `.env` and `docker-compose.yml` at the same Create the files `rebuild.sh`, `.env` and `docker-compose.yml` at the same
place. place.

View File

@@ -5,7 +5,7 @@ This is a [Docker](/wiki/docker.md) container for a
The container and documentation was made by The container and documentation was made by
[itzg](https://hub.docker.com/r/itzg/minecraft-server). [itzg](https://hub.docker.com/r/itzg/minecraft-server).
## Set-up ## Setup
Create the file `rebuild.sh`. Create the file `rebuild.sh`.
Change the settings according to your needs and run `./rebuild.sh` afterward. Change the settings according to your needs and run `./rebuild.sh` afterward.

View File

@@ -8,7 +8,7 @@ There is no official pre-build on docker-hub.
In addition to the main container you need to connect a In addition to the main container you need to connect a
[postgres container](/wiki/docker/postgres.md) to it. [postgres container](/wiki/docker/postgres.md) to it.
## Set-up ## Setup
First of all create a folder for your `rebuild.sh`. First of all create a folder for your `rebuild.sh`.
After that clone invidious from [GitHub](https://github.com/iv-org/invidious) into a folder within After that clone invidious from [GitHub](https://github.com/iv-org/invidious) into a folder within

View File

@@ -4,7 +4,7 @@ This is a [Docker](/wiki/docker.md) container for a [git](/wiki/git_%28general%2
The official container and documentation was made by The official container and documentation was made by
[jkarlos](https://hub.docker.com/r/jkarlos/git-server-docker). [jkarlos](https://hub.docker.com/r/jkarlos/git-server-docker).
## Set-up ## Setup
Create the file `rebuild.sh`. Create the file `rebuild.sh`.
Change the settings according to your needs and run `./rebuild.sh` afterward. Change the settings according to your needs and run `./rebuild.sh` afterward.

View File

@@ -5,7 +5,7 @@ This is a [Docker](/wiki/docker.md) container for
The official container and documentation was made by The official container and documentation was made by
[johnktims](https://hub.docker.com/r/johnktims/folding-at-home). [johnktims](https://hub.docker.com/r/johnktims/folding-at-home).
## Set-up ## Setup
Create the file `rebuild.sh`. Create the file `rebuild.sh`.
Change the settings according to your needs and run `./rebuild.sh` afterward. Change the settings according to your needs and run `./rebuild.sh` afterward.

View File

@@ -4,7 +4,7 @@ This is a [Docker](/wiki/docker.md) container for a [Kiwix](/wiki/kiwix.md) serv
The official container and documentation was made by The official container and documentation was made by
[kiwix](https://github.com/kiwix/kiwix-tools/pkgs/container/kiwix-serve). [kiwix](https://github.com/kiwix/kiwix-tools/pkgs/container/kiwix-serve).
## Set-up ## Setup
Create the file `rebuild.sh`. Create the file `rebuild.sh`.
Make sure to place the `.zim` files inside the volume. Make sure to place the `.zim` files inside the volume.

View File

@@ -6,7 +6,7 @@ The Server consists of multiple Docker containers.
These are containers for the KohakuHub API and depending on configuration MinIO, LakeFS, These are containers for the KohakuHub API and depending on configuration MinIO, LakeFS,
[Postgres](/wiki/docker/postgres.md) [Postgres](/wiki/docker/postgres.md)
## Set-up ## Setup
Create the files `rebuild.sh` and `docker-compose.yml` at the same place. Create the files `rebuild.sh` and `docker-compose.yml` at the same place.
The file `docker-compose.yml` is usually created automatically. The file `docker-compose.yml` is usually created automatically.

View File

@@ -5,7 +5,7 @@ This is a [Docker](/wiki/docker.md) container for an
The official container and documentation was made by The official container and documentation was made by
[kylemanna](https://hub.docker.com/r/kylemanna/openvpn). [kylemanna](https://hub.docker.com/r/kylemanna/openvpn).
## Set-up ## Setup
Create the file `rebuild.sh`. Create the file `rebuild.sh`.
Change the settings according to your needs. Change the settings according to your needs.

View File

@@ -5,7 +5,7 @@ This is a [Docker](/wiki/docker.md) container for a
The official container and documentation was made by The official container and documentation was made by
[linuxserver](https://github.com/linuxserver/docker-airsonic-advanced). [linuxserver](https://github.com/linuxserver/docker-airsonic-advanced).
## Set-up ## Setup
Create the file `rebuild.sh`. Create the file `rebuild.sh`.
Change the settings according to your needs and run `./rebuild.sh` afterward. Change the settings according to your needs and run `./rebuild.sh` afterward.

View File

@@ -5,7 +5,7 @@ server.
The official container and documentation was made by The official container and documentation was made by
[linuxserver](https://hub.docker.com/r/linuxserver/airsonic). [linuxserver](https://hub.docker.com/r/linuxserver/airsonic).
## Set-up ## Setup
Create the file `rebuild.sh`. Create the file `rebuild.sh`.
Change the settings according to your needs and run `./rebuild.sh` afterward. Change the settings according to your needs and run `./rebuild.sh` afterward.

View File

@@ -5,7 +5,7 @@ The official container and documentation was made by
[linuxserver](https://github.com/linuxserver/docker-calibre-web). [linuxserver](https://github.com/linuxserver/docker-calibre-web).
This docker-rebuild is made up by a `docker-compose.yml` file. This docker-rebuild is made up by a `docker-compose.yml` file.
## Set-up ## Setup
Create the files `rebuild.sh` and `docker-compose.yml` at the same place. Create the files `rebuild.sh` and `docker-compose.yml` at the same place.
Change the settings according to your needs and run `./rebuild.sh` afterward. Change the settings according to your needs and run `./rebuild.sh` afterward.

View File

@@ -6,7 +6,7 @@ The official container and documentation was made by
[linuxserver](https://docs.linuxserver.io/images/docker-freshrss). [linuxserver](https://docs.linuxserver.io/images/docker-freshrss).
This docker-rebuild is made up by a `docker-compose.yml` file. This docker-rebuild is made up by a `docker-compose.yml` file.
## Set-up ## Setup
Create the files `rebuild.sh` and `docker-compose.yml` at the same place. Create the files `rebuild.sh` and `docker-compose.yml` at the same place.
Change the settings according to your needs and run `./rebuild.sh` afterward. Change the settings according to your needs and run `./rebuild.sh` afterward.

View File

@@ -6,7 +6,7 @@ The official container and documentation was made by
[linuxserver](https://hub.docker.com/r/linuxserver/jellyfin). [linuxserver](https://hub.docker.com/r/linuxserver/jellyfin).
This docker-rebuild is made up by a `docker-compose.yml` file. This docker-rebuild is made up by a `docker-compose.yml` file.
## Set-up ## Setup
Create the files `rebuild.sh` and `docker-compose.yml` at the same place. Create the files `rebuild.sh` and `docker-compose.yml` at the same place.
Change the settings according to your needs and run `./rebuild.sh` afterward. Change the settings according to your needs and run `./rebuild.sh` afterward.

View File

@@ -5,7 +5,7 @@ server.
The official container and documentation was made by The official container and documentation was made by
[linuxserver](https://hub.docker.com/r/linuxserver/lidarr). [linuxserver](https://hub.docker.com/r/linuxserver/lidarr).
## Set-up ## Setup
Create the files `rebuild.sh` and `docker-compose.yml` at the same place. Create the files `rebuild.sh` and `docker-compose.yml` at the same place.
Change the settings according to your needs and run `./rebuild.sh` afterward. Change the settings according to your needs and run `./rebuild.sh` afterward.

View File

@@ -5,7 +5,7 @@ server.
The official container and documentation was made by The official container and documentation was made by
[linuxserver](https://hub.docker.com/r/linuxserver/radarr). [linuxserver](https://hub.docker.com/r/linuxserver/radarr).
## Set-up ## Setup
Create the files `rebuild.sh` and `docker-compose.yml` at the same place. Create the files `rebuild.sh` and `docker-compose.yml` at the same place.
Change the settings according to your needs and run `./rebuild.sh` afterward. Change the settings according to your needs and run `./rebuild.sh` afterward.

View File

@@ -5,7 +5,7 @@ server.
The official container and documentation was made by The official container and documentation was made by
[linuxserver](https://hub.docker.com/r/linuxserver/sonarr). [linuxserver](https://hub.docker.com/r/linuxserver/sonarr).
## Set-up ## Setup
Create the files `rebuild.sh` and `docker-compose.yml` at the same place. Create the files `rebuild.sh` and `docker-compose.yml` at the same place.
Change the settings according to your needs and run `./rebuild.sh` afterward. Change the settings according to your needs and run `./rebuild.sh` afterward.

View File

@@ -5,7 +5,7 @@ This is a [Docker](/wiki/docker.md) container for syncthing for
The official container and documentation was made by The official container and documentation was made by
[linuxserver](https://hub.docker.com/r/linuxserver/syncthing). [linuxserver](https://hub.docker.com/r/linuxserver/syncthing).
## Set-up ## Setup
Create the file `rebuild.sh`. Create the file `rebuild.sh`.
Change the settings according to your needs and run `./rebuild.sh` afterward. Change the settings according to your needs and run `./rebuild.sh` afterward.

View File

@@ -5,7 +5,7 @@ server.
The official container and documentation was made by The official container and documentation was made by
[linuxserver](https://hub.docker.com/r/linuxserver/tvheadend). [linuxserver](https://hub.docker.com/r/linuxserver/tvheadend).
## Set-up ## Setup
Create the files `rebuild.sh` and `docker-compose.yml` at the same place. Create the files `rebuild.sh` and `docker-compose.yml` at the same place.
Change the settings according to your needs and run `./rebuild.sh` afterward. Change the settings according to your needs and run `./rebuild.sh` afterward.

View File

@@ -5,7 +5,7 @@ This is a [Docker](/wiki/docker.md) container for a
The official container and documentation was made by The official container and documentation was made by
[linuxserver](https://hub.docker.com/r/linuxserver/wireguard). [linuxserver](https://hub.docker.com/r/linuxserver/wireguard).
## Set-Up ## Setup
Create the file `rebuild.sh`. Create the file `rebuild.sh`.
Change the settings according to your needs. Change the settings according to your needs.
@@ -101,4 +101,4 @@ certificate.
### Add New Client to Existing WireGuard Installation ### Add New Client to Existing WireGuard Installation
To add a new client to the existing WireGuard installation increase the number To add a new client to the existing WireGuard installation increase the number
of peers or append a peer to the list of peers specified in the [setup section](#set-up) section. of peers or append a peer to the list of peers specified in the [setup section](#setup) section.

View File

@@ -5,9 +5,9 @@ The official container and documentation was made by
[mailserver](https://hub.docker.com/r/mailserver/docker-mailserver). [mailserver](https://hub.docker.com/r/mailserver/docker-mailserver).
It contains dovecot, antispam, antivirus, ssl and many more features. It contains dovecot, antispam, antivirus, ssl and many more features.
## Set-up ## Setup
This section addresses the set-up of the docker-mailserver [Docker](/wiki/docker.md) container. This section addresses the setup of the docker-mailserver [Docker](/wiki/docker.md) container.
### Download ### Download
@@ -151,7 +151,7 @@ No further setup is needed and [emails](/wiki/email.md) using the new domains ca
After setting up the [Email](/wiki/email.md) server, some [Client](/wiki/email.md#client) After setting up the [Email](/wiki/email.md) server, some [Client](/wiki/email.md#client)
configurations may be taken. configurations may be taken.
Especially recommended is the set-up of Especially recommended is the setup of
[end-to-end encryption](/wiki/email.md#end-to-end-encryption). [end-to-end encryption](/wiki/email.md#end-to-end-encryption).
### rebuild.sh ### rebuild.sh

View File

@@ -5,7 +5,7 @@ The official container and documentation was made by [mariadb](https://hub.docke
The Docker container is mainly used in combination with other containers. The Docker container is mainly used in combination with other containers.
To achieve this in the easiest way use a docker-compose file. To achieve this in the easiest way use a docker-compose file.
## Set-Up ## Setup
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. The exact setup will be described in the regarding entry.

View File

@@ -9,7 +9,7 @@ This docker-rebuild is made up by a `docker-compose.yml` file.
In addition to the client and server containers a [postgres container](/wiki/docker/postgres.md) In addition to the client and server containers a [postgres container](/wiki/docker/postgres.md)
needs to be connected. needs to be connected.
## Set-up ## Setup
Create the files `rebuild.sh`, `.env` and `docker-compose.yml` at the same Create the files `rebuild.sh`, `.env` and `docker-compose.yml` at the same
place. place.

View File

@@ -6,7 +6,7 @@ The official container and documentation was made by
[matrixdotorg](https://hub.docker.com/matrixdotorg/synapse). [matrixdotorg](https://hub.docker.com/matrixdotorg/synapse).
This docker-rebuild is made up by a `docker-compose.yml` file. This docker-rebuild is made up by a `docker-compose.yml` file.
## Set-up ## Setup
Create the files `rebuild.sh` and `docker-compose.yml` at the same place. Create the files `rebuild.sh` and `docker-compose.yml` at the same place.
Change the settings according to your needs and run `./rebuild.sh` afterward. Change the settings according to your needs and run `./rebuild.sh` afterward.

View File

@@ -6,7 +6,7 @@ This is a [Docker](/wiki/docker.md) container for a
The official container and documentation was made by The official container and documentation was made by
[mikenye](https://github.com/mikenye/docker-picard). [mikenye](https://github.com/mikenye/docker-picard).
## Set-up ## Setup
Create the file `rebuild.sh`. Create the file `rebuild.sh`.
Change the settings according to your needs and run `./rebuild.sh` afterward. Change the settings according to your needs and run `./rebuild.sh` afterward.

View File

@@ -8,7 +8,7 @@ The services in this files are explained seperately.
The main Docker container needs a database in form of a [MariaDB](/wiki/docker/mariadb.md) The main Docker container needs a database in form of a [MariaDB](/wiki/docker/mariadb.md)
Docker container. Docker container.
## Set-up ## Setup
Create the files `rebuild.sh` and `docker-compose.yml` at the same place. Create the files `rebuild.sh` and `docker-compose.yml` at the same place.
Change the settings according to your needs and run `./rebuild.sh` afterward. Change the settings according to your needs and run `./rebuild.sh` afterward.

View File

@@ -6,7 +6,7 @@ The official container and documentation was made by
[nginx](https://hub.docker.com/_/nginx). [nginx](https://hub.docker.com/_/nginx).
This docker-rebuild is made up by a `docker-compose.yml` file. This docker-rebuild is made up by a `docker-compose.yml` file.
## Set-up ## Setup
Create the files `rebuild.sh` and `docker-compose.yml` at the same place. Create the files `rebuild.sh` and `docker-compose.yml` at the same place.
Change the settings according to your needs and run `./rebuild.sh` afterward. Change the settings according to your needs and run `./rebuild.sh` afterward.

View File

@@ -4,7 +4,7 @@ This is a [Docker](/wiki/docker.md) container for a [Cups](/wiki/cups.md) server
The official container and documentation was made by The official container and documentation was made by
[olbat](https://hub.docker.com/r/olbat/cupsd). [olbat](https://hub.docker.com/r/olbat/cupsd).
## Set-up ## Setup
Create the file `rebuild.sh`. Create the file `rebuild.sh`.
Change the settings according to your needs and run `./rebuild.sh` afterward. Change the settings according to your needs and run `./rebuild.sh` afterward.

View File

@@ -4,7 +4,7 @@ This is a [Docker](/wiki/docker.md) container for an ollama server.
The official container and documentation was made by The official container and documentation was made by
[ollama](https://hub.docker.com/r/ollama/ollama). [ollama](https://hub.docker.com/r/ollama/ollama).
## Set-up ## Setup
Create the file `rebuild.sh`. Create the file `rebuild.sh`.
Change the settings according to your needs and run `./rebuild.sh` afterward. Change the settings according to your needs and run `./rebuild.sh` afterward.

View File

@@ -4,7 +4,7 @@ This is a [Docker](/wiki/docker.md) container for a Open WebUI server.
The official container and documentation was made by The official container and documentation was made by
[open-webui](https://github.com/open-webui/open-webui). [open-webui](https://github.com/open-webui/open-webui).
## Set-up ## Setup
Create the file `rebuild.sh`. Create the file `rebuild.sh`.
Change the settings according to your needs and run `./rebuild.sh` afterward. Change the settings according to your needs and run `./rebuild.sh` afterward.

View File

@@ -7,7 +7,7 @@ The services in this files are explained seperately.
The main Docker container needs a database in form of a [MariaDB](/wiki/docker/mariadb.md) Docker The main Docker container needs a database in form of a [MariaDB](/wiki/docker/mariadb.md) Docker
container. container.
## Set-up ## Setup
Create the files `rebuild.sh` and `docker-compose.yml` at the same place. Create the files `rebuild.sh` and `docker-compose.yml` at the same place.
Change the settings according to your needs and run `./rebuild.sh` afterward. Change the settings according to your needs and run `./rebuild.sh` afterward.

View File

@@ -5,7 +5,7 @@ cloudflare dns entries.
The official container and documentation was made by The official container and documentation was made by
[oznu](https://github.com/oznu/docker-cloudflare-ddns). [oznu](https://github.com/oznu/docker-cloudflare-ddns).
## Set-up ## Setup
Create the file `rebuild.sh`. Create the file `rebuild.sh`.
Change the settings according to your needs and run `./rebuild.sh` afterward. Change the settings according to your needs and run `./rebuild.sh` afterward.

View File

@@ -3,7 +3,7 @@
This is a docker container for a onedrive client. This is a docker container for a onedrive client.
The official container and documentation was made by [oznu](https://hub.docker.com/r/oznu/onedrive). The official container and documentation was made by [oznu](https://hub.docker.com/r/oznu/onedrive).
## Set-up ## Setup
Create the file `rebuild.sh`. Create the file `rebuild.sh`.
Change the settings according to your needs and run `./rebuild.sh` afterward. Change the settings according to your needs and run `./rebuild.sh` afterward.

View File

@@ -5,7 +5,7 @@ agent.
The official container and documentation was made by The official container and documentation was made by
[portainer](https://hub.docker.com/r/portainer/agent). [portainer](https://hub.docker.com/r/portainer/agent).
## Set-up ## Setup
Create the file `rebuild.sh`. Create the file `rebuild.sh`.
Change the settings according to your needs and run `./rebuild.sh` afterward. Change the settings according to your needs and run `./rebuild.sh` afterward.

View File

@@ -5,7 +5,7 @@ server.
The official container and documentation was made by The official container and documentation was made by
[portainer](https://hub.docker.com/r/portainer/portainer). [portainer](https://hub.docker.com/r/portainer/portainer).
## Set-up ## Setup
Create the file `rebuild.sh`. Create the file `rebuild.sh`.
Change the settings according to your needs and run `./rebuild.sh` afterward. Change the settings according to your needs and run `./rebuild.sh` afterward.

View File

@@ -5,7 +5,7 @@ bookmarks, commands and aliases.
The official container and documentation was made by The official container and documentation was made by
[prologic](https://git.mills.io/prologic/golinks). [prologic](https://git.mills.io/prologic/golinks).
## Set-up ## Setup
Create the files `rebuild.sh` and `docker-compose.yml` at the same place. Create the files `rebuild.sh` and `docker-compose.yml` at the same place.
Change the settings according to your needs and run `./rebuild.sh` afterward. Change the settings according to your needs and run `./rebuild.sh` afterward.

View File

@@ -4,7 +4,7 @@ This is a [Docker](/wiki/docker.md) container for a gopher to http proxy.
The official container and documentation was made by The official container and documentation was made by
[prologic](https://hub.docker.com/r/prologic/gopherproxy). [prologic](https://hub.docker.com/r/prologic/gopherproxy).
## Set-up ## Setup
Create the file `rebuild.sh`. Create the file `rebuild.sh`.
Change the settings according to your needs and run `./rebuild.sh` afterward. Change the settings according to your needs and run `./rebuild.sh` afterward.

View File

@@ -4,7 +4,7 @@ This is a [Docker](/wiki/docker.md) container for a todo-manager.
The official container and documentation was made by The official container and documentation was made by
[prologic](https://hub.docker.com/r/prologic/todo). [prologic](https://hub.docker.com/r/prologic/todo).
## Set-up ## Setup
Create the file `rebuild.sh`. Create the file `rebuild.sh`.
Change the settings according to your needs and run `./rebuild.sh` afterward. Change the settings according to your needs and run `./rebuild.sh` afterward.

View File

@@ -0,0 +1,66 @@
# qmcgaw gluetun
This is a [Docker](/wiki/docker.md) container for a [Gluetun](/wiki/gluetun.md) [VPN](/wiki/vpn.md)
client.
The official container and documentation was made by [qmcgaw](https://github.com/qdm12/gluetun).
## Setup
Create the file `rebuild.sh`.
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 |
| ------------------------ | -------------------------------------------- | ------- |
| `VPN_SERVICE_PROVIDER` | VPN provider | |
| `VPN_TYPE` | VPN type (`wireguard` or `openvpn`) | |
| `VPN_ENDPOINT_IP` | VPN server IP address | |
| `VPN_ENDPOINT_PORT` | VPN server port | |
| `WIREGUARD_PUBLIC_KEY` | WireGuard server public key | |
| `WIREGUARD_PRIVATE_KEY` | WireGuard client private key | |
| `WIREGUARD_ADDRESSES` | WireGuard client IP address | |
| `HTTPPROXY` | Enable HTTP proxy | `false` |
| `HTTPPROXY_STEALTH` | Hide proxy-related headers | `false` |
## Ports
Set the following ports with the `-p` tag.
| Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ----------- |
| `8888` | `9050` | TCP | HTTP proxy |
## Capabilities
The following Linux capabilities have to be added.
| Capability |
| ---------- |
| `NET_ADMIN` |
## rebuild.sh
```sh
#!/bin/sh
docker stop gluetun
docker rm gluetun
docker pull qmcgaw/gluetun
docker run --name gluetun \
--restart unless-stopped \
--cap-add=NET_ADMIN \
-e VPN_SERVICE_PROVIDER=custom \
-e VPN_TYPE=wireguard \
-e VPN_ENDPOINT_IP="<server-ip>" \
-e VPN_ENDPOINT_PORT="<server-port>" \
-e WIREGUARD_PUBLIC_KEY="<public-key>" \
-e WIREGUARD_PRIVATE_KEY="<private-key>" \
-e WIREGUARD_ADDRESSES="<client-address>/32" \
-e HTTPPROXY=true \
-e HTTPPROXY_STEALTH=true \
-p 9050:8888 \
-d qmcgaw/gluetun
```

View File

@@ -6,7 +6,7 @@ The official container and documentation was made by
[rblsb](https://github.com/rblsb/synctube). [rblsb](https://github.com/rblsb/synctube).
There is no official pre-build on docker-hub. There is no official pre-build on docker-hub.
## Set-up ## Setup
First of all create a folder for your `rebuild.sh`. First of all create a folder for your `rebuild.sh`.
After that clone synctube from [GitHub](https://github.com/rblsb/synctube) into After that clone synctube from [GitHub](https://github.com/rblsb/synctube) into

View File

@@ -4,7 +4,7 @@ This is a [Docker](/wiki/docker.md) container for a hastebin server.
The official container and documentation was made by The official container and documentation was made by
[rlister](https://hub.docker.com/r/rlister/hastebin). [rlister](https://hub.docker.com/r/rlister/hastebin).
## Set-up ## Setup
Create the file `rebuild.sh`. Create the file `rebuild.sh`.
Change the settings according to your needs and run `./rebuild.sh` afterward. Change the settings according to your needs and run `./rebuild.sh` afterward.

View File

@@ -5,7 +5,7 @@ server.
The official container and documentation was made by The official container and documentation was made by
[dperson](https://hub.docker.com/r/samba). [dperson](https://hub.docker.com/r/samba).
## Set-up ## Setup
Create the file `rebuild.sh`. Create the file `rebuild.sh`.
Change the settings according to your needs and run `./rebuild.sh` afterward. Change the settings according to your needs and run `./rebuild.sh` afterward.

View File

@@ -5,7 +5,7 @@ meta-search machine.
The official container and documentation was made by The official container and documentation was made by
[searx](https://hub.docker.com/r/searx/searx). [searx](https://hub.docker.com/r/searx/searx).
## Set-up ## Setup
Create the files `rebuild.sh` and `docker-compose.yml` at the same place. Create the files `rebuild.sh` and `docker-compose.yml` at the same place.
Change the settings according to your needs and run `./rebuild.sh` afterward. Change the settings according to your needs and run `./rebuild.sh` afterward.

View File

@@ -3,7 +3,7 @@
This is a [Docker](/wiki/docker.md) container for a [Sinusbot](/wiki/sinusbot.md). This is a [Docker](/wiki/docker.md) container for a [Sinusbot](/wiki/sinusbot.md).
The Server consists of a single Docker container. The Server consists of a single Docker container.
## Set-up ## Setup
Create the files `rebuild.sh` and `docker-compose.yml` at the same place. Create the files `rebuild.sh` and `docker-compose.yml` at the same place.

View File

@@ -5,7 +5,7 @@ bookmark and archive service.
The official container and documentation was made by The official container and documentation was made by
[sissbrueckner](https://github.com/sissbruecker/linkding). [sissbrueckner](https://github.com/sissbruecker/linkding).
## Set-up ## Setup
Create the file `rebuild.sh`. Create the file `rebuild.sh`.
Change the settings according to your needs and run `./rebuild.sh` afterward. Change the settings according to your needs and run `./rebuild.sh` afterward.

View File

@@ -5,7 +5,7 @@ frontend [libreddit](/wiki/libreddit.md).
The official container and documentation was made by The official container and documentation was made by
[spikecodes](https://github.com/spikecodes/libreddit). [spikecodes](https://github.com/spikecodes/libreddit).
## Set-up ## Setup
Create the file `rebuild.sh`. Create the file `rebuild.sh`.
Change the settings according to your needs and run `./rebuild.sh` afterward. Change the settings according to your needs and run `./rebuild.sh` afterward.

View File

@@ -5,7 +5,7 @@ This is a [Docker](/wiki/docker.md) container for a
The official container and documentation was made by The official container and documentation was made by
[Teamspeak](https://hub.docker.com/_/teamspeak). [Teamspeak](https://hub.docker.com/_/teamspeak).
## Set-up ## Setup
Create the file `rebuild.sh`. Create the file `rebuild.sh`.
Change the settings according to your needs and run `./rebuild.sh` afterward. Change the settings according to your needs and run `./rebuild.sh` afterward.

View File

@@ -4,7 +4,7 @@ This is a [Docker](/wiki/docker.md) container for a mordhau server.
The official container and documentation was made by The official container and documentation was made by
[tetricz](https://hub.docker.com/r/tetricz/mordhau-server). [tetricz](https://hub.docker.com/r/tetricz/mordhau-server).
## Set-up ## Setup
Create the files `start.sh` and `stop.sh`. Create the files `start.sh` and `stop.sh`.
Change the settings according to your needs and run `./start.sh` to start Change the settings according to your needs and run `./start.sh` to start

View File

@@ -7,7 +7,7 @@ The official container and documentation was made by
This docker-rebuild is made up by a `docker-compose.yml` file. This docker-rebuild is made up by a `docker-compose.yml` file.
The Server consists of two Docker containers, one is the kitchenowl frontend, another is a backend. The Server consists of two Docker containers, one is the kitchenowl frontend, another is a backend.
## Set-up ## Setup
Create the files `rebuild.sh` and `docker-compose.yml` at the same Create the files `rebuild.sh` and `docker-compose.yml` at the same
place. place.

View File

@@ -7,7 +7,7 @@ The official container and documentation was made by
The `latest` tag at the moment of writing this readme was corrupted. The `latest` tag at the moment of writing this readme was corrupted.
The last usable tag was used therefore to guarantee best performance for all users. The last usable tag was used therefore to guarantee best performance for all users.
## Set-up ## Setup
Create the file `rebuild.sh`. Create the file `rebuild.sh`.
Create a volume with the name `radicale_config`. Create a volume with the name `radicale_config`.

View File

@@ -5,7 +5,7 @@ The official container and documentation was made by
[traefik](https://hub.docker.com/_/traefik). [traefik](https://hub.docker.com/_/traefik).
This docker-rebuild is made up by a `docker-compose.yml` file. This docker-rebuild is made up by a `docker-compose.yml` file.
## Set-up ## Setup
Create the files `rebuild.sh` and `docker-compose.yml` at the same place. Create the files `rebuild.sh` and `docker-compose.yml` at the same place.
In that folder create the directories `data/config`. In that folder create the directories `data/config`.

View File

@@ -8,7 +8,7 @@ This docker-rebuild is made up by a `docker-compose.yml` file.
In addition to the main container you need to connect a In addition to the main container you need to connect a
[postgres container](/wiki/docker/postgres.md) to it. [postgres container](/wiki/docker/postgres.md) to it.
## Set-up ## Setup
Create the files `rebuild.sh`, `.env` and `docker-compose.yml` at the same Create the files `rebuild.sh`, `.env` and `docker-compose.yml` at the same
place. place.

View File

@@ -6,7 +6,7 @@ The official container and documentation was made by
[linuxserver](https://hub.docker.com/vectorim/riot-web). [linuxserver](https://hub.docker.com/vectorim/riot-web).
This docker-rebuild is made up by a `docker-compose.yml` file. This docker-rebuild is made up by a `docker-compose.yml` file.
## Set-up ## Setup
Create the files `rebuild.sh` and `docker-compose.yml` at the same place. Create the files `rebuild.sh` and `docker-compose.yml` at the same place.
Change the settings according to your needs and run `./rebuild.sh` afterward. Change the settings according to your needs and run `./rebuild.sh` afterward.

View File

@@ -5,7 +5,7 @@ This is a [Docker](/wiki/docker.md) container for a [bind](/wiki/bind.md)
The official container and documentation was made by The official container and documentation was made by
[ventz](https://hub.docker.com/r/ventz/bind). [ventz](https://hub.docker.com/r/ventz/bind).
## Set-up ## Setup
Create the file `rebuild.sh`. Create the file `rebuild.sh`.
Change the settings according to your needs and run `./rebuild.sh` afterward. Change the settings according to your needs and run `./rebuild.sh` afterward.

View File

@@ -6,7 +6,7 @@ server, which is used for building the Viper verifiers
The official container and documentation was made by The official container and documentation was made by
[viperproject](https://hub.docker.com/r/viperproject/viperserver). [viperproject](https://hub.docker.com/r/viperproject/viperserver).
## Set-up ## Setup
Create the file `rebuild.sh`. Create the file `rebuild.sh`.
Change the settings according to your needs and run `./rebuild.sh` afterward. Change the settings according to your needs and run `./rebuild.sh` afterward.

View File

@@ -5,7 +5,7 @@ The official container and documentation was made by
[wabayang](https://github.com/bayang/jelu). [wabayang](https://github.com/bayang/jelu).
This docker-rebuild is made up by a `docker-compose.yml` file. This docker-rebuild is made up by a `docker-compose.yml` file.
## Set-up ## Setup
Create the files `rebuild.sh` and `docker-compose.yml` at the same place. Create the files `rebuild.sh` and `docker-compose.yml` at the same place.
Change the settings according to your needs and run `./rebuild.sh` afterward. Change the settings according to your needs and run `./rebuild.sh` afterward.

View File

@@ -6,7 +6,7 @@ one a Redis instance.
In addition to the main container you need to connect a In addition to the main container you need to connect a
[mariadb container](/wiki/docker/mariadb.md) and a [redis container](/wiki/docker/redis.md) to it. [mariadb container](/wiki/docker/mariadb.md) and a [redis container](/wiki/docker/redis.md) to it.
## Set-up ## Setup
Create the files `rebuild.sh` and `docker-compose.yml` at the same place. Create the files `rebuild.sh` and `docker-compose.yml` at the same place.
Change the settings according to your needs and run `./rebuild.sh` afterward. Change the settings according to your needs and run `./rebuild.sh` afterward.

View File

@@ -4,7 +4,7 @@ This is a [Docker](/wiki/docker.md) container for the file viewer pinedocs.
The official container and documentation was made by The official container and documentation was made by
[xy2z](https://hub.docker.com/r/xy2z/pinedocs). [xy2z](https://hub.docker.com/r/xy2z/pinedocs).
## Set-up ## Setup
Create the file `rebuild.sh`. Create the file `rebuild.sh`.
Change the settings according to your needs and run `./rebuild.sh` afterward. Change the settings according to your needs and run `./rebuild.sh` afterward.

View File

@@ -5,7 +5,7 @@ The official container and documentation was made by [YOURLS](https://hub.docker
In addition to the main container you need to connect a [mySQL container](/wiki/docker/mysql.md) to In addition to the main container you need to connect a [mySQL container](/wiki/docker/mysql.md) to
it. it.
## Set-up ## Setup
Create the files `rebuild.sh` and `docker-compose.yml` at the same place. Create the files `rebuild.sh` and `docker-compose.yml` at the same place.
Change the settings according to your needs and run `./rebuild.sh` afterward. Change the settings according to your needs and run `./rebuild.sh` afterward.

View File

@@ -5,7 +5,7 @@ frontend [nitter](/wiki/nitter.md).
The official container and documentation was made by The official container and documentation was made by
[zedeus](https://github.com/zedeus/nitter). [zedeus](https://github.com/zedeus/nitter).
## Set-up ## Setup
Create the file `rebuild.sh`, `docker-compose.yml` and `nitter.conf` at the same Create the file `rebuild.sh`, `docker-compose.yml` and `nitter.conf` at the same
place. place.

View File

@@ -65,7 +65,7 @@ mail._domainkey.<domain>. TXT "v=DKIM1; h=sha256; k=rsa; p=<public-key>"
The key has to be retrieved from the mail server. The key has to be retrieved from the mail server.
For example for [docker-mailserver](/wiki/docker/mailserver_-_docker-mailserver.md) the process is For example for [docker-mailserver](/wiki/docker/mailserver_-_docker-mailserver.md) the process is
described in the described in the
[corresponding set-up section](/wiki/docker/mailserver_-_docker-mailserver.md#set-up). [corresponding setup section](/wiki/docker/mailserver_-_docker-mailserver.md#setup).
#### DMARC record #### DMARC record

View File

@@ -37,6 +37,7 @@ The following add-ons increase the security or privacy.
lets you separate cookies in different containers on a per site base. lets you separate cookies in different containers on a per site base.
With this add-on a proxy can be selected for each container which enables usage of a With this add-on a proxy can be selected for each container which enables usage of a
[VPN](/wiki/vpn.md) that acts as a Proxy like a [OpenVPN Proxy](/wiki/openvpn.md#proxy). [VPN](/wiki/vpn.md) that acts as a Proxy like a [OpenVPN Proxy](/wiki/openvpn.md#proxy).
For this software like [Gluetun](/wiki/gluetun.md) can be used.
- [I don't care about cookies](https://addons.mozilla.org/en-US/firefox/addon/i-dont-care-about-cookies/) - [I don't care about cookies](https://addons.mozilla.org/en-US/firefox/addon/i-dont-care-about-cookies/)
is an even faster alternative to Consent-O-Matic. is an even faster alternative to Consent-O-Matic.
- [Temporary Containers](https://addons.mozilla.org/en-GB/firefox/addon/temporary-containers) opens - [Temporary Containers](https://addons.mozilla.org/en-GB/firefox/addon/temporary-containers) opens

21
wiki/gluetun.md Normal file
View File

@@ -0,0 +1,21 @@
# Gluetun
[Gluetun](https://github.com/qdm12/gluetun) is a free and open-source Docker-based VPN client.
It supports multiple VPN providers and protocols including [WireGuard](/wiki/wireguard.md) and
[OpenVPN](/wiki/openvpn.md).
## Setup
Gluetun can be set up via [Docker](/wiki/docker.md) with the
[qmcgaw image](/wiki/docker/qmcgaw_-_gluetun.md).
## Usage
This section addresses the usage of Gluetun.
### Routing Traffic of Firefox' Containers
Gluetun routes the network traffic of Docker containers through a VPN tunnel.
It can be used as a gateway for other containers or in combination with [Firefox'](/wiki/firefox.md)
Multi-Account Containers to access selected websites through a VPN without routing all system
traffic through the tunnel.

View File

@@ -10,6 +10,8 @@ This entry also features medicinal image and visual formats such as DICOM.
- [sxiv](https://github.com/xyb3rt/sxiv) is an image viewer for [Linux'](/wiki/linux.md) - [sxiv](https://github.com/xyb3rt/sxiv) is an image viewer for [Linux'](/wiki/linux.md)
[X window system](/wiki/linux/x_window_system.md). [X window system](/wiki/linux/x_window_system.md).
- [Weasis](https://github.com/nroduit/Weasis) is a cross-platform DICOM viewer. - [Weasis](https://github.com/nroduit/Weasis) is a cross-platform DICOM viewer.
- [imv](https://sr.ht/~exec64/imv/) is an image viewer native to [Linux'](/wiki/linux.md)
[Wayland](/wiki/linux/wayland.md).
## Editors ## Editors

34
wiki/krita.md Normal file
View File

@@ -0,0 +1,34 @@
# Krita
[Krita](https://krita.org/) is a free and open-source cross-platform
[digital painting](/wiki/digital_painting.md) program focused on illustrations, concept art, comics
and animation.
It is available for [Linux](/wiki/linux.md), [Windows](/wiki/windows.md) and
[Android](/wiki/android.md).
## Setup
The Krita program can be installed from source as described [on GitHub](https://github.com/KDE/krita).
Alternatively many [Linux](/wiki/linux.md) [package managers](/wiki/linux/package_manager.md)
package Krita in the `krita` package.
The software can also be installed on [Android](/wiki/android.md) via
[F-Droid](/wiki/android/f-droid.md) packaged under
[org.krita](https://f-droid.org/packages/org.krita/).
## Usage
This section addresses the usage of Krita.
### Disable Finger Drawing (Pen-only Mode)
On [Android](/wiki/android.md), accidental touches from your hand can create unwanted brush strokes.
While palm rejection is primarily handled by the tablet hardware, Krita allows disabling drawing
with touch input.
To enable pen-only drawing navigate to *Settings*, *Configure Krita*, *General* and *Tools* and
disable *Enable Touch Painting*.
Afterward, restart Krita.
After restarting, only the stylus can draw, while finger touches are ignored.
This provides a better drawing experience on devices with active stylus support.

85
wiki/laundry.md Normal file
View File

@@ -0,0 +1,85 @@
# Laundry
This article is about laundry and all the steps involved in cleaning them.
## Process of Washing and Drying Clothes
This section explains the basic process of washing and drying clothes while preserving their quality
and avoiding common mistakes.
## Sort Laundry
Separate laundry before washing according to color and material.
One category should in the following steps not be washed with another.
- Light colors: e.g. beige, pastel colors, light blue
- White clothes
- Dark colors: e.g. black, dark blue, gray, dark green
- Bright colors: e.g. red
- Towels and underwear
- Sportswear made from functional fabrics
- Cleaning cloths
## Check the Care Label
Before washing, check the care label inside the garment.
Pay particular attention to the following information:
- Maximum washing temperature (e.g. 30 °C or 40 °C)
- Whether tumble drying is allowed
- Whether a delicate wash cycle is required
## Load the Washing Machine
Do not overload the washing machine.
There should still be enough space to fit one hand comfortably above the laundry inside the drum.
For better results turn jeans, T-shirts, sweatshirts and jerseys inside out to protect colors and
prints and close all zippers and buttons before washing.
## Select the Washing Program
The following programs are recommended for common types of laundry.
| Clothing | Program | Temperature | Spin Speed |
| --------- | ------- | ----------- | ---------- |
| Cleaning cloths | Cotton | 90 °C | Maximum |
| Towels and underwear | Eco / Cotton | 4060 °C | Maximum |
| T-shirts | Easy Care | 30 °C | 600800 rpm |
| Sweatshirts | Easy Care | 30 °C | 600800 rpm |
| Jeans | Easy Care | 30 °C | 600 rpm |
| Sports jerseys and sports trousers | Outdoor | 30 °C | 600 rpm |
| Fencing clothing | Outdoor | 30 °C | 400 rpm |
## Add Detergent
Use the appropriate detergent for the type of laundry.
- Heavy-duty detergent for cleaning cloths
- Sports detergent for sportswear
- Delicate detergent for all other clothes washed at 30 °C
- Do not use heavy-duty detergent for colored clothes as it may cause fading
The detergent drawer is typically organized as follows (from left to right):
1. Main wash detergent
2. Fabric softener
3. Pre-wash detergent
## After Washing
After the washing program has finished:
- Remove the laundry immediately.
- Leave the washing machine door and detergent drawer open to allow the machine to dry.
- Return the program selector to the 12 o'clock position.
- Towels, bed linen and underwear can usually be tumble dried.
## Tumble Dryer
When using a tumble dryer:
- Do not operate it unattended or overnight.
- After every drying cycle, switch it off completely.
- Clean both lint filters after or before every use to reduce the risk of fire.

View File

@@ -12,7 +12,9 @@ To create a encrypted device simply run the following command.
cryptsetup -c aes-xts-plain -s 512 -y -v luksFormat /dev/sda2 cryptsetup -c aes-xts-plain -s 512 -y -v luksFormat /dev/sda2
``` ```
Where `/dev/sda2` is the device to be created. `/dev/sda2` is the device to be created.
This command will automatically ask for a passowrd and add it as a keyslot to a given volume.
### Create/Add a Key File to an encrypted volume ### Create/Add a Key File to an encrypted volume
@@ -37,8 +39,8 @@ openssl genrsa -out <path to destination> 4096
The key file will then be saved to `<path to destination>`. The key file will then be saved to `<path to destination>`.
Finally, the key file can be added to an opened LUKS encrypted volume by running the following Finally, the key file can be added as a keyslot to an opened LUKS encrypted volume by running the
command. following command.
```sh ```sh
cryptsetup luksAddKey <path to LUKS volume> <path to key file> cryptsetup luksAddKey <path to LUKS volume> <path to key file>
@@ -218,6 +220,8 @@ created in the previous step (for example `/root/key.bin`).
### Use FIDO2 to Unlock a Volume ### Use FIDO2 to Unlock a Volume
This guide will add a FIDO2 stick as a keyslot for a given volume.
To use a FIDO2-Stick on [Linux-based systems](/wiki/linux.md) with To use a FIDO2-Stick on [Linux-based systems](/wiki/linux.md) with
[DM-Crypt](/wiki/linux/dm-crypt.md) first set up the FIDO2 stick and add it to the encrypted [DM-Crypt](/wiki/linux/dm-crypt.md) first set up the FIDO2 stick and add it to the encrypted
volume. volume.
@@ -229,6 +233,12 @@ sudo systemd-cryptenroll --fido2-device=auto /dev/nvme0n1p1
sudo cryptsetup open --token-only /dev/nvme1n1p2 test sudo cryptsetup open --token-only /dev/nvme1n1p2 test
``` ```
In the `systemd-cryptenroll` command the flag `--fido2-with-client-pin=no` can be also be set to
disable the pin.
Similarly `--fido2-with-user-presence=no` will disable the user showing his presence by pressing the
button on the FIDO 2 stick and `--fido2-with-user-verification=no` disables the need for user
verification.
Next the hooks in the file `/etc/mkinitcpio.conf` need to be changed. Next the hooks in the file `/etc/mkinitcpio.conf` need to be changed.
It is recommended to set up [Plymouth]() so that the login screen is clean. It is recommended to set up [Plymouth]() so that the login screen is clean.
Switch `udev` and other `HOOKS` to `systemd`. Switch `udev` and other `HOOKS` to `systemd`.
@@ -256,3 +266,25 @@ Make sure to touch FIDO2-key during boot to make it work.
sudo mkinitcpio -p linux sudo mkinitcpio -p linux
reboot reboot
``` ```
### Removing a Keyslot
LUKS supports multiple keyslots, allowing several passwords, key files or hardware tokens to unlock
the same encrypted volume.
If a key is no longer needed, the corresponding keyslot can be removed.
To remove a keyslot, replace `<LUKS-device-path>` with the encrypted device (e.g. `/dev/sda2`)
and `<slot>` with the keyslot number.
```sh
sudo systemd-cryptenroll <LUKS-device-path> --wipe-slot=<slot>
```
The available keyslots can be listed beforehand using the following command.
```sh
sudo systemd-cryptenroll <LUKS-device-path>
```
Be careful not to remove the last remaining valid keyslot, otherwise the encrypted volume can no
longer be unlocked.

View File

@@ -45,6 +45,17 @@ Check which session is created by your compositor.
ln -s /usr/share/wayland-sessions/<session> /usr/share/wayland-sessions/default.desktop ln -s /usr/share/wayland-sessions/<session> /usr/share/wayland-sessions/default.desktop
``` ```
However, for Wayland the call for the compositor can also occur in the `.profile` file or another
file that is called at startup.
In this case replace the `Exec` line with a dummy.
This can look similar to the following.
```txt
Exec=echo "ok"
```
Alternatively to linking the session to `default.desktop` the `.dmrc` file can also be set to the
name of the session.
Before finishing the setup the functionality should be tested. Before finishing the setup the functionality should be tested.
This can be done by using one or both of the following commands. This can be done by using one or both of the following commands.

View File

@@ -176,6 +176,9 @@ kill <process-id>
Files that are based on a remote server can be mounted as described in Files that are based on a remote server can be mounted as described in
[the corresponding section](#mount-directory-with-sshfs) to set up complete remote development. [the corresponding section](#mount-directory-with-sshfs) to set up complete remote development.
This can also be used for tunneling [VNC](/wiki/vnc.md) which is then called
[VNC over SSH](/wiki/vnc.md#vnc-over-ssh).
### Specify Key Exchange Algorithms ### Specify Key Exchange Algorithms
It can be useful to specify the key exchange algorithms in the OpenSSH config file `~/.ssh/config`. It can be useful to specify the key exchange algorithms in the OpenSSH config file `~/.ssh/config`.

View File

@@ -20,5 +20,12 @@ across distributions.
These formats are not package managers. These formats are not package managers.
They distribute standalone applications that can run independently of the system package database. They distribute standalone applications that can run independently of the system package database.
- [AppImage](/wiki/linux/appimage.md) - [AppImage](/wiki/linux/appimage.md) packages applications together with their dependencies in a
- [Flatpak](/wiki/linux/flatpak.md) single executable file.
- [Flatpak](/wiki/linux/flatpak.md) distributes sandboxed desktop applications across different
Linux distributions.
- [uv](/wiki/programming_language/python/uv.md) manages Python installations,
[virtual environments](/wiki/programming_language/python.md#using-virtual-environments), project
dependencies and Python-based command-line tools.
- [pip](/wiki/programming_language/python/pip.md) manages Python installations and can be used in a
virtual environment.

View File

@@ -2,21 +2,26 @@
In [Arch Linux](/wiki/linux/arch-linux.md) there are 2 main types of In [Arch Linux](/wiki/linux/arch-linux.md) there are 2 main types of
package managers. package managers.
The first is pacman, the default package manager. The first is Pacman, the default package manager.
For the second type there are many different managers to chose from. For the second type there are many different managers to chose from.
Those managers are handling for the Arch User Repositories (AUR). Those managers are handling for the Arch User Repositories (AUR).
In this article yay is used as the go to AUR manager. In this article yay is used as the go to AUR manager.
yay is also a wrapper for pacman so yay can be used instead of pacman to yay is also a wrapper for Pacman so yay can be used instead of Pacman to
install and update both AUR and main repository programs. install and update both AUR and main repository programs.
It features the same syntax. It features the same syntax.
## Usage ## Usage
This section addresses various usages of the arch linux package managers. This section addresses various usages of the [Arch Linux](/wiki/linux/arch-linux.md) package
managers.
### Yay: Remove Make Dependencies ### Yay
Commands that are available for Pacman are also available for Yay and some other AUR managers.
#### Remove Make Dependencies
This section is based on a This section is based on a
[Reddit comment by AnalShart](https://www.reddit.com/r/archlinux/comments/116dd58/is_it_possible_to_default_remove_make). [Reddit comment by AnalShart](https://www.reddit.com/r/archlinux/comments/116dd58/is_it_possible_to_default_remove_make).
@@ -30,6 +35,39 @@ by editing it accordingly.
} }
``` ```
### Installing Packages
This section focuses on the installation of packages.
Before installing new software it is recommended to synchronize the package databases and update the
system.
```sh
pacman -Sy
```
Afterward, install the desired package by replacing `<package>` with its name.
```sh
pacman -S <package>
```
Alternatively both steps can be done simultaneously using the following command.
```sh
pacman -Sy <package>
```
### Removing Packages
Packages can be removed together with their dependencies and configuration files if they are no
longer needed.
This is the recommended way to remove packages as it also gets rid of dependencies that are no
longer required by other packages and its configuration files.
```sh
pacman -Rns <package>
```
### Ignoring Packages ### Ignoring Packages
Packages can be ignored by adding the package in `/etc/pacman.conf` under `IgnorePkg`. Packages can be ignored by adding the package in `/etc/pacman.conf` under `IgnorePkg`.
@@ -50,7 +88,7 @@ This program can then easily be used to an AUR package.
This works like the following assuming the package `v4l2loopback-dmks` needs to be downgraded. This works like the following assuming the package `v4l2loopback-dmks` needs to be downgraded.
```sh ```sh
sudo downgrade v4l2loopback-dmks downgrade v4l2loopback-dmks
``` ```
Afterward 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.
@@ -79,6 +117,28 @@ commit list.
Next to `download` a `.tar.gz` file can be downloaded which includes a `PKGBUILD` file. Next to `download` a `.tar.gz` file can be downloaded which includes a `PKGBUILD` file.
Afterward 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).
### List and Remove Orphaned Packages
Packages that were installed automatically as dependencies may remain on the system after the
package requiring them has been removed.
These packages are called orphaned packages and can usually be removed safely.
To list all orphaned packages, run the following command.
```sh
pacman -Qdt
```
If the command returns one or more packages, they can be removed together with their unused
configuration files using the following command.
```sh
pacman -Rns $(pacman -Qdtq)
```
It is recommended to review the list of orphaned packages before removing them, as some packages may
still be desired despite no longer being required as a dependency.
### Clear Cache ### Clear Cache
The cache of all packages except the one installed can be deleted by running the following command. The cache of all packages except the one installed can be deleted by running the following command.
@@ -126,6 +186,89 @@ To enable it search and uncomment the following lines in the file `/etc/pacman.c
Include = /etc/pacman.d/mirrorlist Include = /etc/pacman.d/mirrorlist
``` ```
### Searching for Packages by File
Sometimes it is useful to determine which package provides a specific file.
Before searching the file database it has to be synchronized.
```sh
sudo pacman -Fy
```
Afterward, search for one or more file names by replacing `<file>` with the desired file.
```sh
pacman -F <file>
```
For example, this can be used to determine which package provides a missing binary, library or
configuration file.
### Replacing Globally Installed Python Packages
[Python](/wiki/programming_language/python.md) packages installed using
[pip](/wiki/programming_language/python/pip.md) are not managed by Pacman or Yay.
Whenever possible, Python packages should instead be installed using a
[package manager](/wiki/linux/package_manager.md) and the official repositories or the AUR.
This allows them to be updated together with the rest of the system and avoids conflicts with the
system package manager.
However, project-specific dependencies should generally be installed inside
[virtual environments](/wiki/programming_language/python.md#venv-virtual-environments) instead of
globally.
To begin replacing globally installed Python packages, first list all explicitly installed Python
packages.
```sh
pacman -Qet | grep -E '^(python-|python3-)'
```
These packages are usually candidates to keep, as they are already managed by the system package
manager.
Next check for Python packages that exist on the file system but are not owned by Pacman.
The following command searches the global Python installation for unmanaged packages.
```sh
find /usr/lib/python*/site-packages -maxdepth 1 \
| while read package; do
pacman -Qo "$package" >/dev/null 2>&1 || echo "$package"
done
```
Some manually installed packages may instead reside in `/usr/local`.
These can be listed using the following command.
```sh
find /usr/local/lib/python*/site-packages -maxdepth 1
```
For each package that is unmanaged or managed by another source than Pacman or Yay determine the
package name.
Then search whether it is available using Pacman or Yay.
```sh
pacman -Ss <package>
yay -Ss <package>
```
If it is, uninstall the package.
For this pip could be used like shown in the following command.
Finally, reinstall the package using the Pacman or Yay.
```sh
yay -S <package>
```
Note that the packages may not have the same name.
Often the package has a prepended `python-` for Pacmand and Yay packages, however, this does not
have to be the case.
Packages that are not available in either the official repositories or the AUR can still be
installed using tools such as [pip](/wiki/programming_language/python/pip.md) or
[uv](/wiki/programming_language/python/uv.md).
### Hooks ### Hooks
Hooks are commands that are run before or after installation of one or more packages. Hooks are commands that are run before or after installation of one or more packages.
@@ -333,7 +476,7 @@ To update the package either way the following command can be used.
`<package name>` should be exchanged for the package that throws the error. `<package name>` should be exchanged for the package that throws the error.
```sh ```sh
sudo pacman -S --overwrite "*" <package name> pacman -S --overwrite "*" <package name>
``` ```
### Error `error: could not open file /var/lib/pacman/sync/core.db: Unrecognized archive format` ### Error `error: could not open file /var/lib/pacman/sync/core.db: Unrecognized archive format`

50
wiki/linux/pam.md Normal file
View File

@@ -0,0 +1,50 @@
# PAM
PAM (Pluggable Authentication Modules) is the authentication framework used by most
[Linux](/wiki/linux.md) distributions.
It allows authentication methods to be configured independently of the applications using them.
This makes it possible to integrate passwords,
[fingerprint readers](/wiki/linux/fingerprint_reader.md), [FIDO2](/wiki/fido2.md) security keys and
other authentication mechanisms into services such as `sudo`, `login` and
[display managers](/wiki/linux/display_managers.md).
## Authenticate `sudo` with a FIDO2 Security Key
This section describes how to configure a FIDO2 security key for authentication when running `sudo`.
The following guide is based on a
[YouTube video by pixeledi](https://www.youtube.com/watch?v=e5k1ye-_tNs).
First install the required package [PAM U2F](https://github.com/Yubico/pam-u2f) with a
[package manager](/wiki/linux/package_manager.md) matching your
[Linux distribution](/wiki/linux.md#distributions).
It is often packaged under the name `pam-u2f`.
Next create an UDEV rule that allows access to the FIDO2 device.
```sh
echo 'KERNEL=="hidraw*", SUBSYSTEM=="hidraw", MODE="0664", GROUP="plugdev"' | sudo tee /etc/udev/rules.d/fido2-u2f.rules
```
Then create the configuration directory and generate the authentication mapping file.
```sh
mkdir -p ~/.config/fido2-u2f
cd ~/.config/fido2-u2f
pamu2fcfg > keys.txt
```
Open the PAM configuration for `sudo`.
```sh
sudo vim /etc/pam.d/sudo
```
Add the following line before all existing `auth` entries.
Replace `<username>` with the name of the current user.
```txt
auth sufficient pam_u2f.so cue authfile=/home/<username>/.config/fido2-u2f/keys.txt
```
The `cue` option causes PAM to prompt for user presence before requesting a touch on the security
key.

View File

@@ -115,6 +115,31 @@ Afterward the logind service has to be restarted
sudo systemctl restart systemd-logind sudo systemctl restart systemd-logind
``` ```
### Limiting Journal Size
The `journalctl` command stores persistent system logs which can grow significantly over time and
consume disk space.
To display the current disk usage of the journal, run the following command.
```sh
journalctl --disk-usage
```
The journal can then be limited to a maximum size by using the following command and replacing
`<size>` with the desired limit (e.g. `500M`).
```sh
sudo journalctl --vacuum-size=<size>
```
Alternatively, logs older than a specified period can be removed by using the following command and
replacing `<time>` with the desired retention time (e.g. `7d`).
```sh
sudo journalctl --vacuum-time=<time>
```
## Troubleshooting ## Troubleshooting
This section focusses on errors that correspond to the systemd software. This section focusses on errors that correspond to the systemd software.

View File

@@ -3,14 +3,137 @@
[Wayland](https://wayland.freedesktop.org/) is a replacement for the [Wayland](https://wayland.freedesktop.org/) is a replacement for the
[X11 window system](/wiki/linux/x_window_system.md). [X11 window system](/wiki/linux/x_window_system.md).
## Setup
For Wayland to work properly the following is needed.
- a Wayland [compositor](#compositors)
- `wayland`
- `wayland-protocols`
- optionally `xwayland` for running [X11](/wiki/linux/x_window_system.md) applications
- optionally `xdg-desktop-portal` and a suitable backend (e.g. `xdg-desktop-portal-wlr`) for screen
sharing and desktop integration
Wayland is then started via the Compositor.
When migrating from X11 to Wayland additional steps may have to be taken.
Since the start is done via the compositor some settings especially potential `startx` statements
in the `.profile` or other files that are run on login (e.g. by [systemd](/wiki/linux/systemd.md))
to start X11 need to be removed.
In the correponding places statements to start the Wayland compositor may be put.
## Statusbar
This section focuses on Wayland statusbars.
### Waybar
Waybar is a simple status bar which in most [Linux distributions](/wiki/linux.md#distributions) can
simply be installed via the [package](/wiki/linux/package_manager.md) `waybar`.
It can then be started using the `waybar` command after choosing the settings inside
`.config/waybar`.
## Compositors ## Compositors
The following is a list of Wayland compositors. The following is a list of Wayland compositors.
- [dwl](/wiki/linux/suckless.md) is a compositor which is similar to suckless' X11 window manager - [dwl](/wiki/linux/suckless.md) is a compositor which is similar to
called dwm. [suckless'](/wiki/linux/suckless.md) X11 window manager called dwm.
To make dwl start additional software the `-s` flag followed by a [shell](/wiki/linux/shell.md)
file can be used.
This will run all commands within the file.
An example may look similar to `dwl -s ~/.config/wayland/wayland.conf`.
For toggling the touchpad the patch called
[inputdevicerules](https://codeberg.org/dwl/dwl-patches/src/branch/main/patches/inputdevicerules/inputdevicerules-v0.6.patch)
can be used.
- [mango](https://github.com/mangowm/mango) is a feature-rich Wayland compositor built on dwl. - [mango](https://github.com/mangowm/mango) is a feature-rich Wayland compositor built on dwl.
## Programs
This section contains Wayland-native alternatives to common X11 programs.
Further alternatives can be found in the
[Sway migration guide](https://github.com/swaywm/sway/wiki/i3-Migration-Guide).
### Background
`swaybg` can be used to set the desktop background.
### Hotkey Daemon
`swhkd` is a Wayland alternative to [sxhkd](/wiki/linux/sxhkd.md).
After installation create the configuration file
`~/.config/swhkd/swhkdrc` and mark the binary as setuid.
```sh
sudo chmod u+s $(which swhkd)
```
The daemon can then be started using
```sh
swhks && swhkd
```
### Lock Screen
`swaylock` can be used as a lock screen.
Configuration is stored in `~/.config/swaylock/config`.
A lock screen can then be activated using
```sh
swaylock
```
### Idle Daemon
`swayidle` is a Wayland replacement for idle management.
### Screenshots
Wayland screen capture can be achieved using
- `grim` for taking screenshots
- `slurp` for selecting a region
- `wl-clipboard` for clipboard integration
Together these can replace tools such as `maim`.
### Display Configuration
`wlr-randr` can be used instead of `xrandr` for wlroots-based compositors.
Many Wayland compositors configure displays automatically, making manual configuration unnecessary
in many cases.
### Input Events
`wev` is a Wayland alternative to `xev`.
### Window Information
The functionality of `xprop` can be replaced by a combination of `lswt`, `wlrctl`
(`wlrctl toplevel list`) as well as compositor-specific IPC interfaces.
### Color Temperature
`wlsunset` provides functionality similar to `redshift`.
### Image Viewer
[imv](https://sr.ht/~exec64/imv/) is a Wayland-native [image viewer](/wiki/image.md#viewer) and can
be used instead of `sxiv`.
### Desktop Managers
There are many [display managers](/wiki/linux/display_managers.md) which support Wayland
compositors.
[LightDM](/wiki/linux/lightdm.md) is especially easy to use and the corresponding entry contains a
[setup section for dwl](/wiki/linux/lightdm.md).
## Usage ## Usage
This section addresses the usage of Wayland. This section addresses the usage of Wayland.
@@ -24,6 +147,45 @@ For this to work the compositor needs to use wlroots.
wlr-randr wlr-randr
``` ```
### Setup Screen Capture
Many Wayland applications access [screen capture](/wiki/screen_capture.md) or
[sharing](/wiki/screen_sharing.md) through `xdg-desktop-portal`.
This setup is required by applications such as [Discord](/wiki/discord.md) and [OBS](/wiki/obs.md).
Install the following packages.
- `xdg-desktop-portal-gtk`
- `xdg-desktop-portal-wlr`
- `qt5-wayland`
- `qt6-wayland`
Set the following environment variables.
```sh
export QT_QPA_PLATFORM=wayland
export XDG_CURRENT_DESKTOP=wlroots
```
Import the variables into the user systemd instance during startup.
```sh
systemctl --user import-environment WAYLAND_DISPLAY XDG_CURRENT_DESKTOP
dbus-update-activation-environment --systemd WAYLAND_DISPLAY XDG_CURRENT_DESKTOP
```
Create the file `~/.config/xdg-desktop-portal/portals.conf` with the following contents.
```ini
[preferred]
default=gtk
org.freedesktop.impl.portal.Screenshot=wlr
org.freedesktop.impl.portal.ScreenCast=wlr
```
Afterward, restart the system.
Then screen capture and sharing should be available.
## Troubleshooting ## Troubleshooting
This section addresses problems that can occur when using Wayland and ways to solve them. This section addresses problems that can occur when using Wayland and ways to solve them.

View File

@@ -2,8 +2,10 @@
[wayvnc](https://github.com/any1/wayvnc) is a VNC server for [Linux](/wiki/linux.md) systems using [wayvnc](https://github.com/any1/wayvnc) is a VNC server for [Linux](/wiki/linux.md) systems using
[Waylands](/wiki/linux/wayland.md) compositors using wlroots. [Waylands](/wiki/linux/wayland.md) compositors using wlroots.
To use wayvnc the system with the server has to be on the same network as the client. To use wayvnc the client has to be able to reach the server either directly or through an
This is also explained in the [screen sharing entry](/wiki/screen-sharing.md). [SSH tunnel](/wiki/linux/openssh.md#port-tunneling).
It is the default VNC server used on modern [Raspberry Pi OS](/wiki/linux/raspberry_pi.md)
installations.
## Setup ## Setup
@@ -25,3 +27,23 @@ The name of the screen can be retrieved by using
```sh ```sh
wayvnc <ip> --output=<screen> --render-cursor wayvnc <ip> --output=<screen> --render-cursor
``` ```
### Binding to an IP Address
By default, wayvnc is reachable on the IP address it is bound to.
Usually this is `0.0.0.0` and makes the VNC server on all network interfaces.
However, binding to `127.0.0.1` exposes the VNC server only on the loopback interface of
[SSH tunnels](/wiki/linux/openssh.md).
This may be useful when using [VNC over SSH](/wiki/vnc.md#vnc-over-ssh).
When using a systemd user service (for example
`~/.config/systemd/user/wayvnc.service`), the same can be achieved by changing
the `ExecStart` line to
```ini
ExecStart=/usr/bin/wayvnc 127.0.0.1
```
The server can then be accessed remotely using
[VNC over SSH](/wiki/vnc.md#vnc-over-ssh).

Some files were not shown because too many files have changed in this diff Show More