diff --git a/docs/general/installation/advanced/synology.md b/docs/general/installation/advanced/synology.md index 81718f2f..7f397551 100644 --- a/docs/general/installation/advanced/synology.md +++ b/docs/general/installation/advanced/synology.md @@ -5,30 +5,67 @@ description: Install on Synology NAS. sidebar_position: 2 --- -For [Synology](https://www.synology.com/en-us/dsm), Jellyfin is installed using Docker. +# Installation on Synology -![Docker image add from url](/images/docs/install-synology-1.png) +:::caution Pre-built NAS Devices -![add from url window](/images/docs/install-synology-2.png) +Many pre-built NAS devices are underpowered. We generally do not recommend running Jellyfin on those devices. +See: [Hardware Selection](/docs/general/administration/hardware-selection) for more information. -![choose tag window](/images/docs/install-synology-3.png) +::: +For [Synology](https://www.synology.com/en-us/dsm), Jellyfin is installed using Docker. In this guide, the Synology Container Manager will be used to install Jellyfin. -Create the container. +## Prerequisites -![create container general settings](/images/docs/install-synology-4.png) +Everything is done through the Synology web interface. +This guide assumes you have already set up your Synology NAS and have access to the web interface. And your Synology NAS is running DSM 7.0 or newer. +Install the "Container Manager" package from the Synology Package Center. +Open the Package Center and search for "Container Manager" to find the package. +For further information read this [guide](https://kb.synology.com/en-global/DSM/help/DSM/PkgManApp/install_buy?version=7). -![create container advance settings](/images/docs/install-synology-5.png) +The creation and initialization of a volume will not be touched in this guide. Further information is provided by [Synology](https://kb.synology.com/en-global/DSM/help/DSM/StorageManager/volume_create_volume?version=7) -Use Advanced Settings to add mount points to your media and config. +## Installation -![add mounts window](/images/docs/install-synology-6.png) +The installation is done with the Synology Container Manager. +If you don't see the icon in the main menu after the installation of `Container Manager`, it can be found by clicking the top left corner of the main menu. -![advance settings showing mount added](/images/docs/install-synology-7.png) +### Downloading the Jellyfin Image -Host Mode is required for HdHR and DLNA. Use bridge mode if running multiple instances. +Navigate to the "Registry" tab and search for "Jellyfin". You should see the official jellyfin/jellyfin image. Click on it and then click "Download". -![advance settings network tab](/images/docs/install-synology-8.png) +![Downloading the Image](/images/docs/advanced/synology/install-synology-0.png) -![create container summary](/images/docs/install-synology-9.png) +A new window will open and a Jellyfin version can be selected for installation. The latest version is recommended. Click `Apply` after selection a version. -Browse to `http://SERVER_IP:8096` to access the web client. +![Downloading the Image](/images/docs/advanced/synology/install-synology-1.png) + +After the image is downloaded, it can be found in the `Image` tab. + +### Creating the Container + +Navigate to the `Container` tab and click `Create`. +Select the `Jellyfin` image and give the container a name. This is mainly for identification purposes and can be set to anything desired. `auto-restart` can be enabled to automatically start Jellyfin when the NAS boots. +Resource limits can also be set for the container. It is recommended that all CPU resources and at least 4GB of ram be allocated to the Jellyfin container. +Click `Next` to proceed to the next step. +![Creating the Container](/images/docs/advanced/synology/install-synology-2.png) + +#### Network and Port Settings + +For the [Network Settings](https://jellyfin.org/docs/general/post-install/networking/dlna#general) and [Port Settings](https://jellyfin.org/docs/general/post-install/networking/#port-bindings) please refer their respected guides. + +#### Volume Settings + +This setting maps, directories on the host within the container. Use this setting to allow Jellyfin access to media and a place to store application data. +To add a volume, click "Add Folder" and select the folder desired. The mount point is set in the middle column and the directory will be accessible at this path within the container. For media files, `/media` can be used, and for config files, `/config` can be used. + +#### Example + +Your settings should look like this: +![Advanced Settings](/images/docs/advanced/synology/install-synology-3.png) +![Advanced Settings](/images/docs/advanced/synology/install-synology-4.png) +Click `Next` to proceed to the next step. + +Settings can be reviewed on this screen. Check the `Run this container after the wizard is finished` checkbox and click `Apply` if everything looks correct. The container should now be shown in the `Container` tab. +Browse to `http://SERVER_IP:8096` in a browser on a other device to finish setting up the Jellyfin server. +If a different port was used, replace `8096` with the port used instead. diff --git a/static/images/docs/advanced/synology/install-synology-0.png b/static/images/docs/advanced/synology/install-synology-0.png new file mode 100644 index 00000000..459dac03 Binary files /dev/null and b/static/images/docs/advanced/synology/install-synology-0.png differ diff --git a/static/images/docs/advanced/synology/install-synology-1.png b/static/images/docs/advanced/synology/install-synology-1.png new file mode 100644 index 00000000..84a74c49 Binary files /dev/null and b/static/images/docs/advanced/synology/install-synology-1.png differ diff --git a/static/images/docs/advanced/synology/install-synology-2.png b/static/images/docs/advanced/synology/install-synology-2.png new file mode 100644 index 00000000..a5848ab2 Binary files /dev/null and b/static/images/docs/advanced/synology/install-synology-2.png differ diff --git a/static/images/docs/advanced/synology/install-synology-3.png b/static/images/docs/advanced/synology/install-synology-3.png new file mode 100644 index 00000000..88e643c9 Binary files /dev/null and b/static/images/docs/advanced/synology/install-synology-3.png differ diff --git a/static/images/docs/advanced/synology/install-synology-4.png b/static/images/docs/advanced/synology/install-synology-4.png new file mode 100644 index 00000000..d339b9cf Binary files /dev/null and b/static/images/docs/advanced/synology/install-synology-4.png differ diff --git a/static/images/docs/install-synology-1.png b/static/images/docs/install-synology-1.png deleted file mode 100644 index ac58b2dd..00000000 Binary files a/static/images/docs/install-synology-1.png and /dev/null differ diff --git a/static/images/docs/install-synology-2.png b/static/images/docs/install-synology-2.png deleted file mode 100644 index 860f887d..00000000 Binary files a/static/images/docs/install-synology-2.png and /dev/null differ diff --git a/static/images/docs/install-synology-3.png b/static/images/docs/install-synology-3.png deleted file mode 100644 index e34e6cdd..00000000 Binary files a/static/images/docs/install-synology-3.png and /dev/null differ diff --git a/static/images/docs/install-synology-4.png b/static/images/docs/install-synology-4.png deleted file mode 100644 index 43ab5373..00000000 Binary files a/static/images/docs/install-synology-4.png and /dev/null differ diff --git a/static/images/docs/install-synology-5.png b/static/images/docs/install-synology-5.png deleted file mode 100644 index 89ee9fa1..00000000 Binary files a/static/images/docs/install-synology-5.png and /dev/null differ diff --git a/static/images/docs/install-synology-6.png b/static/images/docs/install-synology-6.png deleted file mode 100644 index 04d34b4a..00000000 Binary files a/static/images/docs/install-synology-6.png and /dev/null differ diff --git a/static/images/docs/install-synology-7.png b/static/images/docs/install-synology-7.png deleted file mode 100644 index 530239d9..00000000 Binary files a/static/images/docs/install-synology-7.png and /dev/null differ diff --git a/static/images/docs/install-synology-8.png b/static/images/docs/install-synology-8.png deleted file mode 100644 index 2ee2b6d0..00000000 Binary files a/static/images/docs/install-synology-8.png and /dev/null differ diff --git a/static/images/docs/install-synology-9.png b/static/images/docs/install-synology-9.png deleted file mode 100644 index 40c880e6..00000000 Binary files a/static/images/docs/install-synology-9.png and /dev/null differ