style(guide): standardize usage of "docker(s)/Docker" (#2311)

style(misc): standardize usage of 'docker(s)/Docker"
pull/2315/head
zenodotus280 1 month ago committed by GitHub
parent e3fa164740
commit 8bf276fe0e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

@ -303,7 +303,7 @@ These prerequisites are taken from the [mkdocs installation instructions][mkdoci
[mkdocinstall]: https://www.mkdocs.org/user-guide/installation/
Alternatively, you can check out the docker container and instructions maintained by [zakkarry](https://github.com/zakkarry) specifically for developing the guides [here](https://gist.github.com/zakkarry/1305f713539c9fee22bdeeddcff3a263). The documentation in the README explains the installation process.
Alternatively, you can check out the Docker container and instructions maintained by [zakkarry](https://github.com/zakkarry) specifically for developing the guides [here](https://gist.github.com/zakkarry/1305f713539c9fee22bdeeddcff3a263). The documentation in the README explains the installation process.
### Mkdocs Installation

@ -30,7 +30,7 @@ Click on `Enabled`
!!! info
**Be aware that when using Bazarr in docker, you cannot reach another container on the same Docker host using the loopback address (ex.: 127.0.0.1 or localhost). Loopback address refers to the Bazarr Docker container, not the Docker host.**
**Be aware that when using Bazarr in Docker, you cannot reach another container on the same Docker host using the loopback address (ex.: 127.0.0.1 or localhost). Loopback address refers to the Bazarr Docker container, not the Docker host.**
1. Enter the TCP port of your Sonarr instance. Default is 8989.
1. Sonarr uses the Base URL _ONLY_ if used with a "Reverse Proxy" (ex: Nginx Proxy Manager or SWAG) and MUST have a leading slash if it is needed (ex: /sonarr).
@ -122,7 +122,7 @@ Click on `Enabled`
!!! info
**Be aware that when using Bazarr in docker, you cannot reach another container on the same Docker host using the loopback address (ex.: 127.0.0.1 or localhost). Loopback address refers to the Bazarr Docker container, not the Docker host.**
**Be aware that when using Bazarr in Docker, you cannot reach another container on the same Docker host using the loopback address (ex.: 127.0.0.1 or localhost). Loopback address refers to the Bazarr Docker container, not the Docker host.**
1. Enter the TCP port of your Radarr instance. Default is 7878.
1. Radarr uses the Base URL _ONLY_ if used with a "Reverse Proxy" (ex: Nginx Proxy Manager or SWAG) and MUST have a leading slash if it is needed (ex: /radarr).

@ -188,7 +188,7 @@ Finally, you will want to enable some plugins. There are plenty of plugins on th
!!! info
If you are running a docker container, such as binhex's image, the `WebUI` plugin may not need to be enabled. Instead, it may be configured in the container.
If you are running a Docker container, such as binhex's image, the `WebUI` plugin may not need to be enabled. Instead, it may be configured in the container.
### WebUI

@ -156,7 +156,7 @@ And it SABnzbd you will see something like this.
Then go in to `Settings` => `Special` => `Values`.
Scroll down to `host_whitelist ( )` and enter your docker container name and or your domain name.
Scroll down to `host_whitelist ( )` and enter your Docker container name and or your domain name.
Example: `sabnzbd.domain.tld, <container name >`

@ -1,6 +1,6 @@
# qBittorrent - How to add categories
This basic example is based on the use of docker images
This basic example is based on the use of Docker images
!!! tip ""

@ -2,17 +2,17 @@
!!! tip
If you're new to dockers and want an easy setup, we suggest taking a look at [DockSTARTer](https://dockstarter.com/){:target="_blank" rel="noopener noreferrer"}.
If you're new to Docker containers and want an easy setup, we suggest taking a look at [DockSTARTer](https://dockstarter.com/){:target="_blank" rel="noopener noreferrer"}.
We've also created a short guide [HERE](/File-and-Folder-Structure/How-to-set-up/Dockstarter/) where we explain the settings for the most used applications.
The main goal of DockSTARTer is to make it quick and easy to get up and running with Docker.
You may choose to rely on DockSTARTer for various changes to your Docker system or use DockSTARTer as a stepping stone and learn to do more advanced configurations.
*DockSTARTer was actually my first step into the world of dockers.*
*DockSTARTer was actually my first step into the world of Docker containers.*
!!! note
I'm not going to explain how to get dockers installed and running, we will only explain which folder structure we recommend.
I'm not going to explain how to get Docker installed and running, we will only explain which folder structure we recommend.
The paths mentioned below refer to internal paths (or `Container Path`) for the containers!

@ -2,7 +2,7 @@
!!! note
Being I don't have a Synology myself and I kind of hate the Synology GUI for the dockers, we're going to do this with the use of docker-compose through a terminal.
Being I don't have a Synology myself and I kind of hate the Synology GUI for managing Docker containers, we're going to do this with the use of docker-compose through a terminal.
This is faster than the GUI and after installing, it shows up in the Docker GUI.
@ -17,11 +17,11 @@ This page will provide you with guidance on how to install several Docker images
## Summary
1. We will create **_one_** share that will hold all your data. This ensures hardlinking and/or instant moves are possible.
1. Create one user that will be assigned to the docker images as the user they run out of security reasons.
1. Create one user that will be assigned to the Docker images as the user they run out of security reasons.
1. Create a folder structure on the `data` and `docker` share with a few commands (or manually).
1. Download and edit the `docker-compose.yml` and `.env` files to your system settings.
1. Set permissions to all folders related to the shares.
1. Run and execute docker commands to start the containers.
1. Run and execute Docker commands to start the containers.
### Automated Script
@ -127,7 +127,7 @@ Once logged in to the terminal type `id docker`. If you used a different usernam
![!synology-id](images/synology-id.png)
This will show you the UID (aka PUID).
In the screenshot above this is `1035` for the docker user and `100` is the GID (aka PGID) for the user's group.
In the screenshot above this is `1035` for the Docker user and `100` is the GID (aka PGID) for the user's group.
Save these values for later use.
## Create Folder Structure
@ -204,7 +204,7 @@ wget https://raw.githubusercontent.com/TRaSH-/Guides-Synology-Templates/main/doc
### What's included in the compose and what is not included
This docker-compose file will have the following docker containers included.
This docker-compose file will have the following Docker containers included.
```none
- Radarr
@ -282,7 +282,7 @@ At `Task Settings` tab, add the following line in the Run Command section:
/usr/local/bin/pullio > /volume1/docker/appdata/pullio/pullio.log 2>&1
```
It can be frustrating to test the script if no docker image updates are available, therefore you can run the command `sudo pullio` --debug` and the script will behave as if an update is available. If you have set to receive notifications, you should receive them.
It can be frustrating to test the script if no Docker image updates are available, therefore you can run the command `sudo pullio` --debug` and the script will behave as if an update is available. If you have set to receive notifications, you should receive them.
More info about Pullio [HERE](https://hotio.dev/scripts/pullio/){:target="\_blank" rel="noopener noreferrer"}
@ -316,7 +316,7 @@ sudo chmod -R a=,a+rX,u+w,g+w /volume1/data /volume1/docker
!!! tip
make sure you delete/remove all your existing dockers from the Docker GUI and also remove your native installs (in Package Center) of these applications !!!
make sure you delete/remove all your existing Docker containers from the Docker GUI and also remove your native installs (in Package Center) of these applications !!!
If you had previously installed apps, make a backup of their config folders or backup through the WebUI of the app.
If you have followed all the steps and your compose file is ready, run the following commands:

@ -99,12 +99,12 @@ mkdir -p /mnt/user/data/{torrents/{tv,movies,music},media/{tv,movies,music}}
## Setting up the containers
!!! tip "Create a custom docker network"
Why would you want a custom docker network?
!!! tip "Create a custom Docker network"
Why would you want a custom Docker network?
A major benefit of having your Docker containers on the same custom Docker network is that they will be able to communicate with other using their container names, rather than having to use IP addresses.
Unraid doesn't create a custom docker network by default, you need to create one yourself.
Unraid doesn't create a custom Docker network by default, you need to create one yourself.
- Open a terminal window and type:
@ -112,7 +112,7 @@ mkdir -p /mnt/user/data/{torrents/{tv,movies,music},media/{tv,movies,music}}
docker network create your_uber_cool_network_name
```
- or watch the following video below on how to create a custom docker network
- or watch the following video below on how to create a custom Docker network
<iframe width="560" height="315" src="https://www.youtube.com/embed/7fzBDCI8O2w?si=itGS624rC7jxD8ly" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>

@ -1,5 +1,5 @@
nav:
- Home: index.md
- How to provide a docker compose: how-to-provide-a-docker-compose.md
- How to provide a Docker compose: how-to-provide-a-docker-compose.md
- Setup TorGuard for port forwarding: How-to-setup-Torguard-for-port-forwarding.md
- x265-4k and Golden Rule: x265-4k.md

@ -1,18 +1,18 @@
# How to provide a docker compose
# How to provide a Docker compose
When you're running dockers and you need help on Discord etc you often hear the question:
When you're running Docker containers and you need help on Discord etc you often hear the question:
"Provide a docker compose"
"Provide a Docker compose"
If you need to provide this info always remember to provide it from all your Starr Apps (Sonarr, Radarr, Lidarr, Bazarr) and also from your download client(s).
If you're using a system with a GUI (Synology, unRAID, OMV, etc.) it's not always easy to provide a docker compose but it's possible.
If you're using a system with a GUI (Synology, unRAID, OMV, etc.) it's not always easy to provide a Docker compose but it's possible.
!!! warning
Please don't use screenshots to provide the info as they aren't always revealing all the needed info
Use one of the following commands in the terminal of your choice (e.g. puTTY) to generate the docker compose, with or without the use of `sudo`. Note that you can pass in multiple container names.
Use one of the following commands in the terminal of your choice (e.g. puTTY) to generate the Docker compose, with or without the use of `sudo`. Note that you can pass in multiple container names.
```bash
sudo docker run --rm -v /var/run/docker.sock:/var/run/docker.sock ghcr.io/red5d/docker-autocompose CONTAINER_NAME CONTAINER_NAME2
@ -36,4 +36,4 @@ Copy and paste the results on one of the following sites.
- [privatebin.net](https://privatebin.net/){:target="\_blank" rel="noopener noreferrer"}
- [bpaste](https://bpa.st/){:target="\_blank" rel="noopener noreferrer"}
If you use the `docker run` command to create your docker containers, paste your run command into [composerize](https://www.composerize.com/){:target="\_blank" rel="noopener noreferrer"}
If you use the `docker run` command to create your Docker containers, paste your run command into [composerize](https://www.composerize.com/){:target="\_blank" rel="noopener noreferrer"}

@ -2,6 +2,6 @@
## Miscellaneous guides and info
- [How to provide a docker compose](/Misc/how-to-provide-a-docker-compose/) - When requested this will show you how to create and provide a docker-compose of your running docker containers.
- [How to provide a Docker compose](/Misc/how-to-provide-a-docker-compose/) - When requested this will show you how to create and provide a docker-compose of your running Docker containers.
- [Setup TorGuard for port forwarding](/Misc/How-to-setup-Torguard-for-port-forwarding/) - Guide on how to set up port forwarding when you use Torguard as a VPN Service.
- [x265-4k and Golden Rule](/Misc/x265-4k/) - Explanation of how 1080p x265 should be used correctly and how it's used often wrongly, and why the guide in general doesn't prefer 1080p x265 releases.

@ -382,7 +382,7 @@ Directory to use when transcoding temporary files for streaming.
*Speeds up transcoding and less I/O, transcode data is temporary and doesn't need to be written to a disk.*
*If you run docker set this to `/transcode` and map it to `/tmp/plex`*
*If you run Docker set this to `/transcode` and map it to `/tmp/plex`*
*Default Linux only allocates a max of 50% of total system RAM to any ram directories (ie. /tmp, /dev/shm, etc.)*

@ -18,7 +18,7 @@ In this guide, we will try to explain how to set up Prowlarr to use your VPN fro
If you use docker, you need to enable privoxy in your torrent client so you can use it to pass through traffic.
Please check your docker image's documentation on how to enable privoxy.
Please check your Docker image's documentation on how to enable privoxy.
## Add privoxy to Prowlarr

@ -8,11 +8,11 @@ Remote Path Mapping acts as a dumb find `Remote Path` and replace it with the `L
- If Radarr and your download client are not on the same server/system.
- If you use either merged local/remote setups using mergerfs or similar.
- You run dockers and **DON'T** have consistent and well-planned paths.
- You use Docker and **DON'T** have consistent and well-planned paths.
!!! note
If you run dockers it would be smarter to fix the problem at the source of what's causing the actual issue.
If you use Docker it would be smarter to fix the problem at the source of what's causing the actual issue.
- [Radarr Wiki Servarr - Docker Guide](https://wiki.servarr.com/docker-guide#consistent-and-well-planned-paths){:target="_blank" rel="noopener noreferrer"}

@ -8,11 +8,11 @@ Remote Path Mapping acts as a dumb find `Remote Path` and replaces it with the `
- If Sonarr and your download client are not on the same server/system.
- If you use either merged local/remote setups using mergerfs or similar.
- You run dockers and **DON'T** have consistent and well-planned paths.
- You use Docker and **DON'T** have consistent and well-planned paths.
!!! note
If you run dockers it would be smarter to fix the problem at the source of what's causing the actual issue.
If you use Docker it would be smarter to fix the problem at the source of what's causing the actual issue.
- [Sonarr Wiki Servarr - Docker Guide](https://wiki.servarr.com/docker-guide#consistent-and-well-planned-paths){:target="_blank" rel="noopener noreferrer"}

@ -45,7 +45,7 @@ All of the information provided in these guides, as well as in Discord or any gu
### Special Thanks
- [iXNyNe aka nemchik](https://github.com/nemchik){:target="_blank" rel="noopener noreferrer"} for introducing me to the world of dockers with DockSTARTer, and helping me to learn the basics for it.
- [iXNyNe aka nemchik](https://github.com/nemchik){:target="_blank" rel="noopener noreferrer"} for introducing me to the world of Docker containers with DockSTARTer, and helping me to learn the basics for it.
- [Roxedus](https://github.com/Roxedus){:target="_blank" rel="noopener noreferrer"} for helping me with the transfer/conversion of my Github guides to MkDocs and making everything look great.
--8<-- "CONTRIBUTORS.md"

@ -1,4 +1,4 @@
This basic example is based on the use of docker images
This basic example is based on the use of Docker images
!!! tip ""

@ -1,4 +1,4 @@
This basic example is based on the use of docker images
This basic example is based on the use of Docker images
!!! tip ""

@ -1,3 +1,3 @@
### Bad path suggestion
!!! warning "The default path setup suggested by some docker developers that encourages people to use mounts like `/movies`, `/tv`, `/books` or `/downloads` is very suboptimal and it makes them look like two or three file systems, even if they arent (_Because of how Dockers volumes work_). It is the easiest way to get started. While easy to use, it has a major drawback. Mainly losing the ability to hardlink or instant move, resulting in a slower and more I/O intensive copy + delete is used."
!!! warning "The default path setup suggested by some Docker developers that encourages people to use mounts like `/movies`, `/tv`, `/books` or `/downloads` is very suboptimal and it makes them look like two or three file systems, even if they arent (_Because of how Dockers volumes work_). It is the easiest way to get started. While easy to use, it has a major drawback. Mainly losing the ability to hardlink or instant move, resulting in a slower and more I/O intensive copy + delete is used."

Loading…
Cancel
Save