- Changed: Complete overhaul/cleanup.
- Added: New easier to use docker-compose.yml.
- Added: .env file for the use with the new docker-compose.yml.
- Added: New template Repository for Synology section of this Guide.
- Added: Breakdown of the Folder Structure.
- Added: docker-compose commands cheat sheet.
- Added: line breaks to make it more readable.
- Removed: docker-compose-collection.yml.
Then use a program like Putty and SSH to your Synology.
@ -425,7 +425,7 @@ Then keep reading.
Enter the login information of your main Synology user account.
Once logged in type `id`.
This will show your UID (aka PUID).
@ -437,12 +437,14 @@ Then keep reading.
Yes we know it's not recommended to use the admin account but if you already know this then you wouldn't need to read this ;)
------
##### Folder Structure
!!! attention
To get Hardlinks and Atomic-Moves working with your Synology you will need to make use of **ONE** share with subfolders.
##### Folder Structure
For this example we're going to make use of a share called `data`.
On the host (Synology) you will need to add `/volume1/` before it. So `/volume1/data`
@ -451,6 +453,8 @@ Then keep reading.
These subfolders you need to create your self.
*I'm using lower case on all folder on purpose, being Linux is case sensitive.*
```none
data
├── torrents
@ -467,7 +471,75 @@ Then keep reading.
└── tv
```
*I'm using lower case on all folder on purpose, being Linux is case sensitive.*
??? summary "Breakdown of the Folder Structure"
##### Breakdown of the Folder Structure
###### Torrent clients
qBittorrent, Deluge, ruTorrent
The reason why we use `/data/torrents` for the torrent client is because it only needs access to the torrent files. In the torrent software settings, you’ll need to reconfigure paths and you can sort into sub-folders like `/data/torrents/{tv|movies|music}`.
```none
data
└── torrents
├── movies
├── music
└── tv
```
###### Usenet clients
NZBGet or SABnzbd
The reason why we use `/data/usenet` for the usenet client is because it only needs access to the usenet files. In the usenet software settings, you’ll need to reconfigure paths and you can sort into sub-folders like `/data/usenet/{tv|movies|music}`.
```none
data
└── usenet
├── movies
├── music
└── tv
```
###### The arr(s)
Sonarr, Radarr and Lidarr
Sonarr, Radarr and Lidarr gets access to everything because the download folder(s) and media folder will look like and be one file system. Hard links will work and moves will be atomic, instead of copy + delete.
```none
data
├── torrents
│ ├── movies
│ ├── music
│ └── tv
├── usenet
│ ├── movies
│ ├── music
│ └── tv
└── media
├── movies
├── music
└── tv
```
###### Media Server
Plex, Emby, JellyFin and Bazarr
Plex, Emby, JellyFin and Bazarr only needs access to your media library, which can have any number of sub folders like Movies, Kids Movies, TV, Documentary TV and/or Music as sub folders.
A docker-compose file exist of 1 file that holds all the needed info of all your docker containers.
this makes it easy to maintain and compare paths.
------
##### Needed files
Download this [docker-compose.yml](https://gist.github.com/TRaSH-/6eddbc251b54b22acffba6baf5cbb5ed){:target="_blank" rel="noopener noreferrer"} to your `/volume1/docker/appdata` location so you got your important stuff together.
First we will download the `docker-compose.yml` file
Download this [docker-compose.yml](https://github.com/TRaSH-/Guides-Synology-Templates/blob/main/docker-compose/docker-compose.yml){:target="_blank" rel="noopener noreferrer"} to your `/volume1/docker/appdata` location so you got your important stuff together.
This docker-compose file will have the following docker containers included.
??? question "What's included and What's not included"
- Radarr
- Sonarr
- Bazarr (Subtitle searcher and downloaded)
- NZBGet
- qBittorent
- Plex
- Tautulli
- Watchtower (automatic docker container updater)
This docker-compose file will have the following docker containers included.
##### Changes you need to do
- Radarr
- Sonarr
- Bazarr (Subtitle searcher and downloaded)
- Plex
- Tautulli
- Watchtower (automatic docker container updater at 4am)
1. PUID/PGID (this info you got earlier)
1. TZ (Change to your timezone)
What's not included.
##### Permissions
I didn't add a downloader to it because it depends on what you prefer usenet/torrents and which client you prefer, so i created a new [Repository](https://github.com/TRaSH-/Guides-Synology-Templates){:target="_blank" rel="noopener noreferrer"} on Github where I provide and maintain some templates that you can find in the `template` folder ready to use with the main `docker-compose.yml`.
The only thing you need to do is copy/paste what's inside the `.yml` file in to the main `docker-compose.yml`, the template also has the command what you need to use to create the [appdata](#appdata) folder that we explained earlier.
Second we will download the `.env` file
Download this [.env](https://github.com/TRaSH-/Guides-Synology-Templates/blob/main/docker-compose/.env){:target="_blank" rel="noopener noreferrer"} to your `/volume1/docker/appdata` location so you got your important stuff together.
Synology doesn't always pick up the `$USER` correctly, you can test it if the right user is been used with the following command
------
```bash
ls -al /volume1/docker
```
##### Changes you need to do
The `.env` we downloaded holds the variables/information you need to change so everything works (I added also a description in the `.env` file)
and user should be the same user you used for your PUID !
1. DOCKERCONFDIR (only change this if you know what you're doing and decide to use another path then in this guide used)
1. DOCKERDATADIR (only change this if you know what you're doing and decide to use another path then in this guide used)
1. PUID/PGID (this info you got earlier from [HERE](#puid-and-pgid))
1. TZ (Change to your timezone)
If it isn't the same then you need to replace `$USER` with the user what you used for your PUID, in the following example I used admin like we did in the start of the guide.
It holds more variables/information for other containers but they are described in the `.env`
You will notice that all the images will be downloaded, and after that the containers will be started. If you get a error then look at the error what it says and try to fix it. If you still got issues then put your used docker-compose.yml on pastebin and join the guides-discord [here](https://trash-guides.info/discord){:target="_blank" rel="noopener noreferrer"} and provide the pastebin link with the error, have patience because of timezone differences.
Don't forget to look at the [Examples](#examples) how to setup the paths inside the containers.
------
**Don't forget to look at the [Examples](#examples) how to setup the paths inside the containers.**
!!! attention
@ -564,15 +659,14 @@ Then keep reading.
Any changes you do/did in the GUI will be reverted when you run the docker-compose.
Just don't use the GUI
!!! tip
##### Synology Compose Collection
Just don't use the GUI !!!
I've created a collection of often used applications that you can use to add/replace in the current `docker-compose.yml`
- `sudo docker-compose up -d` (This Docker-compose command helps builds the image, then creates and starts Docker containers. The containers are from the services specified in the compose file. If the containers are already running and you run docker-compose up, it recreates the container.)
- `sudo docker-compose pull` (Pulls an image associated with a service defined in a docker-compose.yml)
- `sudo docker-compose down` (The Docker-compose down command also stops Docker containers like the stop command does. But it goes the extra mile. Docker-compose down, doesn’t just stop the containers, it also removes them.)
- `sudo docker system prune -a --volumes --force` (Remove all unused containers, networks, images (both dangling and unreferenced), and optionally, volumes.)
TRaSH
4 years ago