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 5 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
69 changes: 68 additions & 1 deletion docs/general/installation/synology.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,73 @@ description: Install on Synology NAS.
sidebar_position: 4
---

For [Synology](https://www.synology.com/en-us/dsm), Jellyfin is installed using Docker.
# Install on Synology
LeRoid-hub marked this conversation as resolved.
Show resolved Hide resolved

LeRoid-hub marked this conversation as resolved.
Show resolved Hide resolved
:::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](https://jellyfin.org/docs/general/administration/hardware-selection#normal-server) for more information.
LeRoid-hub marked this conversation as resolved.
Show resolved Hide resolved

:::
For [Synology](https://www.synology.com/en-us/dsm), Jellyfin is installed using Docker. For this guide, we will use the Synology Container Manager 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.
If you are running an older version of DSM, you can use the guide at the bottom.
felix920506 marked this conversation as resolved.
Show resolved Hide resolved
Install the "Container Manager" package from the Synology Package Center.
To do this you need to open the Package Center and search for "Container Manager" and install it.
LeRoid-hub marked this conversation as resolved.
Show resolved Hide resolved

## Installation

The installation is done with the Synology Container Manager.
If after the installation of the "Container Manager" you don´t see the icon in the main menu, you can find it in when clicking on the top left corner of the main menu.
LeRoid-hub marked this conversation as resolved.
Show resolved Hide resolved

### 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, there you can select a version of Jellyfin. We recommend using the latest version. Click "Apply".
LeRoid-hub marked this conversation as resolved.
Show resolved Hide resolved

![Downloading the Image](/images/docs/install-synology-11.png)

After a few seconds, the image will be downloaded and you can find it in the "Image" tab.
LeRoid-hub marked this conversation as resolved.
Show resolved Hide resolved

### Creating the Container

Navigate to the "Container" tab and click "Create".
LeRoid-hub marked this conversation as resolved.
Show resolved Hide resolved
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.
LeRoid-hub marked this conversation as resolved.
Show resolved Hide resolved
Also, you can set the resource limits for the container. We recommend that you let the container use all available resources.
LeRoid-hub marked this conversation as resolved.
Show resolved Hide resolved
Click "Next".
LeRoid-hub marked this conversation as resolved.
Show resolved Hide resolved
![Creating the Container](/images/docs/install-synology-12.png)

**Port Settings**
LeRoid-hub marked this conversation as resolved.
Show resolved Hide resolved
You need to set the port settings for the container. Jellyfin uses port 8096 for the web interface and 1900 for DLNA. You can set the container to use the same ports as the host or use different ports. We recommend using the same ports as the host.
LeRoid-hub marked this conversation as resolved.
Show resolved Hide resolved

**Volume Settings**
LeRoid-hub marked this conversation as resolved.
Show resolved Hide resolved
You need to set the volume settings for the container. Jellyfin needs access to your media files and configuration files.
LeRoid-hub marked this conversation as resolved.
Show resolved Hide resolved
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".
LeRoid-hub marked this conversation as resolved.
Show resolved Hide resolved

**Network Settings**
LeRoid-hub marked this conversation as resolved.
Show resolved Hide resolved
You need to set the network settings for the container. Jellyfin needs access to the network to stream media and use DLNA. You can use "Bridge" mode if you are running multiple instances of Jellyfin or "Host" mode if you are only running one instance. We recommend using "Host" mode.
LeRoid-hub marked this conversation as resolved.
Show resolved Hide resolved

Any other settings can be left as default.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Any other settings can be left as default.
Other settings can be left as default.

There should also be explainers on what other settings do for advanced users.

Your settings should look like this:
![Advanced Settings](/images/docs/install-synology-13.png)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Where is the directory for config files?

![Advanced Settings](/images/docs/install-synology-14.png)
Click "Next".
LeRoid-hub marked this conversation as resolved.
Show resolved Hide resolved

You can review your settings and then click "Apply".
Make sure the checkbox "Run this container after the wizard is finished" is checked.
You can now see the container in the "Container" tab.
LeRoid-hub marked this conversation as resolved.
Show resolved Hide resolved

Browse to `http://SERVER_IP:8096` to access the web client.
If you used a different port, replace 8096 with the port you used.
LeRoid-hub marked this conversation as resolved.
Show resolved Hide resolved

## earlier versions of DSM
LeRoid-hub marked this conversation as resolved.
Show resolved Hide resolved

![Installing Synology](/images/docs/install-synology-1.png)

Expand All @@ -32,3 +98,4 @@ Host Mode is required for HdHR and DLNA. Use bridge mode if running multiple ins
![Installing Synology](/images/docs/install-synology-9.png)

Browse to `http://SERVER_IP:8096` to access the web client.
If you used a different port, replace 8096 with the port you used.
LeRoid-hub marked this conversation as resolved.
Show resolved Hide resolved
Binary file added static/images/docs/install-synology-10.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 added static/images/docs/install-synology-11.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 added static/images/docs/install-synology-12.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 added static/images/docs/install-synology-13.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 added static/images/docs/install-synology-14.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.