Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated the Synology instructions #867

Open
wants to merge 35 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 34 commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
55dfa8d
Updated the Synology instructions
LeRoid-hub Feb 23, 2024
dabe456
Resolved linter issues
LeRoid-hub Feb 24, 2024
b2fa098
Merge branch 'master' into master
LeRoid-hub Feb 26, 2024
a233306
Update docs/general/installation/synology.md
LeRoid-hub Feb 27, 2024
1825cfb
Resolved Linter issues
LeRoid-hub Feb 27, 2024
1ae4bda
Update docs/general/installation/synology.md
LeRoid-hub Feb 28, 2024
5580973
Update docs/general/installation/synology.md
LeRoid-hub Feb 28, 2024
611f684
Update docs/general/installation/synology.md
LeRoid-hub Feb 28, 2024
5469bfd
Update docs/general/installation/synology.md
LeRoid-hub Feb 28, 2024
1e5477a
Update docs/general/installation/synology.md
LeRoid-hub Feb 28, 2024
6efd291
Update docs/general/installation/synology.md
LeRoid-hub Feb 28, 2024
95a53dc
Update docs/general/installation/synology.md
LeRoid-hub Feb 28, 2024
f850d7c
Update docs/general/installation/synology.md
LeRoid-hub Feb 28, 2024
774f615
Update docs/general/installation/synology.md
LeRoid-hub Feb 28, 2024
02c9fbf
Update docs/general/installation/synology.md
LeRoid-hub Feb 28, 2024
6fde97d
Update docs/general/installation/synology.md
LeRoid-hub Feb 28, 2024
570e695
Update docs/general/installation/synology.md
LeRoid-hub Feb 28, 2024
6b7857f
Update docs/general/installation/synology.md
LeRoid-hub Feb 28, 2024
e8a1236
Update docs/general/installation/synology.md
LeRoid-hub Feb 28, 2024
ba8ff84
Update docs/general/installation/synology.md
LeRoid-hub Feb 28, 2024
12706e4
Update docs/general/installation/synology.md
LeRoid-hub Feb 28, 2024
131ad30
Update docs/general/installation/synology.md
LeRoid-hub Feb 28, 2024
d4ee5dc
Update docs/general/installation/synology.md
LeRoid-hub Feb 28, 2024
abfd60e
Update docs/general/installation/synology.md
LeRoid-hub Feb 28, 2024
3980738
some changes
LeRoid-hub Feb 28, 2024
a0a24fa
Merge
LeRoid-hub Feb 28, 2024
e8fcf1e
linebreak
LeRoid-hub Feb 28, 2024
8f9f4ad
Update docs/general/installation/synology.md
LeRoid-hub Feb 28, 2024
87284bd
Merge branch 'master' of github.com:LeRoid-hub/jellyfin.org
LeRoid-hub Feb 28, 2024
fb18fdf
Auto-restart
LeRoid-hub Feb 28, 2024
7ceec4b
Update docs/general/installation/synology.md
LeRoid-hub Mar 7, 2024
de97720
Update docs/general/installation/synology.md
LeRoid-hub Mar 7, 2024
aaaccf4
deleted images; Added creating Volume instructions; Advanced Example
LeRoid-hub Mar 7, 2024
2863fb4
markdown lint
LeRoid-hub Apr 12, 2024
e15d912
Apply suggestions from code review
LeRoid-hub Jul 23, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 59 additions & 14 deletions docs/general/installation/synology.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

LeRoid-hub marked this conversation as resolved.
Show resolved Hide resolved
![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. For this guide, the Synology Container Manager will be used to install Jellyfin.
LeRoid-hub marked this conversation as resolved.
Show resolved Hide resolved

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 initialation of an 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)
LeRoid-hub marked this conversation as resolved.
Show resolved Hide resolved

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 install. The latest version is recommended. Click `Apply` after selection a version.
LeRoid-hub marked this conversation as resolved.
Show resolved Hide resolved

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 to within the container. Use this setting to allow Jellyfin access to media and a place to store application data.
LeRoid-hub marked this conversation as resolved.
Show resolved Hide resolved
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 at 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.
LeRoid-hub marked this conversation as resolved.
Show resolved Hide resolved
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.
77 changes: 77 additions & 0 deletions docs/general/installation/synology.md.orig
Original file line number Diff line number Diff line change
@@ -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. For this guide, the Synology Container Manager will be used to install Jellyfin.
LeRoid-hub marked this conversation as resolved.
Show resolved Hide resolved

## 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 install. The latest version is recommended. Click `Apply` after selection a version.
LeRoid-hub marked this conversation as resolved.
Show resolved Hide resolved

![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 at 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.
LeRoid-hub marked this conversation as resolved.
Show resolved Hide resolved

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.

Binary file added static/images/docs/install-synology-0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/images/docs/install-synology-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/images/docs/install-synology-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/images/docs/install-synology-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/images/docs/install-synology-4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed static/images/docs/install-synology-5.png
Binary file not shown.
Binary file removed static/images/docs/install-synology-6.png
Binary file not shown.
Binary file removed static/images/docs/install-synology-7.png
Binary file not shown.
Binary file removed static/images/docs/install-synology-8.png
Binary file not shown.
Binary file removed static/images/docs/install-synology-9.png
Binary file not shown.