mirror of
				https://github.com/tiyn/wiki.git
				synced 2025-10-31 02:11:15 +01:00 
			
		
		
		
	Compare commits
	
		
			291 Commits
		
	
	
		
			612939f846
			...
			master
		
	
	| Author | SHA1 | Date | |
|---|---|---|---|
|  | 6afc9f57ca | ||
|  | 7b7bd7eb45 | ||
|  | 74352a8ea9 | ||
|  | d2897b2acd | ||
|  | 0999571c2c | ||
|  | 9bbc54cadf | ||
|  | 6325b9e1f8 | ||
|  | cf4d915b61 | ||
|  | b30fddb886 | ||
|  | 77020a5fae | ||
|  | 7934fbbd0c | ||
|  | ba4ec1ad29 | ||
|  | b7a59dfa72 | ||
|  | 896bf3505f | ||
|  | c6f2ca92df | ||
|  | e4c8d22266 | ||
|  | a8c4167fcf | ||
|  | ad4b4fb1c6 | ||
|  | c411dbab05 | ||
|  | 8142f3894f | ||
|  | 402e23d8c6 | ||
|  | 6d14cd78e1 | ||
|  | cb7f284264 | ||
|  | b09fa8353f | ||
|  | 5a12bae277 | ||
|  | 859a48cc91 | ||
| 4e66c061ed | |||
| 05bebbc5c9 | |||
|  | efedc006ea | ||
|  | 911a4c596c | ||
|  | 474d8426e5 | ||
|  | 4a08d33ed0 | ||
|  | f376e81497 | ||
|  | f7f2b995ea | ||
|  | 069ea7682c | ||
|  | b3cdc0b077 | ||
|  | c6940b4f6c | ||
|  | 958afd5de5 | ||
|  | 3f7ff001b7 | ||
|  | 712d002e6d | ||
|  | 0eab8be04e | ||
|  | 008233103a | ||
|  | 97eeb692b8 | ||
|  | a1dc4dc91e | ||
|  | c1a67669c4 | ||
|  | 1306db027d | ||
|  | e139b739ad | ||
|  | 0222175ef0 | ||
|  | 4f4b9e8c73 | ||
| 8749538670 | |||
| c1297a66a8 | |||
|  | 570dbbdd70 | ||
|  | 0687fdd2a0 | ||
|  | 4451eb9b3c | ||
|  | b306eb9df4 | ||
|  | acd39ea5c5 | ||
|  | 36b6399b40 | ||
|  | fd5e45fd7e | ||
|  | 20f403a0d2 | ||
|  | 7f53b56b90 | ||
|  | c23a46a6cf | ||
|  | 97d8e4b744 | ||
|  | aa3bc74f1d | ||
|  | 7361fd9330 | ||
|  | 55bf7387f0 | ||
|  | 3ecd487d85 | ||
|  | ca2af83639 | ||
|  | cac6b61b76 | ||
|  | 303c42eca5 | ||
|  | 56e648d7a9 | ||
|  | 161170abcf | ||
|  | 7476364f83 | ||
|  | c0e3170619 | ||
| 50cdd1680a | |||
| 6e2e8e51c2 | |||
| 3df955ddc1 | |||
| 66d420d49a | |||
|  | 561f59758b | ||
|  | c245c0e8b0 | ||
|  | 6d766d8974 | ||
|  | f37225f272 | ||
|  | 5b0ae30f88 | ||
|  | a595de964f | ||
|  | 111c3c829e | ||
|  | 26a4516652 | ||
|  | a3d1515e3f | ||
|  | ff693d65e8 | ||
|  | 8404e863a4 | ||
|  | 80f8c8f5ab | ||
|  | 778efabe6c | ||
|  | aa314c3352 | ||
|  | 4405c3da1e | ||
|  | 8ca2cd546f | ||
|  | ffb07d7614 | ||
|  | 2f832b86f2 | ||
|  | 8496769af6 | ||
|  | d451970107 | ||
| a6817f9a52 | |||
|  | ed4267a976 | ||
|  | c3f19f3356 | ||
| 8865c1df47 | |||
| bf28675931 | |||
| 3bd6dcd9a6 | |||
|  | dfb57a4b21 | ||
|  | 555deee780 | ||
|  | a0d4534a17 | ||
|  | 52c43e3ed3 | ||
|  | c400e70e02 | ||
|  | 3f5ccc92cb | ||
|  | 7e82d177f9 | ||
|  | ea13ef3afa | ||
|  | d1269ac658 | ||
|  | 318a9e4269 | ||
|  | c3c37929a8 | ||
|  | d0aa1faeec | ||
|  | a97f3a6bab | ||
|  | 6457d0849f | ||
|  | 725e2e380c | ||
|  | 8cb32856e2 | ||
|  | 2c0bc5f3dc | ||
|  | 06fe905af0 | ||
|  | 2918173ee0 | ||
|  | aa2ff10a02 | ||
|  | 8e5a24fe8c | ||
|  | e0bbb76598 | ||
|  | 2f4f6e6028 | ||
|  | 8f6512e921 | ||
| d7c2062047 | |||
|  | e88420ae6d | ||
|  | e5d89f1a8c | ||
|  | bb61042d31 | ||
| 29a2e08c74 | |||
|  | f82b99d4aa | ||
|  | f6ebee5187 | ||
|  | c4c592b84c | ||
|  | 95bb67a9e7 | ||
|  | afdcc39018 | ||
|  | a395b7a03e | ||
| 0a1a76d11e | |||
| e3681e1e47 | |||
| 931258888d | |||
|  | aa1e073119 | ||
|  | 3914097907 | ||
|  | 694a183300 | ||
|  | 269c6abbc5 | ||
|  | 967e9b1a92 | ||
|  | 412df39a9c | ||
|  | d8f6708da4 | ||
|  | b21e63554e | ||
|  | ab0e2f9349 | ||
|  | caf0b2214c | ||
|  | 607f3806b9 | ||
|  | 0f550650f6 | ||
|  | f50c9d991b | ||
|  | 257ce8a96a | ||
|  | 366a48e16e | ||
|  | 2e8301c9aa | ||
| 01c7dc67df | |||
| b0af0949d2 | |||
|  | 033ad68dfb | ||
|  | ecfbf58d04 | ||
|  | 6ddc5199a1 | ||
| f1d1c6928e | |||
| 1dafedcaee | |||
|  | 8faf4bc4ec | ||
|  | d94a6b9b7e | ||
|  | ef494d8fb7 | ||
| ea535b4d2c | |||
| 097b53bd6b | |||
|  | f97a75958e | ||
|  | 2690f17685 | ||
| f07b498bdd | |||
| da89126cc1 | |||
| 34d76f654d | |||
| 609b775292 | |||
| f8b83cf92f | |||
| 027410d25e | |||
| b0c84c4d0c | |||
| e1a8ca627b | |||
| a98c02dce6 | |||
| c2bb757e5a | |||
| 669a4ac30f | |||
| a216cf3655 | |||
|  | 546b52e217 | ||
|  | 7297d3f2ce | ||
| ce5ec63719 | |||
| 05368b3ff9 | |||
| 3e50b3a85c | |||
| b100cd0e85 | |||
| 4b63f2948f | |||
| a211ec7829 | |||
| b56304d0c8 | |||
| 2cc2e087e5 | |||
| 8294e24a95 | |||
| cf97254a17 | |||
| c31d8df0fb | |||
| 330ffc916f | |||
| 950d9ae34e | |||
| ea5e3ba16a | |||
| 6681cabde9 | |||
| 3e15ea1df9 | |||
| 74bdf3994d | |||
| df5ddbb689 | |||
| 873ecd9f1b | |||
| a16be77412 | |||
| 6f897be6ea | |||
| c950cf3a71 | |||
| f4f52bcfb5 | |||
| b1f9377546 | |||
| 15da9e502c | |||
| d3cb2cdfd3 | |||
| 48d177e3c9 | |||
| af3b4a9d13 | |||
| bc3ae0cb2e | |||
| 625aa0b419 | |||
| 4caaa3a0a8 | |||
| 3feba9c3cf | |||
| 1abdc66ab0 | |||
| a791e45fbb | |||
| 83d7032ad7 | |||
| 0a078d6f2c | |||
| 112e420dec | |||
| 8de676286b | |||
| eb42952a78 | |||
| e5ffcc14f1 | |||
| 9f2045cd8c | |||
| bd71612aa5 | |||
| 1f57b8a880 | |||
| e1e5f84aaa | |||
| ca8868a5e8 | |||
| 429539617c | |||
| a84e7748c3 | |||
| 28486ed624 | |||
| e59df03559 | |||
| 730a0d312b | |||
| 295c33ddb4 | |||
| 54c479957c | |||
| cb8aecca0d | |||
| 49922719b7 | |||
| b4d08d5bfb | |||
| 0e16b687a7 | |||
| f45e412e41 | |||
| 3b2bcb3c33 | |||
| 38c6258439 | |||
| 985ae74260 | |||
| 5c15e7d311 | |||
| 6fba5d2a21 | |||
| 23a7f413f1 | |||
| adfeba84ea | |||
| cf8b1e99f5 | |||
| 5a95fd9849 | |||
| 7f7ec85cb5 | |||
| 27b1762069 | |||
| d7fd042a11 | |||
| 36189dbb0b | |||
| 7ae683eb6a | |||
| f39a94d5bf | |||
| 1449d9bed8 | |||
| 75233ea75d | |||
| 888f64e362 | |||
| dbfc1f88d5 | |||
| 4d16b07130 | |||
| a83aad451a | |||
| adddfc698b | |||
| b607f727bc | |||
| 95cbcdf66a | |||
| 2689df0bce | |||
| e64b880da1 | |||
| 1392b08f7b | |||
| 6d048759a2 | |||
| fdce5a4f52 | |||
| 6449503fcf | |||
| 3f7a160603 | |||
| 77f273bc66 | |||
| 3fadecd67a | |||
| 0090117a8e | |||
| f642f5f46a | |||
| ee4d9ac1ca | |||
| ac1e565e11 | |||
| 4432ba3477 | |||
| 3fa38b19e4 | |||
| a04883e67c | |||
| d161b848b3 | |||
| 674332e022 | |||
| 2acea089a4 | |||
| 04c82d8aff | |||
| a3b14731ea | |||
| ba9ff03504 | |||
| 1b40f8b360 | |||
| 29c1cb0d62 | |||
| 86e8b19be0 | 
							
								
								
									
										1
									
								
								.gitignore
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										1
									
								
								.gitignore
									
									
									
									
										vendored
									
									
										Normal file
									
								
							| @@ -0,0 +1 @@ | |||||||
|  | *.pdf | ||||||
							
								
								
									
										0
									
								
								templates/.gitkeep
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										0
									
								
								templates/.gitkeep
									
									
									
									
									
										Normal file
									
								
							
							
								
								
									
										14
									
								
								templates/android-program.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										14
									
								
								templates/android-program.md
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,14 @@ | |||||||
|  | # /name/ | ||||||
|  |  | ||||||
|  | [/name/]() is a /description. | ||||||
|  |  | ||||||
|  | ## Setup | ||||||
|  |  | ||||||
|  | On [Android](/wiki/android.md) /name/ is available on  | ||||||
|  | [F-Droid](/wiki/android/f-droid.md)/the [Google Play store](/wiki/android.md#app-store) in a | ||||||
|  | package called [/name/](). | ||||||
|  |  | ||||||
|  | ## Usage | ||||||
|  |  | ||||||
|  | This section addresses the usage of /name/. | ||||||
|  | /basic description for usage/ | ||||||
							
								
								
									
										61
									
								
								templates/docker-compose.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										61
									
								
								templates/docker-compose.md
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,61 @@ | |||||||
|  | # /maintainer/ - /name/ | ||||||
|  |  | ||||||
|  | This is a [Docker](/wiki/docker.md) container for a /service/ server. | ||||||
|  | The official container and documentation was made by | ||||||
|  | [/maintainer/](). | ||||||
|  | This docker-rebuild is made up by a `docker-compose.yml` file. | ||||||
|  | In addition to the main container you need to connect a | ||||||
|  | [/additional containers needed/]() to it. | ||||||
|  |  | ||||||
|  | ## Set-up | ||||||
|  |  | ||||||
|  | Create the files `rebuild.sh`, `.env` and `docker-compose.yml` at the same | ||||||
|  | place. | ||||||
|  | Change the settings according to your needs and run `./rebuild.sh` afterwards. | ||||||
|  |  | ||||||
|  | ### Environment-variables | ||||||
|  |  | ||||||
|  | Set the following variables in the `environment:` section. | ||||||
|  |  | ||||||
|  | | Name       | Usage         | Default | | ||||||
|  | | ---------- | ------------- | ------- | | ||||||
|  | | `/name/`   | /description/ |         | | ||||||
|  |  | ||||||
|  | <!-- ### Environment-variables --> | ||||||
|  | <!----> | ||||||
|  | <!-- The environment variables are set via the `.env` file and listed in the --> | ||||||
|  | <!-- [corresponding section](#env). --> | ||||||
|  | <!----> | ||||||
|  | ### Ports | ||||||
|  |  | ||||||
|  | Set the following ports in the `ports:` section. | ||||||
|  |  | ||||||
|  | | Container Port | Recommended outside port | Protocol  | Description   | | ||||||
|  | | -------------- | ------------------------ | --------- | ------------- | | ||||||
|  | | `/port/`       | `/port/`                 | /TCP/UDP/ | /description/ | | ||||||
|  |  | ||||||
|  | ### Volumes | ||||||
|  |  | ||||||
|  | Set the following volumes with the -v tag. | ||||||
|  |  | ||||||
|  | | Outside mount/volume name | Container mount | Description   | | ||||||
|  | | ------------------------- | --------------- | ------------- | | ||||||
|  | | `/volume name/`           | `/mount point/` | /description/ | | ||||||
|  |  | ||||||
|  | ### rebuild.sh | ||||||
|  |  | ||||||
|  | ```sh | ||||||
|  | #!/bin/sh | ||||||
|  | docker-compose down | ||||||
|  | docker-compose up -d | ||||||
|  | ``` | ||||||
|  |  | ||||||
|  | <!-- ### .env --> | ||||||
|  | <!----> | ||||||
|  | <!-- ```sh --> | ||||||
|  | <!-- ``` --> | ||||||
|  | <!----> | ||||||
|  | ### docker-compose.yml | ||||||
|  |  | ||||||
|  | ```yml | ||||||
|  | ``` | ||||||
							
								
								
									
										39
									
								
								templates/docker.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										39
									
								
								templates/docker.md
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,39 @@ | |||||||
|  | # /maintainer/ - /name/ | ||||||
|  |  | ||||||
|  | This is a [Docker](/wiki/docker.md) container for a /service/ server. | ||||||
|  | The official container and documentation was made by | ||||||
|  | [/maintainer/](). | ||||||
|  |  | ||||||
|  | ## Set-up | ||||||
|  |  | ||||||
|  | Create the file `rebuild.sh`. | ||||||
|  | Change the settings according to your needs and run `./rebuild.sh` afterwards. | ||||||
|  |  | ||||||
|  | ## Environment-variables | ||||||
|  |  | ||||||
|  | Set the following variables with the -e tag. | ||||||
|  |  | ||||||
|  | | Name       | Usage         | Default | | ||||||
|  | | ---------- | ------------- | ------- | | ||||||
|  | | `/name/`   | /description/ |         | | ||||||
|  |  | ||||||
|  | ## Ports | ||||||
|  |  | ||||||
|  | Set the following ports in the `ports:` section. | ||||||
|  |  | ||||||
|  | | Container Port | Recommended outside port | Protocol  | Description   | | ||||||
|  | | -------------- | ------------------------ | --------- | ------------- | | ||||||
|  | | `/port/`       | `/port/`                 | /TCP/UDP/ | /description/ | | ||||||
|  |  | ||||||
|  | ## Volumes | ||||||
|  |  | ||||||
|  | Set the following volumes with the -v tag. | ||||||
|  |  | ||||||
|  | | Outside mount/volume name | Container mount | Description   | | ||||||
|  | | ------------------------- | --------------- | ------------- | | ||||||
|  | | `/volume name/`           | `/mount point/` | /description/ | | ||||||
|  |  | ||||||
|  | ## rebuild.sh | ||||||
|  |  | ||||||
|  | ```sh | ||||||
|  | ``` | ||||||
							
								
								
									
										19
									
								
								templates/program.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										19
									
								
								templates/program.md
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,19 @@ | |||||||
|  | # /name/ | ||||||
|  |  | ||||||
|  | [/name/]() is a /description. | ||||||
|  |  | ||||||
|  | ## Setup | ||||||
|  |  | ||||||
|  | The /name/ program can be installed from source as described [/on GitHub-the official website/](). | ||||||
|  | Alternatively many [Linux](/wiki/linux.md) [package managers](/wiki/linux/package_manager.md)  | ||||||
|  | package /name/ in the `/package/` package. | ||||||
|  | The software can be setup via [Docker](/wiki/docker.md) with the [/docker name/ image](). | ||||||
|  |  | ||||||
|  | ## Usage | ||||||
|  |  | ||||||
|  | This section addresses the usage of /name/. | ||||||
|  | /basic description for usage/ | ||||||
|  |  | ||||||
|  | ## Troubleshooting  | ||||||
|  |  | ||||||
|  | This section will focus on errors and the fixing of errors of /name/. | ||||||
							
								
								
									
										0
									
								
								wiki/.gitkeep
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										0
									
								
								wiki/.gitkeep
									
									
									
									
									
										Normal file
									
								
							
							
								
								
									
										13
									
								
								wiki/acer.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										13
									
								
								wiki/acer.md
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,13 @@ | |||||||
|  | # Acer | ||||||
|  |  | ||||||
|  | [Acer](https://www.acer.com) is a company that produces computers. | ||||||
|  |  | ||||||
|  | ## Troubleshooting  | ||||||
|  |  | ||||||
|  | This section focusses on vendor specific problems and ways how to fix them. | ||||||
|  |  | ||||||
|  | ### Recovering the BIOS Password  | ||||||
|  |  | ||||||
|  | Acer laptops usually feature a 8-digit BIOS password. | ||||||
|  | If it was lost it can easily be regenerated/recovered by using the website | ||||||
|  | [BIOSBug](https://www.biosbug.com/acer). | ||||||
| @@ -36,7 +36,8 @@ Log in with the clients now works correctly. | |||||||
|  |  | ||||||
| It is possible to use many different clients because the server is compatible | It is possible to use many different clients because the server is compatible | ||||||
| with all the Subsonic clients. | with all the Subsonic clients. | ||||||
| These can be found in the [Subsonic entry](./subsonic.md#clients). | These can be found in the [Subsonic entry](./subsonic.md#clients) and the [Airsonic | ||||||
|  | entry](/wiki/airsonic.md#clients). | ||||||
|  |  | ||||||
| ## Scrobbling with Last.fm | ## Scrobbling with Last.fm | ||||||
|  |  | ||||||
|   | |||||||
| @@ -17,3 +17,6 @@ The software can be setup via [Docker](/wiki/docker.md) with the | |||||||
| It is possible to use many different clients because the server is compatible | It is possible to use many different clients because the server is compatible | ||||||
| with all the Subsonic clients. | with all the Subsonic clients. | ||||||
| These can be found in the [Subsonic entry](./subsonic.md#clients). | These can be found in the [Subsonic entry](./subsonic.md#clients). | ||||||
|  |  | ||||||
|  | Additionally to these clients there is an improved web user interface made by tamland called | ||||||
|  | [airsonic-refix](https://github.com/tamland/airsonic-refix). | ||||||
|   | |||||||
							
								
								
									
										115
									
								
								wiki/android.md
									
									
									
									
									
								
							
							
						
						
									
										115
									
								
								wiki/android.md
									
									
									
									
									
								
							| @@ -4,12 +4,82 @@ | |||||||
| [Linux](/wiki/linux.md) kernel. | [Linux](/wiki/linux.md) kernel. | ||||||
| It is designed primarily for mobile devices with touch screens like tablets or smart phones. | It is designed primarily for mobile devices with touch screens like tablets or smart phones. | ||||||
|  |  | ||||||
|  | ## Managing the Data | ||||||
|  |  | ||||||
|  | The data and files stored on Android | ||||||
|  | [smart devices](/wiki/smart_device.md#smartphones-and-tablet-computers) are sometimes needed on | ||||||
|  | computers. | ||||||
|  |  | ||||||
|  | For [Windows](/wiki/windows.md) this can easily be achieved by connecting it via USB. | ||||||
|  | No further software is needed as the device manager handles the phone correctly most of the times. | ||||||
|  |  | ||||||
|  | For [Linux-based systems](/wiki/linux.md) the | ||||||
|  | [device](/wiki/smart_device.md#smartphones-and-tablet-computers) also has to be connected to the | ||||||
|  | computer. | ||||||
|  | But in this case also a software is needed to [mount it](/wiki/linux/disk-management.md#mounting), | ||||||
|  | this software/program is called [android-file-transfer](/wiki/linux/android-file-transfer.md). | ||||||
|  | For further information and a guide on how to mount a Android device correctly navigate to the | ||||||
|  | [corresponding section](/wiki/linux/android-file-transfer.md#mounting-and-unmounting-android-device). | ||||||
|  |  | ||||||
| ## App Store | ## App Store | ||||||
|  |  | ||||||
| The most used app store of android is the [Google Play Store](https://play.google.com/). | The most used app store of android is the [Google Play Store](https://play.google.com/). | ||||||
| A free and open-source alternative to it is [F-Droid](/wiki/android/f-droid.md) which only features | A free and open-source alternative to it is [F-Droid](/wiki/android/f-droid.md) which only features | ||||||
| open-source software. | open-source software. | ||||||
|  |  | ||||||
|  | A list of open-source software options is also available on Alberto Mosconis | ||||||
|  | [Github](/wiki/git_%28general%29.md#server-with-web-interface) repository | ||||||
|  | [foss apps](https://github.com/albertomosconi/foss-apps/tree/main). | ||||||
|  |  | ||||||
|  | Additionally open-source apps can be installed from source using | ||||||
|  | [Obtainium](https://github.com/ImranR98/Obtainium). | ||||||
|  |  | ||||||
|  | ### Useful Applications | ||||||
|  |  | ||||||
|  | This section addresses various useful applications. | ||||||
|  |  | ||||||
|  | - [Arcticons](https://github.com/Donnnno/Arcticons) a mono-color line-based icon pack | ||||||
|  | - [disky](https://github.com/newhinton/disky) is a filesystem analyzer that shows usage of the | ||||||
|  |   storage. | ||||||
|  | - [Markor](https://github.com/gsantner/markor) is a text editor supporting | ||||||
|  |   [Markdown](/wiki/markup_language.md) | ||||||
|  | - [SystemUI Tuner](https://play.google.com/store/apps/details?id=com.zacharee1.systemuituner) is an | ||||||
|  |   application that allows various small tweaks for the Android user interface. | ||||||
|  | - [SimpleMarkdown](https://f-droid.org/packages/com.wbrawner.simplemarkdown.free/) is another text | ||||||
|  |   editor made for Markdown. It does work a bit better with a [NextCloud](/wiki/nextcloud.md). | ||||||
|  | - [Fossify](https://github.com/FossifyOrg) is a suite of open-source apps that among other include | ||||||
|  |   apps like calendar, file-manager, phone, messages and more. | ||||||
|  |  | ||||||
|  | ## Improve Security and Privacy | ||||||
|  |  | ||||||
|  | Security and privacy are important topics, especially so when dealing with mobile phones. | ||||||
|  | This section focusses on improving them on a standard Android system. | ||||||
|  |  | ||||||
|  | The Elecronic Frontier Foundation recommends the following changes in their guide  | ||||||
|  | [Guide](https://ssd.eff.org/module/how-to-get-to-know-android-privacy-and-security-settings). | ||||||
|  |  | ||||||
|  | - [2FA](#multi-factor-authentication) | ||||||
|  | - A strong password (though the usage of biometrics is not recommended due to the possibility of | ||||||
|  |   being physically forced to unlock a phone with them) | ||||||
|  | - Privacy permission | ||||||
|  | - Find my device | ||||||
|  | - Theft protection | ||||||
|  | - Google privacy checkup | ||||||
|  | - Backups (though the usage of them gives data to Google, so it may rather be turned off) | ||||||
|  | - Disable WEP networks | ||||||
|  | - Obscure lockscreen notifications | ||||||
|  |  | ||||||
|  | The YouTube Channel 9to5Google also has a  | ||||||
|  | [video on security and privcacy](https://www.youtube.com/watch?v=eswIeNxSIqo) which additionally | ||||||
|  | suggest the following changes. | ||||||
|  |  | ||||||
|  | - Alert when clipboard is accessed | ||||||
|  | - Enable app pinnig | ||||||
|  |  | ||||||
|  | Another option to add which may not improve security or privacy but improves usability - especially | ||||||
|  | if a difficult passphrase is used - is the enabling of "Extend Unlock". | ||||||
|  | There "Trusted Devices" can be set or the "On-body Detection" can be enabled. | ||||||
|  |  | ||||||
| ## Multi-Factor Authentication | ## Multi-Factor Authentication | ||||||
|  |  | ||||||
| [Multi-factor authentication](/wiki/multi-factor_authentication.md) can easily be set up on android | [Multi-factor authentication](/wiki/multi-factor_authentication.md) can easily be set up on android | ||||||
| @@ -21,3 +91,48 @@ This app is available at [F-Droid](/wiki/android/f-droid.md) as | |||||||
| [FreeOTP+](https://f-droid.org/de/packages/org.liberty.android.freeotpplus/) and on | [FreeOTP+](https://f-droid.org/de/packages/org.liberty.android.freeotpplus/) and on | ||||||
| [Google Play Store](#app-store) by the | [Google Play Store](#app-store) by the | ||||||
| [same name](https://f-droid.org/de/packages/org.liberty.android.freeotpplus/). | [same name](https://f-droid.org/de/packages/org.liberty.android.freeotpplus/). | ||||||
|  |  | ||||||
|  | ## Custom ROMs | ||||||
|  |  | ||||||
|  | Besites the stock-firmware of vendors there are also custom ROMs. | ||||||
|  | These are alternative firmware variants made by third party providers. | ||||||
|  | A well known custom ROM is [LineageOS](/wiki/android/lineageos.md). | ||||||
|  |  | ||||||
|  | It is possible that some custom ROMs require the user to | ||||||
|  | [unlock the bootloader](#unlocking-the-bootloader) before the installation can happen. | ||||||
|  |  | ||||||
|  | ## Unlocking the Bootloader | ||||||
|  |  | ||||||
|  | Unlocking the bootloader can be a bit challenging for some vendors especially. | ||||||
|  |  | ||||||
|  | For [smartphones and tablets](/wiki/smart_device.md#smartphones-and-tablet-computers) made by | ||||||
|  | Xiaomi there are some steps that have to be done to unlock the bootloader. | ||||||
|  | This section is based on an | ||||||
|  | [article about unlocking the bootloader](https://new.c.mi.com/global/post/101245) on Xiaomi | ||||||
|  | Community aswell as another | ||||||
|  | [article on specifics for HyperOS](https://xiaomiui.net/how-unlock-bootloader-xiaomi-hyperos-53493/). | ||||||
|  | First the user has to apply to unlock the bootloader. | ||||||
|  | For this open the Xiaomi Community app, navigate to the "Settings" and select "Change region". | ||||||
|  | Select the region "Global". | ||||||
|  | A new option called "Unlock bootloader" now appears in the settings. | ||||||
|  | Select "Unlock bootloader" and "Apply for unlocking". | ||||||
|  | It may be possible that a specified time has to be waited for the application process to happen. | ||||||
|  | Next go to the phones settings. | ||||||
|  | Navigate to "About Phone" and "MIUI Version", repeatedly tap on "MIUI version" to get into | ||||||
|  | developer mode if the phone is not already in developer mode. | ||||||
|  | Navigate to "Additional settings" and "Developer options". | ||||||
|  | Enable "OEM unlocking" and "USB debugging". | ||||||
|  | Now add your Xiaomi account to your device. | ||||||
|  | To do so navigate to "Mi Unlock status" and agree then "Add account and device". | ||||||
|  | Shutdown your phone and boot into "Fastboot" by holding down the volume down button and the power | ||||||
|  | button. | ||||||
|  | Then connect it to a computer via USB. | ||||||
|  | The following steps have to take place on a [Windows](/wiki/windows.md) system or an emulation or | ||||||
|  | virtualization of it. | ||||||
|  | Download and start "Mi Unlock" - it is available on the | ||||||
|  | [article mentioned prior in this section](https://new.c.mi.com/global/post/101245). | ||||||
|  | Follow the steps of the software, select "Unlock" and confirm it multiple times. | ||||||
|  | It is possible that now 72 hours have to pass for the unlocking process to continue. | ||||||
|  | If that is the case wait the specified amount of time and repeat the last step. | ||||||
|  | Make sure to not apply for unlocking again and do not add your account to your phone again as this | ||||||
|  | will reset the timer. | ||||||
|   | |||||||
| @@ -2,7 +2,7 @@ | |||||||
|  |  | ||||||
| [DroidCam](https://www.dev47apps.com/) is an App developed and published | [DroidCam](https://www.dev47apps.com/) is an App developed and published | ||||||
| by Dev47Apps for [Android](/wiki/android.md) systems. | by Dev47Apps for [Android](/wiki/android.md) systems. | ||||||
| It enables a [smartphone](/wiki/smart_devices.md) to be used as [webcam](/wiki/webcams.md). | It enables a [smartphone](/wiki/smart_device.md) to be used as [webcam](/wiki/webcam.md). | ||||||
|  |  | ||||||
| ## Setup | ## Setup | ||||||
|  |  | ||||||
| @@ -19,7 +19,7 @@ Alternatively most [Linux systems](/wiki/linux/package_manager.md) feature a pac | |||||||
|  |  | ||||||
| ## Usage | ## Usage | ||||||
|  |  | ||||||
| To initiate a connection between the [smartphone](/wiki/smart_devices.md) and the computer first | To initiate a connection between the [smartphone](/wiki/smart_device.md) and the computer first | ||||||
| start the app on the smartphone. | start the app on the smartphone. | ||||||
| Make sure to be connected to the same W-LAN as the computer or alternatively connect them with an | Make sure to be connected to the same W-LAN as the computer or alternatively connect them with an | ||||||
| USB-cable. | USB-cable. | ||||||
| @@ -27,7 +27,7 @@ After starting the application an IP and a port will be displayed. | |||||||
| These have to be pasted into the form that is shown on the computer after starting the corresponding | These have to be pasted into the form that is shown on the computer after starting the corresponding | ||||||
| program. | program. | ||||||
| After pressing `Connect` the link will be established. | After pressing `Connect` the link will be established. | ||||||
| The [video feed](/wiki/webcams.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 | ||||||
|   | |||||||
| @@ -3,8 +3,8 @@ | |||||||
| [Gadgetbridge](https://codeberg.org/Freeyourgadget/Gadgetbridge/) is a free and open source software | [Gadgetbridge](https://codeberg.org/Freeyourgadget/Gadgetbridge/) is a free and open source software | ||||||
| for [Android](/wiki/android.md) systems. | for [Android](/wiki/android.md) systems. | ||||||
| It is a cloudless replacement for proprietary software for | It is a cloudless replacement for proprietary software for | ||||||
| [smart devices](/wiki/smart_devices.md), but is especially designed for | [smart devices](/wiki/smart_device.md), but is especially designed for | ||||||
| [smartwatches and smart bands](/wiki/smart_devices.md#smartwatches-and-smart-bands). | [smartwatches and smart bands](/wiki/smart_device.md#smartwatches-and-smart-bands). | ||||||
|  |  | ||||||
| ## Setup | ## Setup | ||||||
|  |  | ||||||
| @@ -42,16 +42,25 @@ Afterwards the device will be paired and connected. | |||||||
| ### Add Weather Function | ### Add Weather Function | ||||||
|  |  | ||||||
| For correct displaying of weather data an additional app is needed. | For correct displaying of weather data an additional app is needed. | ||||||
| An example for this is the | This section is based on the official documentation and recommendation that can be found on | ||||||
| [Weather notification app](https://f-droid.org/en/packages/ru.gelin.android.weather.notification/). | [Gadgetbridges Codeberg page](https://codeberg.org/Freeyourgadget/Gadgetbridge/wiki/Weather#user-content-install-and-configure-openweatherprovider). | ||||||
| Install it, check the Gadgetbridge option inside the Weather notification app to on and set the |  | ||||||
| location. | An example for this is the [Breezy Weather app](https://github.com/breezy-weather/breezy-weather) | ||||||
| Finally create an account at [OpenWeather](https://home.openweathermap.org). | which is available on the F-Droid store. | ||||||
| On that website create an API key and paste it into the according setting in the Weather | Install and configure it to your needs. | ||||||
| notification app. | Then check the Gadgetbridge option insdie the Breezy Weather app. | ||||||
| Finally set the desired location in the Gadgetbridge app inside the settings. |  | ||||||
| Afterwards the weather function will be working. | Afterwards the weather function will be working. | ||||||
|  |  | ||||||
|  | In the past an application named | ||||||
|  | [Weather Notification](https://f-droid.org/en/packages/ru.gelin.android.weather.notification/) | ||||||
|  | was often used. | ||||||
|  | The installation and configuration process was similar but an | ||||||
|  | [OpenWeather](https://home.openweathermap.org)  API key had to be specified in the Weather | ||||||
|  | Notification app. | ||||||
|  | For this an account on [OpenWeather](https://home.openweathermap.org) was needed. | ||||||
|  | Due to different API versions Weather Notification currently does not work. | ||||||
|  | However it is possible that an update to the application will bring a fix in the future. | ||||||
|  |  | ||||||
| ### Install Watchfaces | ### Install Watchfaces | ||||||
|  |  | ||||||
| Watchfaces can be installed by using Gadgetbridges `File Installer` option that is available in the | Watchfaces can be installed by using Gadgetbridges `File Installer` option that is available in the | ||||||
| @@ -60,3 +69,13 @@ Watchface files for Xiaomi/Amazfit devices can be downloaded on | |||||||
| [amazfitwatchfaces.com](https://amazfitwatchfaces.com/). | [amazfitwatchfaces.com](https://amazfitwatchfaces.com/). | ||||||
| The same catalog is also available as an | The same catalog is also available as an | ||||||
| [Android app on the Google Play Store](https://play.google.com/store/apps/details?id=com.amazfitwatchfaces.st). | [Android app on the Google Play Store](https://play.google.com/store/apps/details?id=com.amazfitwatchfaces.st). | ||||||
|  |  | ||||||
|  | This section is based on a  | ||||||
|  | [Reddit post by myhairisawesome](https://www.reddit.com/r/Huawei/comments/1dexenl/watch_fit_3_is_there_a_way_to_create_custom_watch/). | ||||||
|  |  | ||||||
|  | ### Download Maps | ||||||
|  |  | ||||||
|  | To download one or more map files to display them for activity GPS data on the mobile phone | ||||||
|  | navigate to the main `Settings`. | ||||||
|  | Then Select `Maps` and set the `Folder` aswell as download the map and move it into the selected | ||||||
|  | folder. | ||||||
|   | |||||||
| @@ -2,7 +2,10 @@ | |||||||
|  |  | ||||||
| [IP Webcam](https://play.google.com/store/apps/details?id=com.pas.webcam&hl=de&gl=US) is an App | [IP Webcam](https://play.google.com/store/apps/details?id=com.pas.webcam&hl=de&gl=US) is an App | ||||||
| developed and published by Pavel Khlebovich for [Android](/wiki/android.md) systems. | developed and published by Pavel Khlebovich for [Android](/wiki/android.md) systems. | ||||||
| It enables a [smartphone](/wiki/smart_devices.md) to be used as [webcam](/wiki/webcams.md). | It enables a [smartphone](/wiki/smart_device.md) to be used as [webcam](/wiki/webcam.md). | ||||||
|  |  | ||||||
|  | When wanting to stream the screen and not the camera the application | ||||||
|  | [ScreenStream](/wiki/android/screenstream.md) can be used. | ||||||
|  |  | ||||||
| ## Setup | ## Setup | ||||||
|  |  | ||||||
| @@ -12,7 +15,7 @@ On [Android](/wiki/android.md) IP Webcam is available on the | |||||||
|  |  | ||||||
| ## Usage | ## Usage | ||||||
|  |  | ||||||
| To initiate a connection between the [smartphone](/wiki/smart_devices.md) and the computer first | To initiate a connection between the [smartphone](/wiki/smart_device.md) and the computer first | ||||||
| start the app on the smartphone. | start the app on the smartphone. | ||||||
| Make sure to be connected to the same W-LAN as the computer or alternatively connect them with an | Make sure to be connected to the same W-LAN as the computer or alternatively connect them with an | ||||||
| USB-cable. | USB-cable. | ||||||
|   | |||||||
							
								
								
									
										20
									
								
								wiki/android/ir_remote.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										20
									
								
								wiki/android/ir_remote.md
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,20 @@ | |||||||
|  | # IR Remote | ||||||
|  |  | ||||||
|  | [IR Remote](https://gitlab.com/divested-mobile/irremote) is a free and open-source App developed | ||||||
|  | for [Android](/wiki/android.md) systems. | ||||||
|  | It can use a [smartphone](/wiki/smart_device.md#smartphones-and-tablet-computers) that is capable | ||||||
|  | of sending [infrared](/wiki/infrared.md) signals to be used as an | ||||||
|  | [infrared remote control](/wiki/infrared.md#remote-controls) | ||||||
|  |  | ||||||
|  | ## Setup | ||||||
|  |  | ||||||
|  | On [Android](/wiki/android.md) IR Remote is available on the | ||||||
|  | [F-Droid app store](/wiki/android/f-droid.md) in a package called | ||||||
|  | [IR Remote](https://f-droid.org/de/packages/us.spotco.ir_remote/). | ||||||
|  |  | ||||||
|  | ## Usage | ||||||
|  |  | ||||||
|  | IR Remote features many preset remote controls for devices of major brands. | ||||||
|  | For devices not included in these presets the infrared codes can be searched on the web. | ||||||
|  | The [infrared article](/wiki/infrared.md) features a | ||||||
|  | [list of available resources](/wiki/infrared.md#remote-controls). | ||||||
							
								
								
									
										13
									
								
								wiki/android/launcher.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										13
									
								
								wiki/android/launcher.md
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,13 @@ | |||||||
|  | # Launcher | ||||||
|  |  | ||||||
|  | A launcher is the software that controls the home screen and app drawer on an | ||||||
|  | [Android](/wiki/android.md) phone. | ||||||
|  |  | ||||||
|  | ## Software Options | ||||||
|  |  | ||||||
|  | This section lists various possible launchers. | ||||||
|  |  | ||||||
|  | - [Kvaesitso](https://kvaesitso.mm20.de/) is a free and open-source launcher. | ||||||
|  |   It is available on [F-Droid](/wiki/android/f-droid.md) from its | ||||||
|  |   [repository](https://f-droid.org/de/packages/de.mm20.launcher2.release/). | ||||||
|  |   It focusses on a search but also has the option to label apps with tags. | ||||||
							
								
								
									
										22
									
								
								wiki/android/lineageos.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										22
									
								
								wiki/android/lineageos.md
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,22 @@ | |||||||
|  | # LineageOS | ||||||
|  |  | ||||||
|  | [LineageOS](https://lineageos.org/) - or short Lineage - is a custom | ||||||
|  | [Android](/wiki/android.md)-ROM and operating system for | ||||||
|  | [Smartphones and Tablets](/wiki/smart_device.md#smartphones-and-tablet-computers) with mostly free | ||||||
|  | and open-source software. | ||||||
|  | It was formerly known as CyanogenMod. | ||||||
|  |  | ||||||
|  | ## Compatible Devices and Installation | ||||||
|  |  | ||||||
|  | Lineage is only available on specific devices that feature a maintained build of LineageOS. | ||||||
|  | A list of compatible devices sorted by vendor can be found on the | ||||||
|  | [official wiki](https://wiki.lineageos.org/devices/). | ||||||
|  |  | ||||||
|  | For installation navigate to the [official wiki](https://wiki.lineageos.org/devices/) and select | ||||||
|  | the device LineageOS should be installed on. | ||||||
|  | A guide will be available to help users in the process of installation. | ||||||
|  | The device page also features any build file needed for the setup. | ||||||
|  | If Google Services should be installed on the device close attention has to be payed in the guide | ||||||
|  | section called "Installing Add-Ons". | ||||||
|  | The Google Apps packages for Lineage can be downloaded from the | ||||||
|  | [corresponding wiki page](https://wiki.lineageos.org/gapps/). | ||||||
							
								
								
									
										13
									
								
								wiki/android/screenstream.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										13
									
								
								wiki/android/screenstream.md
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,13 @@ | |||||||
|  | # ScreenStream | ||||||
|  |  | ||||||
|  | [ScreenStream](https://f-droid.org/de/packages/info.dvkr.screenstream/) is an application that | ||||||
|  | allows to stream the screen via HTTP. | ||||||
|  |  | ||||||
|  | When wanting to stream the camera and not the screen the application | ||||||
|  | [IP Webcam](/wiki/android/ip_webcam.md) can be used. | ||||||
|  |  | ||||||
|  | ## Setup | ||||||
|  |  | ||||||
|  | On [Android](/wiki/android.md) ScreenStream is available on  | ||||||
|  | [F-Droid](/wiki/android/f-droid.md) in a package called | ||||||
|  | [ScreenStream](https://f-droid.org/de/packages/info.dvkr.screenstream/). | ||||||
							
								
								
									
										38
									
								
								wiki/android/tasker.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										38
									
								
								wiki/android/tasker.md
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,38 @@ | |||||||
|  | # Tasker | ||||||
|  |  | ||||||
|  | [Tasker](https://tasker.joaoapps.com/) is a tool to automate various settings and other things on | ||||||
|  | an [Android-phone](/wiki/android.md). | ||||||
|  |  | ||||||
|  | ## Setup | ||||||
|  |  | ||||||
|  | On [Android](/wiki/android.md) /name/ is available on the | ||||||
|  | [Google Play store](/wiki/android.md#app-store) in a package called | ||||||
|  | [Tasker](https://play.google.com/store/apps/details?id=net.dinglisch.android.taskerm). | ||||||
|  |  | ||||||
|  | Additionally the installation of [Tasker Settings](https://github.com/joaomgcd/TaskerSettings) is | ||||||
|  | recommended. | ||||||
|  | Please note that on the [Github releases page](https://github.com/joaomgcd/TaskerSettings/releases) | ||||||
|  | there are different versions to be used with Xiaomi-phones. | ||||||
|  |  | ||||||
|  | Another recommended action to be taken is to grant Tasker permission to write secure settings. | ||||||
|  | This has to be done for Tasker to be able to turn on or off Wifi and Location. | ||||||
|  | Allowing Tasker to set these settings can be done by the following command that has to be run on a | ||||||
|  | computer with the corresponding phone connected via USB and USB-debugging enabled. | ||||||
|  |  | ||||||
|  | ```sh | ||||||
|  | adb shell pm grant net.dinglisch.android.taskerm android.permission.WRITE_SECURE_SETTINGS | ||||||
|  | ``` | ||||||
|  |  | ||||||
|  | `adb` is also often used to install [LineageOS](/wiki/android/lineageos.md). | ||||||
|  |  | ||||||
|  | ## Usage | ||||||
|  |  | ||||||
|  | This section addresses the usage of Tasker. | ||||||
|  |  | ||||||
|  | On Tasker profiles, tasks and more can be manually added and edited. | ||||||
|  | An easier way to get things started is importing premade Tasker projects from | ||||||
|  | [TaskerNet](https://taskernet.com/?public). | ||||||
|  |  | ||||||
|  | Recommended TaskerNet-projects are the following. | ||||||
|  |  | ||||||
|  | - Flip To Shhh | ||||||
							
								
								
									
										133
									
								
								wiki/audio.md
									
									
									
									
									
								
							
							
						
						
									
										133
									
								
								wiki/audio.md
									
									
									
									
									
								
							| @@ -10,8 +10,67 @@ Podcasts need a so called Podcatcher. | |||||||
| A Podcatcher is used to subscribe to podcasts and download them automatically. | A Podcatcher is used to subscribe to podcasts and download them automatically. | ||||||
| For Linux specific music software navigate to the corresponding | For Linux specific music software navigate to the corresponding | ||||||
| [wiki entry](/wiki/linux/audio.md). | [wiki entry](/wiki/linux/audio.md). | ||||||
| For voice based communication navigate to the [Communication article](/wiki/communication.md) and | For voice based communication, social platforms or messengers navigate to the | ||||||
| the corresponding [VoIP section](/wiki/communication.md#voip). | [communication article](/wiki/communication.md) and the corresponding | ||||||
|  | [section](/wiki/communication.md#social-platforms-messengers-and-voip-services). | ||||||
|  | For headphones navigate to the [headphones article](/wiki/headphones.md): | ||||||
|  |  | ||||||
|  | ## Technical Specifications | ||||||
|  |  | ||||||
|  | This section aswell as its subsections address all technical things about audio, like connections, | ||||||
|  | cables and devices. | ||||||
|  | The most frequently used audio formats are also addressed. | ||||||
|  |  | ||||||
|  | ### Balanced & Unbalanced Audio | ||||||
|  |  | ||||||
|  | Unbalanced audio uses a wire for the positive signal for audio transmission and one for ground. | ||||||
|  | This is the most frequently used type of cable bound audio transmission. | ||||||
|  | Usually they are connected with jack connections like 3.5mm and 6.25mm. | ||||||
|  |  | ||||||
|  | Balanced audio uses one wire for the positive signal, one for negative and another one for the | ||||||
|  | ground. | ||||||
|  | Due to this extra cable a balanced connection can cancel out noise that entered the cable and | ||||||
|  | affected both the positive and the negative signal. | ||||||
|  | Balanced uses connectors like 4-pin XLR aswell as 2.5mm and 4.4mm jacks | ||||||
|  |  | ||||||
|  | ### Audio Formats and Encoding | ||||||
|  |  | ||||||
|  | An audio format is an encoding of an audio file. | ||||||
|  | There are lossy and lossless formats, the latter not compromising quality for | ||||||
|  | smaller file sizes. | ||||||
|  | Following is a list of often used formats: | ||||||
|  |  | ||||||
|  | - wav is an uncompressed lossless format | ||||||
|  | - aiff is an uncompressed lossless format | ||||||
|  | - [flac](./flac_(codec).md) is a compressed lossless format | ||||||
|  | - alac is a compressed lossless format | ||||||
|  | - ape is a compressed lossless format | ||||||
|  | - mp3 is a compressed lossy codec | ||||||
|  | - aac is a compressed lossy codec | ||||||
|  | - wma is a compressed lossy codec | ||||||
|  | - ac3 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. | ||||||
|  | Lossless formats can be converted from and to each other without loosing | ||||||
|  | information. | ||||||
|  | Lossless formats can also be converted to lossy formats to make the files | ||||||
|  | smaller and save space. | ||||||
|  | Files should not be converted to lossy formats more than once. | ||||||
|  | Additionally lossy formats should not be converted to lossless formats as it | ||||||
|  | increases the file size without adding any audio information. | ||||||
|  | These not recommended conversions are called bad conversions. | ||||||
|  |  | ||||||
|  | ### Cue Files | ||||||
|  |  | ||||||
|  | `.cue` files act as a table of contents for a CD rip. | ||||||
|  | These can be created when the | ||||||
|  | [audio of a CD is extracted](#extract-audio-files-from-cds). | ||||||
|  | Usually this appears together with a single file for the whole CD. | ||||||
|  | The audio file can then be split according to the `.cue` file. | ||||||
|  | For splitting of `.flac` files on a Linux system check the | ||||||
|  | [a flac (package) entry](/wiki/linux/flac_(package).md#splitting-flac-file-according-to-cue-file) | ||||||
|  | for further informations. | ||||||
|  |  | ||||||
| ## Media Software | ## Media Software | ||||||
|  |  | ||||||
| @@ -19,6 +78,14 @@ If you want to keep your system clean of much data, you can use this kind of | |||||||
| setup. | setup. | ||||||
| There are differences depending on your preffered software interface. | There are differences depending on your preffered software interface. | ||||||
|  |  | ||||||
|  | ### Digital Audio Workstations | ||||||
|  |  | ||||||
|  | Digital Audio Workstations - short DAWs - is an application that can be used to record, edit or | ||||||
|  | produce audio files. | ||||||
|  |  | ||||||
|  | - [LMMS](https://lmms.io/) is a free and cross-platform DAW that is highly compatible with | ||||||
|  |   [Linux-based systems](/wiki/linux.md). | ||||||
|  |  | ||||||
| ### Software for Music/Podcasts/Audiobooks | ### Software for Music/Podcasts/Audiobooks | ||||||
|  |  | ||||||
| The following is a list of server software, that is featured in this wiki. | The following is a list of server software, that is featured in this wiki. | ||||||
| @@ -40,37 +107,24 @@ The corresponding client software is handled in the server softwares wiki entry. | |||||||
|   It is self-hostable and can be dockerized. |   It is self-hostable and can be dockerized. | ||||||
|   It has a web-interface and does not feature client software. |   It has a web-interface and does not feature client software. | ||||||
|  |  | ||||||
| ## Audio Formats | #### Obtaining Audio Files from Different Services | ||||||
|  |  | ||||||
| An audio format is an encoding of an audio file. | [YouTube](/wiki/youtube.md) features a wide variety of uploaded music and audiobooks. | ||||||
| There are lossy and lossless formats, the latter not compromising quality for | Using programs like [yt-dl](/wiki/youtube.md#downloading-youtube-videos) they can be downloaded. | ||||||
| smaller file sizes. |  | ||||||
| Following is a list of often used formats: |  | ||||||
|  |  | ||||||
| - wav is an uncompressed lossless format | [Audible](https://www.audible.de/) is a popular service that makes sells audibooks. | ||||||
| - aiff is an uncompressed lossless format | After purchasing an audiobook it can be downloaded directly from Audible after navigating to the | ||||||
| - [flac](./flac_(codec).md) is a compressed lossless format | `Library` tab and selecting `Download`. | ||||||
| - alac is a compressed lossless format | Another option is to use [OpenAudible](/wiki/openaudible.md). | ||||||
| - ape is a compressed lossless format | This program features various functions to manage Audible audiobooks that include download, | ||||||
| - mp3 is a compressed lossy codec | converting and splitting. | ||||||
| - aac is a compressed lossy codec |  | ||||||
| - wma is a compressed lossy codec |  | ||||||
| - ac3 is a compressed lossy codec usually found in DVDs |  | ||||||
| - dts is a compressed lossy codec usually found in DVDs |  | ||||||
|  |  | ||||||
| ### Lossy and Lossless Formats and Their Conversion | ## Digitalizing and Analyzing Physical Mediums | ||||||
|  |  | ||||||
| Music files can either be encoded lossy or lossless. | This section focusses on physical audio mediums like CDs, their digitalization to a digital audio | ||||||
| Lossless formats can be converted from and to each other without loosing | file of [specific format](#audio-formats-and-encoding) and conversions between them. | ||||||
| information. |  | ||||||
| Lossless formats can also be converted to lossy formats to make the files |  | ||||||
| smaller and save space. |  | ||||||
| Files should not be converted to lossy formats more than once. |  | ||||||
| Additionally lossy formats should not be converted to lossless formats as it |  | ||||||
| increases the file size without adding any audio information. |  | ||||||
| These not recommended conversions are called bad conversions. |  | ||||||
|  |  | ||||||
| #### Detect Bad Conversions | ### Detect Bad Conversions | ||||||
|  |  | ||||||
| The bitrate, format and the sample rate can be usually checked with simple | The bitrate, format and the sample rate can be usually checked with simple | ||||||
| tools. | tools. | ||||||
| @@ -78,7 +132,7 @@ For Linux a simple software solution for this is the `file` command. | |||||||
| Running it will display these features of a given audio file. | Running it will display these features of a given audio file. | ||||||
| This will however only display the format features. | This will however only display the format features. | ||||||
| Bad convserions as described in | Bad convserions as described in | ||||||
| [the previous section](#lossy-and-lossless-formats-and-their-conversion) can not | [the previous section](#audio-formats-and-encoding) can not | ||||||
| be detected by this. | be detected by this. | ||||||
| A spectral analysis can detect bad conversions. | A spectral analysis can detect bad conversions. | ||||||
| For this a audio analyzer like | For this a audio analyzer like | ||||||
| @@ -91,7 +145,7 @@ If the frequency extends up to at least 22kHz the file is lossless for sure. | |||||||
| If the frequency is cut before and the file is encoded in a lossless file it has | If the frequency is cut before and the file is encoded in a lossless file it has | ||||||
| undergone a bad conversion and is not really lossless. | undergone a bad conversion and is not really lossless. | ||||||
|  |  | ||||||
| ## Extract Audio Files from CDs | ### Extract Audio Files from CDs | ||||||
|  |  | ||||||
| You can convert your CDs to files on your computer. | You can convert your CDs to files on your computer. | ||||||
| This way you don't have to search for your CDs all the time. | This way you don't have to search for your CDs all the time. | ||||||
| @@ -106,20 +160,20 @@ This way you don't have to search for your CDs all the time. | |||||||
| - [MusicBrainz Picard](./picard.md) for linux is a | - [MusicBrainz Picard](./picard.md) for linux is a | ||||||
|   graphical user interface for tagging files of many different formats. |   graphical user interface for tagging files of many different formats. | ||||||
|  |  | ||||||
| ## Analysis of Different Versions of an Album | ### Analysis of Different Versions of an Album | ||||||
|  |  | ||||||
| While deciding on what version of an album is the best visit | While deciding on what version of an album is the best visit | ||||||
| [Dynamic Range DB](https://dr.loudness-war.info). | [Dynamic Range DB](https://dr.loudness-war.info). | ||||||
| It shows dynamic range scorings of each version. | It shows dynamic range scorings of each version. | ||||||
|  |  | ||||||
| ## Get Additional Data to an Album/Single | ### Get Additional Data to an Album/Single | ||||||
|  |  | ||||||
| If additional information for an album is needed, visit | If additional information for an album is needed, visit | ||||||
| [Discogs](https://www.discogs.com). | [Discogs](https://www.discogs.com). | ||||||
| Discogs has tracklists, dates and more information to nearly all versions of | Discogs has tracklists, dates and more information to nearly all versions of | ||||||
| albums and singles. | albums and singles. | ||||||
|  |  | ||||||
| ## Naming Convention | ### Naming Convention | ||||||
|  |  | ||||||
| It is suggested to place the audio files in a directory named after the album they | It is suggested to place the audio files in a directory named after the album they | ||||||
| belong to. | belong to. | ||||||
| @@ -129,18 +183,7 @@ Files can be named in the following scheme: | |||||||
| - music: `[<discnumber>.]<tracknumber>._<artist>_-_<title>` | - music: `[<discnumber>.]<tracknumber>._<artist>_-_<title>` | ||||||
| - audiobooks: `[<discnumber>.]<tracknumber>._<artist>_-_<album>_<tracknumber>` | - audiobooks: `[<discnumber>.]<tracknumber>._<artist>_-_<album>_<tracknumber>` | ||||||
|  |  | ||||||
| ## Cue Files | ### Scoring Music | ||||||
|  |  | ||||||
| `.cue` files act as a table of contents for a CD rip. |  | ||||||
| These can be created when the |  | ||||||
| [audio of a CD is extracted](#extract-audio-files-from-cds). |  | ||||||
| Usually this appears together with a single file for the whole CD. |  | ||||||
| The audio file can then be split according to the `.cue` file. |  | ||||||
| For splitting of `.flac` files on a Linux system check the |  | ||||||
| [a flac (package) entry](/wiki/linux/flac_(package).md#splitting-flac-file-according-to-cue-file) |  | ||||||
| for further informations. |  | ||||||
|  |  | ||||||
| ## Scoring Music |  | ||||||
|  |  | ||||||
| Scoring music has moved more and more into the computer realm. | Scoring music has moved more and more into the computer realm. | ||||||
| An easy and intuitive software that can be used for this is | An easy and intuitive software that can be used for this is | ||||||
|   | |||||||
							
								
								
									
										86
									
								
								wiki/betterdiscord.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										86
									
								
								wiki/betterdiscord.md
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,86 @@ | |||||||
|  | # BetterDiscord | ||||||
|  |  | ||||||
|  | [BetterDiscord](https://betterdiscord.app) is an unofficial extension to | ||||||
|  | [Discord](/wiki/discord.md) which allows to add various functionality through plugins and new | ||||||
|  | themes. | ||||||
|  |  | ||||||
|  | ## Setup | ||||||
|  |  | ||||||
|  | BetterDiscord can be downloaded from [the official website](https://betterdiscord.app). | ||||||
|  |  | ||||||
|  | For [Linux-based systems](/wiki/linux.md) the tool | ||||||
|  | [betterdiscordctl](https://github.com/bb010g/betterdiscordctl) can be used. | ||||||
|  | After installing it the following commands have to be run for the stable version of Discord to be | ||||||
|  | converted to BetterDiscord. | ||||||
|  |  | ||||||
|  | ```sh | ||||||
|  | betterdiscordctl install | ||||||
|  | ``` | ||||||
|  |  | ||||||
|  | Afterwards BetterDiscord can be kept up to date with the following command. | ||||||
|  |  | ||||||
|  | ```sh | ||||||
|  | betterdiscordctl self-upgrade | ||||||
|  | ``` | ||||||
|  |  | ||||||
|  | ### Pacman Hook | ||||||
|  |  | ||||||
|  | When using [Arch Linux](/wiki/linux/arch-linux.md) and its package managers | ||||||
|  | [Pacman and Yay](/wiki/linux/package_manager.md#arch-linux-pacman-and-yay) a hook can be set that | ||||||
|  | automatically updates the discord installation to setup betterdiscord using betterdiscordctl. | ||||||
|  | The following is a [pacman hook](/wiki/linux/package_manager.md#hooks) that can be used to update | ||||||
|  | betterdiscord automatically. | ||||||
|  | Make sure to change the three occurences of `<username>` to the name of the user to install | ||||||
|  | betterdiscord for. | ||||||
|  |  | ||||||
|  | ```sh | ||||||
|  | [Trigger] | ||||||
|  | Type = Package | ||||||
|  | Operation = Install | ||||||
|  | Operation = Upgrade | ||||||
|  | Target = discord* | ||||||
|  |  | ||||||
|  | [Action] | ||||||
|  | Description = Rebuild BetterDiscord after Discord update | ||||||
|  | When = PostTransaction | ||||||
|  | Exec = /usr/bin/sh -c 'sudo -u <username> betterdiscordctl reinstall >/dev/null 2>&1; sudo -u <username> xvfb-run -a discord --help >/dev/null 2>&1; sudo -u <username> betterdiscordctl install >/dev/null 2>&1; true' | ||||||
|  | Depends = xorg-server-xvfb | ||||||
|  | Depends = betterdiscordctl | ||||||
|  | NeedsTargets | ||||||
|  | ``` | ||||||
|  |  | ||||||
|  | ## Usage | ||||||
|  |  | ||||||
|  | This section addresses the usage of BetterDiscord. | ||||||
|  |  | ||||||
|  | ### Recommended Themes | ||||||
|  |  | ||||||
|  | The following themes are recommended by the author of this wiki. | ||||||
|  |  | ||||||
|  | - `midnight` is a dark, customizable discord theme. | ||||||
|  | - `system24` is a tui-like discord theme. | ||||||
|  |  | ||||||
|  | ### Recommended Plugins | ||||||
|  |  | ||||||
|  | The following plugins are recommended by the author of this wiki. | ||||||
|  |  | ||||||
|  | - `BetterChatNames` improves chat names by removing dashes in chat channels. | ||||||
|  | - `BetterFriendList` adds extra controls to the friend page. | ||||||
|  | - `BetterVolume` allows to set user volume manually and higher than 200%. | ||||||
|  | - `ChatCounter` adds a character counter to most inputs. | ||||||
|  | - `DoNotTrack` stops Discord from tracking many things. | ||||||
|  | - `GameActivityToggle` adds a quick-toggle game activity button. | ||||||
|  | - `HideDisabledEmojis` hides disabled emojis form the emoji picker. | ||||||
|  | - `ImageUtilities` adds several utilities for images/videos. | ||||||
|  | - `InterTimestamps` allows you to insert timestamp markdown. | ||||||
|  | - `InvisibleTyping` is an enhanced version of silent typing. | ||||||
|  | - `MoreRoleColors` adds role colors to usernames. | ||||||
|  | - `OnlineFriendCount` adds the old online friend count. | ||||||
|  | - `PermissionViewer` allows to view a users permissions. | ||||||
|  | - `PinDMs` allows to pin DMs. | ||||||
|  | - `QuickMention` adds a mention button to the message 3-dot menu. | ||||||
|  | - `ServerDetails` shows server details in the server list tooltip. | ||||||
|  | - `SplitLargeMessages` allows you to enter larger messages, which will automatically split into | ||||||
|  |   several smaller messages. | ||||||
|  | - `StaffTag` adds a crown to server owners (or admins/management). | ||||||
|  | - `Uncompressed Images` will improve image quality of previews. | ||||||
							
								
								
									
										9
									
								
								wiki/bibliographic_software.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										9
									
								
								wiki/bibliographic_software.md
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,9 @@ | |||||||
|  | # Bibliographic Software | ||||||
|  |  | ||||||
|  | A bibliographic software is software that manages a database of citation or bibliographic records. | ||||||
|  | It produces citations for the stored records that are used in scholarly research. | ||||||
|  |  | ||||||
|  | ## Software Solutions | ||||||
|  |  | ||||||
|  | - [Papis](/wiki/linux/papis.md) is a [command-line based](/wiki/linux/shell.md) for | ||||||
|  |   [Linux](/wiki/linux.md) bibliography manager that can be used for LaTeX using the BibTeX format. | ||||||
| @@ -95,7 +95,7 @@ $TTL 1D | |||||||
|  |  | ||||||
|  |  | ||||||
| To make the server you operate on the nameserver select a subdomain for it and | To make the server you operate on the nameserver select a subdomain for it and | ||||||
| subsitute `<servername>` for it and its IP address `<ip of server>`. | subsitute `<servername>` for it and its [IP address](/wiki/ip_address.md) `<ip of server>`. | ||||||
| The following uses a filled in example with multiple subdomains. | The following uses a filled in example with multiple subdomains. | ||||||
| It uses CNAME records as a placeholder for the ip. | It uses CNAME records as a placeholder for the ip. | ||||||
| In the last section the domain itself `home.server` is mapped to the ip | In the last section the domain itself `home.server` is mapped to the ip | ||||||
|   | |||||||
| @@ -28,5 +28,5 @@ This is not a legal advice. | |||||||
| Take your local laws into account when downloading torrents. | Take your local laws into account when downloading torrents. | ||||||
| Some torrents can be copyright infringing and therefor illegal to download. | Some torrents can be copyright infringing and therefor illegal to download. | ||||||
| Only download legal and safe torrents like the | Only download legal and safe torrents like the | ||||||
| [Arch Linux ISO](/wiki/linux/arch-linux.md#iso-medium). | [Arch Linux ISO](/wiki/linux/arch-linux.md#create-installation-medium). | ||||||
| Seeding it can help the community. | Seeding it can help the community. | ||||||
|   | |||||||
| @@ -1,11 +1,13 @@ | |||||||
| # Calibre | # calibre | ||||||
|  |  | ||||||
| [Calibre](https://calibre-ebook.com/) is a cross-platform, free and open-source | [calibre](https://calibre-ebook.com/) is a cross-platform, free and open-source | ||||||
| software suite for [e-book](/wiki/e-books.md) management. | software suite for [e-book](/wiki/e-book.md) management. | ||||||
| It supports various formats aswell as conversion between them. | It supports various formats aswell as conversion between them. | ||||||
|  |  | ||||||
| ## Usage | ## Usage | ||||||
|  |  | ||||||
|  | This section addresses various features of calibre. | ||||||
|  |  | ||||||
| ## Adding a Plugin | ## Adding a Plugin | ||||||
|  |  | ||||||
| A plugin by a third party can be added by selecting a `.zip` archive - usually | A plugin by a third party can be added by selecting a `.zip` archive - usually | ||||||
| @@ -31,6 +33,10 @@ thomas_schickinger;_angelika_steger/diskrete_strukturen_2/thomas_schickinger_&_a | |||||||
| This assumes the sort author names and sort titles are set as described in | This assumes the sort author names and sort titles are set as described in | ||||||
| [the following section](#changing-the-default-author-and-title-sort). | [the following section](#changing-the-default-author-and-title-sort). | ||||||
|  |  | ||||||
|  | In the same view only the boxes `Save cover separately`, `Save metadata in a separate OPF file` and | ||||||
|  | `Save data file as well` should be unchecked. | ||||||
|  | All others are used to ensure a lowercase directory and file name without special characters. | ||||||
|  |  | ||||||
| ## Changing the Default Author and Title Sort | ## Changing the Default Author and Title Sort | ||||||
|  |  | ||||||
| Under `Preferences` and `Tweaks` the corresponding settings to change the title | Under `Preferences` and `Tweaks` the corresponding settings to change the title | ||||||
| @@ -55,3 +61,59 @@ This entry is based on two posts on mobileread - one regarding the | |||||||
| [sort author name](https://www.mobileread.com/forums/showthread.php?t=314663) | [sort author name](https://www.mobileread.com/forums/showthread.php?t=314663) | ||||||
| and the other regarding the | and the other regarding the | ||||||
| [sort title](https://www.mobileread.com/forums/showthread.php?t=249870). | [sort title](https://www.mobileread.com/forums/showthread.php?t=249870). | ||||||
|  |  | ||||||
|  | ## Changing the Cover of a Book | ||||||
|  |  | ||||||
|  | Changing covers of a book can be done by editing the metadata available via the right-click menu. | ||||||
|  | However this is not enough in some cases. | ||||||
|  | `.pdf` in contrast to `.epub` files won't save the cover just by this action. | ||||||
|  | After changing the cover in the metadata screen `.pdf` files have to be converted to correctly | ||||||
|  | display the cover since the first page of such a file is generally considered the cover. | ||||||
|  | An alternative to this is the `PDF Cover` Plugin which allows the insertion of the cover before all | ||||||
|  | other pages without an extra conversion. | ||||||
|  | Please note that it prepends the cover and does not delete any pages. | ||||||
|  |  | ||||||
|  | ## Transfer Books to a Device | ||||||
|  |  | ||||||
|  | To transfer books to a device connect a e-reader to the computer. | ||||||
|  | After a while calibre should recognize the device which will be apparent by the appearance of | ||||||
|  | additional buttons on the top menu like the `Send to device`- and the `Device`-Button. | ||||||
|  | First make sure only the formats you want will be transfered. | ||||||
|  | This can be done by selecting `Device`, `File formats` and checking the formats as needed. | ||||||
|  | Afterwards select the books and press `Send to device` to start the process of transfering the | ||||||
|  | devices. | ||||||
|  | Alternatively only specific formats of the books can be send to the device by selecting | ||||||
|  | `Send specific format to` and `Main memory` under the `Send to device` menu. | ||||||
|  | If there are books that contain series metadata make sure to disconnect the e-reader once and | ||||||
|  | reconnect it. | ||||||
|  | Afterwards select `Update cached metadata on device` under `Device` to update the metadata | ||||||
|  | including the series. | ||||||
|  | Finally disconnect the device. | ||||||
|  |  | ||||||
|  | ## KEPUB Format | ||||||
|  |  | ||||||
|  | The `.kepub` format is a format that is similar to a normal epub but has some performance | ||||||
|  | improvements for Kobo devices. | ||||||
|  | It is recommended to convert `.mobi` and `.epub` files to a `.kepub` file before | ||||||
|  | [transfering it to a Kobo device](#transfer-books-to-a-device). | ||||||
|  | For this the Plugin `KePub Output` by Joel Goguen [can be added](#adding-a-plugin) can be | ||||||
|  | installed. | ||||||
|  | Afterwards books can be converted the normal way, but now the output format `.kepub` is available. | ||||||
|  | Additionally the `Kobo Touch Extended` plugin is recommended to use since it makes sending books to | ||||||
|  | Kobo e-readers easier. | ||||||
|  | Finally `KePub Metadata Reader` and `KePub Metadata Reader` make it possible to read and write | ||||||
|  | metadata to `.kepub` files which is especially useful. | ||||||
|  |  | ||||||
|  | ## Exporting and Importing Settings and Libraries | ||||||
|  |  | ||||||
|  | This section explains how to export and import the settings of one calibre instance to another. | ||||||
|  | It is based on a | ||||||
|  | [reddit comment by dwhitzzz](https://www.reddit.com/r/Calibre/comments/1313kix/comment/mo4b9rn). | ||||||
|  |  | ||||||
|  | To export the settings and libraries of a calibre instance open the corresponding instance and then | ||||||
|  | right-click the `calibre` Button on the top menu. | ||||||
|  | Select `Export/import all calibre data`, select the export or import option and then follow the | ||||||
|  | instructions. | ||||||
|  | Please note that the export only works when an empty folder is selected. | ||||||
|  | All calibre data will then be exported into the selected directory. | ||||||
|  | For the import process the folder that includes the calibre data has to be selected. | ||||||
|   | |||||||
							
								
								
									
										14
									
								
								wiki/chameleon.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										14
									
								
								wiki/chameleon.md
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,14 @@ | |||||||
|  | # Chameleon | ||||||
|  |  | ||||||
|  | [Chameleon](https://addons.mozilla.org/en-GB/firefox/addon/chameleon-ext/) is a | ||||||
|  | [Firefox](/wiki/firefox.md) [add-on](/wiki/firefox.md#list-of-useful-firefox-add-ons) that spoofs | ||||||
|  | your browser profile including user agent and screen size. | ||||||
|  | It also can be used to change the [IP address](/wiki/ip_address.md) | ||||||
|  |  | ||||||
|  | ## Spoofing the IP Address | ||||||
|  |  | ||||||
|  | This add-on can also be used to avoid [geo-blocking](/wiki/ip_address.md#geo-blocking) by selecting | ||||||
|  | IP ranges in the `Headers` tab. | ||||||
|  | The following are example ranges that work well for specific countries. | ||||||
|  |  | ||||||
|  | - Brazil: `124.81.64.0` to `124.81.127.255` | ||||||
| @@ -4,12 +4,14 @@ Computer communication can have multiple different forms. | |||||||
| There are voice and video calls aswell as text based messaging. | There are voice and video calls aswell as text based messaging. | ||||||
| This article bundles all of them. | This article bundles all of them. | ||||||
|  |  | ||||||
| ## VoIP | ## Social Platforms, Messengers and VoIP Services | ||||||
|  |  | ||||||
| This section lists some of the most common Voice over IP (VoIP) platforms. | This section lists some of the most common Voice over IP (VoIP) services, messengers and other | ||||||
|  | social platforms. | ||||||
|  |  | ||||||
|  | - [Discord](/wiki/discord.md) is a widely used, proprietary social platform. | ||||||
| - [Matrix](/wiki/matrix.md) is a decentralized and open-source social platform. | - [Matrix](/wiki/matrix.md) is a decentralized and open-source social platform. | ||||||
| - [Discord](https://discord.com/) is a widely used, proprietary social platform. | - [Signal](/wiki/signal.md) is an open-source, encrypted messaging service. | ||||||
|  |  | ||||||
| ### Soundboards | ### Soundboards | ||||||
|  |  | ||||||
|   | |||||||
							
								
								
									
										69
									
								
								wiki/cups.md
									
									
									
									
									
								
							
							
						
						
									
										69
									
								
								wiki/cups.md
									
									
									
									
									
								
							| @@ -21,3 +21,72 @@ For Linux computers follow these instructions: | |||||||
| - Restart the CUPS service: `systemctl restart cups` | - Restart the CUPS service: `systemctl restart cups` | ||||||
| - Test connectivity: `lpstat -r` | - Test connectivity: `lpstat -r` | ||||||
| - Check the detected printers with: `lpstat -v` | - Check the detected printers with: `lpstat -v` | ||||||
|  |  | ||||||
|  | ## Usage | ||||||
|  |  | ||||||
|  | This section addresses the usage of the CUPS. | ||||||
|  |  | ||||||
|  | ### Adding a Printer | ||||||
|  |  | ||||||
|  | A printer can be added using the webinterface. | ||||||
|  | The webinterface is normally reachable on port 631. | ||||||
|  | This process is guided and should be self-explanatory. | ||||||
|  | However in some cases additional drivers have to be installed. | ||||||
|  | For example Brother label printers of the ptouch series feature drivers that are available for most | ||||||
|  | [Linux](/wiki/linux.md) distributions in a package named `printer-driver-ptouch`. | ||||||
|  | When adding the printer a network address has to be given. | ||||||
|  | For USB printers this can be done via the USB protocol. | ||||||
|  | Continuing the example Brother label Printer QL-600 the connection `usb://Brother/QL-600` is | ||||||
|  | sufficient. | ||||||
|  | When using multiple printers the serial number can be given in addition to this. | ||||||
|  | This is done by appending it the the mentioned connection string and will look like | ||||||
|  | `usb://Brother/QL-600?serial=000J1Z140282`. | ||||||
|  | The examples using the Brother printer are taken from a | ||||||
|  | [dwaves article](https://dwaves.de/2022/07/13/gnu-linux-debian-11-how-to-setup-brother-ql-600-labelprinter/). | ||||||
|  |  | ||||||
|  | ### Custom Formats For Brother Printers  | ||||||
|  |  | ||||||
|  | This section is based on an entry in the | ||||||
|  | [german FAQ on the brother website](https://support.brother.com/g/b/faqend.aspx?c=de&lang=de&prod=lpql1110nwbeuk&faqid=faqp00100409_000). | ||||||
|  |  | ||||||
|  | Especially when using continuos-length Brother label printers it can be useful to set up custom | ||||||
|  | formats. | ||||||
|  | After setting up the CUPS install the package that provides | ||||||
|  | `brpapertoollpr_<printer name in cups>` which differs from printer to printer. | ||||||
|  | For example when using a Brother QL-600 this command is named `brpapertoollpr_ql600` and on some | ||||||
|  | [Linux](/wiki/linux.md) distributions like [Arch Linux](/wiki/linux/arch-linux.md) is provided in a | ||||||
|  | package called `brother-ql600`. | ||||||
|  |  | ||||||
|  | To then set up a new custom format run the following command. | ||||||
|  |  | ||||||
|  | ```sh  | ||||||
|  | brpapertoollpr_<printer name in command> -P <printer name in cups> -n <format name> -w <width> -h <height> | ||||||
|  | ``` | ||||||
|  |  | ||||||
|  | `<printer name in command>` is the part of the command that corresponds to the printer as described | ||||||
|  | in the previous sentence. | ||||||
|  | `<printer name in cups>` and `<format name>` are the name of the printer already set up and given in | ||||||
|  | CUPS and the name chosen for the new format. | ||||||
|  | And `<width>` and `<height>` are width and height of the new format both given in millimeters. | ||||||
|  | A complete command could look something like the following.  | ||||||
|  |  | ||||||
|  |  | ||||||
|  | ```sh  | ||||||
|  | brpapertoollpr_ql600 -P Brother_QL-600 -n "62mmx12mm" -w 62 -h 12 | ||||||
|  | ``` | ||||||
|  |  | ||||||
|  | The command to delete a custom format is the following. | ||||||
|  | It uses the same variables and names as the command above. | ||||||
|  |  | ||||||
|  | ```sh  | ||||||
|  | brpapertoollpr_ql600 -P <printer name> -d <format name> | ||||||
|  | ``` | ||||||
|  |  | ||||||
|  | The usage of this command could look similar to the following example. | ||||||
|  |  | ||||||
|  | ```sh  | ||||||
|  | brpapertoollpr_ql600 -P Brother_QL-600 -d "62mmx12mm" | ||||||
|  | ``` | ||||||
|  |  | ||||||
|  | After setting up the new format it can be selected in the CUPS interface and used with the Brother | ||||||
|  | printer it was set up for. | ||||||
|   | |||||||
| @@ -1,6 +1,6 @@ | |||||||
| # Databases | # Database | ||||||
| 
 | 
 | ||||||
| Databases are data collections of a computer system. | A database is a data collections of a computer system. | ||||||
| Most prominent type of database are SQL databases. | Most prominent type of database are SQL databases. | ||||||
| 
 | 
 | ||||||
| ## Database management systems (DBMS) | ## Database management systems (DBMS) | ||||||
							
								
								
									
										5
									
								
								wiki/deskreen.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										5
									
								
								wiki/deskreen.md
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,5 @@ | |||||||
|  | # Deskreen | ||||||
|  |  | ||||||
|  | [Deskreen](https://github.com/pavlobu/deskreen) is a tool for [Linux](/wiki/linux.md), | ||||||
|  | [Windows](/wiki/windows.md) and MacOS that allows to extend the screen of a device with Deskreen | ||||||
|  | installed to a device with any web browser. | ||||||
							
								
								
									
										28
									
								
								wiki/discord.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										28
									
								
								wiki/discord.md
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,28 @@ | |||||||
|  | # Discord | ||||||
|  |  | ||||||
|  | [Discord](https://discord.com/) is an social platform that combines voice and video conferences as | ||||||
|  | well as instant messaging chats. | ||||||
|  |  | ||||||
|  | ## Usage | ||||||
|  |  | ||||||
|  | This section addresses various features of Discord. | ||||||
|  |  | ||||||
|  | ### Disable Automatic Update Checks | ||||||
|  |  | ||||||
|  | By default Discord performs an automatic check to see if it is up to date. | ||||||
|  | On [Linux](/wiki/linux.md)-based systems it can be disabled by adding `"SKIP_HOST_UPDATE": true` to | ||||||
|  | the `~/.config/discord/settings.json` file. | ||||||
|  |  | ||||||
|  | ### Setting Up a Music Bot | ||||||
|  |  | ||||||
|  | For Discord there are various bots capable of playing music. | ||||||
|  | The following is a list of bots featured in this wiki that can do this. | ||||||
|  |  | ||||||
|  | - [Sinusbot](/wiki/sinusbot.md) is a self-hosted bot for Discord that can play music and sounds.  | ||||||
|  |   It's closed-source and free of charge. | ||||||
|  |   It also features [Teamspeak](/wiki/teamspeak.md) support. | ||||||
|  |  | ||||||
|  | ### Themes and Plugins | ||||||
|  |  | ||||||
|  | By default Discord has no option to use themes or plugins. | ||||||
|  | This however can be changed by using [BetterDiscord](/wiki/betterdiscord.md). | ||||||
| @@ -5,7 +5,7 @@ Due to easy handling and reproducable environments it is a useful tool. | |||||||
|  |  | ||||||
| ## Setup | ## Setup | ||||||
|  |  | ||||||
| - Arch linux: run `pacman -S docker` to install docker | - [Arch Linux](/wiki/linux/arch-linux.md): run `pacman -S docker` to install docker | ||||||
| - Ubuntu: visit [the official installation guide](https://docs.docker.com/engine/install/ubuntu/) | - Ubuntu: visit [the official installation guide](https://docs.docker.com/engine/install/ubuntu/) | ||||||
|  |  | ||||||
| Another possibility is to try the official convenience script. | Another possibility is to try the official convenience script. | ||||||
| @@ -19,6 +19,14 @@ sudo sh get-docker.sh | |||||||
|  |  | ||||||
| ## Usage | ## Usage | ||||||
|  |  | ||||||
|  | This section addresses various features of Docker. | ||||||
|  |  | ||||||
|  | ### virtualize Operating Systems | ||||||
|  |  | ||||||
|  | Docker is a tool that can be used to virtualize different programs and softwares. | ||||||
|  | Especially for containerizing and virtualizing operating systems (mostly based on | ||||||
|  | [Linux](/wiki/linux.md)) can be handled by [distrobox](https://github.com/89luca89/distrobox). | ||||||
|  |  | ||||||
| ### Run Docker as non-root user | ### Run Docker as non-root user | ||||||
|  |  | ||||||
| To run docker as a non-root user you need to add your user to the `docker` group. | To run docker as a non-root user you need to add your user to the `docker` group. | ||||||
| @@ -32,7 +40,7 @@ After that relog into your machine and you should be able to run | |||||||
| The programs below are useful docker-management systems in different style. | The programs below are useful docker-management systems in different style. | ||||||
|  |  | ||||||
| - [ctop](https://github.com/bcicen/ctop): top-like cli interface for containers | - [ctop](https://github.com/bcicen/ctop): top-like cli interface for containers | ||||||
| - [portainer](./docker/portainer.md): web ui for managing docker and kubernetes | - [portainer](https://www.portainer.io/): web ui for managing docker and kubernetes | ||||||
|  |  | ||||||
| ### Enable Nvidia GPUs | ### Enable Nvidia GPUs | ||||||
|  |  | ||||||
| @@ -57,7 +65,7 @@ publish ports to reverse proxy them. | |||||||
| ### Dockerize a graphical application | ### Dockerize a graphical application | ||||||
|  |  | ||||||
| A graphical application can easily be dockerized and made available over both | A graphical application can easily be dockerized and made available over both | ||||||
| the [web browser](/wiki/browser.md) or [VNC](/wiki/vnc.md). | the [web browser](/wiki/web_browser.md) or [VNC](/wiki/vnc.md). | ||||||
| For this | For this | ||||||
| [jlesages baseimage-gui container](https://hub.docker.com/r/jlesage/baseimage-gui) | [jlesages baseimage-gui container](https://hub.docker.com/r/jlesage/baseimage-gui) | ||||||
| can be used. | can be used. | ||||||
|   | |||||||
							
								
								
									
										67
									
								
								wiki/docker/actualbudget_-actual-server.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										67
									
								
								wiki/docker/actualbudget_-actual-server.md
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,67 @@ | |||||||
|  | # actualbudget - actual-server | ||||||
|  |  | ||||||
|  | This is a [Docker](/wiki/docker.md) container for an actualbudget server. | ||||||
|  | The official container and documentation was made by | ||||||
|  | [actualbudget](https://actualbudget.org/docs/install/docker/). | ||||||
|  | This docker-rebuild is made up by a `docker-compose.yml` file. | ||||||
|  |  | ||||||
|  | ## Set-up | ||||||
|  |  | ||||||
|  | Create the files `rebuild.sh`, `docker-compose.yml` at the same | ||||||
|  | place. | ||||||
|  | Change the settings according to your needs and run `./rebuild.sh` afterwards. | ||||||
|  |  | ||||||
|  | ### Ports | ||||||
|  |  | ||||||
|  | Set the following ports in the `ports:` section. | ||||||
|  |  | ||||||
|  | | Container Port | Recommended outside port | Protocol  | Description   | | ||||||
|  | | -------------- | ------------------------ | --------- | ------------- | | ||||||
|  | | `5006`         | `5006`                   | TCP       | WebUI         | | ||||||
|  |  | ||||||
|  | ### Volumes | ||||||
|  |  | ||||||
|  | Set the following volumes with the -v tag. | ||||||
|  |  | ||||||
|  | | Outside mount/volume name | Container mount | Description        | | ||||||
|  | | ------------------------- | --------------- | ------------------ | | ||||||
|  | | `actual`                  | `/data`         | Actual Budget data | | ||||||
|  |  | ||||||
|  | ### rebuild.sh | ||||||
|  |  | ||||||
|  | ```sh | ||||||
|  | #!/bin/sh | ||||||
|  | docker-compose down | ||||||
|  | docker-compose up -d | ||||||
|  | ``` | ||||||
|  |  | ||||||
|  | ### docker-compose.yml | ||||||
|  |  | ||||||
|  | ```yml | ||||||
|  | version: '3' | ||||||
|  | services: | ||||||
|  |   actual_server: | ||||||
|  |     image: docker.io/actualbudget/actual-server:latest | ||||||
|  |     ports: | ||||||
|  |       # This line makes Actual available at port 5006 of the device you run the server on, | ||||||
|  |       # i.e. http://localhost:5006. You can change the first number to change the port, if you want. | ||||||
|  |       - '5006:5006' | ||||||
|  |     # environment: | ||||||
|  |       # Uncomment any of the lines below to set configuration options. | ||||||
|  |       # - ACTUAL_HTTPS_KEY=/data/selfhost.key | ||||||
|  |       # - ACTUAL_HTTPS_CERT=/data/selfhost.crt | ||||||
|  |       # - ACTUAL_PORT=5006 | ||||||
|  |       # - ACTUAL_UPLOAD_FILE_SYNC_SIZE_LIMIT_MB=20 | ||||||
|  |       # - ACTUAL_UPLOAD_SYNC_ENCRYPTED_FILE_SYNC_SIZE_LIMIT_MB=50 | ||||||
|  |       # - ACTUAL_UPLOAD_FILE_SIZE_LIMIT_MB=20 | ||||||
|  |       # See all options and more details at https://actualbudget.github.io/docs/Installing/Configuration | ||||||
|  |       # !! If you are not using any of these options, remove the 'environment:' tag entirely. | ||||||
|  |     volumes: | ||||||
|  |       # Change './actual-data' below to the path to the folder you want Actual to store its data in on your server. | ||||||
|  |       # '/data' is the path Actual will look for its files in by default, so leave that as-is. | ||||||
|  |       - actual:/data | ||||||
|  |     restart: unless-stopped | ||||||
|  |  | ||||||
|  | volumes: | ||||||
|  |    actual: | ||||||
|  | ``` | ||||||
							
								
								
									
										67
									
								
								wiki/docker/alexjustesen_-_speedtest-tracker.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										67
									
								
								wiki/docker/alexjustesen_-_speedtest-tracker.md
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,67 @@ | |||||||
|  | # alexjustesen - speedtest-tracker | ||||||
|  |  | ||||||
|  | This is a [Docker](/wiki/docker.md) container for a selfhosted internet speed | ||||||
|  | tracker. | ||||||
|  | The official container and documentation was made by | ||||||
|  | [alexjustesen](https://github.com/alexjustesen/speedtest-tracker). | ||||||
|  |  | ||||||
|  | ## Set-up | ||||||
|  |  | ||||||
|  | Create the file `rebuild.sh`. | ||||||
|  | Change the settings according to your needs and run `./rebuild.sh` afterwards. | ||||||
|  | It is important to set a correct app key as described in | ||||||
|  | [the following section](#environment-variables). | ||||||
|  |  | ||||||
|  | ### Environment-variables | ||||||
|  |  | ||||||
|  | Set the following variables with the -e tag. | ||||||
|  |  | ||||||
|  | | Name                 | Usage                                                                                              | Default         | | ||||||
|  | | -------------------- | -------------------------------------------------------------------------------------------------- | --------------- | | ||||||
|  | | `APP_KEY`            | This is used for encryption and can be generated by `echo -n 'base64:'; openssl rand -base64 32;`  |                 | | ||||||
|  | | `DB_CONNECTION`      | Database connection type                                                                           |                 | | ||||||
|  | | `PGID`               | Group ID                                                                                           |                 | | ||||||
|  | | `PUID`               | User ID                                                                                            |                 | | ||||||
|  | | `APP_TIMEZONE`       | Timezone of the app                                                                                | `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)              |                 | | ||||||
|  |  | ||||||
|  | ### Volumes | ||||||
|  |  | ||||||
|  | Set the following volumes with the -v tag. | ||||||
|  |  | ||||||
|  | | Outside mount/volume name | Container mount | Description          | | ||||||
|  | | ------------------------- | --------------- | -------------------- | | ||||||
|  | | `speedtest_config`        | `/config`       | storage for config   | | ||||||
|  | | `speedtest_keys`          | `/config/keys`  | storage for ssl keys | | ||||||
|  |  | ||||||
|  | ### Ports | ||||||
|  |  | ||||||
|  | Set the following ports with the -p tag. | ||||||
|  |  | ||||||
|  | | Container Port | Recommended outside port | Protocol | Description               | | ||||||
|  | | -------------- | ------------------------ | -------- | ------------------------- | | ||||||
|  | | `80`           | `8765`                   | TCP      | WebUI                     | | ||||||
|  | | `443`          | ``                       | TCP      | SSL-encrypted WebUI       | | ||||||
|  |  | ||||||
|  | ### rebuild.sh | ||||||
|  |  | ||||||
|  | ```sh | ||||||
|  | #!/bin/sh | ||||||
|  | docker stop speedtest | ||||||
|  | docker rm speedtest | ||||||
|  | docker pull lscr.io/linuxserver/speedtest-tracker:latest | ||||||
|  | docker run --name speedtest \ | ||||||
|  |     --restart unless-stopped \ | ||||||
|  |     -p 8765:80 \ | ||||||
|  |     -e PUID=1000 \ | ||||||
|  |     -e PGID=1000 \ | ||||||
|  |     -e APP_KEY="<generate>" \ | ||||||
|  |     -e DB_CONNECTION=sqlite \ | ||||||
|  |     -e SPEEDTEST_SCHEDULE="6 */6 * * *" \ | ||||||
|  |     -e APP_TIMEZONE="Europe/Berlin" \ | ||||||
|  |     -e DISPLAY_TIMEZONE="Europe/Berlin" \ | ||||||
|  |     -v speedtest_config:/config \ | ||||||
|  |     -v speedtest_keys:/config/keys \ | ||||||
|  |     -d lscr.io/linuxserver/speedtest-tracker:latest | ||||||
|  | ``` | ||||||
| @@ -11,7 +11,7 @@ This docker-rebuild is made up by a `docker-compose.yml` file. | |||||||
| 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` afterwards. | ||||||
|  |  | ||||||
| ## 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. | ||||||
|  |  | ||||||
| @@ -19,7 +19,7 @@ Set the following volumes in the `volumes:` section of the docker-compose file. | |||||||
| | ------------------------- | --------------- | ------------------------------------ | | | ------------------------- | --------------- | ------------------------------------ | | ||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -27,16 +27,16 @@ Set the following ports in the `ports:` section. | |||||||
| | -------------- | ------------------------ | -------- | ----------- | | | -------------- | ------------------------ | -------- | ----------- | | ||||||
| | `8881`         | `8081`                   | TCP      | WebUI       | | | `8881`         | `8081`                   | TCP      | WebUI       | | ||||||
|  |  | ||||||
| ## rebuild.sh | ### rebuild.sh | ||||||
|  |  | ||||||
| ```sh | ```sh | ||||||
| #!/bin/sh | #!/bin/sh | ||||||
| docker-compose down | docker-compose down | ||||||
| docker pull vim alexta69/metube | docker pull alexta69/metube | ||||||
| docker-compose up -d | docker-compose up -d | ||||||
| ``` | ``` | ||||||
|  |  | ||||||
| ## docker-compose.yml | ### docker-compose.yml | ||||||
|  |  | ||||||
| ```yml | ```yml | ||||||
| version: "3" | version: "3" | ||||||
|   | |||||||
| @@ -1,6 +1,7 @@ | |||||||
| # awesometechnologies - synapse-admin | # awesometechnologies - synapse-admin | ||||||
|  |  | ||||||
| This is a [Docker](/wiki/docker.md) container for a Synapse server of [Matrix](../matrix.md). | This is a [Docker](/wiki/docker.md) container for a Synapse administration server of | ||||||
|  | [Matrix](../matrix.md). | ||||||
| The official container and documentation was made by | The official container and documentation was made by | ||||||
| [awesometechnologies](https://hub.docker.com/awesometechnologies/synapse-admin). | [awesometechnologies](https://hub.docker.com/awesometechnologies/synapse-admin). | ||||||
| This docker-rebuild is made up by a `docker-compose.yml` file. | This docker-rebuild is made up by a `docker-compose.yml` file. | ||||||
| @@ -10,7 +11,7 @@ This docker-rebuild is made up by a `docker-compose.yml` file. | |||||||
| 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` afterwards. | ||||||
|  |  | ||||||
| ## Ports | ### Ports | ||||||
|  |  | ||||||
| Set the following ports in the `ports:` section. | Set the following ports in the `ports:` section. | ||||||
|  |  | ||||||
| @@ -18,7 +19,7 @@ Set the following ports in the `ports:` section. | |||||||
| | -------------- | ------------------------ | -------- | ----------- | | | -------------- | ------------------------ | -------- | ----------- | | ||||||
| | `80`           | `80`                     | TCP      | WebUI       | | | `80`           | `80`                     | TCP      | WebUI       | | ||||||
|  |  | ||||||
| ## rebuild.sh | ### rebuild.sh | ||||||
|  |  | ||||||
| ```sh | ```sh | ||||||
| #!/bin/sh | #!/bin/sh | ||||||
| @@ -27,7 +28,7 @@ docker pull awesometechnologies/synapse-admin:latest | |||||||
| docker-compose up -d | docker-compose up -d | ||||||
| ``` | ``` | ||||||
|  |  | ||||||
| ## docker-compose.yml | ### docker-compose.yml | ||||||
|  |  | ||||||
| ```yml | ```yml | ||||||
| version: "2" | version: "2" | ||||||
|   | |||||||
| @@ -10,7 +10,7 @@ The official container and documentation was made by | |||||||
| Create the file `rebuild.sh`. | Create the file `rebuild.sh`. | ||||||
| Change the settings according to your needs and run `./rebuild.sh` afterwards. | Change the settings according to your needs and run `./rebuild.sh` afterwards. | ||||||
|  |  | ||||||
| ## Environment-variables | ### Environment-variables | ||||||
|  |  | ||||||
| Set the following variables with the -e tag. | Set the following variables with the -e tag. | ||||||
|  |  | ||||||
| @@ -18,7 +18,7 @@ Set the following variables with the -e tag. | |||||||
| | ---------- | ----------------------------- | ------- | | | ---------- | ----------------------------- | ------- | | ||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -27,7 +27,7 @@ Set the following volumes with the -v tag. | |||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -35,7 +35,7 @@ Set the following ports with the -p tag. | |||||||
| | -------------- | ------------------------ | -------- | ----------- | | | -------------- | ------------------------ | -------- | ----------- | | ||||||
| | `8080`         | `8080`                   | TCP      | WebUI       | | | `8080`         | `8080`                   | TCP      | WebUI       | | ||||||
|  |  | ||||||
| ## rebuild.sh | ### rebuild.sh | ||||||
|  |  | ||||||
| ```sh | ```sh | ||||||
| #!/bin/sh | #!/bin/sh | ||||||
|   | |||||||
| @@ -11,7 +11,7 @@ Place the file `config.yml` in the `homer` docker volume and change it to your | |||||||
| needs. | needs. | ||||||
| After that rerun `./rebuild.sh` to make update your config. | After that rerun `./rebuild.sh` to make update your config. | ||||||
|  |  | ||||||
| ## Volumes | ### Volumes | ||||||
|  |  | ||||||
| Set the following volumes with the -v tag. | Set the following volumes with the -v tag. | ||||||
|  |  | ||||||
| @@ -19,7 +19,7 @@ Set the following volumes with the -v tag. | |||||||
| | ------------------------- | --------------- | ---------------------- | | | ------------------------- | --------------- | ---------------------- | | ||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -27,7 +27,7 @@ Set the following ports with the -p tag. | |||||||
| | -------------- | ------------------------ | -------- | ----------- | | | -------------- | ------------------------ | -------- | ----------- | | ||||||
| | `8080`         | `8080`                   | TCP      | WebUI       | | | `8080`         | `8080`                   | TCP      | WebUI       | | ||||||
|  |  | ||||||
| ## rebuild.sh | ### rebuild.sh | ||||||
|  |  | ||||||
| ```sh | ```sh | ||||||
| #!/bin/sh | #!/bin/sh | ||||||
| @@ -41,7 +41,7 @@ docker run --name homer \ | |||||||
|     -d b4bz/homer:latest |     -d b4bz/homer:latest | ||||||
| ``` | ``` | ||||||
|  |  | ||||||
| ## config.yml | ### config.yml | ||||||
|  |  | ||||||
| ```yml | ```yml | ||||||
| title: "tmp" | title: "tmp" | ||||||
|   | |||||||
| @@ -10,7 +10,7 @@ TubeArchivist specific version of Elasticsearch and one a [redis](/wiki/docker/r | |||||||
| 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` afterwards. | ||||||
|  |  | ||||||
| ## 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. | ||||||
| @@ -36,7 +36,7 @@ The following table lists the environment variables for the image `bbilly1/tubea | |||||||
| | `ELASTIC_PASSWORD` | Password for Elasticsearch                  | ``      | | | `ELASTIC_PASSWORD` | Password for Elasticsearch                  | ``      | | ||||||
| | `ES_JAVA_OPTS`     | Additional Java options                     | ``      | | | `ES_JAVA_OPTS`     | Additional Java options                     | ``      | | ||||||
|  |  | ||||||
| ## 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. | ||||||
|  |  | ||||||
| @@ -53,7 +53,7 @@ The following table lists the environment variables for the image `bbilly1/tubea | |||||||
| | ------------------------- | ------------------------------- | --------------------------- | | | ------------------------- | ------------------------------- | --------------------------- | | ||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -61,7 +61,7 @@ Set the following ports in the `ports:` section. | |||||||
| | -------------- | ------------------------ | -------- | ----------- | | | -------------- | ------------------------ | -------- | ----------- | | ||||||
| | `8000`         | `8881`                   | TCP      | WebUI       | | | `8000`         | `8881`                   | TCP      | WebUI       | | ||||||
|  |  | ||||||
| ## rebuild.sh | ### rebuild.sh | ||||||
|  |  | ||||||
| ```sh | ```sh | ||||||
| #!/bin/sh | #!/bin/sh | ||||||
| @@ -69,7 +69,7 @@ docker-compose down | |||||||
| docker-compose up -d | docker-compose up -d | ||||||
| ``` | ``` | ||||||
|  |  | ||||||
| ## docker-compose.yml | ### docker-compose.yml | ||||||
|  |  | ||||||
| ```yml | ```yml | ||||||
| version: '3.3' | version: '3.3' | ||||||
|   | |||||||
| @@ -14,7 +14,7 @@ just created folder. | |||||||
| You can find the `docker-compose.yml` in the cloned directory. | You can find the `docker-compose.yml` in the cloned directory. | ||||||
| Set the variables, volumes and ports according and run the `rebuild.sh`. | Set the variables, volumes and ports according and run the `rebuild.sh`. | ||||||
|  |  | ||||||
| ## Volumes | ### Volumes | ||||||
|  |  | ||||||
| Set the following volumes with the -v tag. | Set the following volumes with the -v tag. | ||||||
|  |  | ||||||
| @@ -22,7 +22,7 @@ Set the following volumes with the -v tag. | |||||||
| | ------------------------- | ---------------- | ---------------- | | | ------------------------- | ---------------- | ---------------- | | ||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -30,7 +30,7 @@ Set the following ports with the -p tag. | |||||||
| | -------------- | ------------------------ | -------- | ----------- | | | -------------- | ------------------------ | -------- | ----------- | | ||||||
| | `5000`         | `8000`                   | TCP      | WebUI       | | | `5000`         | `8000`                   | TCP      | WebUI       | | ||||||
|  |  | ||||||
| ## rebuild.sh | ### rebuild.sh | ||||||
|  |  | ||||||
| ```sh | ```sh | ||||||
| #!/bin/sh | #!/bin/sh | ||||||
| @@ -40,7 +40,7 @@ docker-compose up -d | |||||||
| cd .. | cd .. | ||||||
| ``` | ``` | ||||||
|  |  | ||||||
| ## docker-compose.yml | ### docker-compose.yml | ||||||
|  |  | ||||||
| ```yml | ```yml | ||||||
| version: "2.2" | version: "2.2" | ||||||
|   | |||||||
| @@ -23,7 +23,7 @@ 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. | ||||||
|  |  | ||||||
| @@ -31,7 +31,7 @@ Set the following volumes in the `volumes:` section of the docker-compose file. | |||||||
| | ------------------------- | ------------------ | ------------------------------ | | | ------------------------- | ------------------ | ------------------------------ | | ||||||
| | `./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. | ||||||
|  |  | ||||||
| @@ -39,7 +39,7 @@ Set the following ports in the `ports:` section. | |||||||
| | -------------- | ------------------------ | -------- | ---------------------- | | | -------------- | ------------------------ | -------- | ---------------------- | | ||||||
| | `80`           | `80`                     | TCP      | Basic service          | | | `80`           | `80`                     | TCP      | Basic service          | | ||||||
|  |  | ||||||
| ## rebuild.sh | ### rebuild.sh | ||||||
|  |  | ||||||
| ```sh | ```sh | ||||||
| #!/bin/sh | #!/bin/sh | ||||||
| @@ -48,7 +48,7 @@ docker pull bilde2910/hauk | |||||||
| docker-compose up -d | docker-compose up -d | ||||||
| ``` | ``` | ||||||
|  |  | ||||||
| ## docker-compose.yml | ### docker-compose.yml | ||||||
|  |  | ||||||
| ```yml | ```yml | ||||||
| version: "2" | version: "2" | ||||||
|   | |||||||
| @@ -14,7 +14,7 @@ Create the files `rebuild.sh`, `.env` and `docker-compose.yml` at the same | |||||||
| place. | place. | ||||||
| Change the settings according to your needs and run `./rebuild.sh` afterwards. | Change the settings according to your needs and run `./rebuild.sh` afterwards. | ||||||
|  |  | ||||||
| ## Ports | ### Ports | ||||||
|  |  | ||||||
| Set the following ports in the `ports:` section. | Set the following ports in the `ports:` section. | ||||||
|  |  | ||||||
| @@ -22,7 +22,7 @@ Set the following ports in the `ports:` section. | |||||||
| | -------------- | ------------------------ | -------- | ----------- | | | -------------- | ------------------------ | -------- | ----------- | | ||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -32,7 +32,7 @@ Set the following volumes with the -v tag. | |||||||
| | `config`                  | `/config`                  | configuration data     | | | `config`                  | `/config`                  | configuration data     | | ||||||
| | `data`                    | `/data`                    | further data storage   | | | `data`                    | `/data`                    | further data storage   | | ||||||
|  |  | ||||||
| ## rebuild.sh | ### rebuild.sh | ||||||
|  |  | ||||||
| ```sh | ```sh | ||||||
| #!/bin/sh | #!/bin/sh | ||||||
| @@ -40,7 +40,7 @@ docker-compose down | |||||||
| docker-compose up -d | docker-compose up -d | ||||||
| ``` | ``` | ||||||
|  |  | ||||||
| ## .env | ### .env | ||||||
|  |  | ||||||
| ```sh | ```sh | ||||||
| TZ="Europe/Berlin" | TZ="Europe/Berlin" | ||||||
| @@ -75,7 +75,7 @@ PEERTUBE_SMTP_TLS=false | |||||||
| PEERTUBE_SMTP_DISABLE_STARTTLS=false | PEERTUBE_SMTP_DISABLE_STARTTLS=false | ||||||
| ``` | ``` | ||||||
|  |  | ||||||
| ## docker-compose.yml | ### docker-compose.yml | ||||||
|  |  | ||||||
| ```yml | ```yml | ||||||
| version: "3.3" | version: "3.3" | ||||||
|   | |||||||
| @@ -14,7 +14,7 @@ a folder within the just created folder. | |||||||
| You can find the `docker-compose.yml` in the cloned directory. | You can find the `docker-compose.yml` in the cloned directory. | ||||||
| Set the variables, volumes and ports according and run the `rebuild.sh`. | Set the variables, volumes and ports according and run the `rebuild.sh`. | ||||||
|  |  | ||||||
| ## Volumes | ### Volumes | ||||||
|  |  | ||||||
| Set the following volumes with the -v tag. | Set the following volumes with the -v tag. | ||||||
|  |  | ||||||
| @@ -22,7 +22,7 @@ Set the following volumes with the -v tag. | |||||||
| | ------------------------- | --------------- | ----------------------------------- | | | ------------------------- | --------------- | ----------------------------------- | | ||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -30,7 +30,7 @@ Set the following ports in the `ports:` section. | |||||||
| | -------------- | ------------------------ | -------- | ----------- | | | -------------- | ------------------------ | -------- | ----------- | | ||||||
| | `10407`        | `10407`                  | TCP      | WebUI       | | | `10407`        | `10407`                  | TCP      | WebUI       | | ||||||
|  |  | ||||||
| ## rebuild.sh | ### rebuild.sh | ||||||
|  |  | ||||||
| ```sh | ```sh | ||||||
| #!/bin/sh | #!/bin/sh | ||||||
| @@ -40,7 +40,7 @@ docker-compose up -d | |||||||
| cd .. | cd .. | ||||||
| ``` | ``` | ||||||
|  |  | ||||||
| ## docker-compose.yml | ### docker-compose.yml | ||||||
|  |  | ||||||
| ```yml | ```yml | ||||||
| version: "3" | version: "3" | ||||||
|   | |||||||
							
								
								
									
										72
									
								
								wiki/docker/coturn_-_coturn.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										72
									
								
								wiki/docker/coturn_-_coturn.md
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,72 @@ | |||||||
|  | # coturn - coturn | ||||||
|  |  | ||||||
|  | This is a [Docker](/wiki/docker.md) container for a TURN/STUN server. | ||||||
|  | A server like this can be used in a [Matrix](../matrix.md) server configuration. | ||||||
|  | The official container and documentation was made by | ||||||
|  | [coturn](https://github.com/coturn/coturn). | ||||||
|  | This docker-rebuild is made up by a `docker-compose.yml` file. | ||||||
|  |  | ||||||
|  | ## Set-up | ||||||
|  |  | ||||||
|  | Create the files `rebuild.sh`, `data/matrix/coturn/turnserver.conf` and `docker-compose.yml` at the | ||||||
|  | same place. | ||||||
|  | Change the settings according to your needs and run `./rebuild.sh` afterwards. | ||||||
|  | For the `data/matrix/coturn/turnserver.conf` file change the values for `static-auth-secret`, | ||||||
|  | `realm`, `cli-password` and `external-ip`. | ||||||
|  | For the passwords [OpenSSL](/wiki/linux/openssl.md#password-generator) can be used to create a | ||||||
|  | sufficiently random password. | ||||||
|  | The value of `external-ip` consists of the local IP (left side) and the public IP (right side). | ||||||
|  | To get the local IP the command `ip route get 1` can be used. | ||||||
|  | For the public IP the command `curl api.ipify.org` can be used. | ||||||
|  |  | ||||||
|  |  | ||||||
|  | ### Ports | ||||||
|  |  | ||||||
|  | Set the following ports in the `ports:` section. | ||||||
|  |  | ||||||
|  | | Container Port | Recommended outside port | Protocol | Description | | ||||||
|  | | -------------- | ------------------------ | -------- | ----------- | | ||||||
|  | | `3478`         | `3478`                   | TCP/UDP  | TURN/STUN   | | ||||||
|  | | `5349`         | `5349`                   | TCP/UDP  | TURN/STUN   | | ||||||
|  | | `49152-65535`  | `49152-65535`            | UDP      | TURN/STUN   | | ||||||
|  |  | ||||||
|  | ### rebuild.sh | ||||||
|  |  | ||||||
|  | ```sh | ||||||
|  | #!/bin/sh | ||||||
|  | docker-compose down | ||||||
|  | docker pull coturn/coturn:latest | ||||||
|  | docker-compose up -d | ||||||
|  | ``` | ||||||
|  |  | ||||||
|  | ### docker-compose.yml | ||||||
|  |  | ||||||
|  | ```yml | ||||||
|  | version: "2" | ||||||
|  | services: | ||||||
|  |   coturn: | ||||||
|  |     image: "instrumentisto/coturn:latest" | ||||||
|  |     restart: "unless-stopped" | ||||||
|  |     volumes: | ||||||
|  |       - "./data/matrix/coturn/turnserver.conf:/etc/coturn/turnserver.conf" | ||||||
|  |     ports: | ||||||
|  |       - "49160-49200:49160-49200/udp" | ||||||
|  |       - "3478:3478" | ||||||
|  |       - "5349:5349" | ||||||
|  | ``` | ||||||
|  |  | ||||||
|  | ### data/matrix/coturn/turnserver.conf | ||||||
|  |  | ||||||
|  | ```txt | ||||||
|  | use-auth-secret | ||||||
|  | static-auth-secret=SomeSecretPasswordForMatrix | ||||||
|  | realm=matrix.example.com | ||||||
|  | listening-port=3478 | ||||||
|  | tls-listening-port=5349 | ||||||
|  | min-port=49160 | ||||||
|  | max-port=49200 | ||||||
|  | verbose | ||||||
|  | allow-loopback-peers | ||||||
|  | cli-password=SomePasswordForCLI | ||||||
|  | external-ip=192.168.0.2/123.123.123.123 | ||||||
|  | ``` | ||||||
| @@ -8,7 +8,7 @@ The container and documentation was made by [dperson](https://hub.docker.com/r/d | |||||||
| Create the file `rebuild.sh`. | Create the file `rebuild.sh`. | ||||||
| Change the settings according to your needs and run `./rebuild.sh` afterwards. | Change the settings according to your needs and run `./rebuild.sh` afterwards. | ||||||
|  |  | ||||||
| ## Volumes | ### Volumes | ||||||
|  |  | ||||||
| Set the following volumes with the -v tag. | Set the following volumes with the -v tag. | ||||||
|  |  | ||||||
| @@ -17,7 +17,7 @@ Set the following volumes with the -v tag. | |||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -26,7 +26,7 @@ Set the following ports with the -p tag. | |||||||
| | `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 | ||||||
| #!/bin/sh | #!/bin/sh | ||||||
|   | |||||||
| @@ -15,7 +15,7 @@ Place the openvpn certificate in the `jacket_config` docker volume inside the | |||||||
| `openvpn` folder. | `openvpn` folder. | ||||||
| After that rerun `./rebuild.sh` to make update your config. | After that rerun `./rebuild.sh` to make update your config. | ||||||
|  |  | ||||||
| ## Volumes | ### Volumes | ||||||
|  |  | ||||||
| Set the following volumes with the -v tag. | Set the following volumes with the -v tag. | ||||||
|  |  | ||||||
| @@ -24,7 +24,7 @@ Set the following volumes with the -v tag. | |||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -32,7 +32,7 @@ Set the following ports with the -p tag. | |||||||
| | -------------- | ------------------------ | -------- | ----------- | | | -------------- | ------------------------ | -------- | ----------- | | ||||||
| | `9117`         | `9117`                   | TCP      | WebUI       | | | `9117`         | `9117`                   | TCP      | WebUI       | | ||||||
|  |  | ||||||
| ## rebuild.sh | ### rebuild.sh | ||||||
|  |  | ||||||
| ```sh | ```sh | ||||||
| docker stop jackett | docker stop jackett | ||||||
|   | |||||||
| @@ -14,7 +14,7 @@ The default username of the web interface is `admin`. | |||||||
| The default password is `adminadmin`. | The default password is `adminadmin`. | ||||||
| Both can be changed in the web interface after setup. | Both can be changed in the web interface after setup. | ||||||
|  |  | ||||||
| ## Environment-variables | ### Environment-variables | ||||||
|  |  | ||||||
| Set the following variables with the -e tag. | Set the following variables with the -e tag. | ||||||
|  |  | ||||||
| @@ -25,7 +25,7 @@ Set the following variables with the -e tag. | |||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -34,7 +34,7 @@ Set the following volumes with the -v tag. | |||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -42,7 +42,7 @@ Set the following ports with the -p tag. | |||||||
| | -------------- | ------------------------ | -------- | ----------- | | | -------------- | ------------------------ | -------- | ----------- | | ||||||
| | `9091`         | `8080`                   | TCP      | WebUI       | | | `9091`         | `8080`                   | TCP      | WebUI       | | ||||||
|  |  | ||||||
| ## Additional | ### Additional | ||||||
|  |  | ||||||
| There are some special variables to set. | There are some special variables to set. | ||||||
|  |  | ||||||
| @@ -52,7 +52,7 @@ There are some special variables to set. | |||||||
| | `--device`  | connect devices        | | | `--device`  | connect devices        | | ||||||
| | `--sysctl`  | configure systemctl    | | | `--sysctl`  | configure systemctl    | | ||||||
|  |  | ||||||
| ## rebuild.sh | ### rebuild.sh | ||||||
|  |  | ||||||
| ```sh | ```sh | ||||||
| #!/bin/sh | #!/bin/sh | ||||||
|   | |||||||
| @@ -11,7 +11,7 @@ to it. | |||||||
| 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` afterwards. | ||||||
|  |  | ||||||
| ## 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. | ||||||
| @@ -26,7 +26,7 @@ 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. | ||||||
|  |  | ||||||
| @@ -36,7 +36,7 @@ Set the following volumes in the `volumes:` section of the docker-compose file. | |||||||
| | `/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. | ||||||
|  |  | ||||||
| @@ -45,7 +45,7 @@ Set the following ports in the `ports:` section. | |||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -53,7 +53,7 @@ Set the following networks in the `networks:` section of the docker-compose file | |||||||
| | ------- | --------------------- | | | ------- | --------------------- | | ||||||
| | `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. | ||||||
| @@ -62,7 +62,7 @@ docker-compose file. | |||||||
| | ---- | -------------------- | | | ---- | -------------------- | | ||||||
| | `db` | Ensure db is running | | | `db` | Ensure db is running | | ||||||
|  |  | ||||||
| ## rebuild.sh | ### rebuild.sh | ||||||
|  |  | ||||||
| ```sh | ```sh | ||||||
| #!/bin/sh | #!/bin/sh | ||||||
| @@ -70,7 +70,7 @@ docker-compose down | |||||||
| docker-compose up -d | docker-compose up -d | ||||||
| ``` | ``` | ||||||
|  |  | ||||||
| ## docker-compose.yml | ### docker-compose.yml | ||||||
|  |  | ||||||
| ```yml | ```yml | ||||||
| version: "2" | version: "2" | ||||||
|   | |||||||
| @@ -10,7 +10,7 @@ subcontainers - and one a [redis instance](/wiki/docker/redis.md). | |||||||
| 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` afterwards. | ||||||
|  |  | ||||||
| ## 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. | ||||||
| @@ -22,7 +22,7 @@ docker-compose file. | |||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -37,7 +37,7 @@ 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. | ||||||
|  |  | ||||||
| @@ -45,7 +45,7 @@ Set the following ports in the `ports:` section. | |||||||
| | -------------- | ------------------------ | -------- | ----------- | | | -------------- | ------------------------ | -------- | ----------- | | ||||||
| | `5000`         | `80`                     | TCP      | WebUI       | | | `5000`         | `80`                     | TCP      | WebUI       | | ||||||
|  |  | ||||||
| ## rebuild.sh | ### rebuild.sh | ||||||
|  |  | ||||||
| ```sh | ```sh | ||||||
| #!/bin/sh | #!/bin/sh | ||||||
| @@ -55,7 +55,7 @@ docker pull redis:alpine | |||||||
| docker-compose up -d | docker-compose up -d | ||||||
| ``` | ``` | ||||||
|  |  | ||||||
| ## docker-compose.yml | ### docker-compose.yml | ||||||
|  |  | ||||||
| ```yml | ```yml | ||||||
| version: "3" | version: "3" | ||||||
|   | |||||||
| @@ -1,6 +1,6 @@ | |||||||
| # grimsi - gameyfin | # grimsi - gameyfin | ||||||
|  |  | ||||||
| This is a [Docker](/wiki/docker.md) container for a [Gameyfin](/wiki/games/gameyfin.md). | This is a [Docker](/wiki/docker.md) container for a [Gameyfin](/wiki/game/gameyfin.md). | ||||||
|  |  | ||||||
| ## Set-up | ## Set-up | ||||||
|  |  | ||||||
| @@ -11,7 +11,7 @@ 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`. | Afterwards 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. | ||||||
| @@ -23,7 +23,7 @@ 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. | ||||||
|  |  | ||||||
| @@ -31,7 +31,7 @@ Set the following volumes in the `volumes:` section of the docker-compose file. | |||||||
| | ------------------------- | ----------------------- | ------------------------------ | | | ------------------------- | ----------------------- | ------------------------------ | | ||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -40,7 +40,7 @@ Set the following ports in the `ports:` section. | |||||||
| | `8080`         | `8093`                   | TCP      | WebUI                  | | | `8080`         | `8093`                   | TCP      | WebUI                  | | ||||||
|  |  | ||||||
|  |  | ||||||
| ## rebuild.sh | ### rebuild.sh | ||||||
|  |  | ||||||
| ```sh | ```sh | ||||||
| #!/bin/sh | #!/bin/sh | ||||||
| @@ -48,7 +48,7 @@ docker-compose down | |||||||
| docker-compose up -d | docker-compose up -d | ||||||
| ``` | ``` | ||||||
|  |  | ||||||
| ## docker-compose.yml | ### docker-compose.yml | ||||||
|  |  | ||||||
| ```yml | ```yml | ||||||
| version: "3" | version: "3" | ||||||
|   | |||||||
| @@ -13,7 +13,7 @@ To see which providers are supported take a look at the | |||||||
| [official documentation](https://haugene.github.io/docker-transmission-openvpn/supported-providers/). | [official documentation](https://haugene.github.io/docker-transmission-openvpn/supported-providers/). | ||||||
| Change the settings according to your needs and run `./rebuild.sh` afterwards. | Change the settings according to your needs and run `./rebuild.sh` afterwards. | ||||||
|  |  | ||||||
| ## Environment-variables | ### Environment-variables | ||||||
|  |  | ||||||
| Set the following variables with the -e tag. | Set the following variables with the -e tag. | ||||||
|  |  | ||||||
| @@ -26,7 +26,7 @@ Set the following variables with the -e tag. | |||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -36,7 +36,7 @@ Set the following volumes with the -v tag. | |||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -44,7 +44,7 @@ Set the following ports with the -p tag. | |||||||
| | -------------- | ------------------------ | -------- | ----------- | | | -------------- | ------------------------ | -------- | ----------- | | ||||||
| | `9091`         | `9091`                   | TCP      | WebUI       | | | `9091`         | `9091`                   | TCP      | WebUI       | | ||||||
|  |  | ||||||
| ## rebuild.sh | ### rebuild.sh | ||||||
|  |  | ||||||
| ```sh | ```sh | ||||||
| #!/bin/sh | #!/bin/sh | ||||||
|   | |||||||
| @@ -10,7 +10,7 @@ The official container and documentation was made by | |||||||
| Create the file `rebuild.sh`. | Create the file `rebuild.sh`. | ||||||
| Change the settings according to your needs and run `./rebuild.sh` afterwards. | Change the settings according to your needs and run `./rebuild.sh` afterwards. | ||||||
|  |  | ||||||
| ## Environment-variables | ### Environment-variables | ||||||
|  |  | ||||||
| Set the following variables with the -e tag. | Set the following variables with the -e tag. | ||||||
|  |  | ||||||
| @@ -19,7 +19,7 @@ Set the following variables with the -e tag. | |||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -27,7 +27,7 @@ Set the following volumes with the -v tag. | |||||||
| | ------------------------- | --------------- | ------------------ | | | ------------------------- | --------------- | ------------------ | | ||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -35,7 +35,7 @@ Set the following ports with the -p tag. | |||||||
| | -------------- | ------------------------ | -------- | ----------- | | | -------------- | ------------------------ | -------- | ----------- | | ||||||
| | `80`           | `8765`                   | TCP      | WebUI       | | | `80`           | `8765`                   | TCP      | WebUI       | | ||||||
|  |  | ||||||
| ## rebuild.sh | ### rebuild.sh | ||||||
|  |  | ||||||
| ```sh | ```sh | ||||||
| #!/bin/sh | #!/bin/sh | ||||||
|   | |||||||
| @@ -10,7 +10,7 @@ The official container and documentation was made by | |||||||
| Create the file `rebuild.sh`. | Create the file `rebuild.sh`. | ||||||
| Change the settings according to your needs and run `./rebuild.sh` afterwards. | Change the settings according to your needs and run `./rebuild.sh` afterwards. | ||||||
|  |  | ||||||
| ## Volumes | ### Volumes | ||||||
|  |  | ||||||
| Set the following volumes with the -v tag. | Set the following volumes with the -v tag. | ||||||
|  |  | ||||||
| @@ -18,7 +18,7 @@ Set the following volumes with the -v tag. | |||||||
| | ------------------------- | --------------- | ------------------------------- | | | ------------------------- | --------------- | ------------------------------- | | ||||||
| | `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. | ||||||
| @@ -27,12 +27,12 @@ docker-compose file. | |||||||
| | --------------------- | --------------------------- | ----------------------- | | | --------------------- | --------------------------- | ----------------------- | | ||||||
| | `TZ`                  | specify the timezone        | ``                      | | | `TZ`                  | specify the timezone        | ``                      | | ||||||
|  |  | ||||||
| ## Additional | ### Additional | ||||||
|  |  | ||||||
| The container needs acces to the host network. | The container needs acces to the host network. | ||||||
| This will at the same time expose port 8123 as web interface. | This will at the same time expose port 8123 as web interface. | ||||||
|  |  | ||||||
| ## rebuild.sh | ### rebuild.sh | ||||||
|  |  | ||||||
| ```sh | ```sh | ||||||
| docker run --name homeassistant \ | docker run --name homeassistant \ | ||||||
|   | |||||||
							
								
								
									
										75
									
								
								wiki/docker/immich-app_-_immich-server.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										75
									
								
								wiki/docker/immich-app_-_immich-server.md
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,75 @@ | |||||||
|  | # immich-app - immich-server | ||||||
|  |  | ||||||
|  | This is a [Docker](/wiki/docker.md) container for a [immich](/wiki/immich.md) server. | ||||||
|  | The official container and documentation was made by | ||||||
|  | [immich](https://github.com/immich-app/immich). | ||||||
|  | This docker-rebuild is made up by a `docker-compose.yml` file. | ||||||
|  | In addition to the main container you need to connect a | ||||||
|  | [redis](/wiki/docker/redis.md) and a [postgres](/wiki/docker/postgres.md) container to it. | ||||||
|  |  | ||||||
|  | ## Set-up | ||||||
|  |  | ||||||
|  | Create the files `rebuild.sh`, `.env` and `docker-compose.yml` at the same | ||||||
|  | place. | ||||||
|  | Please note that the `docker-compose.yml` file should be retrieved from the | ||||||
|  | [Github releases page](https://github.com/immich-app/immich/releases/) | ||||||
|  | Change the settings according to your needs and run `./rebuild.sh` afterwards. | ||||||
|  |  | ||||||
|  | ### Environment-variables | ||||||
|  |  | ||||||
|  | The environment variables are set via the `.env` file and listed in the | ||||||
|  | [corresponding section](#env). | ||||||
|  |  | ||||||
|  | ### Ports | ||||||
|  |  | ||||||
|  | Set the following ports in the `ports:` section. | ||||||
|  |  | ||||||
|  | | Container Port | Recommended outside port | Protocol  | Description   | | ||||||
|  | | -------------- | ------------------------ | --------- | ------------- | | ||||||
|  | | `2283`         | `3001`                   | TCP       | WebUI         | | ||||||
|  |  | ||||||
|  | ### Volumes | ||||||
|  |  | ||||||
|  | Set the following volumes with the -v tag. | ||||||
|  |  | ||||||
|  | | Outside mount/volume name | Container mount       | Description   | | ||||||
|  | | ------------------------- | --------------------- | ------------- | | ||||||
|  | | `immich_library`          | `/usr/src/app/upload` | Library       | | ||||||
|  | | `/etc/timezone`           | `/etc/timezone:ro`    | Timezone      | | ||||||
|  |  | ||||||
|  | ### rebuild.sh | ||||||
|  |  | ||||||
|  | ```sh #!/bin/sh | ||||||
|  | docker-compose down | ||||||
|  | docker-compose up -d | ||||||
|  | ``` | ||||||
|  |  | ||||||
|  | ### .env | ||||||
|  |  | ||||||
|  | ```sh | ||||||
|  | # You can find documentation for all the supported env variables at https://immich.app/docs/install/environment-variables | ||||||
|  |  | ||||||
|  | # The location where your uploaded files are stored | ||||||
|  | UPLOAD_LOCATION=immich_library | ||||||
|  | # The location where your database files are stored | ||||||
|  | DB_DATA_LOCATION=immich_postgres | ||||||
|  |  | ||||||
|  | # To set a timezone, uncomment the next line and change Etc/UTC to a TZ identifier from this list: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List | ||||||
|  | # TZ=Etc/UTC | ||||||
|  |  | ||||||
|  | # The Immich version to use. You can pin this to a specific version like "v1.71.0" | ||||||
|  | IMMICH_VERSION=release | ||||||
|  |  | ||||||
|  | # Connection secret for postgres. You should change it to a random password | ||||||
|  | # Please use only the characters `A-Za-z0-9`, without special characters or spaces | ||||||
|  | DB_PASSWORD=postgres | ||||||
|  |  | ||||||
|  | # Disable Machine Learning | ||||||
|  | IMMICH_MACHINE_LEARNING_ENABLED=false | ||||||
|  | IMMICH_MACHINE_LEARNING_URL=false | ||||||
|  |  | ||||||
|  | # The values below this line do not need to be changed | ||||||
|  | ################################################################################### | ||||||
|  | DB_USERNAME=postgres | ||||||
|  | DB_DATABASE_NAME=immich | ||||||
|  | ``` | ||||||
| @@ -1,7 +1,7 @@ | |||||||
| # itzg - minecraft-server | # itzg - minecraft-server | ||||||
|  |  | ||||||
| This is a [Docker](/wiki/docker.md) container for a | This is a [Docker](/wiki/docker.md) container for a | ||||||
| [Minecraft](../games/minecraft.md) server. | [Minecraft](/wiki/game/minecraft.md) server. | ||||||
| The container and documentation was made by | The container and documentation was made by | ||||||
| [itzg](https://hub.docker.com/r/itzg/minecraft-server). | [itzg](https://hub.docker.com/r/itzg/minecraft-server). | ||||||
|  |  | ||||||
| @@ -10,7 +10,7 @@ The container and documentation was made by | |||||||
| Create the file `rebuild.sh`. | Create the file `rebuild.sh`. | ||||||
| Change the settings according to your needs and run `./rebuild.sh` afterwards. | Change the settings according to your needs and run `./rebuild.sh` afterwards. | ||||||
|  |  | ||||||
| ## Environment-variables | ### Environment-variables | ||||||
|  |  | ||||||
| Set the following variables with the -e tag. | Set the following variables with the -e tag. | ||||||
|  |  | ||||||
| @@ -24,7 +24,7 @@ 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. | ||||||
|  |  | ||||||
| @@ -32,7 +32,7 @@ Set the following volumes with the -v tag. | |||||||
| | ------------------------- | --------------- | ------------------------------ | | | ------------------------- | --------------- | ------------------------------ | | ||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -40,7 +40,7 @@ Set the following ports with the -p tag. | |||||||
| | -------------- | ------------------------ | --------- | ------------------ | | | -------------- | ------------------------ | --------- | ------------------ | | ||||||
| | `25565`        | `25565`                  | Minecraft | Port for Minecraft | | | `25565`        | `25565`                  | Minecraft | Port for Minecraft | | ||||||
|  |  | ||||||
| ## rebuild.sh | ### rebuild.sh | ||||||
|  |  | ||||||
| ```sh | ```sh | ||||||
| #!/bin/sh | #!/bin/sh | ||||||
| @@ -60,3 +60,25 @@ docker run --name minecraft \ | |||||||
|     -e MOTD="Message of the day" \ |     -e MOTD="Message of the day" \ | ||||||
|     -d itzg/minecraft-server |     -d itzg/minecraft-server | ||||||
| ``` | ``` | ||||||
|  |  | ||||||
|  | ## Usage | ||||||
|  |  | ||||||
|  | This section addresses the usage of the minecraft-server container. | ||||||
|  |  | ||||||
|  | ### Installing Mods | ||||||
|  |  | ||||||
|  | Mods can be installed as described in the | ||||||
|  | [corresponding article of the official documentation](https://github.com/itzg/docker-minecraft-server/blob/master/docs/mods-and-plugins/index.md). | ||||||
|  | For this set the server type by using the `-e TYPE=<type>` flag. | ||||||
|  | `<type>` is the API that is used as the core library. | ||||||
|  | Most notably this value could be `FABRIC` or `FORGE`. | ||||||
|  | After this the mods (as `.jar` files) can be placed in the `mods` directory of the | ||||||
|  | [Docker](/wiki/docker.md) volume. | ||||||
|  | Afterwards run the [`rebuild.sh`](#rebuildsh) to restart the server with loaded mods. | ||||||
|  |  | ||||||
|  | #### Installing Datapacks | ||||||
|  |  | ||||||
|  | The installation of datapacks is done similar to the described process in the | ||||||
|  | [corresponding section of the minecraft entry](/wiki/game/minecraft.md#installing-datapacks). | ||||||
|  | The only difference is the path to place the `.zip` datapack files in which is `world/datapacks` in | ||||||
|  | case of this [Docker](/wiki/docker.md) image. | ||||||
|   | |||||||
| @@ -17,7 +17,7 @@ just created folder. | |||||||
| You can find the `docker-compose.yml` in the cloned directory. | You can find the `docker-compose.yml` in the cloned directory. | ||||||
| Set the variables, volumes and ports according and run the `rebuild.sh`. | Set the variables, volumes and ports according and run the `rebuild.sh`. | ||||||
|  |  | ||||||
| ## 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. | ||||||
| @@ -39,7 +39,7 @@ 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. | ||||||
|  |  | ||||||
| @@ -47,7 +47,7 @@ Set the following ports in the `ports:` section. | |||||||
| | -------------- | ------------------------ | -------- | ----------- | | | -------------- | ------------------------ | -------- | ----------- | | ||||||
| | `3000`         | `3000`                   | TCP      | WebUI       | | | `3000`         | `3000`                   | TCP      | WebUI       | | ||||||
|  |  | ||||||
| ## rebuild.sh | ### rebuild.sh | ||||||
|  |  | ||||||
| ```sh | ```sh | ||||||
| #!/bin/sh | #!/bin/sh | ||||||
| @@ -59,7 +59,7 @@ docker-compose up -d | |||||||
| cd .. | cd .. | ||||||
| ``` | ``` | ||||||
|  |  | ||||||
| ## docker-compose.yml | ### docker-compose.yml | ||||||
|  |  | ||||||
| ```yml | ```yml | ||||||
| version: "3" | version: "3" | ||||||
|   | |||||||
| @@ -1,6 +1,6 @@ | |||||||
| # jkarlos - git-server-docker | # jkarlos - git-server-docker | ||||||
|  |  | ||||||
| This is a [Docker](/wiki/docker.md) container for a [git](../git.md) server. | This is a [Docker](/wiki/docker.md) container for a [git](/wiki/git_%28general%29.md) server. | ||||||
| The official container and documentation was made by | The official container and documentation was made by | ||||||
| [jkarlos](https://hub.docker.com/r/jkarlos/git-server-docker). | [jkarlos](https://hub.docker.com/r/jkarlos/git-server-docker). | ||||||
|  |  | ||||||
| @@ -9,7 +9,7 @@ The official container and documentation was made by | |||||||
| Create the file `rebuild.sh`. | Create the file `rebuild.sh`. | ||||||
| Change the settings according to your needs and run `./rebuild.sh` afterwards. | Change the settings according to your needs and run `./rebuild.sh` afterwards. | ||||||
|  |  | ||||||
| ## Volumes | ### Volumes | ||||||
|  |  | ||||||
| Set the following volumes with the -v tag. | Set the following volumes with the -v tag. | ||||||
|  |  | ||||||
| @@ -18,7 +18,7 @@ Set the following volumes with the -v tag. | |||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -26,7 +26,7 @@ Set the following ports with the -p tag. | |||||||
| | -------------- | ------------------------ | -------- | ------------------------------------- | | | -------------- | ------------------------ | -------- | ------------------------------------- | | ||||||
| | `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 | ||||||
| #!/bin/sh | #!/bin/sh | ||||||
|   | |||||||
| @@ -10,7 +10,7 @@ The official container and documentation was made by | |||||||
| Create the file `rebuild.sh`. | Create the file `rebuild.sh`. | ||||||
| Change the settings according to your needs and run `./rebuild.sh` afterwards. | Change the settings according to your needs and run `./rebuild.sh` afterwards. | ||||||
|  |  | ||||||
| ## Ports | ### Ports | ||||||
|  |  | ||||||
| Set the following ports with the -p tag. | Set the following ports with the -p tag. | ||||||
|  |  | ||||||
| @@ -18,7 +18,7 @@ Set the following ports with the -p tag. | |||||||
| | -------------- | ------------------------ | -------- | ----------- | | | -------------- | ------------------------ | -------- | ----------- | | ||||||
| | `7396`         | `7396`                   | TCP      | WebUI       | | | `7396`         | `7396`                   | TCP      | WebUI       | | ||||||
|  |  | ||||||
| ## Additional | ### Additional | ||||||
|  |  | ||||||
| There are some special variables to set. | There are some special variables to set. | ||||||
|  |  | ||||||
| @@ -28,11 +28,7 @@ There are some special variables to set. | |||||||
| | `--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  | | ||||||
|  |  | ||||||
| ### GPU | ### rebuild.sh | ||||||
|  |  | ||||||
| GPU support is documented in [the docker article](../docker.md). |  | ||||||
|  |  | ||||||
| ## rebuild.sh |  | ||||||
|  |  | ||||||
| ```sh | ```sh | ||||||
| #!/bin/sh | #!/bin/sh | ||||||
| @@ -48,3 +44,9 @@ docker run --name folding-at-home \ | |||||||
|     --power=full \ |     --power=full \ | ||||||
|     --team=000000 |     --team=000000 | ||||||
| ``` | ``` | ||||||
|  |  | ||||||
|  | ## Usage | ||||||
|  |  | ||||||
|  | ### GPU-Support | ||||||
|  |  | ||||||
|  | GPU support is documented in [the docker article](../docker.md). | ||||||
|   | |||||||
| @@ -10,7 +10,7 @@ The official container and documentation was made by | |||||||
| Create the file `rebuild.sh`. | Create the file `rebuild.sh`. | ||||||
| Change the settings according to your needs and run `./rebuild.sh` afterwards. | Change the settings according to your needs and run `./rebuild.sh` afterwards. | ||||||
|  |  | ||||||
| ## Volumes | ### Volumes | ||||||
|  |  | ||||||
| Set the following volumes with the -v tag. | Set the following volumes with the -v tag. | ||||||
|  |  | ||||||
| @@ -18,7 +18,7 @@ Set the following volumes with the -v tag. | |||||||
| | ------------------------- | --------------- | ------------------------ | | | ------------------------- | --------------- | ------------------------ | | ||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -26,7 +26,7 @@ Set the following ports with the -p tag. | |||||||
| | -------------- | ------------------------ | -------- | ------------ | | | -------------- | ------------------------ | -------- | ------------ | | ||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -36,7 +36,7 @@ Set the following variables with the -e tag. | |||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -46,7 +46,7 @@ There are some special variables to set. | |||||||
| | `--device`  | connect devices        | | | `--device`  | connect devices        | | ||||||
| | `--sysctl`  | configure systemctl    | | | `--sysctl`  | configure systemctl    | | ||||||
|  |  | ||||||
| ## rebuild.sh | ### rebuild.sh | ||||||
|  |  | ||||||
| ```sh | ```sh | ||||||
| #!/bin/sh | #!/bin/sh | ||||||
|   | |||||||
| @@ -22,21 +22,7 @@ docker run -v openvpn:/etc/openvpn --rm -it kylemanna/openvpn ovpn_initpki | |||||||
|  |  | ||||||
| Afterwards run `./rebuild.sh`. | Afterwards run `./rebuild.sh`. | ||||||
|  |  | ||||||
| ## Usage | ### Volumes | ||||||
|  |  | ||||||
| ### Create Certificates |  | ||||||
|  |  | ||||||
| Each device that connects to the [OpenVPN](/wiki/openvpn.md) server should |  | ||||||
| have a certificate to connect by. |  | ||||||
| Create a certificate and retrieve it by running the following commands. |  | ||||||
| Change all occurences of `<CLIENTNAME>` to the name of the client. |  | ||||||
|  |  | ||||||
| ```sh |  | ||||||
| docker run -v openvpn:/etc/openvpn --rm -it kylemanna/openvpn easyrsa build-client-full <CLIENTNAME> nopass |  | ||||||
| docker run -v openvpn:/etc/openvpn --rm kylemanna/openvpn ovpn_getclient <CLIENTNAME> > <CLIENTNAME>.ovpn |  | ||||||
| ``` |  | ||||||
|  |  | ||||||
| ## Volumes |  | ||||||
|  |  | ||||||
| Set the following volumes with the -v tag. | Set the following volumes with the -v tag. | ||||||
|  |  | ||||||
| @@ -44,7 +30,7 @@ Set the following volumes with the -v tag. | |||||||
| | ------------------------- | --------------- | ------------------------ | | | ------------------------- | --------------- | ------------------------ | | ||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -52,7 +38,7 @@ Set the following ports with the -p tag. | |||||||
| | -------------- | ------------------------ | -------- | ------------ | | | -------------- | ------------------------ | -------- | ------------ | | ||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -60,7 +46,7 @@ There are some special variables to set. | |||||||
| | ----------- | ---------------------- | | | ----------- | ---------------------- | | ||||||
| | `--cap-add` | add linux capabilities | | | `--cap-add` | add linux capabilities | | ||||||
|  |  | ||||||
| ## rebuild.sh | ### rebuild.sh | ||||||
|  |  | ||||||
| ```sh | ```sh | ||||||
| #!/bin/sh | #!/bin/sh | ||||||
| @@ -74,3 +60,17 @@ docker run --name openvpn \ | |||||||
|     -v ovpn:/etc/openvpn \ |     -v ovpn:/etc/openvpn \ | ||||||
|     -d kylemanna/openvpn |     -d kylemanna/openvpn | ||||||
| ``` | ``` | ||||||
|  |  | ||||||
|  | ## Usage | ||||||
|  |  | ||||||
|  | ### Create Certificates | ||||||
|  |  | ||||||
|  | Each device that connects to the [OpenVPN](/wiki/openvpn.md) server should | ||||||
|  | have a certificate to connect by. | ||||||
|  | Create a certificate and retrieve it by running the following commands. | ||||||
|  | Change all occurences of `<CLIENTNAME>` to the name of the client. | ||||||
|  |  | ||||||
|  | ```sh | ||||||
|  | docker run -v openvpn:/etc/openvpn --rm -it kylemanna/openvpn easyrsa build-client-full <CLIENTNAME> nopass | ||||||
|  | docker run -v openvpn:/etc/openvpn --rm kylemanna/openvpn ovpn_getclient <CLIENTNAME> > <CLIENTNAME>.ovpn | ||||||
|  | ``` | ||||||
|   | |||||||
| @@ -10,7 +10,7 @@ The official container and documentation was made by | |||||||
| Create the file `rebuild.sh`. | Create the file `rebuild.sh`. | ||||||
| Change the settings according to your needs and run `./rebuild.sh` afterwards. | Change the settings according to your needs and run `./rebuild.sh` afterwards. | ||||||
|  |  | ||||||
| ## Environment-variables | ### Environment-variables | ||||||
|  |  | ||||||
| Set the following variables with the -e tag. | Set the following variables with the -e tag. | ||||||
|  |  | ||||||
| @@ -20,7 +20,7 @@ Set the following variables with the -e tag. | |||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -33,7 +33,7 @@ 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. | ||||||
|  |  | ||||||
| @@ -41,7 +41,7 @@ Set the following ports with the -p tag. | |||||||
| | -------------- | ------------------------ | -------- | ----------- | | | -------------- | ------------------------ | -------- | ----------- | | ||||||
| | `4040`         | `4040`                   | TCP      | WebUI       | | | `4040`         | `4040`                   | TCP      | WebUI       | | ||||||
|  |  | ||||||
| ## rebuild.sh | ### rebuild.sh | ||||||
|  |  | ||||||
| ```sh | ```sh | ||||||
| #!/bin/sh | #!/bin/sh | ||||||
|   | |||||||
| @@ -10,7 +10,7 @@ The official container and documentation was made by | |||||||
| Create the file `rebuild.sh`. | Create the file `rebuild.sh`. | ||||||
| Change the settings according to your needs and run `./rebuild.sh` afterwards. | Change the settings according to your needs and run `./rebuild.sh` afterwards. | ||||||
|  |  | ||||||
| ## Environment-variables | ### Environment-variables | ||||||
|  |  | ||||||
| Set the following variables with the -e tag. | Set the following variables with the -e tag. | ||||||
|  |  | ||||||
| @@ -20,7 +20,7 @@ Set the following variables with the -e tag. | |||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -33,7 +33,7 @@ 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. | ||||||
|  |  | ||||||
| @@ -41,7 +41,7 @@ Set the following ports with the -p tag. | |||||||
| | -------------- | ------------------------ | -------- | ----------- | | | -------------- | ------------------------ | -------- | ----------- | | ||||||
| | `4040`         | `4040`                   | TCP      | WebUI       | | | `4040`         | `4040`                   | TCP      | WebUI       | | ||||||
|  |  | ||||||
| ## rebuild.sh | ### rebuild.sh | ||||||
|  |  | ||||||
| ```sh | ```sh | ||||||
| #!/bin/sh | #!/bin/sh | ||||||
|   | |||||||
| @@ -11,7 +11,7 @@ This docker-rebuild is made up by a `docker-compose.yml` file. | |||||||
| 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` afterwards. | ||||||
|  |  | ||||||
| ## 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. | ||||||
| @@ -22,7 +22,7 @@ docker-compose file. | |||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -30,7 +30,7 @@ Set the following volumes in the `volumes:` section of the docker-compose file. | |||||||
| | ------------------------- | --------------- | ------------------------------------ | | | ------------------------- | --------------- | ------------------------------------ | | ||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -38,7 +38,7 @@ Set the following ports in the `ports:` section. | |||||||
| | -------------- | ------------------------ | -------- | ----------- | | | -------------- | ------------------------ | -------- | ----------- | | ||||||
| | `7008`         | `80`                     | TCP      | WebUI       | | | `7008`         | `80`                     | TCP      | WebUI       | | ||||||
|  |  | ||||||
| ## rebuild.sh | ### rebuild.sh | ||||||
|  |  | ||||||
| ```sh | ```sh | ||||||
| #!/bin/sh | #!/bin/sh | ||||||
| @@ -47,7 +47,7 @@ docker pull lscr.io/linuxserver/freshrss:latest | |||||||
| docker-compose up -d | docker-compose up -d | ||||||
| ``` | ``` | ||||||
|  |  | ||||||
| ## docker-compose.yml | ### docker-compose.yml | ||||||
|  |  | ||||||
| ```yml | ```yml | ||||||
| version: "2.1" | version: "2.1" | ||||||
|   | |||||||
| @@ -11,7 +11,7 @@ This docker-rebuild is made up by a `docker-compose.yml` file. | |||||||
| 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` afterwards. | ||||||
|  |  | ||||||
| ## 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. | ||||||
| @@ -22,7 +22,7 @@ docker-compose file. | |||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -40,7 +40,7 @@ it is recommended to use them as external volumes (volumes section: | |||||||
| To use the rebuild the volumes have to exist before creating the container | To use the rebuild the volumes have to exist before creating the container | ||||||
| (`docker volume create media_movies` and tvshows accordingly). | (`docker volume create media_movies` and tvshows accordingly). | ||||||
|  |  | ||||||
| ## Ports | ### Ports | ||||||
|  |  | ||||||
| Set the following ports in the `ports:` section. | Set the following ports in the `ports:` section. | ||||||
|  |  | ||||||
| @@ -48,7 +48,7 @@ Set the following ports in the `ports:` section. | |||||||
| | -------------- | ------------------------ | -------- | ----------- | | | -------------- | ------------------------ | -------- | ----------- | | ||||||
| | `8096`         | `8096`                   | TCP      | WebUI       | | | `8096`         | `8096`                   | TCP      | WebUI       | | ||||||
|  |  | ||||||
| ## rebuild.sh | ### rebuild.sh | ||||||
|  |  | ||||||
| ```sh | ```sh | ||||||
| #!/bin/sh | #!/bin/sh | ||||||
| @@ -57,7 +57,7 @@ docker pull linuxserver/jellyfin:latest | |||||||
| docker-compose up -d | docker-compose up -d | ||||||
| ``` | ``` | ||||||
|  |  | ||||||
| ## docker-compose.yml | ### docker-compose.yml | ||||||
|  |  | ||||||
| ```yml | ```yml | ||||||
| version: "2" | version: "2" | ||||||
|   | |||||||
| @@ -21,7 +21,7 @@ This namely causes the following line in the | |||||||
|       - /var/lib/docker/volumes/transmission_data/_data/completed:/data/completed #optional |       - /var/lib/docker/volumes/transmission_data/_data/completed:/data/completed #optional | ||||||
| ``` | ``` | ||||||
|  |  | ||||||
| ## 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. | ||||||
| @@ -32,7 +32,7 @@ docker-compose file. | |||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -41,7 +41,7 @@ Set the following volumes in the `volumes:` section of the docker-compose file. | |||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -49,7 +49,7 @@ Set the following ports in the `ports:` section. | |||||||
| | -------------- | ------------------------ | -------- | ------------ | | | -------------- | ------------------------ | -------- | ------------ | | ||||||
| | `8686`         | `8686`                   | TCP      | webUI        | | | `8686`         | `8686`                   | TCP      | webUI        | | ||||||
|  |  | ||||||
| ## rebuild.sh | ### rebuild.sh | ||||||
|  |  | ||||||
| ```sh | ```sh | ||||||
| #!/bin/sh | #!/bin/sh | ||||||
| @@ -58,7 +58,7 @@ docker pull lscr.io/linuxserver/lidarr:latest | |||||||
| docker-compose up -d | docker-compose up -d | ||||||
| ``` | ``` | ||||||
|  |  | ||||||
| ## docker-compose.yml | ### docker-compose.yml | ||||||
|  |  | ||||||
| ```yml | ```yml | ||||||
| version: "2.1" | version: "2.1" | ||||||
|   | |||||||
| @@ -21,7 +21,7 @@ This namely causes the following line in the | |||||||
|       - /var/lib/docker/volumes/transmission_data/_data/completed:/data/completed #optional |       - /var/lib/docker/volumes/transmission_data/_data/completed:/data/completed #optional | ||||||
| ``` | ``` | ||||||
|  |  | ||||||
| ## 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. | ||||||
| @@ -32,7 +32,7 @@ docker-compose file. | |||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -41,7 +41,7 @@ Set the following volumes in the `volumes:` section of the docker-compose file. | |||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -49,7 +49,7 @@ Set the following ports in the `ports:` section. | |||||||
| | -------------- | ------------------------ | -------- | ------------ | | | -------------- | ------------------------ | -------- | ------------ | | ||||||
| | `7878`         | `7878`                   | TCP      | webUI        | | | `7878`         | `7878`                   | TCP      | webUI        | | ||||||
|  |  | ||||||
| ## rebuild.sh | ### rebuild.sh | ||||||
|  |  | ||||||
| ```sh | ```sh | ||||||
| #!/bin/sh | #!/bin/sh | ||||||
| @@ -58,7 +58,7 @@ docker pull lscr.io/linuxserver/radarr:latest | |||||||
| docker-compose up -d | docker-compose up -d | ||||||
| ``` | ``` | ||||||
|  |  | ||||||
| ## docker-compose.yml | ### docker-compose.yml | ||||||
|  |  | ||||||
| ```yml | ```yml | ||||||
| version: "2.1" | version: "2.1" | ||||||
|   | |||||||
| @@ -21,7 +21,7 @@ This namely causes the following line in the | |||||||
|       - /var/lib/docker/volumes/transmission_data/_data/completed:/data/completed #optional |       - /var/lib/docker/volumes/transmission_data/_data/completed:/data/completed #optional | ||||||
| ``` | ``` | ||||||
|  |  | ||||||
| ## 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. | ||||||
| @@ -32,7 +32,7 @@ docker-compose file. | |||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -41,7 +41,7 @@ Set the following volumes in the `volumes:` section of the docker-compose file. | |||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -49,7 +49,7 @@ Set the following ports in the `ports:` section. | |||||||
| | -------------- | ------------------------ | -------- | ------------ | | | -------------- | ------------------------ | -------- | ------------ | | ||||||
| | `8989`         | `8989`                   | TCP      | webUI        | | | `8989`         | `8989`                   | TCP      | webUI        | | ||||||
|  |  | ||||||
| ## rebuild.sh | ### rebuild.sh | ||||||
|  |  | ||||||
| ```sh | ```sh | ||||||
| #!/bin/sh | #!/bin/sh | ||||||
| @@ -58,7 +58,7 @@ docker pull lscr.io/linuxserver/sonarr:latest | |||||||
| docker-compose up -d | docker-compose up -d | ||||||
| ``` | ``` | ||||||
|  |  | ||||||
| ## docker-compose.yml | ### docker-compose.yml | ||||||
|  |  | ||||||
| ```yml | ```yml | ||||||
| version: "2.1" | version: "2.1" | ||||||
|   | |||||||
| @@ -10,7 +10,7 @@ The official container and documentation was made by | |||||||
| Create the file `rebuild.sh`. | Create the file `rebuild.sh`. | ||||||
| Change the settings according to your needs and run `./rebuild.sh` afterwards. | Change the settings according to your needs and run `./rebuild.sh` afterwards. | ||||||
|  |  | ||||||
| ## Environment-variables | ### Environment-variables | ||||||
|  |  | ||||||
| Set the following variables with the -e tag. | Set the following variables with the -e tag. | ||||||
|  |  | ||||||
| @@ -21,7 +21,7 @@ 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. | ||||||
|  |  | ||||||
| @@ -29,7 +29,7 @@ Set the following volumes with the -v tag. | |||||||
| | ------------------ | --------------- | ----------------------------------------------- | | | ------------------ | --------------- | ----------------------------------------------- | | ||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -39,7 +39,7 @@ Set the following ports with the -p tag. | |||||||
| | `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 | ||||||
| #!/bin/sh | #!/bin/sh | ||||||
|   | |||||||
| @@ -10,7 +10,7 @@ The official container and documentation was made by | |||||||
| 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` afterwards. | ||||||
|  |  | ||||||
| ## 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. | ||||||
| @@ -22,7 +22,7 @@ docker-compose file. | |||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -31,7 +31,7 @@ Set the following volumes in the `volumes:` section of the docker-compose file. | |||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -49,7 +49,7 @@ docker pull lscr.io/linuxserver/tvheadend:latest | |||||||
| docker-compose up -d | docker-compose up -d | ||||||
| ``` | ``` | ||||||
|  |  | ||||||
| ## docker-compose.yml | ### docker-compose.yml | ||||||
|  |  | ||||||
| ```yml | ```yml | ||||||
| version: "2.1" | version: "2.1" | ||||||
|   | |||||||
| @@ -38,7 +38,7 @@ Finally if a reverse proxy is used check the | |||||||
|  |  | ||||||
| Afterwards you're ready to go by once again running the `rebuild.sh` file. | Afterwards you're ready to go by once again running the `rebuild.sh` file. | ||||||
|  |  | ||||||
| ## rebuild.sh | ### rebuild.sh | ||||||
|  |  | ||||||
| ```sh | ```sh | ||||||
| #!/bin/sh | #!/bin/sh | ||||||
|   | |||||||
| @@ -5,7 +5,15 @@ The official container and documentation was made by [mariadb](https://hub.docke | |||||||
| The Docker container is mainly used in combination with other containers. | The Docker container is mainly used in combination with other containers. | ||||||
| To achieve this in the easiest way use a docker-compose file. | To achieve this in the easiest way use a docker-compose file. | ||||||
|  |  | ||||||
| ## Environment-variables | ## Set-Up | ||||||
|  |  | ||||||
|  | The mariadb Docker container is dependent on another container most of the time.  | ||||||
|  | The exact setup will be described in the regarding entry. | ||||||
|  | Nevertheless both environment variables and volumes are listed in the sections below. | ||||||
|  | Nevertheless both environment variables and volumes and networks are listed in the sections below. | ||||||
|  | These are needed most often. | ||||||
|  |  | ||||||
|  | ### 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. | ||||||
| @@ -17,10 +25,15 @@ 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 | ||||||
|  |  | ||||||
|  | You can set networks in the `networks:` part of a docker-compose file to connect | ||||||
|  | the database with other docker containers. | ||||||
|   | |||||||
							
								
								
									
										97
									
								
								wiki/docker/massivedecks_-_client.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										97
									
								
								wiki/docker/massivedecks_-_client.md
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,97 @@ | |||||||
|  | # massivedecks - client | ||||||
|  |  | ||||||
|  | This is a [Docker](/wiki/docker.md) container for a [Massive Deecks](/wiki/game/massive_decks.md) | ||||||
|  | client. | ||||||
|  | Due to ease of use this entry will also feature the server container. | ||||||
|  | The official container and documentation was made by | ||||||
|  | [Lattyware](https://github.com/Lattyware/massivedecks). | ||||||
|  | This docker-rebuild is made up by a `docker-compose.yml` file. | ||||||
|  | In addition to the client and server containers a [postgres container](/wiki/docker/postgres.md) | ||||||
|  | needs to be connected. | ||||||
|  |  | ||||||
|  | ## Set-up | ||||||
|  |  | ||||||
|  | Create the files `rebuild.sh`, `.env` and `docker-compose.yml` at the same | ||||||
|  | place. | ||||||
|  | Make sure to set `POSTGRES_PASSWORD`. | ||||||
|  | Change the settings according to your needs and run `./rebuild.sh` afterwards. | ||||||
|  |  | ||||||
|  | ### Ports | ||||||
|  |  | ||||||
|  | Set the following ports in the `ports:` section. | ||||||
|  |  | ||||||
|  | | Container Port | Recommended outside port | Protocol | Description | | ||||||
|  | | -------------- | ------------------------ | -------- | ----------- | | ||||||
|  | | `8080`         | `8080`                   | TCP      | WebUI       | | ||||||
|  |  | ||||||
|  | ### Environment-variables | ||||||
|  |  | ||||||
|  | Set the following environment-variables in the `environment:` section of the | ||||||
|  | docker-compose file. | ||||||
|  |  | ||||||
|  | | Name        | Usage                   | Default           | | ||||||
|  | | ----------- | ----------------------- | ----------------- | | ||||||
|  | | `NODE_ENV`  | Setting the environment | `production`      | | ||||||
|  |  | ||||||
|  | ### rebuild.sh | ||||||
|  |  | ||||||
|  | ```sh | ||||||
|  | #!/bin/sh | ||||||
|  | docker-compose down | ||||||
|  | docker pull postgres:14 | ||||||
|  | docker pull ghcr.io/lattyware/massivedecks/server:latest-release | ||||||
|  | docker pull ghcr.io/lattyware/massivedecks/client:latest-release | ||||||
|  | docker-compose up -d | ||||||
|  | ``` | ||||||
|  |  | ||||||
|  | ### docker-compose.yml | ||||||
|  |  | ||||||
|  | ```yml | ||||||
|  | version: "3.3" | ||||||
|  | services: | ||||||
|  |   storage: | ||||||
|  |     image: "postgres:14" | ||||||
|  |     restart: unless-stopped | ||||||
|  |     environment: | ||||||
|  |       - POSTGRES_USER=massivedecks | ||||||
|  |       - POSTGRES_PASSWORD=<password> | ||||||
|  |     networks: | ||||||
|  |       - internal | ||||||
|  |     volumes: | ||||||
|  |       - storage-volume:/var/lib/postgresql/data | ||||||
|  |  | ||||||
|  |   server: | ||||||
|  |     image: "ghcr.io/lattyware/massivedecks/server:latest-release" | ||||||
|  |     restart: unless-stopped | ||||||
|  |     environment: | ||||||
|  |       - NODE_ENV=production | ||||||
|  |     depends_on: | ||||||
|  |       - storage | ||||||
|  |     networks: | ||||||
|  |       - internal | ||||||
|  |     configs: | ||||||
|  |       - source: md_server_config | ||||||
|  |         target: /md/config.json5 | ||||||
|  |  | ||||||
|  |   client: | ||||||
|  |     image: "ghcr.io/lattyware/massivedecks/client:latest-release" | ||||||
|  |     restart: unless-stopped | ||||||
|  |     depends_on: | ||||||
|  |       - server | ||||||
|  |     networks: | ||||||
|  |       - internal | ||||||
|  |     ports: | ||||||
|  |       - "8080:8080" | ||||||
|  |  | ||||||
|  | networks: | ||||||
|  |   internal: | ||||||
|  |     external: false | ||||||
|  |  | ||||||
|  | volumes: | ||||||
|  |   storage-volume: | ||||||
|  |     driver: local | ||||||
|  |  | ||||||
|  | configs: | ||||||
|  |   md_server_config: | ||||||
|  |     external: true | ||||||
|  | ``` | ||||||
| @@ -11,7 +11,7 @@ This docker-rebuild is made up by a `docker-compose.yml` file. | |||||||
| 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` afterwards. | ||||||
|  |  | ||||||
| ## 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. | ||||||
| @@ -24,7 +24,7 @@ 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. | ||||||
|  |  | ||||||
| @@ -32,7 +32,7 @@ Set the following volumes in the `volumes:` section of the docker-compose file. | |||||||
| | ------------------------- | --------------- | --------------------------------- | | | ------------------------- | --------------- | --------------------------------- | | ||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -40,7 +40,7 @@ Set the following ports in the `ports:` section. | |||||||
| | -------------- | ------------------------ | -------- | ---------------------- | | | -------------- | ------------------------ | -------- | ---------------------- | | ||||||
| | `8008`         | `443`                    | TCP      | matrix homeserver port | | | `8008`         | `443`                    | TCP      | matrix homeserver port | | ||||||
|  |  | ||||||
| ## rebuild.sh | ### rebuild.sh | ||||||
|  |  | ||||||
| ```sh | ```sh | ||||||
| #!/bin/sh | #!/bin/sh | ||||||
| @@ -49,7 +49,7 @@ docker pull matrixdotorg/synapse:latest | |||||||
| docker-compose up -d | docker-compose up -d | ||||||
| ``` | ``` | ||||||
|  |  | ||||||
| ## docker-compose.yml | ### docker-compose.yml | ||||||
|  |  | ||||||
| ```yml | ```yml | ||||||
| services: | services: | ||||||
|   | |||||||
| @@ -11,7 +11,7 @@ The official container and documentation was made by | |||||||
| Create the file `rebuild.sh`. | Create the file `rebuild.sh`. | ||||||
| Change the settings according to your needs and run `./rebuild.sh` afterwards. | Change the settings according to your needs and run `./rebuild.sh` afterwards. | ||||||
|  |  | ||||||
| ## Environment-variables | ### Environment-variables | ||||||
|  |  | ||||||
| Set the following variables with the -e tag. | Set the following variables with the -e tag. | ||||||
|  |  | ||||||
| @@ -22,7 +22,7 @@ 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. | ||||||
|  |  | ||||||
| @@ -31,7 +31,7 @@ Set the following volumes with the -v tag. | |||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -41,7 +41,7 @@ Set the following ports with the -p tag. | |||||||
| | `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 | ||||||
| #!/bin/sh | #!/bin/sh | ||||||
|   | |||||||
| @@ -6,7 +6,14 @@ The official container and documentation was made by | |||||||
| The Docker container is mainly used in combination with other containers. | The Docker container is mainly used in combination with other containers. | ||||||
| To achieve this in the easiest way use a docker-compose file | To achieve this in the easiest way use a docker-compose file | ||||||
|  |  | ||||||
| ## Environment-variables | ## Set-Up | ||||||
|  |  | ||||||
|  | The mysql Docker container is dependent on another container most of the time.  | ||||||
|  | The exact setup will be described in the regarding entry. | ||||||
|  | Nevertheless both environment variables and volumes and networks are listed in the sections below. | ||||||
|  | These are needed most often. | ||||||
|  |  | ||||||
|  | ### 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. | ||||||
| @@ -18,7 +25,7 @@ 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. | ||||||
|  |  | ||||||
| @@ -26,7 +33,7 @@ Set the following volumes in the `volumes:` section of the docker-compose file. | |||||||
| | ------------------------- | ---------------- | ------------------------- | | | ------------------------- | ---------------- | ------------------------- | | ||||||
| | `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 | ||||||
| the database with other docker containers. | the database with other docker containers. | ||||||
|   | |||||||
| @@ -23,7 +23,7 @@ mariadb:9 | |||||||
| Make sure to substitute all the occurences of the `:latest` tag accordingly. | Make sure to substitute all the occurences of the `:latest` tag accordingly. | ||||||
| Updating has to be done manually so nothing breaks. | Updating has to be done manually so nothing breaks. | ||||||
|  |  | ||||||
| ## 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. | ||||||
|  |  | ||||||
| @@ -31,7 +31,7 @@ Set the following volumes in the `volumes:` section of the docker-compose file. | |||||||
| | ------------------------- | --------------- | ---------------------------------------- | | | ------------------------- | --------------- | ---------------------------------------- | | ||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -39,7 +39,7 @@ Set the following ports in the `ports:` section. | |||||||
| | -------------- | ------------------------ | -------- | ----------- | | | -------------- | ------------------------ | -------- | ----------- | | ||||||
| | `80`           | `80`                     | TCP      | WebUI       | | | `80`           | `80`                     | TCP      | WebUI       | | ||||||
|  |  | ||||||
| ## rebuild.sh | ### rebuild.sh | ||||||
|  |  | ||||||
| ```sh | ```sh | ||||||
| #!/bin/sh | #!/bin/sh | ||||||
| @@ -49,7 +49,7 @@ docker pull mariadb:latest | |||||||
| docker-compose up -d | docker-compose up -d | ||||||
| ``` | ``` | ||||||
|  |  | ||||||
| ## docker-compose.yml | ### docker-compose.yml | ||||||
|  |  | ||||||
| ```yml | ```yml | ||||||
| version: '2' | version: '2' | ||||||
|   | |||||||
| @@ -11,7 +11,7 @@ This docker-rebuild is made up by a `docker-compose.yml` file. | |||||||
| 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` afterwards. | ||||||
|  |  | ||||||
| ## 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. | ||||||
|  |  | ||||||
| @@ -19,7 +19,7 @@ Set the following volumes in the `volumes:` section of the docker-compose file. | |||||||
| | ------------------------- | -------------------- | --------------------------- | | | ------------------------- | -------------------- | --------------------------- | | ||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -28,7 +28,7 @@ Set the following ports in the `ports:` section. | |||||||
| | `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 | ||||||
| #!/bin/sh | #!/bin/sh | ||||||
| @@ -37,7 +37,7 @@ docker pull nginx:latest | |||||||
| docker-compose up -d | docker-compose up -d | ||||||
| ``` | ``` | ||||||
|  |  | ||||||
| ## docker-compose.yml | ### docker-compose.yml | ||||||
|  |  | ||||||
| ```yml | ```yml | ||||||
| version: "2" | version: "2" | ||||||
|   | |||||||
| @@ -9,7 +9,7 @@ The official container and documentation was made by | |||||||
| Create the file `rebuild.sh`. | Create the file `rebuild.sh`. | ||||||
| Change the settings according to your needs and run `./rebuild.sh` afterwards. | Change the settings according to your needs and run `./rebuild.sh` afterwards. | ||||||
|  |  | ||||||
| ## Volumes | ### Volumes | ||||||
|  |  | ||||||
| Set the following volumes with the -v tag. | Set the following volumes with the -v tag. | ||||||
|  |  | ||||||
| @@ -18,7 +18,7 @@ Set the following volumes with the -v tag. | |||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -26,11 +26,11 @@ Set the following ports with the -p tag. | |||||||
| | -------------- | ------------------------ | -------- | ----------------- | | | -------------- | ------------------------ | -------- | ----------------- | | ||||||
| | `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`. | ||||||
|  |  | ||||||
| ## rebuild.sh | ### rebuild.sh | ||||||
|  |  | ||||||
| ```sh | ```sh | ||||||
| #!/bin/sh | #!/bin/sh | ||||||
|   | |||||||
							
								
								
									
										40
									
								
								wiki/docker/ollama_-_ollama.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										40
									
								
								wiki/docker/ollama_-_ollama.md
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,40 @@ | |||||||
|  | # ollama - ollama | ||||||
|  |  | ||||||
|  | This is a [Docker](/wiki/docker.md) container for an ollama server. | ||||||
|  | The official container and documentation was made by | ||||||
|  | [ollama](https://hub.docker.com/r/ollama/ollama). | ||||||
|  |  | ||||||
|  | ## Set-up | ||||||
|  |  | ||||||
|  | Create the file `rebuild.sh`. | ||||||
|  | Change the settings according to your needs and run `./rebuild.sh` afterwards. | ||||||
|  |  | ||||||
|  | ## Ports | ||||||
|  |  | ||||||
|  | Set the following ports in the `ports:` section. | ||||||
|  |  | ||||||
|  | | Container Port | Recommended outside port | Protocol  | Description         | | ||||||
|  | | -------------- | ------------------------ | --------- | ------------------- | | ||||||
|  | | `11434`        | `11434`                  | TCP       | Communications port | | ||||||
|  |  | ||||||
|  | ## Volumes | ||||||
|  |  | ||||||
|  | Set the following volumes with the -v tag. | ||||||
|  |  | ||||||
|  | | Outside mount/volume name | Container mount | Description   | | ||||||
|  | | ------------------------- | --------------- | ------------- | | ||||||
|  | | `ollama`                  | `/root/.ollama` | Ollama data | | ||||||
|  |  | ||||||
|  | ## rebuild.sh | ||||||
|  |  | ||||||
|  | ```sh | ||||||
|  | #!/bin/sh | ||||||
|  | docker stop ollama | ||||||
|  | docker rm ollama | ||||||
|  | docker pull ollama/ollama | ||||||
|  | docker run --name ollama \ | ||||||
|  |     --restart unless-stopped \ | ||||||
|  |     -p 11434:11434 \ | ||||||
|  |     -v ollama:/root/.ollama \ | ||||||
|  |     -d ollama/ollama | ||||||
|  | ``` | ||||||
							
								
								
									
										41
									
								
								wiki/docker/open-webui_-_open-webui.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										41
									
								
								wiki/docker/open-webui_-_open-webui.md
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,41 @@ | |||||||
|  | # open-webui - open-webui | ||||||
|  |  | ||||||
|  | This is a [Docker](/wiki/docker.md) container for a Open WebUI server. | ||||||
|  | The official container and documentation was made by | ||||||
|  | [open-webui](https://github.com/open-webui/open-webui). | ||||||
|  |  | ||||||
|  | ## Set-up | ||||||
|  |  | ||||||
|  | Create the file `rebuild.sh`. | ||||||
|  | Change the settings according to your needs and run `./rebuild.sh` afterwards. | ||||||
|  |  | ||||||
|  | ## Ports | ||||||
|  |  | ||||||
|  | Set the following ports in the `ports:` section. | ||||||
|  |  | ||||||
|  | | Container Port | Recommended outside port | Protocol  | Description   | | ||||||
|  | | -------------- | ------------------------ | --------- | ------------- | | ||||||
|  | | `11434`        | `8080`                   | TCP       | WebUI         | | ||||||
|  |  | ||||||
|  | ## Volumes | ||||||
|  |  | ||||||
|  | Set the following volumes with the -v tag. | ||||||
|  |  | ||||||
|  | | Outside mount/volume name | Container mount     | Description     | | ||||||
|  | | ------------------------- | ------------------- | --------------- | | ||||||
|  | | `open-webui`              | `/app/backend/data` | Open WebUI data | | ||||||
|  |  | ||||||
|  | ## rebuild.sh | ||||||
|  |  | ||||||
|  | ```sh | ||||||
|  | #!/bin/sh | ||||||
|  | docker stop openwebui | ||||||
|  | docker rm openwebui | ||||||
|  | docker pull ghcr.io/open-webui/open-webui:main | ||||||
|  | docker run --name openwebui \ | ||||||
|  |     --restart unless-stopped \ | ||||||
|  |     -p 11434:8080 \ | ||||||
|  |     -v open-webui:/app/backend/data \ | ||||||
|  |     -d ghcr.io/open-webui/open-webui:main | ||||||
|  |  | ||||||
|  | ``` | ||||||
| @@ -13,7 +13,7 @@ Docker container. | |||||||
| 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` afterwards. | ||||||
|  |  | ||||||
| ## 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. | ||||||
|  |  | ||||||
| @@ -22,7 +22,7 @@ Set the following volumes in the `volumes:` section of the docker-compose file. | |||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -30,7 +30,7 @@ Set the following ports in the `ports:` section. | |||||||
| | -------------- | ------------------------ | -------- | ----------- | | | -------------- | ------------------------ | -------- | ----------- | | ||||||
| | `80`           | `80`                     | TCP      | WebUI       | | | `80`           | `80`                     | TCP      | WebUI       | | ||||||
|  |  | ||||||
| ## rebuild.sh | ### rebuild.sh | ||||||
|  |  | ||||||
| ```sh | ```sh | ||||||
| #!/bin/sh | #!/bin/sh | ||||||
| @@ -40,7 +40,7 @@ docker pull mariadb | |||||||
| docker-compose up -d | docker-compose up -d | ||||||
| ``` | ``` | ||||||
|  |  | ||||||
| ## docker-compose.yml | ### docker-compose.yml | ||||||
|  |  | ||||||
| ```yml | ```yml | ||||||
| version: "3.1" | version: "3.1" | ||||||
|   | |||||||
| @@ -10,7 +10,7 @@ The official container and documentation was made by | |||||||
| Create the file `rebuild.sh`. | Create the file `rebuild.sh`. | ||||||
| Change the settings according to your needs and run `./rebuild.sh` afterwards. | Change the settings according to your needs and run `./rebuild.sh` afterwards. | ||||||
|  |  | ||||||
| ## Environment variables | ### Environment variables | ||||||
|  |  | ||||||
| Set the following variables with the -e tag. | Set the following variables with the -e tag. | ||||||
|  |  | ||||||
| @@ -20,7 +20,7 @@ Set the following variables with the -e tag. | |||||||
| | `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 | ||||||
| #!/bin/sh | #!/bin/sh | ||||||
|   | |||||||
| @@ -8,7 +8,7 @@ The official container and documentation was made by [oznu](https://hub.docker.c | |||||||
| Create the file `rebuild.sh`. | Create the file `rebuild.sh`. | ||||||
| Change the settings according to your needs and run `./rebuild.sh` afterwards. | Change the settings according to your needs and run `./rebuild.sh` afterwards. | ||||||
|  |  | ||||||
| ## Environment-variables | ### Environment-variables | ||||||
|  |  | ||||||
| Set the following variables with the -e tag. | Set the following variables with the -e tag. | ||||||
|  |  | ||||||
| @@ -17,7 +17,7 @@ Set the following variables with the -e tag. | |||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -26,7 +26,7 @@ Set the following volumes with the -v tag. | |||||||
| | `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 | ||||||
| #!/bin/sh | #!/bin/sh | ||||||
|   | |||||||
| @@ -10,7 +10,7 @@ The official container and documentation was made by | |||||||
| Create the file `rebuild.sh`. | Create the file `rebuild.sh`. | ||||||
| Change the settings according to your needs and run `./rebuild.sh` afterwards. | Change the settings according to your needs and run `./rebuild.sh` afterwards. | ||||||
|  |  | ||||||
| ## Volumes | ### Volumes | ||||||
|  |  | ||||||
| Set the following volumes with the -v tag. | Set the following volumes with the -v tag. | ||||||
|  |  | ||||||
| @@ -19,7 +19,7 @@ Set the following volumes with the -v tag. | |||||||
| | `/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. | ||||||
|  |  | ||||||
| @@ -27,7 +27,7 @@ Set the following ports with the -p tag. | |||||||
| | -------------- | ------------------------ | -------- | -------------------- | | | -------------- | ------------------------ | -------- | -------------------- | | ||||||
| | `9001`         | `9001`                   | TCP      | Portainer agent port | | | `9001`         | `9001`                   | TCP      | Portainer agent port | | ||||||
|  |  | ||||||
| ## rebuild.sh | ### rebuild.sh | ||||||
|  |  | ||||||
| ```sh | ```sh | ||||||
| #!/bin/sh | #!/bin/sh | ||||||
|   | |||||||
| @@ -10,7 +10,7 @@ The official container and documentation was made by | |||||||
| Create the file `rebuild.sh`. | Create the file `rebuild.sh`. | ||||||
| Change the settings according to your needs and run `./rebuild.sh` afterwards. | Change the settings according to your needs and run `./rebuild.sh` afterwards. | ||||||
|  |  | ||||||
| ## Volumes | ### Volumes | ||||||
|  |  | ||||||
| Set the following volumes with the -v tag. | Set the following volumes with the -v tag. | ||||||
|  |  | ||||||
| @@ -19,7 +19,7 @@ Set the following volumes with the -v tag. | |||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -27,7 +27,7 @@ Set the following ports with the -p tag. | |||||||
| | -------------- | ------------------------ | -------- | ----------- | | | -------------- | ------------------------ | -------- | ----------- | | ||||||
| | `9000`         | `9000`                   | TCP      | WebUI       | | | `9000`         | `9000`                   | TCP      | WebUI       | | ||||||
|  |  | ||||||
| ## rebuild.sh | ### rebuild.sh | ||||||
|  |  | ||||||
| ```sh | ```sh | ||||||
| #!/bin/sh | #!/bin/sh | ||||||
|   | |||||||
| @@ -1,12 +1,20 @@ | |||||||
| # Postgres | # postgres | ||||||
|  |  | ||||||
| This is a [Docker](/wiki/docker.md) container for a postgresql database. | This is a [Docker](/wiki/docker.md) container for a [postgresql database](/wiki/postgresql.md). | ||||||
| The official container and documentation was made by | The official container and documentation was made by | ||||||
| [Postgres](https://hub.docker.com/_/postgres). | [Postgres](https://hub.docker.com/_/postgres). | ||||||
| The Docker container is mainly used in combination with other containers. | The Docker container is mainly used in combination with other containers. | ||||||
| To achieve this in the easiest way use a docker-compose file | To achieve this in the easiest way use a docker-compose file | ||||||
|  |  | ||||||
| ## Environment-variables | ## Set-Up | ||||||
|  |  | ||||||
|  | The postgres Docker container is dependent on another container most of the time.  | ||||||
|  | The exact setup will be described in the regarding entry. | ||||||
|  | Nevertheless both environment variables and volumes are listed in the sections below. | ||||||
|  | Nevertheless both environment variables and volumes and networks are listed in the sections below. | ||||||
|  | These are needed most often. | ||||||
|  |  | ||||||
|  | ### 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. | ||||||
| @@ -18,7 +26,7 @@ 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. | ||||||
|  |  | ||||||
| @@ -27,7 +35,7 @@ Set the following volumes in the `volumes:` section of the docker-compose file. | |||||||
| | `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 | ||||||
| the database with other docker containers. | the database with other docker containers. | ||||||
|   | |||||||
| @@ -10,7 +10,7 @@ The official container and documentation was made by | |||||||
| 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` afterwards. | ||||||
|  |  | ||||||
| ## Volumes | ### Volumes | ||||||
|  |  | ||||||
| Set the following volumes with the -v tag. | Set the following volumes with the -v tag. | ||||||
|  |  | ||||||
| @@ -18,7 +18,7 @@ Set the following volumes with the -v tag. | |||||||
| | ------------------------- | --------------- | -------------------------- | | | ------------------------- | --------------- | -------------------------- | | ||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -26,7 +26,7 @@ Set the following ports with the -p tag. | |||||||
| | -------------- | ------------------------ | -------- | ----------- | | | -------------- | ------------------------ | -------- | ----------- | | ||||||
| | `8000`         | `8000`                   | TCP      | WebUI       | | | `8000`         | `8000`                   | TCP      | WebUI       | | ||||||
|  |  | ||||||
| ## rebuild.sh | ### rebuild.sh | ||||||
|  |  | ||||||
| ```sh | ```sh | ||||||
| #!/bin/sh | #!/bin/sh | ||||||
| @@ -35,7 +35,7 @@ docker pull prologic/golinks:latest | |||||||
| docker-compose up -d | docker-compose up -d | ||||||
| ``` | ``` | ||||||
|  |  | ||||||
| ## docker-compose.yml | ### docker-compose.yml | ||||||
|  |  | ||||||
| ```yml | ```yml | ||||||
| version: "3.1" | version: "3.1" | ||||||
|   | |||||||
| @@ -9,7 +9,7 @@ The official container and documentation was made by | |||||||
| Create the file `rebuild.sh`. | Create the file `rebuild.sh`. | ||||||
| Change the settings according to your needs and run `./rebuild.sh` afterwards. | Change the settings according to your needs and run `./rebuild.sh` afterwards. | ||||||
|  |  | ||||||
| ## Ports | ### Ports | ||||||
|  |  | ||||||
| Set the following ports with the -p tag. | Set the following ports with the -p tag. | ||||||
|  |  | ||||||
| @@ -17,7 +17,7 @@ Set the following ports with the -p tag. | |||||||
| | -------------- | ------------------------ | -------- | ---------------------------------------- | | | -------------- | ------------------------ | -------- | ---------------------------------------- | | ||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -25,7 +25,7 @@ There are some special variables to set. | |||||||
| | ------ | ------------------------------------------------------------- | | | ------ | ------------------------------------------------------------- | | ||||||
| | `-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 | ||||||
| #!/bin/sh | #!/bin/sh | ||||||
|   | |||||||
| @@ -9,7 +9,7 @@ The official container and documentation was made by | |||||||
| Create the file `rebuild.sh`. | Create the file `rebuild.sh`. | ||||||
| Change the settings according to your needs and run `./rebuild.sh` afterwards. | Change the settings according to your needs and run `./rebuild.sh` afterwards. | ||||||
|  |  | ||||||
| ## Volumes | ### Volumes | ||||||
|  |  | ||||||
| Set the following volumes with the -v tag. | Set the following volumes with the -v tag. | ||||||
|  |  | ||||||
| @@ -17,7 +17,7 @@ Set the following volumes with the -v tag. | |||||||
| | ------------------------- | ---------------------- | ---------------------- | | | ------------------------- | ---------------------- | ---------------------- | | ||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -25,7 +25,7 @@ Set the following ports with the -p tag. | |||||||
| | -------------- | ------------------------ | -------- | ----------- | | | -------------- | ------------------------ | -------- | ----------- | | ||||||
| | `8000`         | `8000`                   | TCP      | WebUI       | | | `8000`         | `8000`                   | TCP      | WebUI       | | ||||||
|  |  | ||||||
| ## rebuild.sh | ### rebuild.sh | ||||||
|  |  | ||||||
| ```sh | ```sh | ||||||
| #!/bin/sh | #!/bin/sh | ||||||
|   | |||||||
| @@ -15,7 +15,7 @@ Then build the image inside the git folder with `docker build -t synctube .`. | |||||||
| Set the variables, volumes and ports according and run the `rebuild.sh`. | Set the variables, volumes and ports according and run the `rebuild.sh`. | ||||||
|  |  | ||||||
|  |  | ||||||
| ## Volumes | ### Volumes | ||||||
|  |  | ||||||
| Set the following volumes with the -v tag. | Set the following volumes with the -v tag. | ||||||
|  |  | ||||||
| @@ -23,7 +23,7 @@ Set the following volumes with the -v tag. | |||||||
| | ------------------------- | ------------------- | ------------------- | | | ------------------------- | ------------------- | ------------------- | | ||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -31,7 +31,7 @@ Set the following ports with the -p tag. | |||||||
| | -------------- | ------------------------ | -------- | ----------- | | | -------------- | ------------------------ | -------- | ----------- | | ||||||
| | `4200`         | `4200`                   | TCP      | WebUI       | | | `4200`         | `4200`                   | TCP      | WebUI       | | ||||||
|  |  | ||||||
| ## rebuild.sh | ### rebuild.sh | ||||||
|  |  | ||||||
| ```sh | ```sh | ||||||
| #!/bin/sh | #!/bin/sh | ||||||
|   | |||||||
| @@ -6,10 +6,23 @@ The official container and documentation was made by | |||||||
| The Docker container is mainly used in combination with other containers. | The Docker container is mainly used in combination with other containers. | ||||||
| To achieve this in the easiest way use a docker-compose file. | To achieve this in the easiest way use a docker-compose file. | ||||||
|  |  | ||||||
| ## Volumes | ## Set-Up | ||||||
|  |  | ||||||
|  | The redis Docker container is dependent on another container most of the time.  | ||||||
|  | The exact setup will be described in the regarding entry. | ||||||
|  | Nevertheless both volumes and networks are listed in the sections below. | ||||||
|  | These are needed most often. | ||||||
|  |  | ||||||
|  | ### 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          | | ||||||
| | ------------------------- | --------------- | -------------------- | | | ------------------------- | --------------- | -------------------- | | ||||||
| | `redis`                   | `/data`         | storage for all data | | | `redis`                   | `/data`         | storage for all data | | ||||||
|  |  | ||||||
|  | ### Networks | ||||||
|  |  | ||||||
|  | You can set networks in the `networks:` part of a docker-compose file to connect | ||||||
|  | the database with other docker containers. | ||||||
|   | |||||||
| @@ -9,7 +9,7 @@ The official container and documentation was made by | |||||||
| Create the file `rebuild.sh`. | Create the file `rebuild.sh`. | ||||||
| Change the settings according to your needs and run `./rebuild.sh` afterwards. | Change the settings according to your needs and run `./rebuild.sh` afterwards. | ||||||
|  |  | ||||||
| ## Environment-variables | ### Environment-variables | ||||||
|  |  | ||||||
| Set the following variables with the -e tag. | Set the following variables with the -e tag. | ||||||
|  |  | ||||||
| @@ -17,7 +17,7 @@ Set the following variables with the -e tag. | |||||||
| | -------------- | ----------------------- | ------- | | | -------------- | ----------------------- | ------- | | ||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -25,7 +25,7 @@ Set the following volumes with the -v tag. | |||||||
| | ------------------------- | --------------- | -------------------------- | | | ------------------------- | --------------- | -------------------------- | | ||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -33,7 +33,7 @@ Set the following ports with the -p tag. | |||||||
| | -------------- | ------------------------ | -------- | ----------- | | | -------------- | ------------------------ | -------- | ----------- | | ||||||
| | `7777`         | `7777`                   | TCP      | WebUI       | | | `7777`         | `7777`                   | TCP      | WebUI       | | ||||||
|  |  | ||||||
| ## rebuild.sh | ### rebuild.sh | ||||||
|  |  | ||||||
| ```sh | ```sh | ||||||
| #!/bin/sh | #!/bin/sh | ||||||
|   | |||||||
| @@ -10,7 +10,7 @@ The official container and documentation was made by | |||||||
| Create the file `rebuild.sh`. | Create the file `rebuild.sh`. | ||||||
| Change the settings according to your needs and run `./rebuild.sh` afterwards. | Change the settings according to your needs and run `./rebuild.sh` afterwards. | ||||||
|  |  | ||||||
| ## Volumes | ### Volumes | ||||||
|  |  | ||||||
| Set the following volumes with the -v tag. | Set the following volumes with the -v tag. | ||||||
|  |  | ||||||
| @@ -23,7 +23,7 @@ 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. | ||||||
|  |  | ||||||
| @@ -32,7 +32,7 @@ Set the following ports with the -p tag. | |||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -42,7 +42,7 @@ There are some special variables to set. | |||||||
| | `-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 | ||||||
| #!/bin/sh | #!/bin/sh | ||||||
|   | |||||||
| @@ -10,7 +10,7 @@ The official container and documentation was made by | |||||||
| 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` afterwards. | ||||||
|  |  | ||||||
| ## Volumes | ### Volumes | ||||||
|  |  | ||||||
| Set the following volumes with the -v tag. | Set the following volumes with the -v tag. | ||||||
|  |  | ||||||
| @@ -19,7 +19,7 @@ Set the following volumes with the -v tag. | |||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -27,7 +27,7 @@ Set the following ports with the -p tag. | |||||||
| | -------------- | ------------------------ | -------- | ----------- | | | -------------- | ------------------------ | -------- | ----------- | | ||||||
| | `8080`         | `8080`                   | TCP      | WebUI       | | | `8080`         | `8080`                   | TCP      | WebUI       | | ||||||
|  |  | ||||||
| ## rebuild.sh | ### rebuild.sh | ||||||
|  |  | ||||||
| ```sh | ```sh | ||||||
| #!/bin/sh | #!/bin/sh | ||||||
| @@ -35,7 +35,7 @@ docker-compose down | |||||||
| docker-compose up -d | docker-compose up -d | ||||||
| ``` | ``` | ||||||
|  |  | ||||||
| ## docker-compose.yml | ### docker-compose.yml | ||||||
|  |  | ||||||
| ```sh | ```sh | ||||||
| version: "2.1" | version: "2.1" | ||||||
|   | |||||||
							
								
								
									
										116
									
								
								wiki/docker/sinusbot_-_docker.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										116
									
								
								wiki/docker/sinusbot_-_docker.md
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,116 @@ | |||||||
|  | # sinusbot - docker | ||||||
|  |  | ||||||
|  | This is a [Docker](/wiki/docker.md) container for a [Sinusbot](/wiki/sinusbot.md). | ||||||
|  | The Server consists of a single Docker container. | ||||||
|  |  | ||||||
|  | ## Set-up | ||||||
|  |  | ||||||
|  | Create the files `rebuild.sh` and `docker-compose.yml` at the same place. | ||||||
|  |  | ||||||
|  | The `docker-compose.yml` file includes a network section. | ||||||
|  | This is only needed if the [Teamspeak](/wiki/teamspeak.md) server is set up on the same machine. | ||||||
|  | If it is not the network `teamspeak` may be removed. | ||||||
|  | If it Teamspeak and Sinusbot are set up on the same machine make sure to include the `teamspeak` | ||||||
|  | network in the [Teamspeak Docker container](/wiki/docker/teamspeak.md) and set an alias. | ||||||
|  | Include the follwing lines in your teamspeak `docker-compose.yml` file under the `teamspeak3` | ||||||
|  | service. | ||||||
|  |  | ||||||
|  | ```yml | ||||||
|  | networks: | ||||||
|  |   teamspeak: | ||||||
|  |     aliases: | ||||||
|  |       - ts3.docker.local | ||||||
|  | ``` | ||||||
|  |  | ||||||
|  | Add the following lines at the end of the `docker-compose.yml` or add it to the definition of | ||||||
|  | already existing networks. | ||||||
|  |  | ||||||
|  | ```yml | ||||||
|  | networks: | ||||||
|  |   teamspeak: | ||||||
|  |     external: true | ||||||
|  | ``` | ||||||
|  |  | ||||||
|  | Finally make sure to create the external network `teamspeak` before starting the containers. | ||||||
|  | This can be done by running the following command. | ||||||
|  |  | ||||||
|  | ```sh | ||||||
|  | docker network create teamspeak | ||||||
|  | ``` | ||||||
|  |  | ||||||
|  | The Teamspeak server can then be found by Sinusbot under host `ts3.docker.local` and port `9987`. | ||||||
|  |  | ||||||
|  | Change the other settings according to your needs and run `./rebuild.sh` afterwards. | ||||||
|  |  | ||||||
|  | ### Environment-variables | ||||||
|  |  | ||||||
|  | Set the following environment-variables in the `environment:` section of the | ||||||
|  | docker-compose file. | ||||||
|  |  | ||||||
|  | | Name        | Usage                          | Default | | ||||||
|  | | ----------- | ------------------------------ | ------- | | ||||||
|  | | `UID`       | User userid to run gitea       |         | | ||||||
|  | | `GID`       | User groupid to run gitea      |         | | ||||||
|  |  | ||||||
|  | ### Volumes | ||||||
|  |  | ||||||
|  | Set the following volumes in the `volumes:` section of the docker-compose file. | ||||||
|  |  | ||||||
|  | | Outside mount/volume name | Container mount         | Description                           | | ||||||
|  | | ------------------------- | ----------------------- | ------------------------------------- | | ||||||
|  | | `sinusbot_scripts`        | `/opt/sinusbot/scripts` | storage for the sinusbot scripts      | | ||||||
|  | | `sinusbot_data`           | `/opt/sinusbot/data`    | storage for the most of sinusbot data | | ||||||
|  |  | ||||||
|  | ### Ports | ||||||
|  |  | ||||||
|  | Set the following ports in the `ports:` section. | ||||||
|  |  | ||||||
|  | | Container Port | Recommended outside port | Protocol | Description            | | ||||||
|  | | -------------- | ------------------------ | -------- | ---------------------- | | ||||||
|  | | `8087`         | `8087`                   | TCP      | WebUI                  | | ||||||
|  |  | ||||||
|  | ### Networks | ||||||
|  |  | ||||||
|  | Set the following networks in the `networks:` section of the docker-compose file. | ||||||
|  |  | ||||||
|  | | Name        | Usage                        | | ||||||
|  | | ----------- | ---------------------------- | | ||||||
|  | | `teamspeak` | connect with local teamspeak | | ||||||
|  |  | ||||||
|  |  | ||||||
|  | ### rebuild.sh | ||||||
|  |  | ||||||
|  | ```sh | ||||||
|  | #!/bin/sh | ||||||
|  | docker-compose down | ||||||
|  | docker pull sinusbot/docker:latest | ||||||
|  | docker-compose up -d | ||||||
|  | ``` | ||||||
|  |  | ||||||
|  | ### docker-compose.yml | ||||||
|  |  | ||||||
|  | ```yml | ||||||
|  | version: "3.3" | ||||||
|  | services: | ||||||
|  |   sinusbot: | ||||||
|  |     image: "sinusbot/docker:latest" | ||||||
|  |     restart: unless-stopped | ||||||
|  |     environment: | ||||||
|  |       - UID=1000 | ||||||
|  |       - GID=1000 | ||||||
|  |     networks: | ||||||
|  |       - teamspeak | ||||||
|  |     volumes: | ||||||
|  |       - sinusbot_scripts:/opt/sinusbot/scripts | ||||||
|  |       - sinusbot_data:/opt/sinusbot/data | ||||||
|  |  | ||||||
|  | networks: | ||||||
|  |   teamspeak: | ||||||
|  |     external: true | ||||||
|  |  | ||||||
|  | volumes: | ||||||
|  |   sinusbot_scripts: | ||||||
|  |     driver: local | ||||||
|  |   sinusbot_data: | ||||||
|  |     driver: local | ||||||
|  | ``` | ||||||
| @@ -18,7 +18,7 @@ docker exec -it linkding python manage.py createsuperuser --username=joe --email | |||||||
|  |  | ||||||
| You will be asked for a password via the commandline. | You will be asked for a password via the commandline. | ||||||
|  |  | ||||||
| ## Volumes | ### Volumes | ||||||
|  |  | ||||||
| Set the following volumes with the -v tag. | Set the following volumes with the -v tag. | ||||||
|  |  | ||||||
| @@ -26,7 +26,7 @@ Set the following volumes with the -v tag. | |||||||
| | ------------------------- | ---------------------- | --------------------------- | | | ------------------------- | ---------------------- | --------------------------- | | ||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -34,7 +34,7 @@ Set the following ports with the -p tag. | |||||||
| | -------------- | ------------------------ | -------- | ----------- | | | -------------- | ------------------------ | -------- | ----------- | | ||||||
| | `9090`         | `9090`                   | TCP      | WebUI       | | | `9090`         | `9090`                   | TCP      | WebUI       | | ||||||
|  |  | ||||||
| ## rebuild.sh | ### rebuild.sh | ||||||
|  |  | ||||||
| ```sh | ```sh | ||||||
| #!/bin/sh | #!/bin/sh | ||||||
|   | |||||||
| @@ -10,7 +10,7 @@ The official container and documentation was made by | |||||||
| Create the file `rebuild.sh`. | Create the file `rebuild.sh`. | ||||||
| Change the settings according to your needs and run `./rebuild.sh` afterwards. | Change the settings according to your needs and run `./rebuild.sh` afterwards. | ||||||
|  |  | ||||||
| ## Ports | ### Ports | ||||||
|  |  | ||||||
| Set the following ports with the -p tag. | Set the following ports with the -p tag. | ||||||
|  |  | ||||||
| @@ -18,7 +18,7 @@ Set the following ports with the -p tag. | |||||||
| | -------------- | ------------------------ | -------- | ----------- | | | -------------- | ------------------------ | -------- | ----------- | | ||||||
| | `8080`         | `8080`                   | TCP      | WebUI       | | | `8080`         | `8080`                   | TCP      | WebUI       | | ||||||
|  |  | ||||||
| ## rebuild.sh | ### rebuild.sh | ||||||
|  |  | ||||||
| ```sh | ```sh | ||||||
| #!/bin/sh | #!/bin/sh | ||||||
|   | |||||||
| @@ -10,7 +10,7 @@ The official container and documentation was made by | |||||||
| Create the file `rebuild.sh`. | Create the file `rebuild.sh`. | ||||||
| Change the settings according to your needs and run `./rebuild.sh` afterwards. | Change the settings according to your needs and run `./rebuild.sh` afterwards. | ||||||
|  |  | ||||||
| ## Environment-variables | ### Environment-variables | ||||||
|  |  | ||||||
| Set the following variables with the -e tag. | Set the following variables with the -e tag. | ||||||
|  |  | ||||||
| @@ -18,7 +18,7 @@ Set the following variables with the -e tag. | |||||||
| | ------------------- | ---------------------------- | ------- | | | ------------------- | ---------------------------- | ------- | | ||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -26,7 +26,7 @@ Set the following volumes with the -v tag. | |||||||
| | ------------------------- | ---------------- | --------------------------- | | | ------------------------- | ---------------- | --------------------------- | | ||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -36,7 +36,7 @@ Set the following ports with the -p tag. | |||||||
| | `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 | ||||||
| #!/bin/sh | #!/bin/sh | ||||||
|   | |||||||
| @@ -11,7 +11,7 @@ Change the settings according to your needs and run `./start.sh` to start | |||||||
| the server. | the server. | ||||||
| With `stop.sh` you can stop it. | With `stop.sh` you can stop it. | ||||||
|  |  | ||||||
| ## Environment-variables | ### Environment-variables | ||||||
|  |  | ||||||
| Set the following variables with the -e tag. | Set the following variables with the -e tag. | ||||||
|  |  | ||||||
| @@ -30,7 +30,7 @@ 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. | ||||||
|  |  | ||||||
| @@ -39,7 +39,7 @@ Set the following volumes with the -v tag. | |||||||
| | `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 | | ||||||
| @@ -48,7 +48,7 @@ Set the following ports with the -p tag. | |||||||
| | `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 | ||||||
| #!/bin/sh | #!/bin/sh | ||||||
| @@ -75,7 +75,7 @@ docker run --name=mordhau \ | |||||||
|  tetricz/mordhau-server |  tetricz/mordhau-server | ||||||
| ``` | ``` | ||||||
|  |  | ||||||
| ## stop.sh | ### stop.sh | ||||||
|  |  | ||||||
| ```sh | ```sh | ||||||
| #/bin/sh | #/bin/sh | ||||||
|   | |||||||
| @@ -1,6 +1,6 @@ | |||||||
| # tombursch - kitchenowl | # tombursch - kitchenowl | ||||||
|  |  | ||||||
| This is a [Docker](/wiki/docker.md) container for a [kitchenowl](kitchenowl) | This is a [Docker](/wiki/docker.md) container for a [kitchenowl](/wiki/kitchenowl.md) | ||||||
| server. | server. | ||||||
| The official container and documentation was made by | The official container and documentation was made by | ||||||
| [tombursch](https://github.com/tombursch/kitchenowl). | [tombursch](https://github.com/tombursch/kitchenowl). | ||||||
| @@ -14,7 +14,7 @@ place. | |||||||
| Make sure to change `JWT_SECRET_KEY`. | Make sure to change `JWT_SECRET_KEY`. | ||||||
| Change the settings according to your needs and run `./rebuild.sh` afterwards. | Change the settings according to your needs and run `./rebuild.sh` afterwards. | ||||||
|  |  | ||||||
| ## Ports | ### Ports | ||||||
|  |  | ||||||
| Set the following ports in the `ports:` section. | Set the following ports in the `ports:` section. | ||||||
|  |  | ||||||
| @@ -22,7 +22,7 @@ Set the following ports in the `ports:` section. | |||||||
| | -------------- | ------------------------ | -------- | ----------- | | | -------------- | ------------------------ | -------- | ----------- | | ||||||
| | `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. | ||||||
|  |  | ||||||
| @@ -30,7 +30,7 @@ Set the following volumes with the -v tag. | |||||||
| | ------------------------- | -------------------------- | ------------------------ | | | ------------------------- | -------------------------- | ------------------------ | | ||||||
| | `kitchenowl_data`         | `/data`                    | storage for all data     | | | `kitchenowl_data`         | `/data`                    | storage for all data     | | ||||||
|  |  | ||||||
| ## rebuild.sh | ### rebuild.sh | ||||||
|  |  | ||||||
| ```sh | ```sh | ||||||
| #!/bin/sh | #!/bin/sh | ||||||
| @@ -40,7 +40,7 @@ docker pull tombursch/kitchenowl:latest | |||||||
| docker-compose up -d | docker-compose up -d | ||||||
| ``` | ``` | ||||||
|  |  | ||||||
| ## docker-compose.yml | ### docker-compose.yml | ||||||
|  |  | ||||||
| ```yml | ```yml | ||||||
| version: "3" | version: "3" | ||||||
|   | |||||||
Some files were not shown because too many files have changed in this diff Show More
		Reference in New Issue
	
	Block a user