1
0
mirror of https://github.com/tiyn/wiki.git synced 2026-05-01 15:41:35 +02:00

Compare commits

..

29 Commits

Author SHA1 Message Date
f990fa6557 KohakuHub: Added and linked into git (general) 2026-04-26 08:37:57 +02:00
456c436e09 hierarchical data format: fixed structure 2026-04-23 04:10:16 +02:00
f2c8027c4d Merge branch 'master' of github.com:tiyn/wiki 2026-04-19 02:00:49 +02:00
603cecf8c4 HDF: Added 2026-04-19 02:00:42 +02:00
ede99678ea Typography: Removed comma after 'Afterwards' at the begin of sentence 2026-04-14 05:25:16 +02:00
e2e2310b81 NextCloud: Added fix for idle loop 2026-04-14 05:23:55 +02:00
d3483b952a NextCloud: Fixed some typography errors 2026-04-14 04:32:13 +02:00
b624010967 Hailo: Fixed some typography errors 2026-04-14 00:21:02 +02:00
f8243dc08f Structure: Fixed typos and sentences 2026-04-09 03:54:15 +02:00
7874c37998 NextCloud: Added Android colon Bug 2026-04-08 06:07:25 +02:00
58f836b4d4 Restructuring: Fixed spelling and tables 2026-04-03 10:17:26 +02:00
f4181c2c3d Restructuring: Fixed links 2026-04-03 09:12:03 +02:00
32e6023f60 Merge branch 'master' of github:/tiyn/wiki 2026-04-03 06:59:03 +02:00
7d0fc3605a E-book: Added E-reader section and added Episteme and linked it to the Note-taking entry 2026-04-03 06:58:53 +02:00
3799fef95e SystemD: added user-flag to an edit command 2026-04-01 00:12:43 +02:00
024a12f7cf Fixed Merge Conflict 2026-04-01 00:09:27 +02:00
587b82e692 EasyEffects: Added Autostart 2026-03-31 23:54:39 +02:00
1989768126 Pipewire: added a guide on virtual microphone 2026-03-31 08:34:48 +02:00
7ad6d6c35d Pipewire: added troubleshooting
Added a section on problems that occur for loopback devices in combination with EasyEffects default configuration.
2026-03-31 05:54:09 +02:00
07e5b01e0e Merge branch 'master' of github:/tiyn/wiki 2026-03-30 07:43:17 +02:00
336b070c06 hardware entries:
- changed wi-fi entry in linux folder for a general one
- improved linking of hardware entries via sections
- added bluez troubleshooting
2026-03-30 07:43:00 +02:00
ab4e54acfc hardware entries:
- changed wi-fi entry in linux folder for a general one
- improved linking of hardware entries via sections
- added bluez troubleshooting
2026-03-30 07:33:21 +02:00
47242e81de speech recognition
- Added Whisper CLI
- Split Nerd Dictation into single file
2026-03-30 04:26:03 +02:00
e285db8486 ffmpeg: added missing introduction to usage section 2026-03-29 00:37:11 +01:00
fc0993e623 Windows: Added Windows activation and MAS 2026-03-24 03:22:20 +01:00
2eb788449e Docker: added guide to find volumes container 2026-03-17 03:20:52 +01:00
77a6431f52 audio: add LilyPond for music notation 2026-03-14 09:53:27 +01:00
1e4c70b606 Merge branch 'master' of github.com:tiyn/wiki 2026-03-13 08:59:18 +01:00
51fe8f96e9 hailo: support for data types noted 2026-03-13 08:59:11 +01:00
252 changed files with 2475 additions and 1509 deletions

View File

@@ -1,30 +1,25 @@
# \*ARR # \*ARR
\*ARR application is a class of applications made as personal video recorders in \*ARR application is a class of applications made as personal video recorders in the usenet and
the usenet and [BitTorrent](/wiki/bittorrent.md) domain. [BitTorrent](/wiki/bittorrent.md) domain.
These applications include but are not limited to These applications include but are not limited to [Sonarr](https://github.com/Sonarr/Sonarr) for
[Sonarr](https://github.com/Sonarr/Sonarr) for [TV shows](/wiki/video.md), [Radarr](https://github.com/Radarr/Radarr) for [movies](/wiki/video.md)
[TV shows](/wiki/video.md), and [Lidarr](https://github.com/Lidarr/Lidarr) for [music](/wiki/audio.md).
[Radarr](https://github.com/Radarr/Radarr) for
[movies](/wiki/video.md) and
[Lidarr](https://github.com/Lidarr/Lidarr) for [music](/wiki/audio.md).
## Setup ## Setup
For the different applications there are different [Docker](/wiki/docker.md) For the different applications there are different [Docker](/wiki/docker.md) containers for setup.
containers for setup: These are [Linuxservers Sonarr image](/wiki/docker/linuxserver_-_sonarr.md),
[Linuxservers Sonarr image](/wiki/docker/linuxserver_-_sonarr.md),
[Linuxservers Radarr image](/wiki/docker/linuxserver_-_radarr.md) and [Linuxservers Radarr image](/wiki/docker/linuxserver_-_radarr.md) and
[Linuxservers Lidarr image](/wiki/docker/linuxserver_-_lidarr.md). [Linuxservers Lidarr image](/wiki/docker/linuxserver_-_lidarr.md).
### Initial Configuration ### Initial Configuration
For the initial configuration navigate to `System` and `Status`. For the initial configuration navigate to `System` and `Status`.
Afterwards check if there are any messages. Afterward check if there are any messages.
There are probably a few steps that need to be taken to complete the setup. There are probably a few steps that need to be taken to complete the setup.
Set the `Download Clients` under `Settings`. Set the `Download Clients` under `Settings`.
For this an instance of a [BitTorrent Client](/wiki/bittorrent.md#clients) can For this an instance of a [BitTorrent Client](/wiki/bittorrent.md#clients) can be used.
be used.
Next an indexer needs to be added. Next an indexer needs to be added.
For this [Jackett](/wiki/jackett.md) can be used. For this [Jackett](/wiki/jackett.md) can be used.
A guide to add Jackett indexers is featured in A guide to add Jackett indexers is featured in

View File

@@ -2,14 +2,14 @@
[Airsonic-Advanced](https://github.com/airsonic-advanced/airsonic-advanced) is [Airsonic-Advanced](https://github.com/airsonic-advanced/airsonic-advanced) is
a free and open-source personal media streamer used for a free and open-source personal media streamer used for
[music, podcasts and audiobooks](./audio.md). [music, podcasts and audiobooks](/wiki/audio.md).
It is a more modern implementation of [Airsonic](./airsonic.md) which in turn It is a more modern implementation of [Airsonic](/wiki/airsonic.md) which in turn
is a fork of [Subsonic](./subsonic.md). is a fork of [Subsonic](/wiki/subsonic.md).
## Setup ## Setup
The software can be setup via docker with the The software can be setup via docker with the
[linuxserver image](./docker/linuxserver_-_airsonic-advanced.md). [linuxserver image](/wiki/docker/linuxserver_-_airsonic-advanced.md).
### Initial configuration ### Initial configuration
@@ -36,7 +36,7 @@ Log in with the clients now works correctly.
It is possible to use many different clients because the server is compatible It is possible to use many different clients because the server is compatible
with all the Subsonic clients. with all the Subsonic clients.
These can be found in the [Subsonic entry](./subsonic.md#clients) and the [Airsonic These can be found in the [Subsonic entry](/wiki/subsonic.md#clients) and the [Airsonic
entry](/wiki/airsonic.md#clients). entry](/wiki/airsonic.md#clients).
## Scrobbling with Last.fm ## Scrobbling with Last.fm

View File

@@ -1,22 +1,21 @@
# Airsonic # Airsonic
[Airsonic](https://github.com/airsonic/airsonic) is a free and open-source [Airsonic](https://github.com/airsonic/airsonic) is a free and open-source personal media streamer
personal media streamer used for [music,podcasts and audiobooks](./audio.md). used for [music, podcasts and audiobooks](/wiki/audio.md).
It is a fork of [Subsonic](./subsonic.md). It is a fork of [Subsonic](/wiki/subsonic.md).
Airsonic is not maintained anymore and therefore deprecated. Airsonic is not maintained anymore and therefore deprecated.
A more modern implementation of it is A more modern implementation of it is [Airsonic-Advanced](/wiki/airsonic-advanced.md).
[Airsonic-Advanced](./airsonic-advanced.md).
## Setup ## Setup
The software can be setup via [Docker](/wiki/docker.md) with the The software can be setup via [Docker](/wiki/docker.md) with the
[linuxserver image](./docker/linuxserver_-_airsonic.md). [linuxserver image](/wiki/docker/linuxserver_-_airsonic.md).
### Clients ### Clients
It is possible to use many different clients because the server is compatible It is possible to use many different clients because the server is compatible with all the Subsonic
with all the Subsonic clients. clients.
These can be found in the [Subsonic entry](./subsonic.md#clients). These can be found in the [Subsonic entry](/wiki/subsonic.md#clients).
Additionally to these clients there is an improved web user interface made by tamland called Additionally, to these clients there is an improved web user interface made by tamland called
[airsonic-refix](https://github.com/tamland/airsonic-refix). [Airsonic (refix) UI](https://github.com/tamland/airsonic-refix).

View File

@@ -11,10 +11,10 @@ A free and open-source alternative to it is [F-Droid](/wiki/android/f-droid.md)
open-source software. open-source software.
A list of open-source software options is also available on Alberto Mosconis A list of open-source software options is also available on Alberto Mosconis
[Github](/wiki/git_%28general%29.md#server-with-web-interface) repository [Github](/wiki/git_%28general%29.md#server) repository
[foss apps](https://github.com/albertomosconi/foss-apps/tree/main). [foss apps](https://github.com/albertomosconi/foss-apps/tree/main).
Additionally open-source apps can be installed from source using Additionally, open-source apps can be installed from source using
[Obtainium](https://github.com/ImranR98/Obtainium). [Obtainium](https://github.com/ImranR98/Obtainium).
### Useful Applications ### Useful Applications

View File

@@ -29,6 +29,6 @@ program.
After pressing `Connect` the link will be established. After pressing `Connect` the link will be established.
The [video feed](/wiki/webcam.md) can then be used in other programs such as Discord or The [video feed](/wiki/webcam.md) can then be used in other programs such as Discord or
[Matrix](/wiki/matrix.md). [Matrix](/wiki/matrix.md).
Additionally it can be piped into [OBS](/wiki/obs.md) to edit it more or create a scene. Additionally, it can be piped into [OBS](/wiki/obs.md) to edit it more or create a scene.
Despite the option the separate app [DroidCam OBS](https://www.dev47apps.com/obs/) is not Despite the option the separate app [DroidCam OBS](https://www.dev47apps.com/obs/) is not
necessarily needed. necessarily needed.

View File

@@ -7,7 +7,7 @@
On [Android](/wiki/android.md) FairEmail is available on [F-Droid](/wiki/android/f-droid.md) in a On [Android](/wiki/android.md) FairEmail is available on [F-Droid](/wiki/android/f-droid.md) in a
package called [FairEmail](https://f-droid.org/en/packages/eu.faircode.email/). package called [FairEmail](https://f-droid.org/en/packages/eu.faircode.email/).
Additionally it is available on the[Google Play store](/wiki/android.md#app-store) in a package Additionally, it is available on the[Google Play store](/wiki/android.md#app-store) in a package
called [FairEmail](https://play.google.com/store/apps/details?id=eu.faircode.email&hl=de). called [FairEmail](https://play.google.com/store/apps/details?id=eu.faircode.email&hl=de).
## Usage ## Usage
@@ -28,6 +28,6 @@ After this is done outgoing mails can be encrypted by signed or encrypted by sel
Decryption can be done by clicking on the padlock when inside an email that is encrypted. Decryption can be done by clicking on the padlock when inside an email that is encrypted.
Additionally in the settings under `Encryption` the signing (`Sign by default`), encryption Additionally, in the settings under `Encryption` the signing (`Sign by default`), encryption
(`Sign and encrypt by default`), decryption (`Auomatically decrypt messages`) and validation (`Sign and encrypt by default`), decryption (`Auomatically decrypt messages`) and validation
(`Automatically verify signed messages`) can be set to occurr automatically. (`Automatically verify signed messages`) can be set to occurr automatically.

View File

@@ -19,25 +19,25 @@ Gadgetbridge.
### Configuration of Devices ### Configuration of Devices
Devices can be added to Gadgetbridge by clicking on the `+` in the main screen. Devices can be added to Gadgetbridge by clicking on the `+` in the main screen.
Afterwards the device can simply be paired. Afterward the device can simply be paired.
A special pairing procedure is needed for Amazfit or Xiaomi devices. A special pairing procedure is needed for Amazfit or Xiaomi devices.
The following describes the steps that need to be done. The following describes the steps that need to be done.
- Download the - Download the
[Zepp app](https://play.google.com/store/apps/details?id=com.huami.watch.hmwatchmanager). [Zepp app](https://play.google.com/store/apps/details?id=com.huami.watch.hmwatchmanager).
- Pair the device with the Zepp app. - Pair the device with the Zepp app.
- Use [huami-token](https://codeberg.org/argrento/huami-token/) to obtain the auth key by using the - Use [huami-token](https://codeberg.org/argrento/huami-token/) to obtain the auth key by using the
command `python3 huami_token.py --method amazfit --email my_email --password password --bt_keys` command `python3 huami_token.py --method amazfit --email my_email --password password --bt_keys`
with adjusted values. with adjusted values.
- Uninstall the Zepp app and unpair the device from inside the bluetooth settings of the smart - Uninstall the Zepp app and unpair the device from inside the bluetooth settings of the smart
phone. phone.
- Inside the Gadgetbridge app click on the `+`, find the device and enter the auth key by long - Inside the Gadgetbridge app click on the `+`, find the device and enter the auth key by long
pressing on the devices name. pressing on the devices name.
Afterwards navigate back to the scanning list. Afterward navigate back to the scanning list.
- Pair the device by clicking on the device name. - Pair the device by clicking on the device name.
Afterwards the device will be paired and connected. Afterward the device will be paired and connected.
### Add Weather Function ### Add Weather Function
@@ -49,7 +49,7 @@ An example for this is the [Breezy Weather app](https://github.com/breezy-weathe
which is available on the F-Droid store. which is available on the F-Droid store.
Install and configure it to your needs. Install and configure it to your needs.
Then check the Gadgetbridge option insdie the Breezy Weather app. Then check the Gadgetbridge option insdie the Breezy Weather app.
Afterwards the weather function will be working. Afterward the weather function will be working.
In the past an application named In the past an application named
[Weather Notification](https://f-droid.org/en/packages/ru.gelin.android.weather.notification/) [Weather Notification](https://f-droid.org/en/packages/ru.gelin.android.weather.notification/)

View File

@@ -28,7 +28,7 @@ An example link will look like the following.
http://192.168.178.66:8080 http://192.168.178.66:8080
``` ```
Additionally it can be piped into [OBS](/wiki/obs.md) to edit it or into Additionally, it can be piped into [OBS](/wiki/obs.md) to edit it or into
[ffmpeg](/wiki/linux/ffmpeg.md) on [Linux](/wiki/linux.md) systems to create a virtual webcam [ffmpeg](/wiki/linux/ffmpeg.md) on [Linux](/wiki/linux.md) systems to create a virtual webcam
device as explained in the device as explained in the
[ffmpeg entry](/wiki/linux/ffmpeg.md#create-a-virtual-camera-using-an-ip-video-stream). [ffmpeg entry](/wiki/linux/ffmpeg.md#create-a-virtual-camera-using-an-ip-video-stream).

View File

@@ -9,7 +9,7 @@ On [Android](/wiki/android.md) /name/ is available on the
[Google Play store](/wiki/android.md#app-store) in a package called [Google Play store](/wiki/android.md#app-store) in a package called
[Tasker](https://play.google.com/store/apps/details?id=net.dinglisch.android.taskerm). [Tasker](https://play.google.com/store/apps/details?id=net.dinglisch.android.taskerm).
Additionally the installation of [Tasker Settings](https://github.com/joaomgcd/TaskerSettings) is Additionally, the installation of [Tasker Settings](https://github.com/joaomgcd/TaskerSettings) is
recommended. recommended.
Please note that on the [Github releases page](https://github.com/joaomgcd/TaskerSettings/releases) Please note that on the [Github releases page](https://github.com/joaomgcd/TaskerSettings/releases)
there are different versions to be used with Xiaomi-phones. there are different versions to be used with Xiaomi-phones.

View File

@@ -39,7 +39,7 @@ This guide assumes the default Anki client is used.
To change this select `Browse` and then navigate to the `Note Type` the deck to add backwards cards To change this select `Browse` and then navigate to the `Note Type` the deck to add backwards cards
uses. uses.
Right click the note type and select `Cards`. Right click the note type and select `Cards`.
Afterwards the cards for backwards learning can be added by `Options` and `Add Card Types...`. Afterward the cards for backwards learning can be added by `Options` and `Add Card Types...`.
You can confirm the fields have been setup correctly by clicking through the card types and You can confirm the fields have been setup correctly by clicking through the card types and
verifying it. verifying it.

View File

@@ -47,7 +47,7 @@ Following is a list of often used formats:
- wav is an uncompressed lossless format - wav is an uncompressed lossless format
- aiff is an uncompressed lossless format - aiff is an uncompressed lossless format
- [flac](./flac_(codec).md) is a compressed lossless format - [flac](/wiki/flac_%28codec%29.md) is a compressed lossless format
- alac is a compressed lossless format - alac is a compressed lossless format
- ape is a compressed lossless format - ape is a compressed lossless format
- mp3 is a compressed lossy codec - mp3 is a compressed lossy codec
@@ -57,13 +57,11 @@ Following is a list of often used formats:
- dts is a compressed lossy codec usually found in DVDs - dts is a compressed lossy codec usually found in DVDs
Music files can either be encoded lossy or lossless. Music files can either be encoded lossy or lossless.
Lossless formats can be converted from and to each other without loosing Lossless formats can be converted from and to each other without loosing information.
information. Lossless formats can also be converted to lossy formats to make the files smaller and save space.
Lossless formats can also be converted to lossy formats to make the files
smaller and save space.
Files should not be converted to lossy formats more than once. Files should not be converted to lossy formats more than once.
Additionally lossy formats should not be converted to lossless formats as it Additionally, lossy formats should not be converted to lossless formats as it increases the file
increases the file size without adding any audio information. size without adding any audio information.
These not recommended conversions are called bad conversions. These not recommended conversions are called bad conversions.
### Cue Files ### Cue Files
@@ -74,7 +72,7 @@ These can be created when the
Usually this appears together with a single file for the whole CD. Usually this appears together with a single file for the whole CD.
The audio file can then be split according to the `.cue` file. The audio file can then be split according to the `.cue` file.
For splitting of `.flac` files on a Linux system check the For splitting of `.flac` files on a Linux system check the
[a flac (package) entry](/wiki/linux/flac_(package).md#splitting-flac-file-according-to-cue-file) [a flac (package) entry](/wiki/linux/flac_%28package%29.md#splitting-flac-file-according-to-cue-file)
for further informations. for further informations.
## Media Software ## Media Software
@@ -96,30 +94,30 @@ Digital Audio Workstations - short DAWs - is an application that can be used to
produce audio files. produce audio files.
- [LMMS](https://lmms.io/) is a free and cross-platform DAW that is highly compatible with - [LMMS](https://lmms.io/) is a free and cross-platform DAW that is highly compatible with
[Linux-based systems](/wiki/linux.md). [Linux-based systems](/wiki/linux.md).
- [Audacity](https://www.audacityteam.org/) is an open source and cross-platform software to record - [Audacity](https://www.audacityteam.org/) is an open source and cross-platform software to record
and edit audio. and edit audio.
### Software for Music/Podcasts/Audiobooks ### Software for Music/Podcasts/Audiobooks
The following is a list of server software, that is featured in this wiki. 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 softwares wiki entry.
- [Subsonic](./subsonic.md) is a media streamer for music, podcasts and - [Subsonic](/wiki/subsonic.md) is a media streamer for music, podcasts and
audiobooks. audiobooks.
Subsonic is self-hostable. Subsonic is self-hostable.
Subsonic that can be dockerized and has a web-interface aswell as several Subsonic that can be dockerized and has a web-interface aswell as several
clients that can be used. clients that can be used.
There are also the free and open-source implementations - that feature all the There are also the free and open-source implementations - that feature all the
same features and using its API - named [Airsonic](./airsonic.md) (no longer same features and using its API - named [Airsonic](/wiki/airsonic.md) (no longer
maintained) and its inofficial successor [Airsonic-advanced](./airsonic.md). maintained) and its inofficial successor [Airsonic-advanced](/wiki/airsonic.md).
### Software for Podcasts ### Software for Podcasts
- [Podgrab](./podgrab.md) is a free and open-source podcatcher that can also be - [Podgrab](/wiki/podgrab.md) is a free and open-source podcatcher that can also be
used to listen to them. used to listen to them.
It is self-hostable and can be dockerized. It is self-hostable and can be dockerized.
It has a web-interface and does not feature client software. It has a web-interface and does not feature client software.
#### Obtaining Audio Files from Different Services #### Obtaining Audio Files from Different Services
@@ -169,14 +167,14 @@ You can convert your CDs to files on your computer.
This way you don't have to search for your CDs all the time. 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 - [Exact Audio Copy](https://www.exactaudiocopy.de) for windows can rip music
and automatically tag it with the help of a list of databases. 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 - [fre:ac](https://freac.org/downloads-mainmenu-33) is a free cross-platform
audio converter and CD ripper with support for various popular formats. audio converter and CD ripper with support for various popular formats.
- [metaflac](./linux/flac_(package).md) for linux is a programm - [metaflac](/wiki/linux/flac_%28package%29.md) for [Linux](/wiki/linux.md) is a program to edit
to edit the tags of [flac](./flac_(codec).md) files from the command line. the tags of [flac](/wiki/flac_%28codec%29.md) files from the command line.
It is bundled in the `flac` package for debian and arch based systems. It is bundled in the `flac` package for [Debian](/wiki/linux/debian.md) and arch based systems.
- [MusicBrainz Picard](./picard.md) for linux is a - [MusicBrainz Picard](/wiki/picard.md) for [Linux](/wiki/linux.md) is a graphical user interface
graphical user interface for tagging files of many different formats. for tagging files of many different formats.
### Analysis of Different Versions of an Album ### Analysis of Different Versions of an Album
@@ -186,31 +184,34 @@ It shows dynamic range scorings of each version.
### Get Additional Data to an Album/Single ### Get Additional Data to an Album/Single
If additional information for an album is needed, visit If additional information for an album is needed, visit [Discogs](https://www.discogs.com).
[Discogs](https://www.discogs.com). Discogs has tracklists, dates and more information to nearly all versions of albums and singles.
Discogs has tracklists, dates and more information to nearly all versions of
albums and singles.
### Naming Convention ### Naming Convention
It is suggested to place the audio files in a directory named after the album they It is suggested to place the audio files in a directory named after the album they belong to.
belong to.
These album directories are placed in directories named after the album artist. These album directories are placed in directories named after the album artist.
Files can be named in the following scheme: Files can be named in the following scheme.
- music: `[<discnumber>.]<tracknumber>._<artist>_-_<title>` - music: `[<discnumber>.]<tracknumber>._<artist>_-_<title>`
- audiobooks: `[<discnumber>.]<tracknumber>._<artist>_-_<album>_<tracknumber>` - audiobooks: `[<discnumber>.]<tracknumber>._<artist>_-_<album>_<tracknumber>`
### Scoring Music ### Sheet Music
Scoring music has moved more and more into the computer realm. Music has moved more and more into the computer realm.
An easy and intuitive software that can be used for this is An easy and intuitive software that can be used for this is [MuseScore.org](https://musescore.org/)
[MuseScore.org](https://musescore.org/). which features notating music aswell as a wide catalogue of available sheet music.
MuseScore is free and open-source and is cross-platform. 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` 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`. package or their [website](https://musescore.org/download) and can be run with the command `mscore`.
For Windows visit the [download section of the MuseScore website](https://musescore.org/download). For Windows visit the [download section of the MuseScore website](https://musescore.org/download).
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).
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/).
### Getting Metadata ### Getting Metadata
Using [MediaInfo](https://github.com/MediaArea/MediaInfo) metadata of a file can be obtained. Using [MediaInfo](https://github.com/MediaArea/MediaInfo) metadata of a file can be obtained.

View File

@@ -18,7 +18,7 @@ converted to BetterDiscord.
betterdiscordctl install betterdiscordctl install
``` ```
Afterwards BetterDiscord can be kept up to date with the following command. Afterward BetterDiscord can be kept up to date with the following command.
```sh ```sh
betterdiscordctl self-upgrade betterdiscordctl self-upgrade

View File

@@ -1,21 +1,21 @@
# Bibliogram # Bibliogram
[Bibliogram](https://sr.ht/~cadence/bibliogram/) is an alternative frontend for [Bibliogram](https://sr.ht/~cadence/bibliogram/) is an alternative frontend for Instagram.
Instagram.
Please note that Bibliogram is now officially discontinued according to Please note that Bibliogram is now officially discontinued according to
[the developer](https://cadence.moe/blog/2022-09-01-discontinuing-bibliogram) [the developer](https://cadence.moe/blog/2022-09-01-discontinuing-bibliogram) as it is not possible
as it is not possible anymore to show user pages but only single posts. anymore to show user pages but only single posts.
## Setup ## Setup
The software can be setup via [Docker](/wiki/docker.md) with the The software can be setup via [Docker](/wiki/docker.md) with the
[cloudrac3r image](./docker/cloudrac3r_-_bibliogram.md). [cloudrac3r image](/wiki/docker/cloudrac3r_-_bibliogram.md).
## Automatic redirect from Instagram ## Automatic redirect from Instagram
There are various add-ons to redirect from Instagram links to your (or a public) There are various add-ons to redirect from Instagram links to your (or a public) Bibliogram
Bibliogram instance. instance.
For Firefox for example there is For Firefox for example there is
[privacy redirect](https://addons.mozilla.org/en-US/firefox/addon/privacy-redirect/). [privacy redirect](https://addons.mozilla.org/en-US/firefox/addon/privacy-redirect/).
For [Android](/wiki/android.md) there is For [Android](/wiki/android.md) there is
[the UntrackMe app](https://framagit.org/tom79/nitterizeme) (available at [f-droid](./android/f-droid.md)). [the UntrackMe app](https://framagit.org/tom79/nitterizeme) (available at
[f-droid](/wiki/android/f-droid.md)).

View File

@@ -1,12 +1,11 @@
# Bind # Bind
[Bind](https://www.isc.org/bind/) is an open-source software suite for [Bind](https://www.isc.org/bind/) is an open-source software suite for interacting with the
interacting with the [DNS](./dns.md). [DNS](/wiki/dns.md).
## Setup ## Setup
The software can be setup via docker with the The software can be setup via docker with the [ventz image](/wiki/docker/ventz_-_bind.md).
[ventz image](./docker/ventz_-_bind.md).
## Usage ## Usage
@@ -20,8 +19,7 @@ Look into the file `/etc/bind/named.conf.options`.
Change it to something like the following lines. Change it to something like the following lines.
Note that `192.168.178.0/24` is the subnet that is used mainly in this example. Note that `192.168.178.0/24` is the subnet that is used mainly in this example.
Only queries from within it will be handled. Only queries from within it will be handled.
The forwarders `8.8.8.8` and `8.8.4.4` can be changed according to the specific The forwarders `8.8.8.8` and `8.8.4.4` can be changed according to the specific needs.
needs.
```txt ```txt
acl "trusted" { acl "trusted" {
@@ -53,8 +51,7 @@ options {
### Configure local domains ### Configure local domains
This section explains how to add local domains for local systems. This section explains how to add local domains for local systems.
It is explicitly compatible with the It is explicitly compatible with the [previous section](#setup-a-local-dns-server-with-forwarding).
[previous section](#setup-a-local-dns-server-with-forwarding).
Locate the `named.conf.local` file in the `/etc/bind` directory. Locate the `named.conf.local` file in the `/etc/bind` directory.
Add the forward zone first. Add the forward zone first.
Substitute `<domain>` and `<tld>` to your wishes. Substitute `<domain>` and `<tld>` to your wishes.
@@ -94,14 +91,13 @@ $TTL 1D
``` ```
To make the server you operate on the nameserver select a subdomain for it and To make the server you operate on the nameserver select a subdomain for it and subsitute
subsitute `<servername>` for it and its [IP address](/wiki/ip_address.md) `<ip of server>`. `<servername>` for it and its [IP address](/wiki/ip_address.md) `<ip of server>`.
The following uses a filled in example with multiple subdomains. The following uses a filled in example with multiple subdomains.
It uses CNAME records as a placeholder for the ip. It uses CNAME records as a placeholder for the IP.
In the last section the domain itself `home.server` is mapped to the ip In the last section the domain itself `home.server` is mapped to the IP `192.168.178.16`.
`192.168.178.16`. This cannot be done with CNAME as `home.server` is already mapped as a nameserver and assigning it
This cannot be done with CNAME as `home.server` is already mapped as a multiple times is not supported.
nameserver and assigning it multiple times is not supported.
```txt ```txt
$TTL 1D $TTL 1D
@@ -145,12 +141,11 @@ quentin IN A 192.168.178.18
sheldon IN A 192.168.178.19 sheldon IN A 192.168.178.19
``` ```
More [DNS records](./dns.md#records) can be added. More [DNS records](/wiki/dns.md#records) can be added.
Most importantly used and needed for [reverse proxies](./reverse-proxy.md) are Most importantly used and needed for [reverse proxies](/wiki/reverse-proxy.md) are
[A records](./dns.md#a-record) and [CNAME records](./dns.md#cname-record). [A records](/wiki/dns.md#a-record) and [CNAME records](/wiki/dns.md#cname-record).
Then create `/etc/bind/extra-zones/revp.178.168.192` and fill it with the Then create `/etc/bind/extra-zones/revp.178.168.192` and fill it with the following lines.
following lines.
```txt ```txt
$ORIGIN 178.168.192.in-addr.arpa. $ORIGIN 178.168.192.in-addr.arpa.
@@ -167,17 +162,16 @@ $TTL 1D
<last part of ipv4> IN PTR <thisserver>.<domain>.<tld>. <last part of ipv4> IN PTR <thisserver>.<domain>.<tld>.
``` ```
Additionally add all domain names in front of the first `(` that have been Additionally, add all domain names in front of the first `(` that have been added in the
added in the `zone.<domain>.<tld>` file as an [A record](./dns.md#a-record). `zone.<domain>.<tld>` file as an [A record](/wiki/dns.md#a-record).
Note that all these have to be followed by a `.` just like Note that all these have to be followed by a `.` just like `<thisserver>.<domain>.<tld>.` is.
`<thisserver>.<domain>.<tld>.` is.
For all these records add a PTR record too. For all these records add a PTR record too.
The first part of the PTR line is part of the IP address. The first part of the PTR line is part of the IP address.
To get the full address add it to the subnet. To get the full address add it to the subnet.
In this case this server has the IP `192.168.178.15`. In this case this server has the IP `192.168.178.15`.
An example of `/etc/bind/extra-zones/revp.178.168.192` that is compatible with An example of `/etc/bind/extra-zones/revp.178.168.192` that is compatible with the previous
the previous examples is shown in the following. examples is shown in the following.
```txt ```txt
$ORIGIN 178.168.192.in-addr.arpa. $ORIGIN 178.168.192.in-addr.arpa.
@@ -196,5 +190,5 @@ $TTL 1D
19 IN PTR sheldon.home.server. 19 IN PTR sheldon.home.server.
``` ```
According to your IPs and domains you may need to create multiple `revp.` or According to your IPs and domains you may need to create multiple `revp.` or `zone.` files and need
`zone.` files and need to map them back to `named.conf.local`. to map them back to `named.conf.local`.

View File

@@ -1,8 +1,8 @@
# Bluetooth # Bluetooth
[Bluetooth](https://www.bluetooth.com/) is a short-range technology for wireless [Bluetooth](https://www.bluetooth.com/) is a short-range technology for wireless data transfer.
data transfer. From a [hardware](/wiki/hardware_%28general%29.md) perspective Bluetooth requires a compatible
adapter to work which may be integrated or external.
For [Linux](/wiki/linux.md) based operating systems the Informations on Bluetooth usage on [Linux](/wiki/linux.md)-based operating systems are described in
[bluez package](/wiki/linux/bluez.md) is used as the implementation of the the [Bluetooth section of the Linux hardware entry](/wiki/linux/hardware_%28linux%29.md#bluetooth).
bluetooth standard.

View File

@@ -53,7 +53,7 @@ Then press `Recalculate all author sort values` for the change to take effect.
titles. titles.
Setting `title_series_sorting = 'strictly_alphabetic'` will use the standard Setting `title_series_sorting = 'strictly_alphabetic'` will use the standard
title and wont make articles of titles suffixes. title and wont make articles of titles suffixes.
Afterwards select all books, right-click and select `Edit metadata in bulk` Afterward select all books, right-click and select `Edit metadata in bulk`
under `Edit metadata`. under `Edit metadata`.
Then check the box `update title sort` and press `Ok` to update all sort titles. Then check the box `update title sort` and press `Ok` to update all sort titles.
@@ -80,15 +80,15 @@ After a while calibre should recognize the device which will be apparent by the
additional buttons on the top menu like the `Send to device`- and the `Device`-Button. additional buttons on the top menu like the `Send to device`- and the `Device`-Button.
First make sure only the formats you want will be transfered. First make sure only the formats you want will be transfered.
This can be done by selecting `Device`, `File formats` and checking the formats as needed. This can be done by selecting `Device`, `File formats` and checking the formats as needed.
Afterwards select the books and press `Send to device` to start the process of transfering the Afterward select the books and press `Send to device` to start the process of transfering the
devices. devices.
Alternatively only specific formats of the books can be send to the device by selecting Alternatively only specific formats of the books can be send to the device by selecting
`Send specific format to` and `Main memory` under the `Send to device` menu. `Send specific format to` and `Main memory` under the `Send to device` menu.
If there are books that contain series metadata make sure to disconnect the e-reader once and If there are books that contain series metadata make sure to disconnect the e-reader once and
reconnect it. reconnect it.
Afterwards select `Update cached metadata on device` under `Device` to update the metadata Afterward select `Update cached metadata on device` under `Device` to update the metadata
including the series. including the series.
Finally disconnect the device. Finally, disconnect the device.
## KEPUB Format ## KEPUB Format
@@ -98,10 +98,10 @@ It is recommended to convert `.mobi` and `.epub` files to a `.kepub` file before
[transfering it to a Kobo device](#transfer-books-to-a-device). [transfering it to a Kobo device](#transfer-books-to-a-device).
For this the Plugin `KePub Output` by Joel Goguen [can be added](#adding-a-plugin) can be For this the Plugin `KePub Output` by Joel Goguen [can be added](#adding-a-plugin) can be
installed. installed.
Afterwards books can be converted the normal way, but now the output format `.kepub` is available. Afterward books can be converted the normal way, but now the output format `.kepub` is available.
Additionally the `Kobo Touch Extended` plugin is recommended to use since it makes sending books to Additionally, the `Kobo Touch Extended` plugin is recommended to use since it makes sending books
Kobo e-readers easier. to Kobo e-readers easier.
Finally `KePub Metadata Reader` and `KePub Metadata Reader` make it possible to read and write Finally, `KePub Metadata Reader` and `KePub Metadata Reader` make it possible to read and write
metadata to `.kepub` files which is especially useful. metadata to `.kepub` files which is especially useful.
## Exporting and Importing Settings and Libraries ## Exporting and Importing Settings and Libraries

View File

@@ -1,7 +1,7 @@
# Cue sheet # Cue sheet
A cue sheet is a metadata file containing information for the tracks of a CD or A cue sheet is a metadata file containing information for the tracks of a CD or
a file [ripped](./audio.md#extract-audio-files-from-cds) from it. a file [ripped](/wiki/audio.md#extract-audio-files-from-cds) from it.
## Example file ## Example file

View File

@@ -6,21 +6,38 @@ unix and unix-like systems.
## Setup ## Setup
The software can be setup via [Docker](/wiki/docker.md) with the The software can be setup via [Docker](/wiki/docker.md) with the
[linuxserver image](./docker/linuxserver_-_airsonic.md). [linuxserver image](/wiki/docker/linuxserver_-_airsonic.md).
Additionally to this a client is needed on the system that need access to the Additionally, to this a client is needed on the system that need access to the server software.
server software.
### Client ### Client
To use CUPS an additional client software is needed. To use CUPS an additional client software is needed.
For Linux computers follow these instructions: For Linux computers follow these instructions:
First install the CUPS-client package (in Arch Linux it is included in `cups`).
Then edit `/etc/cups/client.conf` and insert the following line.
- Install the CUPS-client package (in Arch Linux it is included in `cups`) ```txt
- Edit `/etc/cups/client.conf` and insert `ServerName <ip to print-server>:631` ServerName <ip to print-server>:631
- Restart the CUPS service: `systemctl restart cups` ```
- Test connectivity: `lpstat -r`
- Check the detected printers with: `lpstat -v` Restart the CUPS service.
```ssh
systemctl restart cups
```
Then test the connectivity.
```sh
lpstat -r`
```
Finally, check the detected printers with the following command.
```sh
lpstat -v
```
## Usage ## Usage

View File

@@ -5,5 +5,5 @@ Most prominent type of database are SQL databases.
## Database management systems (DBMS) ## Database management systems (DBMS)
- [MySQL](./docker/mysql.md) is a relational DBMS - [MySQL](/wiki/docker/mysql.md) is a relational DBMS
- [MariaDB](./docker/mariadb.md) is a relational DBMS that is a fork of MySQL - [MariaDB](/wiki/docker/mariadb.md) is a relational DBMS that is a fork of MySQL

View File

@@ -2,7 +2,7 @@
[Discord](https://discord.com/) is an social platform that combines voice and video conferences as [Discord](https://discord.com/) is an social platform that combines voice and video conferences as
well as instant messaging chats. well as instant messaging chats.
Additionally to the default website Discord also features a desktop client in the form of an Additionally, to the default website Discord also features a desktop client in the form of an
[Electron-based app](/wiki/electron.md). [Electron-based app](/wiki/electron.md).
## Alternatives ## Alternatives

View File

@@ -9,7 +9,7 @@ It associates various information with domain names.
The following list shows possible DNS software suites that can be used to set The following list shows possible DNS software suites that can be used to set
up a DNS server. up a DNS server.
- [Bind](./bind.md) is a open source package for setting up DNS - [Bind](/wiki/bind.md) is a open source package for setting up DNS
## Records ## Records

View File

@@ -1,7 +1,7 @@
# Docker # Docker
Docker is a virtualization software that deploys docker containers. Docker is a virtualization software that deploys docker containers.
Due to easy handling and reproducable environments it is a useful tool. Due to easy handling and reproducible environments it is a useful tool.
## Setup ## Setup
@@ -23,53 +23,77 @@ This section addresses various features of Docker.
### Virtualize Operating Systems ### Virtualize Operating Systems
Docker is a tool that can be used to virtualize different programs and softwares. Docker is a tool that can be used to virtualize different programs and software.
Especially for containerizing and virtualizing operating systems (mostly based on Especially for containerizing and virtualizing operating systems (mostly based on
[Linux](/wiki/linux.md)) can be handled by [distrobox](https://github.com/89luca89/distrobox). [Linux](/wiki/linux.md)) can be handled by [Distrobox](https://github.com/89luca89/distrobox).
### Run Docker as non-root user ### Run Docker as non-root user
To run docker as a non-root user you need to add your user to the `docker` group. To run docker as a non-root user you need to add your user to the `docker` group.
To do this create the group docker if it doesn't exist `sudo groupadd docker` To do this, create the group docker if it doesn't exist `sudo groupadd docker`
and then add your user to the group using `sudo usermod -aG docker $USER`. and then add your user to the group using `sudo usermod -aG docker $USER`.
After that relog into your machine and you should be able to run After that log back into your machine.
`docker run hello-world`. Then you should be able to run the following.
### Tools and Visualisation ```sh
docker run hello-world
```
### Tools and Visualization
The programs below are useful docker-management systems in different style. The programs below are useful docker-management systems in different style.
- [ctop](https://github.com/bcicen/ctop): top-like cli interface for containers - [ctop](https://github.com/bcicen/ctop): top-like CLI interface for containers
- [portainer](https://www.portainer.io/): web ui for managing docker and kubernetes - [Portainer](https://www.portainer.io/): web UI for managing docker and Kubernetes
### Enable Nvidia GPUs ### Enable Nvidia GPUs
To use Nvidia GPUs with docker you need to install the nvidia-cuda-toolkit. To use Nvidia GPUs with docker you need to install the Nvidia CUDA toolkit.
There is a [guide on marmelab](https://marmelab.com/blog/2018/03/21/using-nvidia-gpu-within-docker-container.html) There is a [guide on Marmelab](https://marmelab.com/blog/2018/03/21/using-nvidia-gpu-within-docker-container.html)
that focusses on that topic. that focuses on that topic.
### Block remote port access ### Block remote port access
If you configured a [reverse proxy](/wiki/reverse-proxy.md) to a port chances If you configured a [reverse proxy](/wiki/reverse-proxy.md) to a port chances
are you don't want the port to be accessed outside of the proxy. are you don't want the port to be accessed outside the proxy.
Especially if you set up a authentication over nginx the open port will avoid Especially if you set up an authentication over nginx the open port will avoid
the authentication. the authentication.
This can be changed at the forwarded docker-service by replacing for example This can be changed at the forwarded docker-service by replacing for example
`-p 7000:7000` with `-p 172.17.0.1:7000:7000`. `-p 7000:7000` with `-p 172.17.0.1:7000:7000`.
This forces the docker container to only expose the port in the docker bridge This forces the docker container to only expose the port in the docker bridge
network, effectively banning remote access. network, effectively banning remote access.
If you use [Traefik](./traefik.md) it is not needed, because you don't have to If you use [Traefik](/wiki/traefik.md) it is not needed, because you don't have to
publish ports to reverse proxy them. publish ports to reverse proxy them.
### Dockerize a graphical application ### Containerize a graphical application
A graphical application can easily be dockerized and made available over both A graphical application can easily be containerized using Docker and made available over both
the [web browser](/wiki/web_browser.md) or [VNC](/wiki/vnc.md). the [web browser](/wiki/web_browser.md) or [VNC](/wiki/vnc.md).
For this For this
[jlesages baseimage-gui container](https://hub.docker.com/r/jlesage/baseimage-gui) [jlesages baseimage-gui container](https://hub.docker.com/r/jlesage/baseimage-gui)
can be used. can be used.
### Find the Container and the Mounting Point of a Volume
Sometimes it is unclear which container a volume belongs to.
This is especially the case if the volume was created automatically and not manually or explicitly
during the setup.
The following command will output the container a volume with the name `<volume-name>` belongs to.
```sh
docker ps -a --filter volume=<volume_name>
```
Additionally, the mounting point is also of interest.
To display it, run the following command where `<container-name>` is the name of the container the
volume belongs to.
```sh
docker inspect <container-name>
```
## 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.
@@ -78,12 +102,12 @@ This section will focus on errors and the fixing of errors of docker.
As explained by As explained by
[gotam19 in a Docker forum post](https://forums.docker.com/t/docker-login-fails-with-error-message-saving-credentials-cannot-autolaunch-d-bus-without-x11-display/77789) [gotam19 in a Docker forum post](https://forums.docker.com/t/docker-login-fails-with-error-message-saving-credentials-cannot-autolaunch-d-bus-without-x11-display/77789)
this error message only occurs on [Linux](/wiki/linux.md) when trying to login or pulling a Docker this error message only occurs on [Linux](/wiki/linux.md) when trying to log in or pulling a Docker
image. image.
To fix it install [GPG](/wiki/linux/gpg.md) and the `pass` To fix it install [GPG](/wiki/linux/gpg.md) and the `pass`
[package](/wiki/linux/package_manager.md). [package](/wiki/linux/package_manager.md).
Afterwards running the following command should will perform the login to the Docker servers and Afterward running the following command perform the login to the Docker servers and the error
the error message should not come up again. message should not come up again.
```sh ```sh
docker login docker login

View File

@@ -15,18 +15,22 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards.
Set the following ports in the `ports:` section. Set the following ports in the `ports:` section.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | --------- | ------------- | | -------------- | ------------------------ | --------- | ------------- |
| `5006` | `5006` | TCP | WebUI | | `5006` | `5006` | TCP | WebUI |
### Volumes ### Volumes
Set the following volumes with the -v tag. Set the following volumes with the -v tag.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | --------------- | ------------------ | | ------------------------- | --------------- | ------------------ |
| `actual` | `/data` | Actual Budget data | | `actual` | `/data` | Actual Budget data |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -16,6 +16,7 @@ It is important to set a correct app key as described in
Set the following variables with the -e tag. Set the following variables with the -e tag.
| Name | Usage | Default | | Name | Usage | Default |
| -------------------- | -------------------------------------------------------------------------------------------------- | --------------- | | -------------------- | -------------------------------------------------------------------------------------------------- | --------------- |
| `APP_KEY` | This is used for encryption and can be generated by `echo -n 'base64:'; openssl rand -base64 32;` | | | `APP_KEY` | This is used for encryption and can be generated by `echo -n 'base64:'; openssl rand -base64 32;` | |
@@ -26,23 +27,28 @@ Set the following variables with the -e tag.
| `DISPLAY_TIMEZONE` | Timezone of the display | `Europe/London` | | `DISPLAY_TIMEZONE` | Timezone of the display | `Europe/London` |
| `SPEEDTEST_SCHEDULE` | Cron-formatted schedule for speedtest (`6 */6 * * *`: 6 minutes after every 6th hour) | | | `SPEEDTEST_SCHEDULE` | Cron-formatted schedule for speedtest (`6 */6 * * *`: 6 minutes after every 6th hour) | |
### Volumes ### Volumes
Set the following volumes with the -v tag. Set the following volumes with the -v tag.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | --------------- | -------------------- | | ------------------------- | --------------- | -------------------- |
| `speedtest_config` | `/config` | storage for config | | `speedtest_config` | `/config` | storage for config |
| `speedtest_keys` | `/config/keys` | storage for ssl keys | | `speedtest_keys` | `/config/keys` | storage for ssl keys |
### Ports ### Ports
Set the following ports with the -p tag. Set the following ports with the -p tag.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ------------------------- | | -------------- | ------------------------ | -------- | ------------------------- |
| `80` | `8765` | TCP | WebUI | | `80` | `8765` | TCP | WebUI |
| `443` | `` | TCP | SSL-encrypted WebUI | | `443` | | TCP | SSL-encrypted WebUI |
### rebuild.sh ### rebuild.sh

View File

@@ -15,18 +15,22 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards.
Set the following volumes in the `volumes:` section of the docker-compose file. Set the following volumes in the `volumes:` section of the docker-compose file.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | --------------- | ------------------------------------ | | ------------------------- | --------------- | ------------------------------------ |
| `downloads` | `/downloads` | folder to download data to | | `downloads` | `/downloads` | folder to download data to |
### Ports ### Ports
Set the following ports in the `ports:` section. Set the following ports in the `ports:` section.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ----------- | | -------------- | ------------------------ | -------- | ----------- |
| `8881` | `8081` | TCP | WebUI | | `8881` | `8081` | TCP | WebUI |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -22,26 +22,32 @@ Especially set the `<version>` (for example `24.11`) aswell as the `<user>` and
Set the following variables with the -e tag. Set the following variables with the -e tag.
| Name | Usage | Default | | Name | Usage | Default |
| -------------- | -------------------------------------------------------- | ------- | | -------------- | -------------------------------------------------------- | ------- |
| `SYNC_USER1` | contains the `<user>` and `<password>` of the first user | | | `SYNC_USER1` | contains the `<user>` and `<password>` of the first user | |
## Ports ## Ports
Set the following ports in the `ports:` section. Set the following ports in the `ports:` section.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | --------- | ------------- | | -------------- | ------------------------ | --------- | ------------- |
| `27701` | `8080` | TCP | Default port | | `27701` | `8080` | TCP | Default port |
## Volumes ## Volumes
Set the following volumes with the -v tag. Set the following volumes with the -v tag.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | --------------- | ------------- | | ------------------------- | --------------- | ------------- |
| `akni-sync-server-data` | `/anki-data` | Data storage | | `akni-sync-server-data` | `/anki-data` | Data storage |
## rebuild.sh ## rebuild.sh
```sh ```sh

View File

@@ -1,7 +1,7 @@
# awesometechnologies - synapse-admin # awesometechnologies - synapse-admin
This is a [Docker](/wiki/docker.md) container for a Synapse administration server of This is a [Docker](/wiki/docker.md) container for a Synapse administration server of
[Matrix](../matrix.md). [Matrix](/wiki/matrix.md).
The official container and documentation was made by 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.
@@ -15,10 +15,12 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards.
Set the following ports in the `ports:` section. Set the following ports in the `ports:` section.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ----------- | | -------------- | ------------------------ | -------- | ----------- |
| `80` | `80` | TCP | WebUI | | `80` | `80` | TCP | WebUI |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -1,6 +1,6 @@
# axhilrex - podgrab # axhilrex - podgrab
This is a [Docker](/wiki/docker.md) container for a [Podgrab](../podgrab.md) This is a [Docker](/wiki/docker.md) container for a [Podgrab](/wiki/podgrab.md)
server. 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).
@@ -14,27 +14,33 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards.
Set the following variables with the -e tag. Set the following variables with the -e tag.
| Name | Usage | Default | | Name | Usage | Default |
| ---------- | ----------------------------- | ------- | | ---------- | ----------------------------- | ------- |
| `PASSWORD` | Password for `podgrab` user | | | `PASSWORD` | Password for `podgrab` user | |
### Volumes ### Volumes
Set the following volumes with the -v tag. Set the following volumes with the -v tag.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | --------------- | ----------------------- | | ------------------------- | --------------- | ----------------------- |
| `podgrab_config` | `/config` | Configuration files | | `podgrab_config` | `/config` | Configuration files |
| `media_podcasts` | `/assets` | location for podcasts | | `media_podcasts` | `/assets` | location for podcasts |
### Ports ### Ports
Set the following ports with the -p tag. Set the following ports with the -p tag.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ----------- | | -------------- | ------------------------ | -------- | ----------- |
| `8080` | `8080` | TCP | WebUI | | `8080` | `8080` | TCP | WebUI |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -15,18 +15,22 @@ After that rerun `./rebuild.sh` to make update your config.
Set the following volumes with the -v tag. Set the following volumes with the -v tag.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | --------------- | ---------------------- | | ------------------------- | --------------- | ---------------------- |
| `homer` | `/www/assets` | storage for icons, etc | | `homer` | `/www/assets` | storage for icons, etc |
### Ports ### Ports
Set the following ports with the -p tag. Set the following ports with the -p tag.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ----------- | | -------------- | ------------------------ | -------- | ----------- |
| `8080` | `8080` | TCP | WebUI | | `8080` | `8080` | TCP | WebUI |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -17,24 +17,28 @@ docker-compose file.
The following table lists the environment variables for the image `bbilly1/tubearchivist`. The following table lists the environment variables for the image `bbilly1/tubearchivist`.
| Name | Usage | Default | | Name | Usage | Default |
| -------------------| ------------------------------------------- | ------- | | -------------------| ------------------------------------------- | ------- |
| `ES_URL` | Network address for elastic search instance | `` | | `ES_URL` | Network address for elastic search instance | |
| `REDIS_HOST` | Redis broker URL | `` | | `REDIS_HOST` | Redis broker URL | |
| `HOST_UID` | User ID of Host | `` | | `HOST_UID` | User ID of Host | |
| `HOST_GID` | Group ID of Host | `` | | `HOST_GID` | Group ID of Host | |
| `TA_HOST` | Domain name for TubeArchivist | `` | | `TA_HOST` | Domain name for TubeArchivist | |
| `TA_USERNAME` | User name for TubeArchivist | `` | | `TA_USERNAME` | User name for TubeArchivist | |
| `TA_PASSWORD` | Password for TubeArchivist | `` | | `TA_PASSWORD` | Password for TubeArchivist | |
| `ELASTIC_PASSWORD` | Password for Elasticsearch | `` | | `ELASTIC_PASSWORD` | Password for Elasticsearch | |
| `TZ` | Timezone | `` | | `TZ` | Timezone | |
The following table lists the environment variables for the image `bbilly1/tubearchivist-es`. The following table lists the environment variables for the image `bbilly1/tubearchivist-es`.
| Name | Usage | Default | | Name | Usage | Default |
| -------------------| ------------------------------------------- | ------- | | -------------------| ------------------------------------------- | ------- |
| `ELASTIC_PASSWORD` | Password for Elasticsearch | `` | | `ELASTIC_PASSWORD` | Password for Elasticsearch | |
| `ES_JAVA_OPTS` | Additional Java options | `` | | `ES_JAVA_OPTS` | Additional Java options | |
### Volumes ### Volumes
@@ -42,25 +46,31 @@ Set the following volumes in the `volumes:` section of the docker-compose file.
The following table lists the environment variables for the image `bbilly1/tubearchivist`. The following table lists the environment variables for the image `bbilly1/tubearchivist`.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | ------------------------ | --------------------------- | | ------------------------- | ------------------------ | --------------------------- |
| `media` | `/youtube` | storage for media | | `media` | `/youtube` | storage for media |
| `cache` | `/cache` | storage for cache | | `cache` | `/cache` | storage for cache |
The following table lists the environment variables for the image `bbilly1/tubearchivist-es`. The following table lists the environment variables for the image `bbilly1/tubearchivist-es`.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | ------------------------------- | --------------------------- | | ------------------------- | ------------------------------- | --------------------------- |
| `es` | `/usr/share/elasticsearch/data` | storage for elasticsearch | | `es` | `/usr/share/elasticsearch/data` | storage for elasticsearch |
### Ports ### Ports
Set the following ports in the `ports:` section. Set the following ports in the `ports:` section.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ----------- | | -------------- | ------------------------ | -------- | ----------- |
| `8000` | `8881` | TCP | WebUI | | `8000` | `8881` | TCP | WebUI |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -1,6 +1,6 @@
# benbusby - whoogle-search # benbusby - whoogle-search
This is a [Docker](/wiki/docker.md) container for a [whoogle](../whoogle.md) This is a [Docker](/wiki/docker.md) container for a [whoogle](/wiki/whoogle.md)
meta-search machine. 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).
@@ -18,18 +18,22 @@ Set the variables, volumes and ports according and run the `rebuild.sh`.
Set the following volumes with the -v tag. Set the following volumes with the -v tag.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | ---------------- | ---------------- | | ------------------------- | ---------------- | ---------------- |
| `searx_config` | `/config` | configurations | | `searx_config` | `/config` | configurations |
### Ports ### Ports
Set the following ports with the -p tag. Set the following ports with the -p tag.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ----------- | | -------------- | ------------------------ | -------- | ----------- |
| `5000` | `8000` | TCP | WebUI | | `5000` | `8000` | TCP | WebUI |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -1,11 +1,11 @@
# bilde2910 - Hauk # bilde2910 - Hauk
This is a docker container for a [Hauk](../hauk.md). This is a docker container for a [Hauk](/wiki/hauk.md).
## Set-up ## Set-up
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
[config-sample](https://github.com/bilde2910/Hauk/blob/master/backend-php/include/config-sample.php) [config-sample](https://github.com/bilde2910/Hauk/blob/master/backend-php/include/config-sample.php)
at the location specified in your `docker-compose.yml` (in this example it's at the location specified in your `docker-compose.yml` (in this example it's
`./config/hauk`). `./config/hauk`).
@@ -21,24 +21,28 @@ htpasswd -cBC 10 /etc/hauk/users.htpasswd <first user name>
htpasswd -BC 10 /etc/hauk/users.htpasswd <other user name> htpasswd -BC 10 /etc/hauk/users.htpasswd <other user name>
``` ```
Finally run `./rebuild.sh`. Finally, run `./rebuild.sh`.
### Volumes ### Volumes
Set the following volumes in the `volumes:` section of the docker-compose file. Set the following volumes in the `volumes:` section of the docker-compose file.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | ------------------ | ------------------------------ | | ------------------------- | ------------------ | ------------------------------ |
| `./config/hauk` | `/etc/hauk` | config and password location | | `./config/hauk` | `/etc/hauk` | config and password location |
### Ports ### Ports
Set the following ports in the `ports:` section. Set the following ports in the `ports:` section.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ---------------------- | | -------------- | ------------------------ | -------- | ---------------------- |
| `80` | `80` | TCP | Basic service | | `80` | `80` | TCP | Basic service |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -1,12 +1,11 @@
# chocobozz - peertube # chocobozz - peertube
This is a [Docker](/wiki/docker.md) container for a [PeerTube](../peertube.md) This is a [Docker](/wiki/docker.md) container for a [PeerTube](/wiki/peertube.md) server.
server.
The official container and documentation was made by The official container and documentation was made by
[chocobozz](https://github.com/chocobozzz/peertube). [chocobozz](https://github.com/chocobozzz/peertube).
This docker-rebuild is made up by a `docker-compose.yml` file. 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 container](/wiki/docker/redis.md) to
[redis container](./redis.md) to it. it.
## Set-up ## Set-up
@@ -18,20 +17,24 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards.
Set the following ports in the `ports:` section. Set the following ports in the `ports:` section.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ----------- | | -------------- | ------------------------ | -------- | ----------- |
| `9000` | `9000` | TCP | WebUI | | `9000` | `9000` | TCP | WebUI |
### Volumes ### Volumes
Set the following volumes with the -v tag. Set the following volumes with the -v tag.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | -------------------------- | ---------------------- | | ------------------------- | -------------------------- | ---------------------- |
| `assets` | `/app/client/dist` | storage for icons, etc | | `assets` | `/app/client/dist` | storage for icons, etc |
| `config` | `/config` | configuration data | | `config` | `/config` | configuration data |
| `data` | `/data` | further data storage | | `data` | `/data` | further data storage |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -1,7 +1,7 @@
# cloudrac3r - bibliogram # cloudrac3r - bibliogram
This is a [Docker](/wiki/docker.md) container for the alternative Instagram This is a [Docker](/wiki/docker.md) container for the alternative Instagram
frontend [Bibliogram](../bibliogram.md). frontend [Bibliogram](/wiki/bibliogram.md).
The official container and documentation was made by 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.
@@ -18,18 +18,22 @@ Set the variables, volumes and ports according and run the `rebuild.sh`.
Set the following volumes with the -v tag. Set the following volumes with the -v tag.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | --------------- | ----------------------------------- | | ------------------------- | --------------- | ----------------------------------- |
| `db` | `/app/db` | storage for the bibliogram database | | `db` | `/app/db` | storage for the bibliogram database |
### Ports ### Ports
Set the following ports in the `ports:` section. Set the following ports in the `ports:` section.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ----------- | | -------------- | ------------------------ | -------- | ----------- |
| `10407` | `10407` | TCP | WebUI | | `10407` | `10407` | TCP | WebUI |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -1,7 +1,7 @@
# coturn - coturn # coturn - coturn
This is a [Docker](/wiki/docker.md) container for a TURN/STUN server. This is a [Docker](/wiki/docker.md) container for a TURN/STUN server.
A server like this can be used in a [Matrix](../matrix.md) server configuration. A server like this can be used in a [Matrix](/wiki/matrix.md) server configuration.
The official container and documentation was made by 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.
@@ -24,12 +24,14 @@ For the public IP the command `curl api.ipify.org` can be used.
Set the following ports in the `ports:` section. Set the following ports in the `ports:` section.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ----------- | | -------------- | ------------------------ | -------- | ----------- |
| `3478` | `3478` | TCP/UDP | TURN/STUN | | `3478` | `3478` | TCP/UDP | TURN/STUN |
| `5349` | `5349` | TCP/UDP | TURN/STUN | | `5349` | `5349` | TCP/UDP | TURN/STUN |
| `49152-65535` | `49152-65535` | UDP | TURN/STUN | | `49152-65535` | `49152-65535` | UDP | TURN/STUN |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -1,6 +1,6 @@
# dperson - torproxy # dperson - torproxy
This is a [Docker](/wiki/docker.md) container for a [Tor](../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 ## Set-up
@@ -12,20 +12,24 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards.
Set the following volumes with the -v tag. Set the following volumes with the -v tag.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | --------------- | -------------------------- | | ------------------------- | --------------- | -------------------------- |
| `tor_var` | `/var/lib/tor` | Location for various files | | `tor_var` | `/var/lib/tor` | Location for various files |
| `tor_etc` | `/etc/tor` | Various other config | | `tor_etc` | `/etc/tor` | Various other config |
### Ports ### Ports
Set the following ports with the -p tag. Set the following ports with the -p tag.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | -------------------- | | -------------- | ------------------------ | -------- | -------------------- |
| `8118` | `8118` | HTTP | privoxy web proxy | | `8118` | `8118` | HTTP | privoxy web proxy |
| `9050` | `9050` | SOCKS | socks protocol proxy | | `9050` | `9050` | SOCKS | socks protocol proxy |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -9,7 +9,7 @@ The official container and documentation was made by
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.
Additionally change the `LAN_NETWORK` if it differs for your local area network. Additionally, change the `LAN_NETWORK` if it differs for your local area network.
Run `./rebuild.sh` afterwards to create the volumes. Run `./rebuild.sh` afterwards to create the volumes.
Place the openvpn certificate in the `jacket_config` docker volume inside the Place the openvpn certificate in the `jacket_config` docker volume inside the
`openvpn` folder. `openvpn` folder.
@@ -19,19 +19,23 @@ After that rerun `./rebuild.sh` to make update your config.
Set the following volumes with the -v tag. Set the following volumes with the -v tag.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | --------------- | ---------------------- | | ------------------------- | --------------- | ---------------------- |
| `jackett_config` | `/config` | storage for configs | | `jackett_config` | `/config` | storage for configs |
| `jackett_blackhole` | `/blackhole` | storage for magnets | | `jackett_blackhole` | `/blackhole` | storage for magnets |
### Ports ### Ports
Set the following ports with the -p tag. Set the following ports with the -p tag.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ----------- | | -------------- | ------------------------ | -------- | ----------- |
| `9117` | `9117` | TCP | WebUI | | `9117` | `9117` | TCP | WebUI |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -1,7 +1,7 @@
# dyonr - qbittorrentvpn # dyonr - qbittorrentvpn
This is a [Docker](/wiki/docker.md) container for a This is a [Docker](/wiki/docker.md) container for a
[qBittorrent](../qbittorrent.md) server that is connected to the internet via [qBittorrent](/wiki/qbittorrent.md) server that is connected to the internet via
an [openVPN tunnel](/wiki/openvpn.md). 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).
@@ -18,40 +18,48 @@ Both can be changed in the web interface after setup.
Set the following variables with the -e tag. Set the following variables with the -e tag.
| Name | Usage | Default | | Name | Usage | Default |
| ------------------- | --------------------------- | ------- | | ------------------- | --------------------------- | ------- |
| `VPN_ENABLE` | Enable VPN | ` ` | | `VPN_ENABLE` | Enable VPN | |
| `VPN_USERNAME` | Username for OpenVPN | ` ` | | `VPN_USERNAME` | Username for OpenVPN | |
| `VPN_PASSWORD` | Password for OpenVPN | ` ` | | `VPN_PASSWORD` | Password for OpenVPN | |
| `LAN_NETWORK` | Subnet of the local network | ` ` | | `LAN_NETWORK` | Subnet of the local network | |
### Volumes ### Volumes
Set the following volumes with the -v tag. Set the following volumes with the -v tag.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | ------------------- | ----------------------- | | ------------------------- | ------------------- | ----------------------- |
| `qbittorrentvpn_config` | `/config` | Configuration files | | `qbittorrentvpn_config` | `/config` | Configuration files |
| `qbittorrentvpn_data` | `/downloads` | Storage for data | | `qbittorrentvpn_data` | `/downloads` | Storage for data |
### Ports ### Ports
Set the following ports with the -p tag. Set the following ports with the -p tag.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ----------- | | -------------- | ------------------------ | -------- | ----------- |
| `9091` | `8080` | TCP | WebUI | | `9091` | `8080` | TCP | WebUI |
### Additional ### Additional
There are some special variables to set. There are some special variables to set.
| Flag | Usage | | Flag | Usage |
| ----------- | ---------------------- | | ----------- | ---------------------- |
| `--cap-add` | add linux capabilities | | `--cap-add` | add linux capabilities |
| `--device` | connect devices | | `--device` | connect devices |
| `--sysctl` | configure systemctl | | `--sysctl` | configure systemctl |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -1,10 +1,9 @@
# gitea - gitea # gitea - gitea
This is a [Docker](/wiki/docker.md) container for a [Gitea](../gitea.md). This is a [Docker](/wiki/docker.md) container for a [Gitea](/wiki/gitea.md).
The Server consists of 2 Docker containers, one is the gitea main server and one The Server consists of 2 Docker containers, one is the gitea main server and one is a database.
is a database. 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](./mysql.md) it.
to it.
## Set-up ## Set-up
@@ -16,6 +15,7 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards.
Set the following environment-variables in the `environment:` section of the Set the following environment-variables in the `environment:` section of the
docker-compose file. docker-compose file.
| Name | Usage | Default | | Name | Usage | Default |
| ----------- | ------------------------------ | ------- | | ----------- | ------------------------------ | ------- |
| `USER_UID` | User userid to run gitea | | | `USER_UID` | User userid to run gitea | |
@@ -26,42 +26,51 @@ docker-compose file.
| `DB_USER` | Username for the database | | | `DB_USER` | Username for the database | |
| `DB_PASSWD` | Password for the database | | | `DB_PASSWD` | Password for the database | |
### Volumes ### Volumes
Set the following volumes in the `volumes:` section of the docker-compose file. Set the following volumes in the `volumes:` section of the docker-compose file.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | ------------------ | ------------------------------ | | ------------------------- | ------------------ | ------------------------------ |
| `data` | `/data` | storage for data of git server | | `data` | `/data` | storage for data of git server |
| `/etc/timezone` | `/etc/timezone:ro` | link timezone | | `/etc/timezone` | `/etc/timezone:ro` | link timezone |
| `/etc/localtime` | `/etc/localtime` | link localtime | | `/etc/localtime` | `/etc/localtime` | link localtime |
### Ports ### Ports
Set the following ports in the `ports:` section. Set the following ports in the `ports:` section.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ---------------------- | | -------------- | ------------------------ | -------- | ---------------------- |
| `3000` | `3000` | TCP | WebUI | | `3000` | `3000` | TCP | WebUI |
| `22` | `222` | TCP | ssh port of git server | | `22` | `222` | TCP | ssh port of git server |
### Networks ### Networks
Set the following networks in the `networks:` section of the docker-compose file. Set the following networks in the `networks:` section of the docker-compose file.
| Name | Usage | | Name | Usage |
| ------- | --------------------- | | ------- | --------------------- |
| `gitea` | connect db with gitea | | `gitea` | connect db with gitea |
### Dependencies ### Dependencies
Set the following dependencies in the `depends_on:` section of the Set the following dependencies in the `depends_on:` section of the
docker-compose file. docker-compose file.
| Name | Usage | | Name | Usage |
| ---- | -------------------- | | ---- | -------------------- |
| `db` | Ensure db is running | | `db` | Ensure db is running |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -1,6 +1,6 @@
# gramps-project - gramps # gramps-project - gramps
This is a [Docker](/wiki/docker.md) container for a [Gramps](../gramps.md) This is a [Docker](/wiki/docker.md) container for a [Gramps](/wiki/gramps.md)
server. 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).
@@ -15,17 +15,20 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards.
Set the following environment-variables in the `environment:` section of the Set the following environment-variables in the `environment:` section of the
docker-compose file. docker-compose file.
| Name | Usage | Default | | Name | Usage | Default |
| ----------------------------------------- | ------------------------------------ | ------- | | ----------------------------------------- | ------------------------------------ | ------- |
| `GRAMPSWEB_TREE` | Will create a new tree if not exists | `` | | `GRAMPSWEB_TREE` | Will create a new tree if not exists | |
| `GRAMPSWEB_CELERY_CONFIG__broker_url` | Redis broker URL | `` | | `GRAMPSWEB_CELERY_CONFIG__broker_url` | Redis broker URL | |
| `GRAMPSWEB_CELERY_CONFIG__result_backend` | Redis backend URL | `` | | `GRAMPSWEB_CELERY_CONFIG__result_backend` | Redis backend URL | |
| `GRAMPSWEB_RATELIMIT_STORAGE_URI` | Storage URI | `` | | `GRAMPSWEB_RATELIMIT_STORAGE_URI` | Storage URI | |
### Volumes ### Volumes
Set the following volumes in the `volumes:` section of the docker-compose file. Set the following volumes in the `volumes:` section of the docker-compose file.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | ------------------------ | --------------------------- | | ------------------------- | ------------------------ | --------------------------- |
| `gramps_users` | `/app/users` | storage for users | | `gramps_users` | `/app/users` | storage for users |
@@ -37,14 +40,17 @@ Set the following volumes in the `volumes:` section of the docker-compose file.
| `gramps_media` | `/app/media` | storage for media | | `gramps_media` | `/app/media` | storage for media |
| `gramps_tmp` | `/tmp` | storage for temporary files | | `gramps_tmp` | `/tmp` | storage for temporary files |
### Ports ### Ports
Set the following ports in the `ports:` section. Set the following ports in the `ports:` section.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ----------- | | -------------- | ------------------------ | -------- | ----------- |
| `5000` | `80` | TCP | WebUI | | `5000` | `80` | TCP | WebUI |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -9,13 +9,14 @@ Change the settings according to your needs.
Create the volume for the configuration files by running the command `docker volume create Create the volume for the configuration files by running the command `docker volume create
gameyfin_config`. gameyfin_config`.
Make sure to run the following command on the config volume `chown -R 1000:root gameyfin_config`. Make sure to run the following command on the config volume `chown -R 1000:root gameyfin_config`.
Afterwards run `./rebuild.sh`. Afterward run `./rebuild.sh`.
### Environment-variables ### Environment-variables
Set the following environment-variables in the `environment:` section of the Set the following environment-variables in the `environment:` section of the
docker-compose file. docker-compose file.
| Name | Usage | Default | | Name | Usage | Default |
| --------------------------------- | --------------------------------------- | ------- | | --------------------------------- | --------------------------------------- | ------- |
| `GAMEYFIN_USER` | user name for gameyfin | | | `GAMEYFIN_USER` | user name for gameyfin | |
@@ -23,18 +24,22 @@ docker-compose file.
| `GAMEYFIN_IGDB_API_CLIENT_ID` | id of twitch internet game database | | | `GAMEYFIN_IGDB_API_CLIENT_ID` | id of twitch internet game database | |
| `GAMEYFIN_IGDB_API_CLIENT_SECRET` | secret of twitch internet game database | | | `GAMEYFIN_IGDB_API_CLIENT_SECRET` | secret of twitch internet game database | |
### Volumes ### Volumes
Set the following volumes in the `volumes:` section of the docker-compose file. Set the following volumes in the `volumes:` section of the docker-compose file.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | ----------------------- | ------------------------------ | | ------------------------- | ----------------------- | ------------------------------ |
| `media_games` | `/opt/gameyfin-library` | storage for games and configs | | `media_games` | `/opt/gameyfin-library` | storage for games and configs |
### Ports ### Ports
Set the following ports in the `ports:` section. Set the following ports in the `ports:` section.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ---------------------- | | -------------- | ------------------------ | -------- | ---------------------- |
| `8080` | `8093` | TCP | WebUI | | `8080` | `8093` | TCP | WebUI |

View File

@@ -1,7 +1,7 @@
# haugene - transmission-openvpn # haugene - transmission-openvpn
This is a [Docker](/wiki/docker.md) container for a This is a [Docker](/wiki/docker.md) container for a
[transmission](../transmission.md) server that is connected to the internet via [transmission](/wiki/transmission.md) server that is connected to the internet via
an [openVPN tunnel](/wiki/openvpn.md). 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).
@@ -17,33 +17,39 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards.
Set the following variables with the -e tag. Set the following variables with the -e tag.
| Name | Usage | Default | | Name | Usage | Default |
| ------------------- | --------------------------- | ------- | | ------------------- | --------------------------- | ------- |
| `OPENVPN_PROVIDER` | Provider for OpenVPN | ` ` | | `OPENVPN_PROVIDER` | Provider for OpenVPN | |
| `OPENVPN_USERNAME` | Username for OpenVPN | ` ` | | `OPENVPN_USERNAME` | Username for OpenVPN | |
| `OPENVPN_PASSWORD` | Password for OpenVPN | ` ` | | `OPENVPN_PASSWORD` | Password for OpenVPN | |
| `LOCAL_NETWORK` | Subnet of the local network | ` ` | | `LOCAL_NETWORK` | Subnet of the local network | |
| `CREATE_TUN_DEVICE` | Use a tunnel device | ` ` | | `CREATE_TUN_DEVICE` | Use a tunnel device | |
| `WEBPROXY_ENABLES` | Use a webproxy | ` ` | | `WEBPROXY_ENABLES` | Use a webproxy | |
### Volumes ### Volumes
Set the following volumes with the -v tag. Set the following volumes with the -v tag.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | --------------- | ----------------------- | | ------------------------- | --------------- | ----------------------- |
| `transmission_config` | `/config` | Configuration files | | `transmission_config` | `/config` | Configuration files |
| `transmission data` | `/data` | Storage for data | | `transmission data` | `/data` | Storage for data |
| `/etc/localtime` | `/etc/localtime:ro` | Link to the systemtime | | `/etc/localtime` | `/etc/localtime:ro` | Link to the systemtime |
### Ports ### Ports
Set the following ports with the -p tag. Set the following ports with the -p tag.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ----------- | | -------------- | ------------------------ | -------- | ----------- |
| `9091` | `9091` | TCP | WebUI | | `9091` | `9091` | TCP | WebUI |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -14,27 +14,33 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards.
Set the following variables with the -e tag. Set the following variables with the -e tag.
| Name | Usage | Default | | Name | Usage | Default |
| ----------------- | ----------------------------- | ------- | | ----------------- | ----------------------------- | ------- |
| `OOKLA_EULA_GDPR` | set to `true` to accept EULA | | | `OOKLA_EULA_GDPR` | set to `true` to accept EULA | |
| `AUTH` | set to `true` to enable login | | | `AUTH` | set to `true` to enable login | |
### Volumes ### Volumes
Set the following volumes with the -v tag. Set the following volumes with the -v tag.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | --------------- | ------------------ | | ------------------------- | --------------- | ------------------ |
| `speedtest` | `/config` | storage for config | | `speedtest` | `/config` | storage for config |
### Ports ### Ports
Set the following ports with the -p tag. Set the following ports with the -p tag.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ----------- | | -------------- | ------------------------ | -------- | ----------- |
| `80` | `8765` | TCP | WebUI | | `80` | `8765` | TCP | WebUI |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -14,18 +14,22 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards.
Set the following volumes with the -v tag. Set the following volumes with the -v tag.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | --------------- | ------------------------------- | | ------------------------- | --------------- | ------------------------------- |
| `homeassistant_data` | `/config` | configuration for devices, etc | | `homeassistant_data` | `/config` | configuration for devices, etc |
### Environment-variables ### Environment-variables
Set the following environment-variables in the `environment:` section of the Set the following environment-variables in the `environment:` section of the
docker-compose file. docker-compose file.
| Name | Usage | Default | | Name | Usage | Default |
| --------------------- | --------------------------- | ----------------------- | | --------------------- | --------------------------- | ----------------------- |
| `TZ` | specify the timezone | `` | | `TZ` | specify the timezone | |
### Additional ### Additional

View File

@@ -24,19 +24,23 @@ The environment variables are set via the `.env` file and listed in the
Set the following ports in the `ports:` section. Set the following ports in the `ports:` section.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | --------- | ------------- | | -------------- | ------------------------ | --------- | ------------- |
| `2283` | `3001` | TCP | WebUI | | `2283` | `3001` | TCP | WebUI |
### Volumes ### Volumes
Set the following volumes with the -v tag. Set the following volumes with the -v tag.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | --------------------- | ------------- | | ------------------------- | --------------------- | ------------- |
| `immich_library` | `/usr/src/app/upload` | Library | | `immich_library` | `/usr/src/app/upload` | Library |
| `/etc/timezone` | `/etc/timezone:ro` | Timezone | | `/etc/timezone` | `/etc/timezone:ro` | Timezone |
### rebuild.sh ### rebuild.sh
```sh #!/bin/sh ```sh #!/bin/sh

View File

@@ -8,12 +8,13 @@ The container and documentation was made by
## Set-up ## Set-up
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` afterward.
### Environment-variables ### Environment-variables
Set the following variables with the -e tag. Set the following variables with the -e tag.
| Name | Usage | Default | | Name | Usage | Default |
| ------------- | -------------------------------------------------------------- | -------------------------------------------- | | ------------- | -------------------------------------------------------------- | -------------------------------------------- |
| `EULA` | Accept the EULA | | | `EULA` | Accept the EULA | |
@@ -24,22 +25,27 @@ Set the following variables with the -e tag.
| `ICON` | Link the Icon of the Server | | | `ICON` | Link the Icon of the Server | |
| `MOTD` | Set the Message of the day | "A Paper Minecraft Server powered by Docker" | | `MOTD` | Set the Message of the day | "A Paper Minecraft Server powered by Docker" |
### Volumes ### Volumes
Set the following volumes with the -v tag. Set the following volumes with the -v tag.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | --------------- | ------------------------------ | | ------------------------- | --------------- | ------------------------------ |
| `minecraft` | `/data` | location for all relevant data | | `minecraft` | `/data` | location for all relevant data |
### Ports ### Ports
Set the following ports with the -p tag. Set the following ports with the -p tag.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | --------- | ------------------ | | -------------- | ------------------------ | --------- | ------------------ |
| `25565` | `25565` | Minecraft | Port for Minecraft | | `25565` | `25565` | Minecraft | Port for Minecraft |
### rebuild.sh ### rebuild.sh
```sh ```sh
@@ -74,7 +80,7 @@ For this set the server type by using the `-e TYPE=<type>` flag.
Most notably this value could be `FABRIC` or `FORGE`. Most notably this value could be `FABRIC` or `FORGE`.
After this the mods (as `.jar` files) can be placed in the `mods` directory of the After this the mods (as `.jar` files) can be placed in the `mods` directory of the
[Docker](/wiki/docker.md) volume. [Docker](/wiki/docker.md) volume.
Afterwards run the [`rebuild.sh`](#rebuildsh) to restart the server with loaded mods. Afterward run the [`rebuild.sh`](#rebuildsh) to restart the server with loaded mods.
#### Installing Datapacks #### Installing Datapacks

View File

@@ -1,19 +1,18 @@
# iv-org - invidious # iv-org - invidious
This is a [Docker](/wiki/docker.md) container for [Invidious](../invidious.md). This is a [Docker](/wiki/docker.md) container for [Invidious](/wiki/invidious.md).
The official container and documentation was made by The official container and documentation was made by
[invidious](https://github.com/iv-org/invidious). [invidious](https://github.com/iv-org/invidious).
This docker-rebuild is made up by a `docker-compose.yml` file. This docker-rebuild is made up by a `docker-compose.yml` file.
There is no official pre-build on docker-hub. 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](./postgres.md) to it. [postgres container](/wiki/docker/postgres.md) to it.
## Set-up ## Set-up
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 After that clone invidious from [GitHub](https://github.com/iv-org/invidious) into a folder within
[GitHub](https://github.com/iv-org/invidious) into a folder within the the just created folder.
just created folder.
You can find the `docker-compose.yml` in the cloned directory. You can find the `docker-compose.yml` in the cloned directory.
Set the variables, volumes and ports according and run the `rebuild.sh`. Set the variables, volumes and ports according and run the `rebuild.sh`.
@@ -22,6 +21,7 @@ Set the variables, volumes and ports according and run the `rebuild.sh`.
Set the following environment-variables in the `environment:` section of the Set the following environment-variables in the `environment:` section of the
docker-compose file. docker-compose file.
| Name | Usage | Default | | Name | Usage | Default |
| ---------------------- | ---------------------------------------------------------- | ------- | | ---------------------- | ---------------------------------------------------------- | ------- |
| `channel_threads` | numer of threads to use for refreshing channels | `1` | | `channel_threads` | numer of threads to use for refreshing channels | `1` |
@@ -39,14 +39,17 @@ docker-compose file.
| `popular_enabled` | enable the popular section | `true` | | `popular_enabled` | enable the popular section | `true` |
| `registration_enabled` | enable registration for new users | `true` | | `registration_enabled` | enable registration for new users | `true` |
### Ports ### Ports
Set the following ports in the `ports:` section. Set the following ports in the `ports:` section.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ----------- | | -------------- | ------------------------ | -------- | ----------- |
| `3000` | `3000` | TCP | WebUI | | `3000` | `3000` | TCP | WebUI |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -13,19 +13,23 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards.
Set the following volumes with the -v tag. Set the following volumes with the -v tag.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | ------------------- | ------------------------- | | ------------------------- | ------------------- | ------------------------- |
| `git-server_repos` | `/git-server/repos` | storage for git repos | | `git-server_repos` | `/git-server/repos` | storage for git repos |
| `git-server_keys` | `/git-server/keys` | storage for user ssh keys | | `git-server_keys` | `/git-server/keys` | storage for user ssh keys |
### Ports ### Ports
Set the following ports with the -p tag. Set the following ports with the -p tag.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ------------------------------------- | | -------------- | ------------------------ | -------- | ------------------------------------- |
| `22` | `2222` | TCP | ssh port for accessing the git server | | `22` | `2222` | TCP | ssh port for accessing the git server |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -14,20 +14,24 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards.
Set the following ports with the -p tag. Set the following ports with the -p tag.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ----------- | | -------------- | ------------------------ | -------- | ----------- |
| `7396` | `7396` | TCP | WebUI | | `7396` | `7396` | TCP | WebUI |
### Additional ### Additional
There are some special variables to set. There are some special variables to set.
| Flag | Usage | | Flag | Usage |
| --------- | ------------------------------------- | | --------- | ------------------------------------- |
| `--user` | set your username | | `--user` | set your username |
| `--power` | set the default power to fold at home | | `--power` | set the default power to fold at home |
| `--team` | set your teamid to contribute points | | `--team` | set your teamid to contribute points |
### rebuild.sh ### rebuild.sh
```sh ```sh
@@ -49,4 +53,4 @@ docker run --name folding-at-home \
### GPU-Support ### GPU-Support
GPU support is documented in [the docker article](../docker.md). GPU support is documented in [the docker article](/wiki/docker.md).

View File

@@ -14,38 +14,46 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards.
Set the following volumes with the -v tag. Set the following volumes with the -v tag.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | --------------- | ------------------------ | | ------------------------- | --------------- | ------------------------ |
| `ovpn-proxy` | `/config` | storage for openvpn data | | `ovpn-proxy` | `/config` | storage for openvpn data |
### Ports ### Ports
Set the following ports with the -p tag. Set the following ports with the -p tag.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ------------ | | -------------- | ------------------------ | -------- | ------------ |
| `9050` | `8080` | HTTP | proxy port | | `9050` | `8080` | HTTP | proxy port |
### Environment-Variables ### Environment-Variables
Set the following variables with the -e tag. Set the following variables with the -e tag.
| Name | Usage | Default | | Name | Usage | Default |
| ------------------- | --------------------------- | ------- | | ------------------- | --------------------------- | ------- |
| `LOCAL_NETWORK` | Set local network subnet | ` ` | | `LOCAL_NETWORK` | Set local network subnet | |
| `OPENVPN_USERNAME` | username for OpenVPN | ` ` | | `OPENVPN_USERNAME` | username for OpenVPN | |
| `OPENVPN_PASSWORD` | password for OpenVPN | ` ` | | `OPENVPN_PASSWORD` | password for OpenVPN | |
### Additional ### Additional
There are some special variables to set. There are some special variables to set.
| Flag | Usage | | Flag | Usage |
| ----------- | ---------------------- | | ----------- | ---------------------- |
| `--cap-add` | add linux capabilities | | `--cap-add` | add linux capabilities |
| `--device` | connect devices | | `--device` | connect devices |
| `--sysctl` | configure systemctl | | `--sysctl` | configure systemctl |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -14,18 +14,22 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards.
Set the following ports in the `ports:` section. Set the following ports in the `ports:` section.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | --------- | ------------- | | -------------- | ------------------------ | --------- | ------------- |
| `80` | `80` | TCP | WebUI | | `80` | `80` | TCP | WebUI |
## Volumes ## Volumes
Set the following volumes with the -v tag. Set the following volumes with the -v tag.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | --------------- | -------------- | | ------------------------- | --------------- | -------------- |
| `kiwix_data` | `/data` | Data directory | | `kiwix_data` | `/data` | Data directory |
## rebuild.sh ## rebuild.sh
```sh ```sh

View File

@@ -0,0 +1,143 @@
# kohakuhub - kohakuhub
This is a [Docker](/wiki/docker.md) container for a
[KohakuHub](https://github.com/KohakuBlueleaf/KohakuHub) server.
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
Create the files `rebuild.sh` and `docker-compose.yml` at the same place.
The file `docker-compose.yml` is usually created automatically.
For this first download the [repository](https://github.com/KohakuBlueleaf/KohakuHub).
Then run the following command to generate the `docker-compose.yml` file.
```sh
python scripts/generate_docker_compose.py
```
Alternatively the example file `docker-compose.example.yml` file can be copied.
An additional example can be found in the [corresponding section](#docker-composeyml).
Change the settings according to your needs and run `./rebuild.sh` afterwards.
To publish the page on a domain the nginx container usually called `hub-ui` has to be published -
for example using a reverse proxy like
[traefik](/wiki/traefik.md#reverse-proxies-for-docker-service).
### Environment Variables
Set the following environment-variables in the `environment:` section of the
docker-compose file.
There are many other environment variables, which are automatically generated and not listed here.
| Name | Usage | Default |
| ----------------------------------------- | ------------------------------------ | ------- |
| `KOHAKU_HUB_INVITATION_ONLY` | Will disable public registration | false |
### Volumes
There are some volumes, which are automatically generated and not listed here.
### Ports
There are no ports, which are exposed by default.
### rebuild.sh
```sh
#!/bin/sh
docker-compose down
docker-compose up -d
```
### docker-compose.yml
```yml
services:
hub-ui:
image: nginx:alpine
restart: always
volumes:
- ./src/kohaku-hub-ui/dist:/usr/share/nginx/html
- ./src/kohaku-hub-admin/dist:/usr/share/nginx/html-admin
- ./docker/nginx/default.conf:/etc/nginx/conf.d/default.conf
depends_on:
- hub-api
hub-api:
build: .
restart: always
depends_on:
- postgres
- lakefs
- minio
environment:
- KOHAKU_HUB_INVITATION_ONLY=true
- KOHAKU_HUB_BASE_URL=https://hub.sub.domain.tld
- KOHAKU_HUB_S3_PUBLIC_ENDPOINT=https://s3.sub.domain.tld
- KOHAKU_HUB_SESSION_SECRET=CHANGE_ME_SESSION_SECRET
- KOHAKU_HUB_ADMIN_SECRET_TOKEN=CHANGE_ME_ADMIN_TOKEN
- KOHAKU_HUB_DATABASE_KEY=CHANGE_ME_DATABASE_KEY
- KOHAKU_HUB_DB_BACKEND=postgres
- KOHAKU_HUB_DATABASE_URL=postgresql://user:password@postgres:5432/database
- KOHAKU_HUB_S3_ENDPOINT=http://minio:9000
- KOHAKU_HUB_S3_ACCESS_KEY=CHANGE_ME_S3_ACCESS_KEY
- KOHAKU_HUB_S3_SECRET_KEY=CHANGE_ME_S3_SECRET_KEY
- KOHAKU_HUB_S3_BUCKET=example-bucket
- KOHAKU_HUB_S3_REGION=us-east-1
- KOHAKU_HUB_LAKEFS_ENDPOINT=http://lakefs:28000
- KOHAKU_HUB_LAKEFS_REPO_NAMESPACE=example
- KOHAKU_HUB_SITE_NAME=ExampleHub
- KOHAKU_HUB_AUTO_MIGRATE=true
volumes:
- ./hub-meta/hub-api:/hub-api-creds
minio:
image: quay.io/minio/minio:latest
command: server /data --console-address ":29000"
restart: unless-stopped
environment:
- MINIO_ROOT_USER=CHANGE_ME_MINIO_USER
- MINIO_ROOT_PASSWORD=CHANGE_ME_MINIO_PASSWORD
volumes:
- ./hub-storage/minio-data:/data
- ./hub-meta/minio-data:/root/.minio
lakefs:
build:
context: ./docker/lakefs
entrypoint: ["/bin/sh", "/scripts/lakefs-entrypoint.sh"]
command: ["run"]
restart: unless-stopped
depends_on:
- minio
- postgres
environment:
- LAKEFS_DATABASE_TYPE=postgres
- LAKEFS_DATABASE_POSTGRES_CONNECTION_STRING=postgres://user:password@postgres:5432/lakefs?sslmode=disable
- LAKEFS_BLOCKSTORE_TYPE=s3
- LAKEFS_BLOCKSTORE_S3_ENDPOINT=http://minio:9000
- LAKEFS_BLOCKSTORE_S3_BUCKET=example-bucket
- LAKEFS_BLOCKSTORE_S3_FORCE_PATH_STYLE=true
- LAKEFS_BLOCKSTORE_S3_CREDENTIALS_ACCESS_KEY_ID=CHANGE_ME_S3_ACCESS_KEY
- LAKEFS_BLOCKSTORE_S3_CREDENTIALS_SECRET_ACCESS_KEY=CHANGE_ME_S3_SECRET_KEY
- LAKEFS_BLOCKSTORE_S3_REGION=us-east-1
- LAKEFS_AUTH_ENCRYPT_SECRET_KEY=CHANGE_ME_LAKEFS_SECRET
- LAKEFS_LISTEN_ADDRESS=0.0.0.0:28000
volumes:
- ./hub-meta/lakefs-data:/var/lakefs/data
- ./hub-meta/lakefs-cache:/lakefs/data/cache
- ./docker/lakefs/lakefs-entrypoint.sh:/scripts/lakefs-entrypoint.sh:ro
- ./docker/lakefs/init-databases.sh:/scripts/init-databases.sh:ro
postgres:
image: postgres:15
restart: always
environment:
- POSTGRES_USER=user
- POSTGRES_PASSWORD=password
- POSTGRES_DB=database
volumes:
- ./hub-meta/postgres-data:/var/lib/postgresql/data
```

View File

@@ -20,32 +20,38 @@ docker run -v openvpn:/etc/openvpn --rm kylemanna/openvpn ovpn_genconfig -u udp:
docker run -v openvpn:/etc/openvpn --rm -it kylemanna/openvpn ovpn_initpki docker run -v openvpn:/etc/openvpn --rm -it kylemanna/openvpn ovpn_initpki
``` ```
Afterwards run `./rebuild.sh`. Afterward run `./rebuild.sh`.
### Volumes ### Volumes
Set the following volumes with the -v tag. Set the following volumes with the -v tag.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | --------------- | ------------------------ | | ------------------------- | --------------- | ------------------------ |
| `ovpn` | `/etc/openvpn` | storage for openvpn data | | `ovpn` | `/etc/openvpn` | storage for openvpn data |
### Ports ### Ports
Set the following ports with the -p tag. Set the following ports with the -p tag.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ------------ | | -------------- | ------------------------ | -------- | ------------ |
| `1194` | `1194` | UDP | openvpn port | | `1194` | `1194` | UDP | openvpn port |
### Additional ### Additional
There are some special variables to set. There are some special variables to set.
| Flag | Usage | | Flag | Usage |
| ----------- | ---------------------- | | ----------- | ---------------------- |
| `--cap-add` | add linux capabilities | | `--cap-add` | add linux capabilities |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -1,7 +1,7 @@
# linuxserver - airsonic-advanced # linuxserver - airsonic-advanced
This is a [Docker](/wiki/docker.md) container for a This is a [Docker](/wiki/docker.md) container for a
[Airsonic-Advanced](../airsonic-advanced.md) server. [Airsonic-Advanced](/wiki/airsonic-advanced.md) server.
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).
@@ -14,16 +14,19 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards.
Set the following variables with the -e tag. Set the following variables with the -e tag.
| Name | Usage | Default | | Name | Usage | Default |
| ------ | -------- | ------- | | ------ | -------- | ------- |
| `PUID` | UserID | | | `PUID` | UserID | |
| `PGID` | GroupID | | | `PGID` | GroupID | |
| `TZ` | Timezone | | | `TZ` | Timezone | |
### Volumes ### Volumes
Set the following volumes with the -v tag. Set the following volumes with the -v tag.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | --------------- | ----------------------- | | ------------------------- | --------------- | ----------------------- |
| `airsonicadv_config` | `/config` | Configuration files | | `airsonicadv_config` | `/config` | Configuration files |
@@ -33,14 +36,17 @@ Set the following volumes with the -v tag.
| `media_audiobooks` | `/audiobooks` | Location for audiobooks | | `media_audiobooks` | `/audiobooks` | Location for audiobooks |
| `media_podcasts` | `/podcasts` | location for podcasts | | `media_podcasts` | `/podcasts` | location for podcasts |
### Ports ### Ports
Set the following ports with the -p tag. Set the following ports with the -p tag.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ----------- | | -------------- | ------------------------ | -------- | ----------- |
| `4040` | `4040` | TCP | WebUI | | `4040` | `4040` | TCP | WebUI |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -1,6 +1,6 @@
# linuxserver - airsonic # linuxserver - airsonic
This is a [Docker](/wiki/docker.md) container for a [airsonic](../airsonic.md) This is a [Docker](/wiki/docker.md) container for a [airsonic](/wiki/airsonic.md)
server. 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).
@@ -14,16 +14,19 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards.
Set the following variables with the -e tag. Set the following variables with the -e tag.
| Name | Usage | Default | | Name | Usage | Default |
| ------ | -------- | ------- | | ------ | -------- | ------- |
| `PUID` | UserID | | | `PUID` | UserID | |
| `PGID` | GroupID | | | `PGID` | GroupID | |
| `TZ` | Timezone | | | `TZ` | Timezone | |
### Volumes ### Volumes
Set the following volumes with the -v tag. Set the following volumes with the -v tag.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | --------------- | ----------------------- | | ------------------------- | --------------- | ----------------------- |
| `airsonic_config` | `/config` | Configuration files | | `airsonic_config` | `/config` | Configuration files |
@@ -33,14 +36,17 @@ Set the following volumes with the -v tag.
| `media_audiobooks` | `/audiobooks` | Location for audiobooks | | `media_audiobooks` | `/audiobooks` | Location for audiobooks |
| `media_podcasts` | `/podcasts` | location for podcasts | | `media_podcasts` | `/podcasts` | location for podcasts |
### Ports ### Ports
Set the following ports with the -p tag. Set the following ports with the -p tag.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ----------- | | -------------- | ------------------------ | -------- | ----------- |
| `4040` | `4040` | TCP | WebUI | | `4040` | `4040` | TCP | WebUI |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -16,28 +16,34 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards.
Set the following environment-variables in the `environment:` section of the Set the following environment-variables in the `environment:` section of the
docker-compose file. docker-compose file.
| Name | Usage | Default | | Name | Usage | Default |
| ------ | ---------------------------- | ------- | | ------ | ---------------------------- | ------- |
| `PUID` | Userid to run the container | | | `PUID` | Userid to run the container | |
| `PGID` | Groupid to run the container | | | `PGID` | Groupid to run the container | |
| `TZ` | specify the timezone | | | `TZ` | specify the timezone | |
### Volumes ### Volumes
Set the following volumes in the `volumes:` section of the docker-compose file. Set the following volumes in the `volumes:` section of the docker-compose file.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | --------------- | ------------------------------------ | | ------------------------- | --------------- | ------------------------------------ |
| `config` | `/config` | storage for config files of jellyfin | | `config` | `/config` | storage for config files of jellyfin |
### Ports ### Ports
Set the following ports in the `ports:` section. Set the following ports in the `ports:` section.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ----------- | | -------------- | ------------------------ | -------- | ----------- |
| `7008` | `80` | TCP | WebUI | | `7008` | `80` | TCP | WebUI |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -1,6 +1,6 @@
# linuxserver - jellyfin # linuxserver - jellyfin
This is a [Docker](/wiki/docker.md) container for a [jellyfin](../jellyfin.md) This is a [Docker](/wiki/docker.md) container for a [jellyfin](/wiki/jellyfin.md)
server. server.
The official container and documentation was made by The official container and documentation was made by
[linuxserver](https://hub.docker.com/r/linuxserver/jellyfin). [linuxserver](https://hub.docker.com/r/linuxserver/jellyfin).
@@ -16,16 +16,19 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards.
Set the following environment-variables in the `environment:` section of the Set the following environment-variables in the `environment:` section of the
docker-compose file. docker-compose file.
| Name | Usage | Default | | Name | Usage | Default |
| ------ | ---------------------------- | ------- | | ------ | ---------------------------- | ------- |
| `PUID` | Userid to run the container | | | `PUID` | Userid to run the container | |
| `PGID` | Groupid to run the container | | | `PGID` | Groupid to run the container | |
| `TZ` | specify the timezone | | | `TZ` | specify the timezone | |
### Volumes ### Volumes
Set the following volumes in the `volumes:` section of the docker-compose file. Set the following volumes in the `volumes:` section of the docker-compose file.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | --------------- | ------------------------------------ | | ------------------------- | --------------- | ------------------------------------ |
| `config` | `/config` | storage for config files of jellyfin | | `config` | `/config` | storage for config files of jellyfin |
@@ -33,6 +36,7 @@ Set the following volumes in the `volumes:` section of the docker-compose file.
| `media_tvshows` | `/data/tvshows` | storage for tvshows | | `media_tvshows` | `/data/tvshows` | storage for tvshows |
| `transcode` | `/transcode` | tmp storage to transcode | | `transcode` | `/transcode` | tmp storage to transcode |
Because it is useful to have the possibility to use the `media_movies` and Because it is useful to have the possibility to use the `media_movies` and
`media_tvshows` in multiple containers, `media_tvshows` in multiple containers,
it is recommended to use them as external volumes (volumes section: it is recommended to use them as external volumes (volumes section:
@@ -44,10 +48,12 @@ To use the rebuild the volumes have to exist before creating the container
Set the following ports in the `ports:` section. Set the following ports in the `ports:` section.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ----------- | | -------------- | ------------------------ | -------- | ----------- |
| `8096` | `8096` | TCP | WebUI | | `8096` | `8096` | TCP | WebUI |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -26,29 +26,35 @@ This namely causes the following line in the
Set the following environment-variables in the `environment:` section of the Set the following environment-variables in the `environment:` section of the
docker-compose file. docker-compose file.
| Name | Usage | Default | | Name | Usage | Default |
| --------------------- | --------------------------- | ----------------------- | | --------------------- | --------------------------- | ----------------------- |
| `PUID` | user id for container user | `1000` | | `PUID` | user id for container user | `1000` |
| `PGID` | group id for container user | `1000` | | `PGID` | group id for container user | `1000` |
| `TZ` | specify the timezone | `Etc/UTC` | | `TZ` | specify the timezone | `Etc/UTC` |
### Volumes ### Volumes
Set the following volumes in the `volumes:` section of the docker-compose file. Set the following volumes in the `volumes:` section of the docker-compose file.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | ----------------- | --------------------------------- | | ------------------------- | ----------------- | --------------------------------- |
| `config` | `/config` | directory for config | | `config` | `/config` | directory for config |
| `complete` | `/music` | directory for music | | `complete` | `/music` | directory for music |
### Ports ### Ports
Set the following ports in the `ports:` section. Set the following ports in the `ports:` section.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ------------ | | -------------- | ------------------------ | -------- | ------------ |
| `8686` | `8686` | TCP | webUI | | `8686` | `8686` | TCP | webUI |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -26,29 +26,35 @@ This namely causes the following line in the
Set the following environment-variables in the `environment:` section of the Set the following environment-variables in the `environment:` section of the
docker-compose file. docker-compose file.
| Name | Usage | Default | | Name | Usage | Default |
| --------------------- | --------------------------- | ----------------------- | | --------------------- | --------------------------- | ----------------------- |
| `PUID` | user id for container user | `1000` | | `PUID` | user id for container user | `1000` |
| `PGID` | group id for container user | `1000` | | `PGID` | group id for container user | `1000` |
| `TZ` | specify the timezone | `Etc/UTC` | | `TZ` | specify the timezone | `Etc/UTC` |
### Volumes ### Volumes
Set the following volumes in the `volumes:` section of the docker-compose file. Set the following volumes in the `volumes:` section of the docker-compose file.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | ----------------- | --------------------------------- | | ------------------------- | ----------------- | --------------------------------- |
| `config` | `/config` | directory for config | | `config` | `/config` | directory for config |
| `complete` | `/movies` | directory for music | | `complete` | `/movies` | directory for music |
### Ports ### Ports
Set the following ports in the `ports:` section. Set the following ports in the `ports:` section.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ------------ | | -------------- | ------------------------ | -------- | ------------ |
| `7878` | `7878` | TCP | webUI | | `7878` | `7878` | TCP | webUI |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -26,29 +26,35 @@ This namely causes the following line in the
Set the following environment-variables in the `environment:` section of the Set the following environment-variables in the `environment:` section of the
docker-compose file. docker-compose file.
| Name | Usage | Default | | Name | Usage | Default |
| --------------------- | --------------------------- | ----------------------- | | --------------------- | --------------------------- | ----------------------- |
| `PUID` | user id for container user | `1000` | | `PUID` | user id for container user | `1000` |
| `PGID` | group id for container user | `1000` | | `PGID` | group id for container user | `1000` |
| `TZ` | specify the timezone | `Etc/UTC` | | `TZ` | specify the timezone | `Etc/UTC` |
### Volumes ### Volumes
Set the following volumes in the `volumes:` section of the docker-compose file. Set the following volumes in the `volumes:` section of the docker-compose file.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | ----------------- | --------------------------------- | | ------------------------- | ----------------- | --------------------------------- |
| `config` | `/config` | directory for config | | `config` | `/config` | directory for config |
| `complete` | `/tv` | directory for music | | `complete` | `/tv` | directory for music |
### Ports ### Ports
Set the following ports in the `ports:` section. Set the following ports in the `ports:` section.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ------------ | | -------------- | ------------------------ | -------- | ------------ |
| `8989` | `8989` | TCP | webUI | | `8989` | `8989` | TCP | webUI |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -1,7 +1,7 @@
# linuxserver - syncthing # linuxserver - syncthing
This is a [Docker](/wiki/docker.md) container for syncthing for This is a [Docker](/wiki/docker.md) container for syncthing for
[file synchronization](../file-synchronization.md). [file synchronization](/wiki/file-synchronization.md).
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).
@@ -14,6 +14,7 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards.
Set the following variables with the -e tag. Set the following variables with the -e tag.
| Name | Usage | Default | | Name | Usage | Default |
| ----------- | ---------------- | ------- | | ----------- | ---------------- | ------- |
| `PUID` | UserID | | | `PUID` | UserID | |
@@ -21,24 +22,29 @@ Set the following variables with the -e tag.
| `TZ` | Timezone | | | `TZ` | Timezone | |
| `UMASK_SET` | setting usermask | | | `UMASK_SET` | setting usermask | |
### Volumes ### Volumes
Set the following volumes with the -v tag. Set the following volumes with the -v tag.
| Volume-Name | Container mount | Description | | Volume-Name | Container mount | Description |
| ------------------ | --------------- | ----------------------------------------------- | | ------------------ | --------------- | ----------------------------------------------- |
| `syncthing_config` | `/config` | storage for config and possible downloaded data | | `syncthing_config` | `/config` | storage for config and possible downloaded data |
### Ports ### Ports
Set the following ports with the -p tag. Set the following ports with the -p tag.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ------------------ | | -------------- | ------------------------ | -------- | ------------------ |
| `8384` | `8384` | TCP | WebUI | | `8384` | `8384` | TCP | WebUI |
| `22000` | `22000` | TCP | Syncthing internal | | `22000` | `22000` | TCP | Syncthing internal |
| `21027` | `21027` | UDP | Syncthing internal | | `21027` | `21027` | UDP | Syncthing internal |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -1,6 +1,6 @@
# linuxserver - tvheadend # linuxserver - tvheadend
This is a [Docker](/wiki/docker.md) container for a [TVHeadend](../tvheadend.md) This is a [Docker](/wiki/docker.md) container for a [TVHeadend](/wiki/tvheadend.md)
server. 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).
@@ -8,37 +8,42 @@ The official container and documentation was made by
## Set-up ## Set-up
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` afterwards. Change the settings according to your needs and run `./rebuild.sh` afterward.
### Environment-variables ### Environment-variables
Set the following environment-variables in the `environment:` section of the Set the following environment-variables in the `environment:` section of the
docker-compose file. docker-compose file.
| Name | Usage | Default | | Name | Usage | Default |
| --------------------- | --------------------------- | ----------------------- | | --------------------- | --------------------------- | ----------------------- |
| `PUID` | user id for container user | `1000` | | `PUID` | user id for container user | `1000` |
| `PGID` | group id for container user | `1000` | | `PGID` | group id for container user | `1000` |
| `TZ` | specify the timezone | `Europe/London` | | `TZ` | specify the timezone | `Europe/London` |
| `RUN_OPTS` | specify the timezone | ` ` | | `RUN_OPTS` | specify the timezone | |
### Volumes ### Volumes
Set the following volumes in the `volumes:` section of the docker-compose file. Set the following volumes in the `volumes:` section of the docker-compose file.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | --------------- | --------------------------------- | | ------------------------- | --------------- | --------------------------------- |
| `config` | `/config` | directory for config | | `config` | `/config` | directory for config |
| `tvdvr` | `/recordings` | directory for storage | | `tvdvr` | `/recordings` | directory for storage |
### Ports ### Ports
Set the following ports in the `ports:` section. Set the following ports in the `ports:` section.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ------------ | | -------------- | ------------------------ | -------- | ------------ |
| `9981` | ` ` | TCP | webUI | | `9981` | | TCP | webUI |
| `9982` | ` ` | TCP | HTSP port | | `9982` | | TCP | HTSP port |
## rebuild.sh ## rebuild.sh

View File

@@ -22,6 +22,7 @@ Then run `./rebuild.sh`
Set the following variables with the -e tag. Set the following variables with the -e tag.
| Name | Usage | Default | | Name | Usage | Default |
| ----------- | --------------- | ------- | | ----------- | --------------- | ------- |
| `PUID` | UserID | | | `PUID` | UserID | |
@@ -30,30 +31,37 @@ Set the following variables with the -e tag.
| `SERVERURL` | URL of server | | | `SERVERURL` | URL of server | |
| `PEERS` | Number of peers | | | `PEERS` | Number of peers | |
### Volumes ### Volumes
Set the following volumes with the -v tag. Set the following volumes with the -v tag.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | --------------- | ----------------------- | | ------------------------- | --------------- | ----------------------- |
| `wireguard` | `/config` | Configuration files | | `wireguard` | `/config` | Configuration files |
### Ports ### Ports
Set the following ports with the -p tag. Set the following ports with the -p tag.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ----------- | | -------------- | ------------------------ | -------- | ----------- |
| `51820` | `51820` | UDP | VPN port | | `51820` | `51820` | UDP | VPN port |
### Additional ### Additional
There are some special variables to set. There are some special variables to set.
| Flag | Usage | | Flag | Usage |
| ----------- | ---------------------- | | ----------- | ---------------------- |
| `--cap-add` | add linux capabilities | | `--cap-add` | add linux capabilities |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -32,11 +32,10 @@ And finally generate the DCIM keys and rebuild once again.
`./setup.sh config dkim` `./setup.sh config dkim`
Finally if a reverse proxy is used check the Finally, if a reverse proxy is used check the
[traefik entry](/wiki/docker/traefik.md#setup-mailserver) or the [traefik entry](/wiki/docker/traefik.md#setup-mailserver) or the [nginx entry](/wiki/nginx.md).
[nginx entry](./nginx.md).
Afterwards you're ready to go by once again running the `rebuild.sh` file. Afterward you're ready to go by once again running the `rebuild.sh` file.
If setting up this mailserver with [Traefik](/wiki/traefik.md) as a reverse proxy some additional If setting up this mailserver with [Traefik](/wiki/traefik.md) as a reverse proxy some additional
steps should be taken. steps should be taken.

View File

@@ -18,6 +18,7 @@ These are needed most often.
Set the following environment-variables in the `environment:` section of the Set the following environment-variables in the `environment:` section of the
docker-compose file. docker-compose file.
| Name | Usage | Default | | Name | Usage | Default |
| --------------------- | ----------------------------- | ------- | | --------------------- | ----------------------------- | ------- |
| `MYSQL_ROOT_PASSWORD` | set the mysql admin password | | | `MYSQL_ROOT_PASSWORD` | set the mysql admin password | |
@@ -25,14 +26,17 @@ docker-compose file.
| `MYSQL_PASSWORD` | set the mysql user password | | | `MYSQL_PASSWORD` | set the mysql user password | |
| `MYSQL_Database` | specify mysql database to use | | | `MYSQL_Database` | specify mysql database to use | |
### Volumes ### Volumes
Set the following volumes in the `volumes:` section of the docker-compose file. Set the following volumes in the `volumes:` section of the docker-compose file.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | ---------------- | ------------------------- | | ------------------------- | ---------------- | ------------------------- |
| `mysql` | `/var/lib/mysql` | storage for owncloud data | | `mysql` | `/var/lib/mysql` | storage for owncloud data |
### Networks ### Networks
You can set networks in the `networks:` part of a docker-compose file to connect You can set networks in the `networks:` part of a docker-compose file to connect

View File

@@ -20,19 +20,23 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards.
Set the following ports in the `ports:` section. Set the following ports in the `ports:` section.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ----------- | | -------------- | ------------------------ | -------- | ----------- |
| `8080` | `8080` | TCP | WebUI | | `8080` | `8080` | TCP | WebUI |
### Environment-variables ### Environment-variables
Set the following environment-variables in the `environment:` section of the Set the following environment-variables in the `environment:` section of the
docker-compose file. docker-compose file.
| Name | Usage | Default | | Name | Usage | Default |
| ----------- | ----------------------- | ----------------- | | ----------- | ----------------------- | ----------------- |
| `NODE_ENV` | Setting the environment | `production` | | `NODE_ENV` | Setting the environment | `production` |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -1,7 +1,7 @@
# matrixdotorg - synapse # matrixdotorg - synapse
This is a [Docker](/wiki/docker.md) container for a synapse server using the This is a [Docker](/wiki/docker.md) container for a synapse server using the
[matrix](../matrix.md) protocol. [matrix](/wiki/matrix.md) protocol.
The official container and documentation was made by 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.
@@ -16,6 +16,7 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards.
Set the following environment-variables in the `environment:` section of the Set the following environment-variables in the `environment:` section of the
docker-compose file. docker-compose file.
| Name | Usage | Default | | Name | Usage | Default |
| --------------------- | ------------------------- | ----------------------- | | --------------------- | ------------------------- | ----------------------- |
| `SYNAPSE_CONFIG_DIR` | config directory | `/data` | | `SYNAPSE_CONFIG_DIR` | config directory | `/data` |
@@ -24,22 +25,27 @@ docker-compose file.
| `GID` | group id for synapse user | `1000` | | `GID` | group id for synapse user | `1000` |
| `TZ` | specify the timezone | `Europe/London` | | `TZ` | specify the timezone | `Europe/London` |
### Volumes ### Volumes
Set the following volumes in the `volumes:` section of the docker-compose file. Set the following volumes in the `volumes:` section of the docker-compose file.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | --------------- | --------------------------------- | | ------------------------- | --------------- | --------------------------------- |
| `synapse` | `/data` | directory for storage and configs | | `synapse` | `/data` | directory for storage and configs |
### Ports ### Ports
Set the following ports in the `ports:` section. Set the following ports in the `ports:` section.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ---------------------- | | -------------- | ------------------------ | -------- | ---------------------- |
| `8008` | `443` | TCP | matrix homeserver port | | `8008` | `443` | TCP | matrix homeserver port |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -15,6 +15,7 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards.
Set the following variables with the -e tag. Set the following variables with the -e tag.
| Name | Usage | Default | | Name | Usage | Default |
| ---------------- | ------------------- | ------- | | ---------------- | ------------------- | ------- |
| `USER_ID` | UserID | `1000` | | `USER_ID` | UserID | `1000` |
@@ -22,25 +23,30 @@ Set the following variables with the -e tag.
| `DISPLAY_WIDTH` | Width of software | `1280` | | `DISPLAY_WIDTH` | Width of software | `1280` |
| `DISPLAY_HEIGHT` | Height of software | `768` | | `DISPLAY_HEIGHT` | Height of software | `768` |
### Volumes ### Volumes
Set the following volumes with the -v tag. Set the following volumes with the -v tag.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | --------------- | ------------------------- | | ------------------------- | --------------- | ------------------------- |
| `config` | `/config` | Configuration files | | `config` | `/config` | Configuration files |
| `media_music` | `/storage` | Location for audio files | | `media_music` | `/storage` | Location for audio files |
### Ports ### Ports
Set the following ports with the -p tag. Set the following ports with the -p tag.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | -------------------------- | | -------------- | ------------------------ | -------- | -------------------------- |
| `5800` | `5800` | TCP | WebUI | | `5800` | `5800` | TCP | WebUI |
| `5900` | `5900` | TCP | VNC | | `5900` | `5900` | TCP | VNC |
| `8000` | `8000` | TCP | Picard browser integration | | `8000` | `8000` | TCP | Picard browser integration |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -18,6 +18,7 @@ These are needed most often.
Set the following environment-variables in the `environment:` section of the Set the following environment-variables in the `environment:` section of the
docker-compose file. docker-compose file.
| Name | Usage | Default | | Name | Usage | Default |
| --------------------- | ----------------------------- | ------- | | --------------------- | ----------------------------- | ------- |
| `MYSQL_ROOT_PASSWORD` | set the mysql admin password | | | `MYSQL_ROOT_PASSWORD` | set the mysql admin password | |
@@ -25,14 +26,17 @@ docker-compose file.
| `MYSQL_PASSWORD` | set the mysql user password | | | `MYSQL_PASSWORD` | set the mysql user password | |
| `MYSQL_Database` | specify mysql database to use | | | `MYSQL_Database` | specify mysql database to use | |
### Volumes ### Volumes
Set the following volumes in the `volumes:` section of the docker-compose file. Set the following volumes in the `volumes:` section of the docker-compose file.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | ---------------- | ------------------------- | | ------------------------- | ---------------- | ------------------------- |
| `mysql` | `/var/lib/mysql` | storage for owncloud data | | `mysql` | `/var/lib/mysql` | storage for owncloud data |
### Networks ### Networks
You can set networks in the `networks:` part of a docker-compose file to connect You can set networks in the `networks:` part of a docker-compose file to connect

View File

@@ -1,11 +1,11 @@
# NextCloud # NextCloud
This is a [Docker](/wiki/docker.md) container for [NextCloud](../nextcloud.md). This is a [Docker](/wiki/docker.md) container for [NextCloud](/wiki/nextcloud.md).
The official container and documentation was made by The official container and documentation was made by
[NextCloud](https://hub.docker.com/_/nextcloud). [NextCloud](https://hub.docker.com/_/nextcloud).
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 services in this files are explained seperately. The services in this files are explained seperately.
The main Docker container needs a database in form of a [MariaDB](./mariadb.md) The main Docker container needs a database in form of a [MariaDB](/wiki/docker/mariadb.md)
Docker container. Docker container.
## Set-up ## Set-up
@@ -27,18 +27,22 @@ Updating has to be done manually so nothing breaks.
Set the following volumes in the `volumes:` section of the docker-compose file. Set the following volumes in the `volumes:` section of the docker-compose file.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | --------------- | ---------------------------------------- | | ------------------------- | --------------- | ---------------------------------------- |
| `nextcloud` | `/var/www/html` | storage for nextcloud plugins and config | | `nextcloud` | `/var/www/html` | storage for nextcloud plugins and config |
### Ports ### Ports
Set the following ports in the `ports:` section. Set the following ports in the `ports:` section.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ----------- | | -------------- | ------------------------ | -------- | ----------- |
| `80` | `80` | TCP | WebUI | | `80` | `80` | TCP | WebUI |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -1,7 +1,7 @@
# nginx # nginx
This is a [Docker](/wiki/docker.md) container for an This is a [Docker](/wiki/docker.md) container for an
[nginx server](../nginx.md). [nginx server](/wiki/nginx.md).
The official container and documentation was made by 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.
@@ -15,19 +15,23 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards.
Set the following volumes in the `volumes:` section of the docker-compose file. Set the following volumes in the `volumes:` section of the docker-compose file.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | -------------------- | --------------------------- | | ------------------------- | -------------------- | --------------------------- |
| `nginx` | `/etc/nginx/conf.d/` | directory for nginx configs | | `nginx` | `/etc/nginx/conf.d/` | directory for nginx configs |
### Ports ### Ports
Set the following ports in the `ports:` section. Set the following ports in the `ports:` section.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ----------- | | -------------- | ------------------------ | -------- | ----------- |
| `80` | `80` | TCP | http port | | `80` | `80` | TCP | http port |
| `443` | `443` | TCP | https port | | `443` | `443` | TCP | https port |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -1,6 +1,6 @@
# olbat - cupsd # olbat - cupsd
This is a [Docker](/wiki/docker.md) container for a [Cups](../cups.md) server. 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).
@@ -13,19 +13,23 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards.
Set the following volumes with the -v tag. Set the following volumes with the -v tag.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | --------------- | ------------------------------- | | ------------------------- | --------------- | ------------------------------- |
| `cups` | `/etc/cups` | configuration for printers, etc | | `cups` | `/etc/cups` | configuration for printers, etc |
| `/var/run/dbus` | `/var/run/dbus` | connection to host dbus | | `/var/run/dbus` | `/var/run/dbus` | connection to host dbus |
### Ports ### Ports
Set the following ports with the -p tag. Set the following ports with the -p tag.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ----------------- | | -------------- | ------------------------ | -------- | ----------------- |
| `631` | `631` | TCP | cups server webui | | `631` | `631` | TCP | cups server webui |
### Additional ### Additional
The default username is `print`, the default password is `print`. The default username is `print`, the default password is `print`.

View File

@@ -13,18 +13,22 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards.
Set the following ports in the `ports:` section. Set the following ports in the `ports:` section.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | --------- | ------------------- | | -------------- | ------------------------ | --------- | ------------------- |
| `11434` | `11434` | TCP | Communications port | | `11434` | `11434` | TCP | Communications port |
## Volumes ## Volumes
Set the following volumes with the -v tag. Set the following volumes with the -v tag.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | --------------- | ------------- | | ------------------------- | --------------- | ------------- |
| `ollama` | `/root/.ollama` | Ollama data | | `ollama` | `/root/.ollama` | Ollama data |
## rebuild.sh ## rebuild.sh
```sh ```sh

View File

@@ -13,18 +13,22 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards.
Set the following ports in the `ports:` section. Set the following ports in the `ports:` section.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | --------- | ------------- | | -------------- | ------------------------ | --------- | ------------- |
| `11434` | `8080` | TCP | WebUI | | `11434` | `8080` | TCP | WebUI |
## Volumes ## Volumes
Set the following volumes with the -v tag. Set the following volumes with the -v tag.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | ------------------- | --------------- | | ------------------------- | ------------------- | --------------- |
| `open-webui` | `/app/backend/data` | Open WebUI data | | `open-webui` | `/app/backend/data` | Open WebUI data |
## rebuild.sh ## rebuild.sh
```sh ```sh

View File

@@ -1,12 +1,11 @@
# owncloud # ownCloud
This is a [Docker](/wiki/docker.md) container for a [owncloud](../owncloud.md) server. This is a [Docker](/wiki/docker.md) container for a [owncloud](/wiki/owncloud.md) server.
The official container and documentation was made by The official container and documentation was made by [ownCloud](https://hub.docker.com/_/owncloud).
[owncloud](https://hub.docker.com/_/owncloud).
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 services in this files are explained seperately. The services in this files are explained seperately.
The main Docker container needs a database in form of a [MariaDB](./mariadb.md) The main Docker container needs a database in form of a [MariaDB](/wiki/docker/mariadb.md) Docker
Docker container. container.
## Set-up ## Set-up
@@ -17,19 +16,23 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards.
Set the following volumes in the `volumes:` section of the docker-compose file. Set the following volumes in the `volumes:` section of the docker-compose file.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | ---------------------- | ---------------------------- | | ------------------------- | ---------------------- | ---------------------------- |
| `owncloud` | `/var/www/html` | storage for owncloud plugins | | `owncloud` | `/var/www/html` | storage for ownCloud plugins |
| `config` | `/var/www/html/config` | storage for owncloud config | | `config` | `/var/www/html/config` | storage for ownCloud config |
### Ports ### Ports
Set the following ports in the `ports:` section. Set the following ports in the `ports:` section.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ----------- | | -------------- | ------------------------ | -------- | ----------- |
| `80` | `80` | TCP | WebUI | | `80` | `80` | TCP | WebUI |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -14,12 +14,14 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards.
Set the following variables with the -e tag. Set the following variables with the -e tag.
| Variable name | Description | | Variable name | Description |
| ------------- | ------------------------------------------------------ | | ------------- | ------------------------------------------------------ |
| `API_KEY=` | append your API key that you retrieved from cloudflare | | `API_KEY=` | append your API key that you retrieved from cloudflare |
| `ZONE=` | append your domain (for example `main.com`) | | `ZONE=` | append your domain (for example `main.com`) |
| `SUBDOMAIN` | append your subdomain (for example `dynamic`) | | `SUBDOMAIN` | append your subdomain (for example `dynamic`) |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -12,20 +12,24 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards.
Set the following variables with the -e tag. Set the following variables with the -e tag.
| Name | Usage | Default | | Name | Usage | Default |
| ------ | ------- | ------- | | ------ | ------- | ------- |
| `PUID` | UserID | | | `PUID` | UserID | |
| `PGID` | GroupID | | | `PGID` | GroupID | |
### Volumes ### Volumes
Set the following volumes with the -v tag. Set the following volumes with the -v tag.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | --------------- | ----------------------------------------------- | | ------------------------- | --------------- | ----------------------------------------------- |
| `onedrive_config` | `/config` | configuration storage for the server connection | | `onedrive_config` | `/config` | configuration storage for the server connection |
| `onedrive_doc` | `/documents` | storage for downloaded documents | | `onedrive_doc` | `/documents` | storage for downloaded documents |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -1,6 +1,6 @@
# portainer - agent # portainer - agent
This is a [Docker](/wiki/docker.md) container for a [portainer](../portainer.md) This is a [Docker](/wiki/docker.md) container for a [portainer](/wiki/portainer.md)
agent. 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).
@@ -14,19 +14,23 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards.
Set the following volumes with the -v tag. Set the following volumes with the -v tag.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | ------------------------- | -------------------------------------- | | ------------------------- | ------------------------- | -------------------------------------- |
| `/var/run/docker.sock` | `/var/run/docker.sock` | connect your running docker containers | | `/var/run/docker.sock` | `/var/run/docker.sock` | connect your running docker containers |
| `/var/lib/docker/volumes` | `/var/lib/docker/volumes` | connect running docker volumes | | `/var/lib/docker/volumes` | `/var/lib/docker/volumes` | connect running docker volumes |
### Ports ### Ports
Set the following ports with the -p tag. Set the following ports with the -p tag.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | -------------------- | | -------------- | ------------------------ | -------- | -------------------- |
| `9001` | `9001` | TCP | Portainer agent port | | `9001` | `9001` | TCP | Portainer agent port |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -1,6 +1,6 @@
# portainer - portainer # portainer - portainer
This is a [Docker](/wiki/docker.md) container for a [portainer](../portainer.md) This is a [Docker](/wiki/docker.md) container for a [portainer](/wiki/portainer.md)
server. 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).
@@ -14,19 +14,23 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards.
Set the following volumes with the -v tag. Set the following volumes with the -v tag.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | ---------------------- | ------------------------------------------------- | | ------------------------- | ---------------------- | ------------------------------------------------- |
| `portainer` | `/data` | configuration directory | | `portainer` | `/data` | configuration directory |
| `/var/run/docker.sock` | `/var/run/docker.sock` | connection to local docker containers and volumes | | `/var/run/docker.sock` | `/var/run/docker.sock` | connection to local docker containers and volumes |
### Ports ### Ports
Set the following ports with the -p tag. Set the following ports with the -p tag.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ----------- | | -------------- | ------------------------ | -------- | ----------- |
| `9000` | `9000` | TCP | WebUI | | `9000` | `9000` | TCP | WebUI |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -19,6 +19,7 @@ These are needed most often.
Set the following environment-variables in the `environment:` section of the Set the following environment-variables in the `environment:` section of the
docker-compose file. docker-compose file.
| Name | Usage | Default | | Name | Usage | Default |
| ------------------------ | -------------------------------- | ------- | | ------------------------ | -------------------------------- | ------- |
| `POSTGRES_ROOT_PASSWORD` | set the postgres admin password | | | `POSTGRES_ROOT_PASSWORD` | set the postgres admin password | |
@@ -26,15 +27,18 @@ docker-compose file.
| `POSTGRES_PASSWORD` | set the postgres user password | | | `POSTGRES_PASSWORD` | set the postgres user password | |
| `POSTGRES_DB` | specify postgres database to use | | | `POSTGRES_DB` | specify postgres database to use | |
### Volumes ### Volumes
Set the following volumes in the `volumes:` section of the docker-compose file. Set the following volumes in the `volumes:` section of the docker-compose file.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | -------------------------- | ---------------------------- | | ------------------------- | -------------------------- | ---------------------------- |
| `postgres` | `/var/lib/postgresql/data` | storage for owncloud data | | `postgres` | `/var/lib/postgresql/data` | storage for owncloud data |
| `postgres_config` | `/config/sql` | initial sql setup and config | | `postgres_config` | `/config/sql` | initial sql setup and config |
### Networks ### Networks
You can set networks in the `networks:` part of a docker-compose file to connect You can set networks in the `networks:` part of a docker-compose file to connect

View File

@@ -14,18 +14,22 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards.
Set the following volumes with the -v tag. Set the following volumes with the -v tag.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | --------------- | -------------------------- | | ------------------------- | --------------- | -------------------------- |
| `golinks` | `/search.db` | database with all commands | | `golinks` | `/search.db` | database with all commands |
### Ports ### Ports
Set the following ports with the -p tag. Set the following ports with the -p tag.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ----------- | | -------------- | ------------------------ | -------- | ----------- |
| `8000` | `8000` | TCP | WebUI | | `8000` | `8000` | TCP | WebUI |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -13,18 +13,22 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards.
Set the following ports with the -p tag. Set the following ports with the -p tag.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ---------------------------------------- | | -------------- | ------------------------ | -------- | ---------------------------------------- |
| `8000` | `8000` | TCP | port to proxy the gopher site as http to | | `8000` | `8000` | TCP | port to proxy the gopher site as http to |
### Additional ### Additional
There are some special variables to set. There are some special variables to set.
| Flag | Usage | | Flag | Usage |
| ------ | ------------------------------------------------------------- | | ------ | ------------------------------------------------------------- |
| `-uri` | define the gopher site to proxy (just 'domain.tld' is enough) | | `-uri` | define the gopher site to proxy (just 'domain.tld' is enough) |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -13,18 +13,22 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards.
Set the following volumes with the -v tag. Set the following volumes with the -v tag.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | ---------------------- | ---------------------- | | ------------------------- | ---------------------- | ---------------------- |
| `todo` | `/go/src/todo/todo.db` | Database for todo list | | `todo` | `/go/src/todo/todo.db` | Database for todo list |
### Ports ### Ports
Set the following ports with the -p tag. Set the following ports with the -p tag.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ----------- | | -------------- | ------------------------ | -------- | ----------- |
| `8000` | `8000` | TCP | WebUI | | `8000` | `8000` | TCP | WebUI |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -19,18 +19,22 @@ Set the variables, volumes and ports according and run the `rebuild.sh`.
Set the following volumes with the -v tag. Set the following volumes with the -v tag.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | ------------------- | ------------------- | | ------------------------- | ------------------- | ------------------- |
| `synctube` | `/usr/src/app/user` | Configuration files | | `synctube` | `/usr/src/app/user` | Configuration files |
### Ports ### Ports
Set the following ports with the -p tag. Set the following ports with the -p tag.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ----------- | | -------------- | ------------------------ | -------- | ----------- |
| `4200` | `4200` | TCP | WebUI | | `4200` | `4200` | TCP | WebUI |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -18,10 +18,12 @@ These are needed most often.
Set the following volumes in the `volumes:` section of the docker-compose file. Set the following volumes in the `volumes:` section of the docker-compose file.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | --------------- | -------------------- | | ------------------------- | --------------- | -------------------- |
| `redis` | `/data` | storage for all data | | `redis` | `/data` | storage for all data |
### Networks ### Networks
You can set networks in the `networks:` part of a docker-compose file to connect You can set networks in the `networks:` part of a docker-compose file to connect

View File

@@ -13,26 +13,32 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards.
Set the following variables with the -e tag. Set the following variables with the -e tag.
| Name | Usage | Default | | Name | Usage | Default |
| -------------- | ----------------------- | ------- | | -------------- | ----------------------- | ------- |
| `STORAGE_TYPE` | Type to store the datas | `file` | | `STORAGE_TYPE` | Type to store the datas | `file` |
### Volumes ### Volumes
Set the following volumes with the -v tag. Set the following volumes with the -v tag.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | --------------- | -------------------------- | | ------------------------- | --------------- | -------------------------- |
| `hastebin` | `/app/data` | storage directory for data | | `hastebin` | `/app/data` | storage directory for data |
### Ports ### Ports
Set the following ports with the -p tag. Set the following ports with the -p tag.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ----------- | | -------------- | ------------------------ | -------- | ----------- |
| `7777` | `7777` | TCP | WebUI | | `7777` | `7777` | TCP | WebUI |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -1,6 +1,6 @@
# samba # samba
This is a [Docker](/wiki/docker.md) container for a [Samba](../samba.md) This is a [Docker](/wiki/docker.md) container for a [Samba](/wiki/samba.md)
server. 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).
@@ -14,6 +14,7 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards.
Set the following volumes with the -v tag. Set the following volumes with the -v tag.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | ------------------ | ----------------------------- | | ------------------------- | ------------------ | ----------------------------- |
| `samba_nas` | `/nas` | storage for samba data | | `samba_nas` | `/nas` | storage for samba data |
@@ -23,25 +24,30 @@ Set the following volumes with the -v tag.
| `samba_etc` | `/etc` | etc directory of samba server | | `samba_etc` | `/etc` | etc directory of samba server |
| `samba_log` | `/var/log/samba` | storage for samba logs | | `samba_log` | `/var/log/samba` | storage for samba logs |
### Ports ### Ports
Set the following ports with the -p tag. Set the following ports with the -p tag.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | -------------- | | -------------- | ------------------------ | -------- | -------------- |
| `139` | `139` | TCP | Samba internal | | `139` | `139` | TCP | Samba internal |
| `445` | `445` | TCP | Samba internal | | `445` | `445` | TCP | Samba internal |
### Additional ### Additional
There are some special variables to set. There are some special variables to set.
| Flag | Usage | | Flag | Usage |
| ------------------------------------------------------------------------- | ---------------- | | ------------------------------------------------------------------------- | ---------------- |
| `-u \<username;password\>(;ID;group;GID)` | define user | | `-u \<username;password\>(;ID;group;GID)` | define user |
| `-w \<workgroup\>` | define workgroup | | `-w \<workgroup\>` | define workgroup |
| `-s \<name;path\>(;browse;readonly;guest;users;admins;writelist;comment)` | define shares | | `-s \<name;path\>(;browse;readonly;guest;users;admins;writelist;comment)` | define shares |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -1,6 +1,6 @@
# searx - searx # searx - searx
This is a [Docker](/wiki/docker.md) container for a [searx](../searx.md) This is a [Docker](/wiki/docker.md) container for a [searx](/wiki/searx.md)
meta-search machine. 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).
@@ -14,19 +14,23 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards.
Set the following volumes with the -v tag. Set the following volumes with the -v tag.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | ---------------- | ---------------- | | ------------------------- | ---------------- | ---------------- |
| `searx_etc` | `/etc/searx` | storage for etc | | `searx_etc` | `/etc/searx` | storage for etc |
| `searx_log` | `/var/log/uwsgi` | storage for logs | | `searx_log` | `/var/log/uwsgi` | storage for logs |
### Ports ### Ports
Set the following ports with the -p tag. Set the following ports with the -p tag.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ----------- | | -------------- | ------------------------ | -------- | ----------- |
| `8080` | `8080` | TCP | WebUI | | `8080` | `8080` | TCP | WebUI |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -31,7 +31,7 @@ networks:
external: true external: true
``` ```
Finally make sure to create the external network `teamspeak` before starting the containers. Finally, make sure to create the external network `teamspeak` before starting the containers.
This can be done by running the following command. This can be done by running the following command.
```sh ```sh
@@ -47,32 +47,39 @@ Change the other settings according to your needs and run `./rebuild.sh` afterwa
Set the following environment-variables in the `environment:` section of the Set the following environment-variables in the `environment:` section of the
docker-compose file. docker-compose file.
| Name | Usage | Default | | Name | Usage | Default |
| ----------- | ------------------------------ | ------- | | ----------- | ------------------------------ | ------- |
| `UID` | User userid to run gitea | | | `UID` | User userid to run gitea | |
| `GID` | User groupid to run gitea | | | `GID` | User groupid to run gitea | |
### Volumes ### Volumes
Set the following volumes in the `volumes:` section of the docker-compose file. Set the following volumes in the `volumes:` section of the docker-compose file.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | ----------------------- | ------------------------------------- | | ------------------------- | ----------------------- | ------------------------------------- |
| `sinusbot_scripts` | `/opt/sinusbot/scripts` | storage for the sinusbot scripts | | `sinusbot_scripts` | `/opt/sinusbot/scripts` | storage for the sinusbot scripts |
| `sinusbot_data` | `/opt/sinusbot/data` | storage for the most of sinusbot data | | `sinusbot_data` | `/opt/sinusbot/data` | storage for the most of sinusbot data |
### Ports ### Ports
Set the following ports in the `ports:` section. Set the following ports in the `ports:` section.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ---------------------- | | -------------- | ------------------------ | -------- | ---------------------- |
| `8087` | `8087` | TCP | WebUI | | `8087` | `8087` | TCP | WebUI |
### Networks ### Networks
Set the following networks in the `networks:` section of the docker-compose file. Set the following networks in the `networks:` section of the docker-compose file.
| Name | Usage | | Name | Usage |
| ----------- | ---------------------------- | | ----------- | ---------------------------- |
| `teamspeak` | connect with local teamspeak | | `teamspeak` | connect with local teamspeak |

View File

@@ -1,6 +1,6 @@
# sissbrueckner - linkding # sissbrueckner - linkding
This is a [Docker](/wiki/docker.md) container for a [linkding](../linkding.md) This is a [Docker](/wiki/docker.md) container for a [linkding](/wiki/linkding.md)
bookmark and archive service. 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).
@@ -8,8 +8,8 @@ The official container and documentation was made by
## Set-up ## Set-up
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` afterward.
Afterwards you need to create a user. Afterward you need to create a user.
This can be done by running the following line with changed credentials: This can be done by running the following line with changed credentials:
```sh ```sh
@@ -22,18 +22,22 @@ You will be asked for a password via the commandline.
Set the following volumes with the -v tag. Set the following volumes with the -v tag.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | ---------------------- | --------------------------- | | ------------------------- | ---------------------- | --------------------------- |
| `linkding` | `/etc/linkding/data` | storage for persistent data | | `linkding` | `/etc/linkding/data` | storage for persistent data |
### Ports ### Ports
Set the following ports with the -p tag. Set the following ports with the -p tag.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ----------- | | -------------- | ------------------------ | -------- | ----------- |
| `9090` | `9090` | TCP | WebUI | | `9090` | `9090` | TCP | WebUI |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -1,7 +1,7 @@
# spikecodes - libreddit # spikecodes - libreddit
This is a [Docker](/wiki/docker.md) container for the alternative reddit This is a [Docker](/wiki/docker.md) container for the alternative reddit
frontend [libreddit](../libreddit.md). 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).
@@ -14,10 +14,12 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards.
Set the following ports with the -p tag. Set the following ports with the -p tag.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ----------- | | -------------- | ------------------------ | -------- | ----------- |
| `8080` | `8080` | TCP | WebUI | | `8080` | `8080` | TCP | WebUI |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -14,28 +14,34 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards.
Set the following variables with the -e tag. Set the following variables with the -e tag.
| Name | Usage | Default | | Name | Usage | Default |
| ------------------- | ---------------------------- | ------- | | ------------------- | ---------------------------- | ------- |
| `TS3SERVER_LICENSE` | accept the license agreement | | | `TS3SERVER_LICENSE` | accept the license agreement | |
### Volumes ### Volumes
Set the following volumes with the -v tag. Set the following volumes with the -v tag.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | ---------------- | --------------------------- | | ------------------------- | ---------------- | --------------------------- |
| `teamspeak3` | `/var/ts3server` | storage for ts3-server data | | `teamspeak3` | `/var/ts3server` | storage for ts3-server data |
### Ports ### Ports
Set the following ports with the -p tag. Set the following ports with the -p tag.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ----------- | | -------------- | ------------------------ | -------- | ----------- |
| `9987` | `9987` | UDP | ts3-intern | | `9987` | `9987` | UDP | ts3-intern |
| `10011` | `10011` | TCP | ts3-intern | | `10011` | `10011` | TCP | ts3-intern |
| `30033` | `30033` | TCP | ts3-intern | | `30033` | `30033` | TCP | ts3-intern |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -15,6 +15,8 @@ With `stop.sh` you can stop it.
Set the following variables with the -e tag. Set the following variables with the -e tag.
| Name | Usage | Default | | Name | Usage | Default |
| ----------------- | ------------------------------------------- | ------- | | ----------------- | ------------------------------------------- | ------- |
| `QUERYPORT` | port for query mordhau | | | `QUERYPORT` | port for query mordhau | |
@@ -30,24 +32,29 @@ Set the following variables with the -e tag.
| `SERVER_PASSWORD` | set a password | | | `SERVER_PASSWORD` | set a password | |
| `ADMIN_PASSWORD` | set an admin password | | | `ADMIN_PASSWORD` | set an admin password | |
### Volumes ### Volumes
Set the following volumes with the -v tag. Set the following volumes with the -v tag.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | ---------------------- | ---------------------------------------- | | ------------------------- | ---------------------- | ---------------------------------------- |
| `mordhau` | `/serverdata/mordhau` | storage for mordhau server relevant data | | `mordhau` | `/serverdata/mordhau` | storage for mordhau server relevant data |
| `mordhau_steamcmd` | `/serverdata/steamcmd` | storage for steam related data | | `mordhau_steamcmd` | `/serverdata/steamcmd` | storage for steam related data |
### Ports ### Ports
Set the following ports with the -p tag. Set the following ports with the -p tag.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ----------------- | | -------------- | ------------------------ | -------- | ----------------- |
| `7777` | `7777` | UDP | mordhau internal | | `7777` | `7777` | UDP | mordhau internal |
| `15000` | `15000` | UDP | mordhau internal | | `15000` | `15000` | UDP | mordhau internal |
| `27015` | `27015` | UDP | mordhau internal | | `27015` | `27015` | UDP | mordhau internal |
### start.sh ### start.sh
```sh ```sh

View File

@@ -18,18 +18,22 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards.
Set the following ports in the `ports:` section. Set the following ports in the `ports:` section.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ----------- | | -------------- | ------------------------ | -------- | ----------- |
| `7890` | `80` | TCP | WebUI | | `7890` | `80` | TCP | WebUI |
### Volumes ### Volumes
Set the following volumes with the -v tag. Set the following volumes with the -v tag.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | -------------------------- | ------------------------ | | ------------------------- | -------------------------- | ------------------------ |
| `kitchenowl_data` | `/data` | storage for all data | | `kitchenowl_data` | `/data` | storage for all data |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -18,27 +18,33 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards.
Set the following volumes with the -v tag. Set the following volumes with the -v tag.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | --------------- | --------------------------- | | ------------------------- | --------------- | --------------------------- |
| `radicale_data` | `/data` | storage for caldav | | `radicale_data` | `/data` | storage for caldav |
| `radicale_config` | `/config` | storage for radicale config | | `radicale_config` | `/config` | storage for radicale config |
### Ports ### Ports
Set the following ports with the -p tag. Set the following ports with the -p tag.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ------------- | | -------------- | ------------------------ | -------- | ------------- |
| `5232` | `5232` | TCP | WebUI, caldav | | `5232` | `5232` | TCP | WebUI, caldav |
### Additional ### Additional
There are some special variables to set. There are some special variables to set.
| Flag | Usage | | Flag | Usage |
| ------------- | ---------------------------------------------------------------------- | | ------------- | ---------------------------------------------------------------------- |
| `--read-only` | make Radicale read-only, caldav can still be changed and used normally | | `--read-only` | make Radicale read-only, caldav can still be changed and used normally |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -19,6 +19,7 @@ the [Traefik wiki entry](/wiki/traefik.md#usage).
Set the following volumes in the `volumes:` section of the docker-compose file. Set the following volumes in the `volumes:` section of the docker-compose file.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | ------------------------- | --------------------------------------- | | ------------------------- | ------------------------- | --------------------------------------- |
| `/etc/localtime` | `/etc/localtime:ro` | get the system time | | `/etc/localtime` | `/etc/localtime:ro` | get the system time |
@@ -27,23 +28,28 @@ Set the following volumes in the `volumes:` section of the docker-compose file.
| `./data/acme.json` | `/acme.json` | place to store certificates for https | | `./data/acme.json` | `/acme.json` | place to store certificates for https |
| `./data/config` | `/configurations` | place for dynamically changable configs | | `./data/config` | `/configurations` | place for dynamically changable configs |
### Ports ### Ports
Set the following ports in the `ports:` section. Set the following ports in the `ports:` section.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ----------- | | -------------- | ------------------------ | -------- | ----------- |
| `80` | `80` | TCP | http | | `80` | `80` | TCP | http |
| `443` | `443` | TCP | https | | `443` | `443` | TCP | https |
### Networks ### Networks
Set the following networks in the `networks:` section of the docker-compose file. Set the following networks in the `networks:` section of the docker-compose file.
| Name | Usage | | Name | Usage |
| ------- | -------------------------------------- | | ------- | -------------------------------------- |
| `proxy` | network to expose http and https ports | | `proxy` | network to expose http and https ports |
### Labels ### Labels
Set the following labels in the `labels:` section. Set the following labels in the `labels:` section.

View File

@@ -19,19 +19,23 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards.
Set the following ports in the `ports:` section. Set the following ports in the `ports:` section.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ----------- | | -------------- | ------------------------ | -------- | ----------- |
| `8083` | `8080` | TCP | WebUI | | `8083` | `8080` | TCP | WebUI |
### Volumes ### Volumes
Set the following volumes with the -v tag. Set the following volumes with the -v tag.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | -------------------------- | ------------------------ | | ------------------------- | -------------------------- | ------------------------ |
| `staticfiles` | `/opt/recipes/staticfiles` | storage for static files | | `staticfiles` | `/opt/recipes/staticfiles` | storage for static files |
| `mediafiles` | `/opt/recipes/mediafiles` | storage for media files | | `mediafiles` | `/opt/recipes/mediafiles` | storage for media files |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -1,6 +1,6 @@
# vectorim - riot-web # vectorim - riot-web
This is a [Docker](/wiki/docker.md) container for a [matrix](../matrix.md) This is a [Docker](/wiki/docker.md) container for a [matrix](/wiki/matrix.md)
client. client.
The official container and documentation was made by The official container and documentation was made by
[linuxserver](https://hub.docker.com/vectorim/riot-web). [linuxserver](https://hub.docker.com/vectorim/riot-web).
@@ -15,18 +15,22 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards.
Set the following volumes in the `volumes:` section of the docker-compose file. Set the following volumes in the `volumes:` section of the docker-compose file.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | --------------------- | ----------- | | ------------------------- | --------------------- | ----------- |
| `./config.json` | `/app/config.json:ro` | config file | | `./config.json` | `/app/config.json:ro` | config file |
### Ports ### Ports
Set the following ports in the `ports:` section. Set the following ports in the `ports:` section.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ----------- | | -------------- | ------------------------ | -------- | ----------- |
| `80` | `80` | TCP | WebUI | | `80` | `80` | TCP | WebUI |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -1,7 +1,7 @@
# ventz - bind # ventz - bind
This is a [Docker](/wiki/docker.md) container for a [bind](../bind.md) This is a [Docker](/wiki/docker.md) container for a [bind](/wiki/bind.md)
[DNS](../dns.md) resolver. [DNS](/wiki/dns.md) resolver.
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).
@@ -14,28 +14,34 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards.
Set the following volumes with the -v tag. Set the following volumes with the -v tag.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | ----------------- | --------------------- | | ------------------------- | ----------------- | --------------------- |
| `bind_cache` | `/var/cache/bind` | cache for DNS | | `bind_cache` | `/var/cache/bind` | cache for DNS |
| `bind_etc` | `/etc/bind` | configuration for DNS | | `bind_etc` | `/etc/bind` | configuration for DNS |
### Ports ### Ports
Set the following ports with the -p tag. Set the following ports with the -p tag.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | -------- | ----------------- | | -------------- | ------------------------ | -------- | ----------------- |
| `53` | `53` | TCP | DNS protocol port | | `53` | `53` | TCP | DNS protocol port |
| `53` | `53` | UDP | DNS protocol port | | `53` | `53` | UDP | DNS protocol port |
### Additional ### Additional
There are some special variables to set. There are some special variables to set.
| Flag | Usage | | Flag | Usage |
| ------- | ------------------------------------------------------- | | ------- | ------------------------------------------------------- |
| `--dns` | set two of these flags for specific DNS forward servers | | `--dns` | set two of these flags for specific DNS forward servers |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -14,7 +14,7 @@ Due to this container being used to build the Silicon and Carbon verifiers it is
started in interactive mode as demonstrated in the [rebuild section](#rebuildsh). started in interactive mode as demonstrated in the [rebuild section](#rebuildsh).
Make sure to substitute `<path-to-carbon>` and `<path-to-silicon>`. Make sure to substitute `<path-to-carbon>` and `<path-to-silicon>`.
If only one of them is to be built, omit the other. If only one of them is to be built, omit the other.
Additionally the version of viperproject has to be added for `<viperproject-version>`. Additionally, the version of viperproject has to be added for `<viperproject-version>`.
It also depends on the Z3 version which will be used later. It also depends on the Z3 version which will be used later.
For example the version `v4_z3_4.8.7` is working for Z3 versions `4.8.7` and later. For example the version `v4_z3_4.8.7` is working for Z3 versions `4.8.7` and later.
@@ -22,11 +22,13 @@ For example the version `v4_z3_4.8.7` is working for Z3 versions `4.8.7` and lat
Set the following volumes with the -v tag. Set the following volumes with the -v tag.
| Outside mount/volume name | Container mount | Description | | Outside mount/volume name | Container mount | Description |
| ------------------------- | --------------- | ----------------------------------------- | | ------------------------- | --------------- | ----------------------------------------- |
| `<path-to-silicon>` | `/mnt/silicon` | (optional) mount Silicon for installation | | `<path-to-silicon>` | `/mnt/silicon` | (optional) mount Silicon for installation |
| `<path-to-carbon>` | `/mnt/carbon` | (optional) mount Carbon for installation | | `<path-to-carbon>` | `/mnt/carbon` | (optional) mount Carbon for installation |
## rebuild.sh ## rebuild.sh
```sh ```sh

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