{"id":349,"date":"2024-03-25T08:19:55","date_gmt":"2024-03-25T08:19:55","guid":{"rendered":"https:\/\/blog.devops955.com\/swain\/?p=349"},"modified":"2024-03-25T08:19:55","modified_gmt":"2024-03-25T08:19:55","slug":"deploy-jellyfin-in-omv-6","status":"publish","type":"post","link":"https:\/\/blog.devops955.com\/swain\/2024\/03\/25\/deploy-jellyfin-in-omv-6\/","title":{"rendered":"Setting Up Your Home NAS with OpenMediaVault Part III"},"content":{"rendered":"

OMV Feature Expansion<\/h1>\n

Beyond providing network storage, OMV officially offers many plugins to extend its functionalities, such as installing and running Plex<\/strong> or enabling Docker to set up a home multimedia platform with Jellyfin<\/strong>. To use these features, the OMV-extra<\/strong> plugin must be installed to enable Docker and then install the respective services. Beginners need not delve into the details of what Docker is; it can be considered as a functional plugin or a configured virtual machine running on OMV. We will attempt to enable Docker<\/strong> and install Jellyfin to set up a home media platform, similar to Plex (although some Plex features require a paid subscription, hence the choice of Jellyfin).<\/p>\n

Installing OMV-extra<\/h2>\n

OMV-extra<\/strong> is a plugin for OMV. Before running Jellyfin on Docker, enable the extra plugin to use advanced features. Install by logging in via SSH or locally to the OMV backend and executing the following command:<\/p>\n

wget -O - https:\/\/github.com\/OpenMediaVault-Plugin-Developers\/packages\/raw\/master\/install | bash<\/code><\/pre>\n
\"\"<\/p>\n
This will download necessary components and execute the installation. After completion, log into the GUI and use Ctrl+Shift+R<\/code> to refresh the page.
\n\"\"<\/p>\n
After reloading, you'll find an omv-extras option under the system menu. Next, install the Docker Compose<\/strong> plugin by searching for 'compose' in Plugins<\/strong>, selecting it, and installing. During this process, the sharerootfs<\/strong> plugin, which is essential for operation, will also be installed and should not be uninstalled.
\n\"\"<\/p>\n
Enabling Docker<\/h2>\n
After installation, check the docker repo<\/strong> in omv-extra to enable Docker, then click Apply to implement changes.<\/p>\n
In services<\/strong>, a new compose<\/strong> service appears, showing that Docker Compose is enabled.
\n\"\"<\/p>\n
Configuring Docker<\/h2>\n
First, create directories for Docker in share folder<\/strong>, named docker, appdata, and data<\/strong>, plus docker_backup<\/strong> if needed. Note down the absolute path of docker<\/strong> for later configurations.
\n\"\"<\/p>\n
Configure Docker under Services - Compose - Settings<\/strong>, link the relevant directories, choose appdata for Compose Files<\/strong>, select data for Data<\/strong>, and fill in the docker path<\/strong> you created. Apply the settings afterwards.
\n\"\"<\/p>\n
Next, create a Docker user<\/strong> under Users - Users<\/strong>, name it appuser<\/strong> or as you prefer, and add it to the users<\/strong> group. Record the user's UID and GID<\/strong>, typically starting from 1000; if appuser is the second user, it would be 1001<\/strong>, with the user group GID at 100<\/strong>. Confirm this by logging into the server backend and entering cat \/etc\/passwd<\/code> to see UID:GID<\/strong>.
\n\"\"<\/p>\n
Now you're ready to configure Docker. Return to Services - Compose - Files<\/strong>, select Edit global environment file<\/strong> to set global variables.
\n\"\"<\/p>\n
Input the following (TZ is TimeZone, check in System - Date & Time<\/strong> under Time zone):<\/p>\n
PUID=1001\nPGID=100\nTZ=Asia\/Hong_Kong<\/code><\/pre>\n
With the basics set, you're now ready to install and configure Jellyfin.<\/p>\n
Installing Jellyfin<\/h2>\n
First, choose a Docker image from Docker Hub<\/a>, like jellyfin\/jellyfin<\/strong> or linuxserver\/jellyfin<\/strong>, recommending the latest<\/strong> stable version. Back in OMV, go to Services - Compose - Files<\/strong> and click Add<\/strong> to set up, or use Add from Example<\/strong> for a quick Jellyfin setup. Example configuration as follows:<\/p>\n
---\n# https:\/\/jellyfin.org\/downloads\/docker\nservices:\n  jellyfin:\n    image: jellyfin\/jellyfin:latest\n    container_name: jellyfin\n    environment:\n      - PUID=1001\n      - PGID=100\n      - TZ=Asia\/Hong_kong\n    volumes:\n      - .\/config:\/config\n      - ${DATA}\/jellyfin\/tvseries:\/data\/tvshows\n      - \/srv\/dev-disk-by-uuid-a5a771ab-4ee8-4c47-bb5b-67754baf02ce\/data\/jellyfin\/movies:\/data\/movies\n    ports:\n      - 8096:8096\n    restart: unless-stopped<\/code><\/pre>\n
\n
Here, .\/config<\/strong> points to the local path, and ${DATA}\/jellyfin\/tvseries<\/strong> uses the variable DATA<\/strong> corresponding to the earlier set \/data directory. You can also use the complete absolute path<\/strong>.
\nPorts are for Docker to expose services through your OMV server, defaults are used here for simplicity.<\/p>\n<\/blockquote>\n
After configuring, select the newly created file, check<\/strong> the configuration, and if all is correct, choose up<\/strong> to start the Docker service.
\n\"\"<\/p>\n
Once the image is pulled and successfully started, access http:\/\/serverip:8096<\/a> in a browser to initialize settings.
\n\"\"<\/p>\n
Further Jellyfin settings are not detailed here; refer to the official documentation for guidance.<\/p>\n
When adding media libraries, since Docker defaults to temporary storage, ensure data is stored outside the container in persistent storage mapped earlier (e.g., \/data\/tvshows and \/data\/movies). If there are more categories (music, photos, etc.), add configurations as needed. Accordingly, or you can place all categories in the same directory for simplicity.
\n\"\"<\/p>\n
Additionally, Jellyfin functions as a standalone service, thus it requires setting up individual users. When creating users, it is not necessary to set up passwords for them if they are not to be administrators, to facilitate ease of use. However, ensure that users are granted access to different media libraries to prevent them from being unable to see any content upon entry.
\n\"\"
\n\"\"<\/p>\n
Lastly, just upload the media files to the server (in the corresponding OMV directories), and then scan them in the admin console to start enjoying your media collection. Future changes or updates only require scanning individual media libraries instead of rescanning all libraries, saving significant time.
\n\"\"<\/p>\n
\n
References\uff1a
\nOMV Extras Plugin<\/a>
\nOMV6 Docker Compose<\/a>
\nDocker in OMV<\/a>
\nPlex in OMV6<\/a><\/p>\n<\/blockquote>\n","protected":false},"excerpt":{"rendered":"
This article discusses expanding OMV’s functionalities through plugins like OMV-extra and Docker, focusing on setting up a home media platform using Jellyfin.<\/p>\n","protected":false},"author":3,"featured_media":276,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":"","_jetpack_memberships_contains_paid_content":false},"categories":[4],"tags":[],"jetpack_sharing_enabled":true,"jetpack_featured_media_url":"https:\/\/blog.devops955.com\/swain\/wp-content\/uploads\/sites\/2\/2024\/03\/jellyfin.png","_links":{"self":[{"href":"https:\/\/blog.devops955.com\/swain\/wp-json\/wp\/v2\/posts\/349"}],"collection":[{"href":"https:\/\/blog.devops955.com\/swain\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/blog.devops955.com\/swain\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/blog.devops955.com\/swain\/wp-json\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/blog.devops955.com\/swain\/wp-json\/wp\/v2\/comments?post=349"}],"version-history":[{"count":6,"href":"https:\/\/blog.devops955.com\/swain\/wp-json\/wp\/v2\/posts\/349\/revisions"}],"predecessor-version":[{"id":369,"href":"https:\/\/blog.devops955.com\/swain\/wp-json\/wp\/v2\/posts\/349\/revisions\/369"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/blog.devops955.com\/swain\/wp-json\/wp\/v2\/media\/276"}],"wp:attachment":[{"href":"https:\/\/blog.devops955.com\/swain\/wp-json\/wp\/v2\/media?parent=349"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/blog.devops955.com\/swain\/wp-json\/wp\/v2\/categories?post=349"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/blog.devops955.com\/swain\/wp-json\/wp\/v2\/tags?post=349"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}