diff --git a/docs/general/installation/synology.md b/docs/general/installation/synology.md index ca450458d..56096efbe 100644 --- a/docs/general/installation/synology.md +++ b/docs/general/installation/synology.md @@ -5,30 +5,75 @@ description: Install on Synology NAS. sidebar_position: 4 --- -For [Synology](https://www.synology.com/en-us/dsm), Jellyfin is installed using Docker. +# Installation on Synology -![Installing Synology](/images/docs/install-synology-1.png) +:::caution Pre-built NAS Devices -![Installing Synology](/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. -![Installing Synology](/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 -![Installing Synology](/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). -![Installing Synology](/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 -![Installing Synology](/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. -![Installing Synology](/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". -![Installing Synology](/images/docs/install-synology-8.png) +![Downloading the Image](/images/docs/install-synology-0.png) -![Installing Synology](/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/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/install-synology-2.png) + +#### Port Settings + +Allocate ports to the container. Jellyfin uses port 8096 for the web interface and 1900 for DLNA by default. It is recommended to use the default ports if they are not being used by other services. + +#### 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. + +#### Network Settings + +Set how the container connects to the network. DLNA requires `Host` mode to function. + +#### Settings for advanced users + +- Enviroment Variables + +#### Example + +Your settings should look like this: +![Advanced Settings](/images/docs/install-synology-3.png) +![Advanced Settings](/images/docs/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/docs/general/installation/synology.md.orig b/docs/general/installation/synology.md.orig new file mode 100644 index 000000000..c6e1c655e --- /dev/null +++ b/docs/general/installation/synology.md.orig @@ -0,0 +1,77 @@ +--- +uid: installation-synology +title: Synology +description: Install on Synology NAS. +sidebar_position: 4 +--- + +# Installation on Synology + +:::caution Pre-built NAS Devices + +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. + +::: +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. + +## Prerequisites + +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. +<<<<<<< HEAD +To do this you need to open the Package Center and search for "Container Manager" and install it. +For further information read this [guide](https://kb.synology.com/en-global/DSM/help/DSM/PkgManApp/install_buy?version=7). +======= +Open the Package Center and search for "Container Manager" to find the package. +>>>>>>> abfd60eacf4d2e6093e8485c3dbd5b0a40e7c0c4 + +## Installation + +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. + +### Downloading the Jellyfin Image + +Navigate to the "Registry" tab and search for "Jellyfin". You should see the official jellyfin/jellyfin image. Click on it and then click "Download". + +![Downloading the Image](/images/docs/install-synology-10.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. + +![Downloading the Image](/images/docs/install-synology-11.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. We recommend using "Jellyfin" as the name. You can also set the container to auto-start if you want Jellyfin to start 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/install-synology-12.png) + +#### Port Settings + +Allocate ports to the container. Jellyfin uses port 8096 for the web interface and 1900 for DLNA by default. It is recommended to use the default ports if they are not being used by other services. + +#### Volume Settings + +You need to set the volume settings for the container. Jellyfin needs access to your media files and configuration files. +To add a volume, click "Add Folder" and select the folder you want to use. In the middle column, you need to set the mount path. For the media files, you can use "/media" and for the configuration files, you can use "/config". + +#### Network Settings +Set how the container connects to the network. DLNA requires `Host` mode to function. + +Any other settings can be left as default. +Your settings should look like this: +![Advanced Settings](/images/docs/install-synology-13.png) +![Advanced Settings](/images/docs/install-synology-14.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/install-synology-0.png b/static/images/docs/install-synology-0.png new file mode 100644 index 000000000..459dac03b Binary files /dev/null and b/static/images/docs/install-synology-0.png differ diff --git a/static/images/docs/install-synology-1.png b/static/images/docs/install-synology-1.png index ac58b2dd5..84a74c492 100644 Binary files a/static/images/docs/install-synology-1.png and b/static/images/docs/install-synology-1.png differ diff --git a/static/images/docs/install-synology-2.png b/static/images/docs/install-synology-2.png index 860f887df..a5848ab2e 100644 Binary files a/static/images/docs/install-synology-2.png and b/static/images/docs/install-synology-2.png differ diff --git a/static/images/docs/install-synology-3.png b/static/images/docs/install-synology-3.png index e34e6cddb..88e643c98 100644 Binary files a/static/images/docs/install-synology-3.png and b/static/images/docs/install-synology-3.png differ diff --git a/static/images/docs/install-synology-4.png b/static/images/docs/install-synology-4.png index 43ab53730..d339b9cf3 100644 Binary files a/static/images/docs/install-synology-4.png and b/static/images/docs/install-synology-4.png differ diff --git a/static/images/docs/install-synology-5.png b/static/images/docs/install-synology-5.png deleted file mode 100644 index 89ee9fa15..000000000 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 04d34b4ad..000000000 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 530239d91..000000000 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 2ee2b6d01..000000000 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 40c880e64..000000000 Binary files a/static/images/docs/install-synology-9.png and /dev/null differ