1
0
mirror of https://github.com/tiyn/wiki.git synced 2026-04-15 16:54:48 +02:00

Restructuring: Fixed spelling and tables

This commit is contained in:
2026-04-03 10:17:26 +02:00
parent f4181c2c3d
commit 58f836b4d4
187 changed files with 1039 additions and 622 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

@@ -14,7 +14,7 @@ A list of open-source software options is also available on Alberto Mosconis
[Github](/wiki/git_%28general%29.md#server-with-web-interface) repository [Github](/wiki/git_%28general%29.md#server-with-web-interface) 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

@@ -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

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

@@ -162,7 +162,7 @@ $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 added in the Additionally, add all domain names in front of the first `(` that have been added in the
`zone.<domain>.<tld>` file as an [A record](/wiki/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 `<thisserver>.<domain>.<tld>.` is. Note that all these have to be followed by a `.` just like `<thisserver>.<domain>.<tld>.` is.
For all these records add a PTR record too. For all these records add a PTR record too.

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

@@ -7,19 +7,37 @@ unix and unix-like systems.
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](/wiki/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 server software. Additionally, to this a client is needed on the system that need access to the 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

@@ -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

@@ -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

@@ -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

@@ -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

@@ -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

@@ -5,7 +5,7 @@ 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

@@ -17,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

@@ -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

@@ -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

@@ -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

@@ -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

@@ -15,6 +15,7 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards.
Set the following environment-variables in the `environment:` section of the 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 | |
@@ -25,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

@@ -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

@@ -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

@@ -21,6 +21,7 @@ Set the variables, volumes and ports according and run the `rebuild.sh`.
Set the following environment-variables in the `environment:` section of the 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` |
@@ -38,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

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

@@ -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

@@ -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

@@ -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

@@ -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

@@ -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

@@ -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,10 +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 [nginx entry](/wiki/nginx.md). [traefik entry](/wiki/docker/traefik.md#setup-mailserver) or the [nginx entry](/wiki/nginx.md).
Afterwards you're ready to go by once again running the `rebuild.sh` file. Afterward, you're ready to go by once again running the `rebuild.sh` file.
If setting up this mailserver with [Traefik](/wiki/traefik.md) as a reverse proxy some additional 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

@@ -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

@@ -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

@@ -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

@@ -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

@@ -16,19 +16,23 @@ Change the settings according to your needs and run `./rebuild.sh` afterwards.
Set the following volumes in the `volumes:` section of the docker-compose file. 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

@@ -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

@@ -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

@@ -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

@@ -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

@@ -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

@@ -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

@@ -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

@@ -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

View File

@@ -19,14 +19,17 @@ The environment variables are set via the `.env` file and listed in the
Set the following ports in the `ports:` section. Set the following ports in the `ports:` section.
| Container Port | Recommended outside port | Protocol | Description | | Container Port | Recommended outside port | Protocol | Description |
| -------------- | ------------------------ | --------- | ------------- | | -------------- | ------------------------ | --------- | ------------- |
| `11111` | `11111` | TCP | WebUI | | `11111` | `11111` | 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 |
| ------------------------- | ------------------ | ------------------- | | ------------------------- | ------------------ | ------------------- |
| `config` | `/config` | configuration files | | `config` | `/config` | configuration files |
@@ -35,6 +38,7 @@ Set the following volumes with the -v tag.
| `files_imports` | `/files/imports` | path for imports | | `files_imports` | `/files/imports` | path for imports |
| `/etc/timezone` | `/etc/timezone:ro` | Timezone | | `/etc/timezone` | `/etc/timezone:ro` | Timezone |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -16,6 +16,7 @@ Change the settings according to your needs and run `./rebuild.sh` afterward.
Set the following environment-variables in the `environment:` section of the 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` | Password for the mySQL root user | | | `MYSQL_ROOT_PASSWORD` | Password for the mySQL root user | |
@@ -33,22 +34,27 @@ docker-compose file.
| `SYMFONY__ENV__DOMAIN_NAME` | URL to wallabag instance | `https://your-wallabag-url-instance.com` | | `SYMFONY__ENV__DOMAIN_NAME` | URL to wallabag instance | `https://your-wallabag-url-instance.com` |
| `SYMFONY__ENV__SERVER_NAME` | Name for the wallabag server | `Your wallabag instance` | | `SYMFONY__ENV__SERVER_NAME` | Name for the wallabag server | `Your wallabag instance` |
### 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 |
| ------------------------- | ------------------------------------- | -------------------------------- | | ------------------------- | ------------------------------------- | -------------------------------- |
| `wallabag_wallabag` | `/var/www/wallabag/web/assets/images` | storage for wallabag config data | | `wallabag_wallabag` | `/var/www/wallabag/web/assets/images` | storage for wallabag config 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 |
| -------------- | ------------------------ | -------- | ----------- | | -------------- | ------------------------ | -------- | ----------- |
| `80` | `80` | TCP | WebUI | | `80` | `80` | 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 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 |
| ------------------------- | --------------- | -------------------- | | ------------------------- | --------------- | -------------------- |
| `pinedocs` | `/data` | storage for pinedocs | | `pinedocs` | `/data` | storage for pinedocs |
### 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` | `80` | TCP | WebUI | | `80` | `80` | TCP | WebUI |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -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 |
| ---------------- | -------------------------- | ------- | | ---------------- | -------------------------- | ------- |
| `YOURLS_DB_PASS` | database password | | | `YOURLS_DB_PASS` | database password | |
@@ -21,22 +22,27 @@ Set the following variables with the -e tag.
| `YOURLS_USER` | username for YOURLS admin | | | `YOURLS_USER` | username for YOURLS admin | |
| `YOURLS_PASS` | password for YOURLS admin | | | `YOURLS_PASS` | password for YOURLS admin | |
### 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 |
| ------------------------- | --------------- | -------------------- | | ------------------------- | --------------- | -------------------- |
| `yourls` | `/var/www/html` | YOURLS specific HTML | | `yourls` | `/var/www/html` | YOURLS specific HTML |
### 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` | `80` | TCP | dns protocol port | | `80` | `80` | TCP | dns protocol port |
### rebuild.sh ### rebuild.sh
```sh ```sh

View File

@@ -15,18 +15,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 |
| ------------------------- | --------------- | ------------------------- | | ------------------------- | --------------- | ------------------------- |
| `nitter` | `/data` | storage for all of nitter | | `nitter` | `/data` | storage for all of nitter |
### 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

@@ -29,14 +29,14 @@ For the Gnome Keyring install the [packages](/wiki/linux/package_manager.md) `li
`gnome-keyring`. `gnome-keyring`.
The name may differ slightly depending on the [package manager](/wiki/linux/package_manager.md) The name may differ slightly depending on the [package manager](/wiki/linux/package_manager.md)
used. used.
Afterwards make sure to run the service and enable it if not already done. Afterward, make sure to run the service and enable it if not already done.
An example for this is shown in the following command An example for this is shown in the following command
```sh ```sh
eval $(/usr/bin/gnome-keyring-daemon --start) eval $(/usr/bin/gnome-keyring-daemon --start)
``` ```
Finally the Electron app `<electron-app>` can be started. Finally, the Electron app `<electron-app>` can be started.
For the secure credential storage to be reachable the environment variable `XDG_CURRENT_DESKTOP` For the secure credential storage to be reachable the environment variable `XDG_CURRENT_DESKTOP`
has to be set. has to be set.
Due to this environment variable being possibly relevant for the system-wide settings it is Due to this environment variable being possibly relevant for the system-wide settings it is

View File

@@ -1,11 +1,10 @@
# Citra # Citra
[Citra](https://citra-emu.org/) is a [Nintendo 3DS](/wiki/game.md) [Citra](https://citra-emu.org/) is a [Nintendo 3DS](/wiki/game.md) [emulator](/wiki/emulator.md).
[emulator](/wiki/emulator.md).
## Setup ## Setup
Citra can be installed on different systems, a list for this can be found on Citra can be installed on different systems, a list for this can be found on the
the [Citra website](https://citra-emu.org/download). [Citra website](https://citra-emu.org/download).
Additionally it can be installed using [Flatpak](/wiki/linux/flatpak.md) where the Additionally, it can be installed using [Flatpak](/wiki/linux/flatpak.md) where the package is
package is called `org.citra_emu.citra`. called `org.citra_emu.citra`.

View File

@@ -7,7 +7,7 @@
Dolphin can be installed on different systems, a list for this can be found on Dolphin can be installed on different systems, a list for this can be found on
the [Dolphin website](https://dolphin-emu.org/download/). the [Dolphin website](https://dolphin-emu.org/download/).
Additionally it can be installed using [Flatpak](/wiki/linux/flatpak.md) where the Additionally, it can be installed using [Flatpak](/wiki/linux/flatpak.md) where the
package is called `org.DolphinEmu.dolphin-emu`. package is called `org.DolphinEmu.dolphin-emu`.
## Usage ## Usage

View File

@@ -5,10 +5,10 @@
## Setup ## Setup
melonDS can be installed on different systems, a list for this can be found on melonDS can be installed on different systems, a list for this can be found on the
the [melonDS website](https://melonds.kuribo64.net/downloads.php). [melonDS website](https://melonds.kuribo64.net/downloads.php).
Additionally it can be installed using [Flatpak](/wiki/linux/flatpak.md) where the Additionally, it can be installed using [Flatpak](/wiki/linux/flatpak.md) where the package is
package is called `net.kuribo64.melonDS`. called `net.kuribo64.melonDS`.
## Usage ## Usage
@@ -17,8 +17,8 @@ and usage of Dolphin.
### Start Emulated Game in Fullscreen Mode ### Start Emulated Game in Fullscreen Mode
In different scenarios it can be useful to start directly into a game in fullscreen mode. In different scenarios it can be useful to start directly into a game in full screen mode.
One example would be using the [Steam Deck](/wiki/game/steam_deck.md) to One example would be using the [Steam Deck](/wiki/game/steam_deck.md) to
[set up a game in the Steam UI](/wiki/game/steam_deck.md#running-a-game-directly-through-the-interface) [set up a game in the Steam UI](/wiki/game/steam_deck.md#running-a-game-directly-through-the-interface)
so it can be run directly without switching to the desktop mode. so it can be run directly without switching to the desktop mode.
For this add the `-f` flag for fullscreen mode. For this add the `-f` flag for full screen mode.

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