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

Compare commits

..

39 Commits

Author SHA1 Message Date
ef929292da Presentation: Added pdfpc zooming guide 2026-08-25 14:56:33 +02:00
dfe169870d Presentatin: PDFPC settings added 2026-08-25 13:00:41 +02:00
834487439a Added OSS Dict and Neo Store 2026-08-24 01:16:19 +02:00
cfef5b10ec Merge branch 'master' of github:/tiyn/wiki 2026-08-18 09:41:29 +02:00
4dd67c6c2c Added rembg 2026-08-18 09:41:21 +02:00
ee3d5929bb Programming Languages/Python: Added tensorflow gpu fix 2026-08-18 09:40:47 +02:00
8abca04b9a Adobe Acrobat: Added Setup 2026-07-29 15:34:59 +02:00
41cd91f173 Added eduroam entry 2026-07-23 04:15:57 +02:00
176a23211e Calibre: Added Web Troubleshooting 2026-07-21 00:39:30 +02:00
ac773e4ede Git/uv: Added Git Hooks 2026-07-19 10:26:39 +02:00
1075ec57e3 Python: Added matplotlib troubleshooting for wayland 2026-07-18 18:27:29 +02:00
75372a2220 Linux/Papis: Expanded importing guide 2026-07-18 18:12:45 +02:00
1ba082fb37 NextCloud: Added trash bin retention and cleaning usage 2026-07-18 14:58:05 +02:00
ea19f91755 Linux/git: Added guide to show commit info 2026-07-17 01:41:37 +02:00
b3009233d8 QMapShack: Added Manual/Automatic Routing; Fixed Error 2026-07-16 00:20:25 +02:00
99083a2c02 Python: Added Shebang Usage 2026-07-15 14:11:44 +02:00
c116d3a433 Added Digital Painting 2026-07-14 06:41:08 +02:00
d77b0dc5ad Wayland: Expanded Migration and Setup, Added Alternative Programs 2026-07-14 05:20:11 +02:00
cbbad11edc Python: Added TensorFlow from Source 2026-07-14 04:27:38 +02:00
3cb9374b82 VPN/VNC: Linked Up and Expanded wayvnc Entry 2026-07-14 04:21:58 +02:00
bf323fa75c Structure: Using 'setup' Instead of 'set-up' 2026-07-14 03:06:58 +02:00
70603a7196 qbittorrent: Added Wireguard Setup 2026-07-14 03:03:39 +02:00
1f9c5e2f85 Python: Added Arch-Migration for Globally Installed pip Packages 2026-07-14 02:50:37 +02:00
4481305b38 Python: Created Own pip Entry 2026-07-14 02:31:41 +02:00
25733ecad8 Python: Created Own uv Entry 2026-07-14 02:22:38 +02:00
3bf8cb6645 Linux/pacman and yay: added searching packages 2026-07-14 02:08:38 +02:00
6990238a7d Linux: Added PAM Entry 2026-07-14 02:08:15 +02:00
cd3100fbf6 Added Sections on how to Free Up Memory Space by Clearing Caches 2026-07-14 01:59:20 +02:00
c3dd26b177 Linux/DM-Crypt: Expanded FIDO2 Section and Added Keyslot Removal 2026-07-14 01:58:03 +02:00
9df0cedb99 Added Sports Taping 2026-07-13 23:43:05 +02:00
c5f53470b5 Added Laundry entry 2026-07-13 23:40:28 +02:00
a8e6450c5f QMapshack: added and integrated 2026-07-12 03:11:40 +02:00
8035be5f13 Calibre: Added Web Troubleshooting 2026-07-10 04:16:39 +02:00
3d0b089dc8 Markup Language: Added LaTeX-packages lettrine and (pgf)ornament 2026-07-09 01:08:45 +02:00
1c9b27c8ee Markup Language: Added HTML-to-PDF-conversion 2026-07-08 15:55:06 +02:00
93ac2dd35e DNS: Added Note to PTR Records 2026-07-07 03:38:52 +02:00
ef37b60318 Emails: End-To-End Encryption Linked Between Entries 2026-07-07 02:50:16 +02:00
4c7759e930 Docker/docker-mailserver: Added Tips for multiple domains and improved set-up 2026-07-07 02:26:06 +02:00
0d92318f13 Docker/docker-mailserver: Added Tips on DNS records 2026-07-07 01:56:27 +02:00
132 changed files with 2226 additions and 287 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
[/additional containers needed/]() to it.
## Set-up
## Setup
Create the files `rebuild.sh`, `.env` and `docker-compose.yml` at the same
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
[/maintainer/]().
## Set-up
## Setup
Create the file `rebuild.sh`.
Change the settings according to your needs and run `./rebuild.sh` afterwards.

View File

@@ -4,6 +4,14 @@
[Adobe](https://www.adobe.com/).
It is free.
## Setup
Adobe Acrobat is available for [Windows](/wiki/windows.md), macOS and [Linux](/wiki/linux.md) on the
[official website](https://get.adobe.com/reader/).
For some [Linux distributions](/wiki/linux.md#distributions) — like
[Arch Linux](/wiki/linux/arch-linux.md) there is also a package called `acroread-dc-wine`, which can
be used to set up Adobe Acrobat.
## Usage
This section addresses the usage of Adobe Acrobat.

View File

@@ -0,0 +1,13 @@
# Episteme Reader
[Episteme Reader](https://github.com/Aryan-Raj3112/episteme) is a free and open-source
[e-book](/wiki/e-book.md) reader for [Android](/wiki/android.md).
It supports annotations and OPDS catalogs and can handle large PDF files.
For looking up words while reading, an offline dictionary application such as
[OSS Dict](/wiki/android/oss_dict.md) can be used.
Episteme Reader also features using translation apps like [DeepL](/wiki/deepl.md).
## Setup
On [Android](/wiki/android.md) Episteme Reader is available on [F-Droid](/wiki/android/f-droid.md)
in a package called [Episteme Reader](https://f-droid.org/en/packages/com.aryan.reader.oss/).

View File

@@ -2,6 +2,8 @@
[F-Droid](https://f-droid.org) is an installable catalogue of free and open source
software for [Android](/wiki/android.md) systems.
Alternatively, [Neo Store](/wiki/android/neo_store.md) can be used as a modern F-Droid client and
alternative.
## Setup

10
wiki/android/neo_store.md Normal file
View File

@@ -0,0 +1,10 @@
# Neo Store
[Neo Store](https://github.com/NeoApplications/Neo-Store) is a free and open-source
[F-Droid](/wiki/android/f-droid.md) client and alternative for [Android](/wiki/android.md).
It can be used to browse, install and update applications from F-Droid and other repositories.
## Setup
On [Android](/wiki/android.md) Neo Store is available on [F-Droid](/wiki/android/f-droid.md) in a
package called [Neo Store](https://f-droid.org/packages/com.machiav3lli.fdroid/).

22
wiki/android/oss_dict.md Normal file
View File

@@ -0,0 +1,22 @@
# OSS Dict
[OSS Dict](https://github.com/fengdeyingzi/OSS-Dict) is a free and open-source offline dictionary
application for [Android](/wiki/android.md) and a fork of Aard 2.
The application can for example be used together with
[Episteme Reader](/wiki/android/episteme_reader.md) for looking up words while reading.
## Setup
On [Android](/wiki/android.md) OSS Dict is available on [F-Droid](/wiki/android/f-droid.md)
in a package called [OSS-Dict](https://f-droid.org/en/packages/com.akylas.aard2/).
## Usage
This section addresses the usage of OSS Dict.
### Installing Dictionaries
Dictionary files have to be downloaded separately and added to OSS Dict.
This is usually done by using `.slob` files.
A guide on where to find them can be found in the
[wiki of the slob Github page](https://github.com/itkach/slob/wiki/Dictionaries).

View File

@@ -6,23 +6,23 @@ depending on your needs.
This entry describes how to handle audio data.
Music and Audiobooks can be obtained by buying the digital files or by
[extracting them off of a CD](#extract-audio-files-from-cds).
Podcasts need a so called Podcatcher.
A Podcatcher is used to subscribe to podcasts and download them automatically.
Podcasts need a podcast client.
A podcast client is used to subscribe to podcasts and download them automatically.
For Linux specific music software navigate to the corresponding
[wiki entry](/wiki/linux/audio.md).
[wiki entry](/wiki/linux/audio_%28linux%29.md).
For voice based communication, social platforms or messengers navigate to the
[communication article](/wiki/communication.md) and the corresponding
[section](/wiki/communication.md#social-platforms-messengers-and-voip-services).
For headphones navigate to the [headphones article](/wiki/headphones.md):
And for headphones navigate to the [headphones article](/wiki/headphones.md):
## Speech Recognition and Synthesis
[Speech recognition and synthesis](/wiki/speech_recognition_and_synthesis.md) describe processes to
understand and convert spoken language to text aswell as the reverse process.
understand and convert spoken language to text as well as the reverse process.
## Technical Specifications
This section aswell as its subsections address all technical things about audio, like connections,
This section as well as its subsections address all technical things about audio, like connections,
cables and devices.
The most frequently used audio formats are also addressed.
@@ -30,13 +30,13 @@ The most frequently used audio formats are also addressed.
Unbalanced audio uses a wire for the positive signal for audio transmission and one for ground.
This is the most frequently used type of cable bound audio transmission.
Usually they are connected with jack connections like 3.5mm and 6.25mm.
Usually they are connected with jack connections like 3.5 mm and 6.25 mm.
Balanced audio uses one wire for the positive signal, one for negative and another one for the
ground.
Due to this extra cable a balanced connection can cancel out noise that entered the cable and
affected both the positive and the negative signal.
Balanced uses connectors like 4-pin XLR aswell as 2.5mm and 4.4mm jacks
Balanced uses connectors like 4-pin XLR as well as 2.5 mm and 4.4 mm jacks
### Audio Formats and Encoding
@@ -72,20 +72,20 @@ These can be created when the
Usually this appears together with a single file for the whole CD.
The audio file can then be split according to the `.cue` file.
For splitting of `.flac` files on a Linux system check the
[a flac (package) entry](/wiki/linux/flac_%28package%29.md#splitting-flac-file-according-to-cue-file)
for further informations.
[flac (package) entry](/wiki/linux/flac_%28package%29.md#splitting-flac-file-according-to-cue-file)
for further information.
## Media Software
If you want to keep your system clean of much data, you can use this kind of
setup.
There are differences depending on your preffered software interface.
There are differences depending on your preferred software interface.
### Import Playlist to Spotify
Importing a playlist to Spotify can be challenging.
An easy way to do it is using [Spotlistr](https://www.spotlistr.com/search/textbox) using the
Textbox function.
text box function.
A List of Songs can be input and after connecting to Spotify, it will be imported automatically.
### Digital Audio Workstations and Recording Software
@@ -101,20 +101,19 @@ produce audio files.
### Software for Music/Podcasts/Audiobooks
The following is a list of server software, that is featured in this wiki.
The corresponding client software is handled in the server softwares wiki entry.
The corresponding client software is handled in the server software wiki entry.
- [Subsonic](/wiki/subsonic.md) is a media streamer for music, podcasts and
- [Subsonic](/wiki/subsonic.md) is a media streamer for music, podcasts and
audiobooks.
Subsonic is self-hostable.
Subsonic that can be dockerized and has a web-interface aswell as several
It is self-hostable and can be dockerized and has a web-interface as well as several
clients that can be used.
There are also the free and open-source implementations that feature all the
same features and using its API named [Airsonic](/wiki/airsonic.md) (no longer
maintained) and its inofficial successor [Airsonic-advanced](/wiki/airsonic.md).
maintained) and its unofficial successor [Airsonic-Advanced](/wiki/airsonic.md).
### Software for Podcasts
- [Podgrab](/wiki/podgrab.md) is a free and open-source podcatcher that can also be
- [Podgrab](/wiki/podgrab.md) is a free and open-source podcast client that can also be
used to listen to them.
It is self-hostable and can be dockerized.
It has a web-interface and does not feature client software.
@@ -124,7 +123,7 @@ The corresponding client software is handled in the server softwares wiki entry.
[YouTube](/wiki/youtube.md) features a wide variety of uploaded music and audiobooks.
Using programs like [yt-dl](/wiki/youtube.md#downloading-youtube-videos) they can be downloaded.
[Audible](https://www.audible.de/) is a popular service that makes sells audibooks.
[Audible](https://www.audible.de/) is a popular service that makes sells audiobooks.
After purchasing an audiobook it can be downloaded directly from Audible after navigating to the
`Library` tab and selecting `Download`.
Another option is to use [OpenAudible](/wiki/openaudible.md).
@@ -137,24 +136,24 @@ An account on any of these services or any account at all is not require
## Digitalizing and Analyzing Physical Mediums
This section focusses on physical audio mediums like CDs, their digitalization to a digital audio
This section focuses on physical audio mediums like CDs, their digitalization to a digital audio
file of [specific format](#audio-formats-and-encoding) and conversions between them.
### Detect Bad Conversions
The bitrate, format and the sample rate can be usually checked with simple
The bit rate, format and the sample rate can be usually checked with simple
tools.
For Linux a simple software solution for this is the `file` command.
Running it will display these features of a given audio file.
This will however only display the format features.
Bad convserions as described in
Bad conversions as described in
[the previous section](#audio-formats-and-encoding) can not
be detected by this.
A spectral analysis can detect bad conversions.
For this a audio analyzer like
For this an audio analyzer like
[Sonic Visualizer](https://www.sonicvisualiser.org/) is needed.
Select a audio file and press `Add Spectogram` under `Layer`.
This will display a spectogram.
Select an audio file and press `Add Spectogram` under `Layer`.
This will display a spectogramm.
Music off of a retail CD and lossless songs have frequencies that extend up to
22kHz and can extend even further for hi-res music.
If the frequency extends up to at least 22kHz the file is lossless for sure.
@@ -168,9 +167,9 @@ This way you don't have to search for your CDs all the time.
- [Exact Audio Copy](https://www.exactaudiocopy.de) for windows can rip music
and automatically tag it with the help of a list of databases.
- [fre:ac](https://freac.org/downloads-mainmenu-33) is a free cross-platform
- [The fre:ac project](https://freac.org/downloads-mainmenu-33) is a free cross-platform
audio converter and CD ripper with support for various popular formats.
- [metaflac](/wiki/linux/flac_%28package%29.md) for [Linux](/wiki/linux.md) is a program to edit
- [The metaflac package](/wiki/linux/flac_%28package%29.md) for [Linux](/wiki/linux.md) is a program to edit
the tags of [flac](/wiki/flac_%28codec%29.md) files from the command line.
It is bundled in the `flac` package for [Debian](/wiki/linux/debian.md) and arch based systems.
- [MusicBrainz Picard](/wiki/picard.md) for [Linux](/wiki/linux.md) is a graphical user interface
@@ -180,12 +179,12 @@ This way you don't have to search for your CDs all the time.
While deciding on what version of an album is the best visit
[Dynamic Range DB](https://dr.loudness-war.info).
It shows dynamic range scorings of each version.
It shows dynamic range scores of each version.
### Get Additional Data to an Album/Single
If additional information for an album is needed, visit [Discogs](https://www.discogs.com).
Discogs has tracklists, dates and more information to nearly all versions of albums and singles.
Discogs has track lists, dates and more information to nearly all versions of albums and singles.
### Naming Convention
@@ -193,14 +192,14 @@ It is suggested to place the audio files in a directory named after the album th
These album directories are placed in directories named after the album artist.
Files can be named in the following scheme.
- music: `[<discnumber>.]<tracknumber>._<artist>_-_<title>`
- audiobooks: `[<discnumber>.]<tracknumber>._<artist>_-_<album>_<tracknumber>`
- Music: `[<discnumber>.]<tracknumber>._<artist>_-_<title>`
- Audiobooks: `[<discnumber>.]<tracknumber>._<artist>_-_<album>_<tracknumber>`
### Sheet Music
Music has moved more and more into the computer realm.
An easy and intuitive software that can be used for this is [MuseScore.org](https://musescore.org/)
which features notating music aswell as a wide catalogue of available sheet music.
which features notating music as well as a wide catalog of available sheet music.
MuseScore is free and open-source and is cross-platform.
On [Linux based systems](/wiki/linux.md) it is available on most distributions via the `musescore`
package or their [website](https://musescore.org/download) and can be run with the command `mscore`.
@@ -208,7 +207,7 @@ For Windows visit the [download section of the MuseScore website](https://musesc
Another option for music notation is [LilyPond](https://lilypond.org/).
It is free software and also features
[a plugin](https://github.com/martineausimon/nvim-lilypond-suite) for [NeoVIM](/wiki/linux/vim.md).
[a plugin](https://github.com/martineausimon/nvim-lilypond-suite) for [Neovim](/wiki/linux/vim.md).
From the `.ly` files typical for LilyPond `.midi` files can automatically be generated.
These can in turn be played using [FluidSynth](https://www.fluidsynth.org/).

View File

@@ -18,7 +18,11 @@ package `calibre` or a similar name, which contains the desktop version as well.
This section addresses various features of calibre.
## Connect via OPDS
### Usage for the Web Version
This section focuses on the basic usage of calibre's web version.
#### Connect via OPDS
OPDS is a protocol to share e-books via HTTP(S) and XML.
For example, it can be used to connect to an e-book reader like [Episteme](/wiki/e-book.md#e-reader)
@@ -37,12 +41,16 @@ http://<subdomain>.<domain>.<tld>/opds
The login data for the OPDS catalog is the same as for calibre's web version in general.
## Adding a Plugin
### Usage for the Desktop Version
This section focuses on the basic usage of calibre's desktop version.
#### Adding a Plugin
A plugin by a third party can be added by selecting a `.zip` archive usually named
`<plugin name>_plugin.zip` under Preferences, Plugins, Load plugin from file.
## Exporting Books
#### Exporting Books
Books can be exported by selecting them and pressing `Save to disk`.
After selecting a path the books will be saved there.
@@ -64,7 +72,7 @@ In the same view only the boxes `Save cover separately`, `Save metadata in a sep
`Save data file as well` should be unchecked.
All others are used to ensure a lowercase directory and file name without special characters.
## Changing the Default Author and Title Sort
#### Changing the Default Author and Title Sort
Under `Preferences` and `Tweaks` the corresponding settings to change the title and author sort name
can be found.
@@ -85,7 +93,7 @@ This entry is based on two posts on mobileread one regarding the
[sort author name](https://www.mobileread.com/forums/showthread.php?t=314663) and the other
regarding the [sort title](https://www.mobileread.com/forums/showthread.php?t=249870).
## Changing the Cover of a Book
#### Changing the Cover of a Book
Changing covers of a book can be done by editing the metadata available via the right-click menu.
However this is not enough in some cases.
@@ -96,7 +104,7 @@ An alternative to this is the `PDF Cover` Plugin which allows the insertion of t
other pages without an extra conversion.
Please note that it prepends the cover and does not delete any pages.
## Transfer Books to a Device
#### Transfer Books to a Device
To transfer books to a device connect a e-reader to the computer.
After a while calibre should recognize the device which will be apparent by the appearance of
@@ -113,12 +121,8 @@ Afterward select `Update cached metadata on device` under `Device` to update the
the series.
Finally, disconnect the device.
## KEPUB Format
The `.kepub` format is a format that is similar to a normal epub but has some performance
improvements for Kobo devices.
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).
It is recommended to convert `.mobi` and `.epub` files to a `.kepub` file before transfering it to a
Kobo device.
For this the Plugin `KePub Output` by Joel Goguen [can be added](#adding-a-plugin) can be installed.
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
@@ -126,7 +130,7 @@ 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
#### Exporting and Importing Settings and Libraries
This section explains how to export and import the settings of one calibre instance to another.
It is based on a
@@ -139,3 +143,53 @@ instructions.
Please note that the export only works when an empty folder is selected.
All calibre data will then be exported into the selected directory.
For the import process the folder that includes the calibre data has to be selected.
## Troubleshooting
This section will focus on errors and the fixing of errors of calibre.
### Troubleshooting for the Web Version
This section focuses on the basic usage of calibre's web version.
#### Problems Logging in With Reverse Proxy
It is [a known problem](https://github.com/janeczku/calibre-web/issues/2916) not being able to login
when using a [reverse proxy](/wiki/reverse-proxy.md) like [Nginx](/wiki/nginx.md) or
[Traefik](/wiki/traefik.md).
In this case a 504 error will be displayed.
According to various sources this can be fixed by trying previous sections until it works again.
#### `sqlite3.OperationalError: no such column: books.isbn`
When starting calibre's web version a `500 Internal Server Error` may be displayed.
The logs contain an error similar to the following.
```txt
sqlite3.OperationalError: no such column: books.isbn
```
This indicates that the `metadata.db` schema is missing the `isbn` and `flags` columns expected by
the installed web version.
As a temporary workaround the missing columns can be added manually using the following command.
The placeholder `<metadata>` is the path to calibre's `metadata.db`.
```sh
sqlite3 <metadata>
```
Afterwards run the following [SQL](/wiki/database.md) commands on the database.
```sql
ALTER TABLE books ADD COLUMN isbn TEXT;
ALTER TABLE books ADD COLUMN flags INTEGER NOT NULL DEFAULT 0;
```
After applying the changes restart the service.
The added columns are metadata fields.
Existing books will keep a `NULL` value for `isbn` and `0` for `flags`.
This workaround allows the web version to start again, however it is recommended to verify that the
library was created with a compatible calibre version and that the correct `metadata.db` is being
used.

14
wiki/deepl.md Normal file
View File

@@ -0,0 +1,14 @@
# DeepL
[DeepL](https://www.deepl.com) is an AI-based translation service for translating text and documents
between various languages.
## Setup
DeepL is a website that can be visited without additional setup needed.
On [Android](/wiki/android.md) DeepL is available on [F-Droid](/wiki/android/f-droid.md) in a
package called [DeepL](https://f-droid.org/en/packages/com.example.deeplviewer/).
Additionally, it is available on the [Google Play store](/wiki/android.md#app-store) in a package
called
[DeepL Translate](https://play.google.com/store/apps/details?id=com.deepl.mobiletranslator&hl=en-US).

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

@@ -25,6 +25,18 @@ name. A IP
Where `name` is the domain to map the `IP` to and `A` is the constant for
the type of the record.
### AAAA record
AAAA records are IPv6 address records that map hostnames to an IPv6 address.
Its basic structure is the following.
```txt
<name>. AAAA <IPv6>
```
Where `<name>` is the domain to map the IPv6 address in this case `<IPv6>` to and `AAAA` is the
constant for the type of the record.
### CNAME record
CNAME (canonical name) records map one domain name to another.
@@ -55,3 +67,52 @@ with the same priority, `port` is the port on that the service can be found and
Note that you need to create an A if you bind a service to a `name` that doesn't
already have one.
### MX record
Mail Exchange often shortened to MX records specify which mail server is responsible for
receiving emails for a domain.
Its basic structure is the following.
```txt
<name>. MX <priority> <target>.
```
Where `<name>` is the domain to receive mail for, `<priority>` is the preference of the mail server
(lower values are preferred), `<target>` is the hostname of the mail server and `MX` is the constant
for the type of the record.
The target of an MX record must resolve to an A or AAAA record.
### TXT record
TXT short for text records associate arbitrary textual information with a domain.
Its basic structure is the following.
```txt
<name>. TXT "<text>"
```
Where `<name>` is the domain to associate the content in this case `<text>` with and `TXT` is the
constant for the type of the record.
TXT records are commonly used for domain verification as well as technologies such as
[SPF](/wiki/email.md#spf-record), [DKIM](/wiki/email.md#dkim-record) and
[DMARC](/wiki/email.md#dmarc-record).
### PTR record
Pointer often shortened to PTR records map an IP address back to a hostname.
Its basic structure is the following.
```txt
<ip>. PTR <hostname>.
```
Where `<ip>` is the reverse DNS representation of an IP address, `<hostname>` is the canonical
hostname and `PTR` is the constant for the type of the record.
PTR records are part of the reverse DNS namespace and are usually managed by the owner of the IP
address rather than the owner of the domain.
Therefor, they usually have to be set on the domain management website or (if accessible) directly
in the DNS server.

View File

@@ -94,6 +94,21 @@ volume belongs to.
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
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/).
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
place.

View File

@@ -5,7 +5,7 @@ tracker.
The official container and documentation was made by
[alexjustesen](https://github.com/alexjustesen/speedtest-tracker).
## Set-up
## Setup
Create the file `rebuild.sh`.
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).
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.
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
setup via [Docker](/wiki/docker.md).
## Set-up
## Setup
Due to the syncserver having to be set up manually first navigate to the
[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).
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.
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
[axhilrex](https://github.com/akhilrex/podgrab).
## Set-up
## Setup
Create the file `rebuild.sh`.
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.
The official container and documentation was made by [b4bz](https://hub.docker.com/r/b4bz/homer).
## Set-up
## Setup
Create the file `rebuild.sh`.
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
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.
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
[benbusby](https://github.com/benbusby/whoogle-search).
## Set-up
## Setup
First of all create a folder for your `rebuild.sh`.
After that clone whoogle from

View File

@@ -2,7 +2,7 @@
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.
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
it.
## Set-up
## Setup
Create the files `rebuild.sh`, `.env` and `docker-compose.yml` at the same
place.

View File

@@ -6,7 +6,7 @@ The official container and documentation was made by
[cloudrac3r](https://github.com/cloudrac3r/bibliogram).
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`.
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).
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
same place.

View File

@@ -3,7 +3,7 @@
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).
## Set-up
## Setup
Create the file `rebuild.sh`.
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
[dyonr](https://github.com/DyonR/docker-Jackettvpn).
## Set-up
## Setup
Create the file `rebuild.sh` and set `<username>` and `<password>` according to
your openvpn.

View File

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

View File

@@ -5,7 +5,7 @@ server.
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).
## Set-up
## Setup
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.

View File

@@ -2,7 +2,7 @@
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.
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
[haugene](https://github.com/haugene/docker-transmission-openvpn).
## Set-up
## Setup
Create the file `rebuild.sh`.
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
[henrywhitaker3](https://hub.docker.com/r/henrywhitaker3/speedtest-tracker).
## Set-up
## Setup
Create the file `rebuild.sh`.
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
[homeassistant](https://hub.docker.com/r/homeassistant/home-assistant).
## Set-up
## Setup
Create the file `rebuild.sh`.
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
[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
place.

View File

@@ -5,7 +5,7 @@ This is a [Docker](/wiki/docker.md) container for a
The container and documentation was made by
[itzg](https://hub.docker.com/r/itzg/minecraft-server).
## Set-up
## Setup
Create the file `rebuild.sh`.
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
[postgres container](/wiki/docker/postgres.md) to it.
## Set-up
## Setup
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

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
[jkarlos](https://hub.docker.com/r/jkarlos/git-server-docker).
## Set-up
## Setup
Create the file `rebuild.sh`.
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
[johnktims](https://hub.docker.com/r/johnktims/folding-at-home).
## Set-up
## Setup
Create the file `rebuild.sh`.
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
[kiwix](https://github.com/kiwix/kiwix-tools/pkgs/container/kiwix-serve).
## Set-up
## Setup
Create the file `rebuild.sh`.
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,
[Postgres](/wiki/docker/postgres.md)
## Set-up
## Setup
Create the files `rebuild.sh` and `docker-compose.yml` at the same place.
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
[kylemanna](https://hub.docker.com/r/kylemanna/openvpn).
## Set-up
## Setup
Create the file `rebuild.sh`.
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
[linuxserver](https://github.com/linuxserver/docker-airsonic-advanced).
## Set-up
## Setup
Create the file `rebuild.sh`.
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
[linuxserver](https://hub.docker.com/r/linuxserver/airsonic).
## Set-up
## Setup
Create the file `rebuild.sh`.
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).
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.
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).
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.
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).
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.
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
[linuxserver](https://hub.docker.com/r/linuxserver/lidarr).
## Set-up
## Setup
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.

View File

@@ -5,7 +5,7 @@ server.
The official container and documentation was made by
[linuxserver](https://hub.docker.com/r/linuxserver/radarr).
## Set-up
## Setup
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.

View File

@@ -5,7 +5,7 @@ server.
The official container and documentation was made by
[linuxserver](https://hub.docker.com/r/linuxserver/sonarr).
## Set-up
## Setup
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.

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
[linuxserver](https://hub.docker.com/r/linuxserver/syncthing).
## Set-up
## Setup
Create the file `rebuild.sh`.
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
[linuxserver](https://hub.docker.com/r/linuxserver/tvheadend).
## Set-up
## Setup
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.

View File

@@ -5,7 +5,7 @@ This is a [Docker](/wiki/docker.md) container for a
The official container and documentation was made by
[linuxserver](https://hub.docker.com/r/linuxserver/wireguard).
## Set-Up
## Setup
Create the file `rebuild.sh`.
Change the settings according to your needs.
@@ -101,4 +101,4 @@ certificate.
### Add New Client to Existing WireGuard Installation
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

@@ -1,11 +1,15 @@
# mailserver docker-mailserver
This is a [Docker](/wiki/docker.md) container for a mailserver.
This is a [Docker](/wiki/docker.md) container for a docker-mailserver.
The official container and documentation was made by
[mailserver](https://hub.docker.com/r/mailserver/docker-mailserver).
It contains dovecot, antispam, antivirus, ssl, etc.
It contains dovecot, antispam, antivirus, ssl and many more features.
## Set-up
## Setup
This section addresses the setup of the docker-mailserver [Docker](/wiki/docker.md) container.
### Download
The configuration is done automatically using scripts by mailserver.
First you need to download the essential setup files.
@@ -18,40 +22,138 @@ wget https://raw.githubusercontent.com/docker-mailserver/docker-mailserver/v9.0.
chmod a+x ./setup.sh
```
After that you need to edit the `.env` and the `mailserver.env<>` files to
configure the mailserver.
After that you need to edit the `docker-compose.yml` and the `mailserver.env` files to configure the
mailserver.
### Initial configuration
Create the file `rebuild.sh`.
You then need to start the container with the `rebuild.sh` and add email
accounts using the following command.
You then need to start the container using `rebuild.sh`.
`./setup.sh email add <user@domain> (<password>)`
`./setup.sh alias add postmaster@<domain> <user@domain>`
After the container is running create the desired mail accounts where `<user@domain>` is the desired
[email](/wiki/email.md) account consisting of its parts and `<password>` is the password.
It is recommended to create a postmaster account aswell.
It can be either created as a secondary account or just linked to the first account as shown in the
following lines.
And finally generate the DCIM keys and rebuild once again.
```sh
./setup.sh email add <user@domain.tld> (<password>)
./setup.sh alias add postmaster@<domain> <user@domain.tld>
```
`./setup.sh config dkim`
Then generate the DKIM keys.
Finally, if a reverse proxy is used check the
[traefik entry](/wiki/docker/traefik.md#setup-mailserver) or the [nginx entry](/wiki/nginx.md).
```sh
./setup.sh config dkim
```
Afterward you're ready to go by once again running the `rebuild.sh` file.
Finally rebuild the container once again.
The required DNS configuration is explained in the
[corresponding section of the email wiki entry](/wiki/email.md#mail-server-records).
This needs to be set up for the [email](/wiki/email.md) to work properly with most other providers.
For the DKIM record the generated configuration has to be retrieved from the following file.
```txt
config/opendkim/keys/<domain>/mail.txt
```
Afterward run the `rebuild.sh` file again.
### Reverse proxy
If setting up this mailserver with [Traefik](/wiki/traefik.md) as a reverse proxy some additional
steps should be taken.
No http or https is needed.
But a certificate for the mailserver is needed regardless.
In this case add the following lines to the file `docker-compose.yml` in the
`services:` section and adapt them.
Although SMTP, IMAP and POP3 do not pass through [Traefik](/wiki/traefik.md), a TLS certificate is
still required.
A simple way to automatically obtain and renew such a certificate is to expose a temporary HTTP
service.
In this case a simple [Traefik](/wiki/traefik.md) `whoami` container is used.
For a single mail domain the following service is sufficient.
In this case add the following lines to the file `docker-compose.yml` in the `services:` section and
adapt them according to your needs.
```yml
whoami:
image: docker.io/traefik/whoami:latest
labels:
"traefik.enable=true"
"traefik.http.routers.whoami.rule=Host(`<subdomain>.<domain>`)"
whoami:
image: docker.io/traefik/whoami:latest
networks:
- proxy
labels:
- "traefik.enable=true"
- "traefik.http.routers.whoami.rule=Host(`mail.<domain>`)"
- "traefik.http.routers.whoami.tls=true"
- "traefik.http.routers.whoami.tls.certresolver=letsencrypt"
```
The mailserver itself does not use this service.
It merely causes [Traefik](/wiki/traefik.md) to request and automatically renew the TLS certificate.
### Optional: Multiple Mail Domains
Multiple independent mail domains can share a single mailserver instance.
In this setup only one TLS certificate is used, containing all mail hostnames as Subject Alternative
Names (SANs).
For two domains the configuration could look as follows.
```yml
whoami:
image: docker.io/traefik/whoami:latest
networks:
- proxy
labels:
- "traefik.enable=true"
- "traefik.http.routers.whoami.rule=Host(`mail.example.com`) || Host(`mail.example.org`)"
- "traefik.http.routers.whoami.tls=true"
- "traefik.http.routers.whoami.tls.certresolver=letsencrypt"
- "traefik.http.routers.whoami.tls.domains[0].main=mail.example.com"
- "traefik.http.routers.whoami.tls.domains[0].sans=mail.example.org"
```
For three domains simply extend both the router rule and the SAN list.
```yml
- "traefik.http.routers.whoami.rule=Host(`mail.example.com`) || Host(`mail.example.org`) || Host(`mail.example.net`)"
- "traefik.http.routers.whoami.tls.domains[0].main=mail.example.com"
- "traefik.http.routers.whoami.tls.domains[0].sans=mail.example.org,mail.example.net"
```
[Traefik](/wiki/traefik.md) will then obtain a single certificate with the following names and keep
it updated in the future.
- `mail.example.com` as the Common Name (CN)
- `mail.example.org` as a Subject Alternative Name (SAN)
- `mail.example.net` as a Subject Alternative Name (SAN)
This single certificate is used by the mailserver for all configured mail domains.
For every additional domain a DKIM key has to be generated.
```sh
docker exec mailserver setup config dkim domain '<domain>'
```
The required DNS records described in the
[corresponding section of the Email entry](/wiki/email.md#mail-server-records) also have to be
created as previously shown in [the previous section](#initial-configuration).
After that mail addresses for the additional domains can simply be created and used.
No further setup is needed and [emails](/wiki/email.md) using the new domains can simply be created.
```sh
./setup.sh email add <user@domain.tld> (<password>)
```
### Optional: Client Setup
After setting up the [Email](/wiki/email.md) server, some [Client](/wiki/email.md#client)
configurations may be taken.
Especially recommended is the setup of
[end-to-end encryption](/wiki/email.md#end-to-end-encryption).
### rebuild.sh
```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.
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 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)
needs to be connected.
## Set-up
## Setup
Create the files `rebuild.sh`, `.env` and `docker-compose.yml` at the same
place.

View File

@@ -6,7 +6,7 @@ The official container and documentation was made by
[matrixdotorg](https://hub.docker.com/matrixdotorg/synapse).
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.
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
[mikenye](https://github.com/mikenye/docker-picard).
## Set-up
## Setup
Create the file `rebuild.sh`.
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)
Docker container.
## Set-up
## Setup
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.

View File

@@ -6,7 +6,7 @@ The official container and documentation was made by
[nginx](https://hub.docker.com/_/nginx).
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.
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
[olbat](https://hub.docker.com/r/olbat/cupsd).
## Set-up
## Setup
Create the file `rebuild.sh`.
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
[ollama](https://hub.docker.com/r/ollama/ollama).
## Set-up
## Setup
Create the file `rebuild.sh`.
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
[open-webui](https://github.com/open-webui/open-webui).
## Set-up
## Setup
Create the file `rebuild.sh`.
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
container.
## Set-up
## Setup
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.

View File

@@ -5,7 +5,7 @@ cloudflare dns entries.
The official container and documentation was made by
[oznu](https://github.com/oznu/docker-cloudflare-ddns).
## Set-up
## Setup
Create the file `rebuild.sh`.
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.
The official container and documentation was made by [oznu](https://hub.docker.com/r/oznu/onedrive).
## Set-up
## Setup
Create the file `rebuild.sh`.
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
[portainer](https://hub.docker.com/r/portainer/agent).
## Set-up
## Setup
Create the file `rebuild.sh`.
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
[portainer](https://hub.docker.com/r/portainer/portainer).
## Set-up
## Setup
Create the file `rebuild.sh`.
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
[prologic](https://git.mills.io/prologic/golinks).
## Set-up
## Setup
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.

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
[prologic](https://hub.docker.com/r/prologic/gopherproxy).
## Set-up
## Setup
Create the file `rebuild.sh`.
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
[prologic](https://hub.docker.com/r/prologic/todo).
## Set-up
## Setup
Create the file `rebuild.sh`.
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).
There is no official pre-build on docker-hub.
## Set-up
## Setup
First of all create a folder for your `rebuild.sh`.
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
[rlister](https://hub.docker.com/r/rlister/hastebin).
## Set-up
## Setup
Create the file `rebuild.sh`.
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
[dperson](https://hub.docker.com/r/samba).
## Set-up
## Setup
Create the file `rebuild.sh`.
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
[searx](https://hub.docker.com/r/searx/searx).
## Set-up
## Setup
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.

View File

@@ -3,7 +3,7 @@
This is a [Docker](/wiki/docker.md) container for a [Sinusbot](/wiki/sinusbot.md).
The Server consists of a single Docker container.
## Set-up
## Setup
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
[sissbrueckner](https://github.com/sissbruecker/linkding).
## Set-up
## Setup
Create the file `rebuild.sh`.
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
[spikecodes](https://github.com/spikecodes/libreddit).
## Set-up
## Setup
Create the file `rebuild.sh`.
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
[Teamspeak](https://hub.docker.com/_/teamspeak).
## Set-up
## Setup
Create the file `rebuild.sh`.
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
[tetricz](https://hub.docker.com/r/tetricz/mordhau-server).
## Set-up
## Setup
Create the files `start.sh` and `stop.sh`.
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.
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
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 last usable tag was used therefore to guarantee best performance for all users.
## Set-up
## Setup
Create the file `rebuild.sh`.
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).
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.
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
[postgres container](/wiki/docker/postgres.md) to it.
## Set-up
## Setup
Create the files `rebuild.sh`, `.env` and `docker-compose.yml` at the same
place.

View File

@@ -6,7 +6,7 @@ The official container and documentation was made by
[linuxserver](https://hub.docker.com/vectorim/riot-web).
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.
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
[ventz](https://hub.docker.com/r/ventz/bind).
## Set-up
## Setup
Create the file `rebuild.sh`.
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
[viperproject](https://hub.docker.com/r/viperproject/viperserver).
## Set-up
## Setup
Create the file `rebuild.sh`.
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).
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.
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
[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.
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
[xy2z](https://hub.docker.com/r/xy2z/pinedocs).
## Set-up
## Setup
Create the file `rebuild.sh`.
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
it.
## Set-up
## Setup
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.

View File

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

View File

@@ -1,6 +1,6 @@
# E-book
An E-book is a digital publication of a book.
An e-book is a digital publication of a book.
They can be read with specific hardware an [e-reader](#e-reader) or on a personal
computer.
E-books are usually available in `.epub` or `.pdf` files.
@@ -25,18 +25,18 @@ If the software is to be used by you check your local laws first.
## Tracking
Many e-book readers include a feature to keep track of read books.
However they do not track the time that was needed to finish them or the number of e-books read in
However they do not track the time that was needed to finish them or the number of e-books read in
a specific timeframe.
This can be done by using a special tracker like [Jelu](/wiki/jelu.md) which can be used to keep
track of e-books and normal books at the same time which is a feature no e-book reader has.
## E-Reader
## E-Reader
An e-reader is a device that is designed for reading digital e-books.
Some of them also feature [annotation tools](/wiki/note-taking.md).
- [Episteme Reader](https://github.com/Aryan-Raj3112/episteme) is a native
[Android](/wiki/android.md) [e-book](/wiki/e-book.md) reader, that is capable of annotations.
- [Episteme Reader](/wiki/android/episteme_reader.md) is a native [Android](/wiki/android.md)
e-book reader, that is capable of annotations.
In contrast to [Saber](/wiki/note-taking.md#software) it is able to handle large PDF-files.
Additionally it features the OPDS protocol for catalogs which can, for example, connect to
[the OPDS catalog of calibre's web version](/wiki/calibre.md#connect-via-opds).

30
wiki/eduroam.md Normal file
View File

@@ -0,0 +1,30 @@
# eduroam
eduroam, short for education roaming, is a wireless network available at many universities and
research institutions worldwide.
It allows users to connect using the credentials or certificates issued by their home institution.
## Android
The recommended [Android](/wiki/android.md) client is called [geteduroam](https://geteduroam.app/).
It is available on the [Google Play Store](/wiki/android.md#app-store) as well as on
[F-Droid](/wiki/android.md#app-store).
It supports both username/password authentication and certificate-based authentication (EAP-TLS).
Install the application, select your institution and follow the setup process.
The application should remain installed, as removing it also removes the eduroam configuration.
## Linux
Most [Linux](/wiki/linux.md) desktop environments support eduroam directly through
[NetworkManager](/wiki/linux/networkmanager.md).
For username/password authentication configure a new WPA2/WPA3 Enterprise connection using the
parameters provided by your institution.
If certificate-based authentication (EAP-TLS) is used, import the supplied client certificate and
configure the connection accordingly.
The certificate is usually provided by your institution.
Some institutions also provide an installer through the official
[eduroam Configuration Assistant Tool (CAT)](https://cat.eduroam.org).

View File

@@ -14,6 +14,106 @@ interfaces.
- [Dovecot](/wiki/docker/mailserver_-_docker-mailserver.md) is a simple dockerized
mail server that has no interface.
### Mail Server Records
To successfully operate a mail server several DNS records are required.
The following records assume that the mail server is reachable via `mail.<domain>`.
#### Mail A Record
The mail host must resolve to the server's public IP using an [A record](#a-record).
```txt
mail.<domain>. A <server-ip>
```
#### MX record
The MX record specifies which host is responsible for receiving mail for the domain.
For this an [MX Record](/wiki/dns.md#mx-record) is used.
```txt
<domain>. MX 10 mail.<domain>.
```
The target of an MX record must always resolve to an [A](/wiki/dns.md#a-record) or
[AAAA record](/wiki/dns.md#aaaa-record).
#### SPF record
SPF specifies which servers are allowed to send mail on behalf of the domain using a
[TXT record](/wiki/dns.md#txt-record).
```txt
<domain>. TXT "v=spf1 mx -all"
```
If mail is only sent via the configured mail server this is sufficient.
If additional providers are used the SPF record maybe has to be extended accordingly.
#### DKIM record
DKIM allows receiving mail servers to verify that an email has not been altered during transport.
The DKIM key is generated by the mail server and published as a
[TXT record](/wiki/dns.md#txt-record).
```txt
mail._domainkey.<domain>. TXT "v=DKIM1; h=sha256; k=rsa; p=<public-key>"
```
The key has to be retrieved from the mail server.
For example for [docker-mailserver](/wiki/docker/mailserver_-_docker-mailserver.md) the process is
described in the
[corresponding setup section](/wiki/docker/mailserver_-_docker-mailserver.md#setup).
#### DMARC record
DMARC defines how receiving mail servers should handle messages that fail SPF or DKIM validation.
The DMARC records is a specific [TXT record](/wiki/dns.md#txt-record).
```txt
_dmarc.<domain>. TXT "v=DMARC1; p=none; rua=mailto:dmarc@<domain>; adkim=s; aspf=s"
```
After verifying that SPF and DKIM work correctly the policy can be changed to
```txt
p=quarantine
```
or
```txt
p=reject
```
#### Reverse DNS Record
The server's IP address should resolve back to the mail host.
This is done using a [PTR record](/wiki/dns.md#ptr-record).
Please note that PTR records can not be set as easily as normal DNS records as explained in
[the corresponding section of the DNS entry](/wiki/dns.md#ptr-record).
```txt
<server-ip> PTR mail.<domain>.
```
The PTR record is configured at the hosting provider and not in the domain's DNS zone.
It is recommended that the PTR record matches the hostname used by the mail server's HELO/EHLO
greeting.
### Administrative addresses
For interoperability every mail domain should provide at least the following addresses.
- `postmaster@<domain>`
- `abuse@<domain>`
- `dmarc@<domain>` (recommended if DMARC reports are enabled)
These addresses may simply be aliases that forward to the primary mailbox.
## Client
If you don't have a built-in web interface for your mail-server you need some
@@ -27,3 +127,20 @@ And even if you have it can be useful to keep your mails synced locally on your
It also features, contact, todo and calendar management.
- [FairEmail](/wiki/android/fairemail.md) is a free and open-source mail client for
[Android](/wiki/android.md).
## Usage
This section addresses the usage of various Email related topics.
### End-to-End Encryption
Besides transport encryption (TLS), emails can also be protected using end-to-end encryption.
The two most common standards are [OpenPGP](/wiki/openpgp.md) and S/MIME.
OpenPGP allows emails to be digitally signed and encrypted.
Unlike TLS, which only protects the transport between mail servers and clients, OpenPGP protects the
message itself.
The generation, management and export of OpenPGP keys is described in the
[GPG entry](/wiki/linux/gpg.md).
The configuration of specific mail clients is described in the corresponding client entries such as
[Thunderbird](/wiki/thunderbird.md#use-openpgp-for-encryption-decryption-and-signing).

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.
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).
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/)
is an even faster alternative to Consent-O-Matic.
- [Temporary Containers](https://addons.mozilla.org/en-GB/firefox/addon/temporary-containers) opens
@@ -97,10 +98,10 @@ The following add-ons provide translation options.
add-on made by Mozilla itself that gives an option for marked text to display its translations
quickly from the extension menu but can also translate whole sites.
- [Simple Translate](https://addons.mozilla.org/en-US/firefox/addon/simple-translate) is an add-on
supporting both DeepL and Google Translate to translate marked text in various different ways that
can be automatically displayed.
supporting both [DeepL](/wiki/deepl.md) and Google Translate to translate marked text in various
different ways that can be automatically displayed.
- [To DeepL translation](https://addons.mozilla.org/en-US/firefox/addon/to-deepl/) gives an option
for marked text to display its translation in a pop-up window using DeepL.
for marked text to display its translation in a pop-up window using [DeepL](/wiki/deepl.md).
#### Shopping Add-ons

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

@@ -8,8 +8,10 @@ This entry also features medicinal image and visual formats such as DICOM.
## Viewer
- [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.
- [imv](https://sr.ht/~exec64/imv/) is an image viewer native to [Linux'](/wiki/linux.md)
[Wayland](/wiki/linux/wayland.md).
## Editors

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