How to Install Gameyfin on Your UGREEN NAS

by

How to Install Gameyfin on Your UGREEN NAS

Gameyfin is a simple, fast, and free open-source application designed to manage your video game library. Inspired by Jellyfin, it automatically scans and indexes your game collection, allowing you to access and download games directly through a web browser. In this step by step guide I will show you how to install GameyfinĀ on your UGREEN NAS using Docker & Portainer.

šŸ’”Note: This guide works perfectly with the latest Gameyfin v2.0.1 release.

šŸ’”Note: Check out my guide on how to Install Gameyfin on Your Synology NAS.

  • STEP 1

Please Support My work by Making a Donation.

  • STEP 2

InstallĀ Portainer using my step by step guide. If you already have Portainer installed on your UGREEN NAS, skip this STEP. Attention: Make sure you have installed the latest Portainer version.

  • STEP 3

āš ļøMandatory Add Read & Write Permissions to the Docker Folder. If you have already added the Read and Write Permissions to the Docker Folder, skip this STEP.

  • STEP 4

Go toĀ Files and open the docker folder. Inside the docker folder, create one new folder and name it gameyfin. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

Gameyfin UGREEN NAS Set up 1

  • STEP 5

Now create four new folders inside the gameyfinĀ folder that you have previously created at STEP 4 and name them data, db, games, logs. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

Gameyfin UGREEN NAS Set up 2

  • STEP 6

Log into Portainer using your username and password. On the left sidebar in Portainer, click on Home then Live connect. Follow the instructions in the image below.

Portainer Add Stack NAS 1

On the left sidebar in Portainer, click on StacksĀ thenĀ + Add stack. Follow the instructions in the image below.

Portainer Add Stack NAS 2

  • STEP 7

In the Name field type in gameyfin. Follow the instructions in the image below.

Note: Copy Paste the code below in the Portainer Stacks Web editor.

services:
  gameyfin:
    image: ghcr.io/gameyfin/gameyfin:2
    container_name: Gameyfin
    healthcheck:
      test: ["CMD-SHELL", "nc -z 127.0.0.1 8080 || exit 1"]
      interval: 10s
      timeout: 5s
      retries: 3
      start_period: 90s  
    ports: 
     - 4335:8080
    environment:
      APP_KEY: w/POFyFJaCMtAybm8U8Cq1mMetGnlhiviq9MWOZpKI4=
      PUID: 999
      PGID: 10
      #APP_URL: https://gameyfin.ddns.net #Your own Domain name or NO-IP DDNS
    volumes: 
     - /volume1/docker/gameyfin/db:/opt/gameyfin/db:rw
     - /volume1/docker/gameyfin/data:/opt/gameyfin/data:rw
     - /volume1/docker/gameyfin/logs:/opt/gameyfin/logs:rw
     - /volume1/docker/gameyfin/games:/games:rw
    restart: on-failure:5

Note: Before you paste the code above in the Web editor area below, change the value for APP_KEY.
(šŸŸ¢Click this Link to Generate Your Own Free APP KEY.) šŸ–¼ļøCheck Example Screenshot. (In the prompt, type in the following text: openssl rand -base64 32 then hit enter on your Keyboard). šŸ–¼ļøCheck Example Screenshot and copy your key.
Note: Before you paste the code above in the Web editor area below, change the value numbers for PUIDĀ andĀ PGIDĀ with your own values. (Follow my step by step guide on how to do this.)

Gameyfin UGREEN NAS Set up 3

  • STEP 8

Scroll down on the page until you see a button namedĀ Deploy the stack. Click on it. Follow the instructions in the image below. The installation process can take up to a few minutes. It will depend on your Internet speed connection.

Gameyfin UGREEN NAS Set up 4

  • STEP 9

If everything goes right, you will see the following message at the top right of your screen: ā€œSuccess Stack successfully deployedā€œ.

Portainer Success Stack NAS

  • STEP 10

šŸŸ¢Please Support My work by Making a Donation. Almost 99,9% of the people that install something using my guidesĀ forget to support my work, or justĀ ignoreĀ STEP 1. Iā€™ve been very honest about this aspect of my work since the beginning: I donā€™t run any ADS, I donā€™t require subscriptions, paid or otherwise, I donā€™t collect IPs, emails, and I donā€™t have any referral links from Amazon or other merchants. I also donā€™t have any POP-UPs or COOKIES. I have repeatedly been told over the years how much I have contributed to the community. Itā€™s something I love doing and have been honest about my passion since the beginning. But I also Need The Community to Support me Back to be able to continue doing this work.

  • STEP 11

The installation process can take up to a few seconds/minutes. It will depend on your Internet speed connection. Now open your browser and type in http://ugreen-ip-address:4335 Click the right arrow icon. Follow the instructions in the image below.

Gameyfin UGREEN NAS Set up 5

  • STEP 12

Select your favorite Theme mode. Choose your favorite color combination. Click the right arrow icon. Follow the instructions in the image below.

Gameyfin UGREEN NAS Set up 6

  • STEP 13

Create your Administrator account. Type in your own Username, Email Address and Password. Click the OK icon. Follow the instructions in the image below.

Gameyfin UGREEN NAS Set up 7

  • STEP 14

Type in your own Username and Password that you have previously added at STEP 13. Click Log in. Follow the instructions in the image below.

Gameyfin UGREEN NAS Set up 8

  • STEP 15

At the top right of the page, click on the user icon then Administration. On the left sidebar, click Plugins. Select your SteamGridDB then click the Settings icon. Follow the instructions in the image below.

Gameyfin UGREEN NAS Set up 9

  • STEP 16

In the apposite area, type in your own SteamGridDB API Key. You can obtain your FREE SteamGridDB API Key from this link. āš ļøWarning: A Steam account is mandatory. After you have added your SteamGridDB API Key in the apposite area, click Save. Turn it on. Follow the instructions in the image below.

Gameyfin UGREEN NAS Set up 10

  • STEP 17

Turn on SteamGridDB Covers and Steam Metadata. Follow the instructions in the image below.

Gameyfin UGREEN NAS Set up 11

  • STEP 18

Populate your games folder that you have previously created at STEP 5 with your games. File extensions to consider as games are the following: zip, tar, gz, rar, 7z, bz2, xz, iso, jar, tgz, exe, bat, cmd, com, msi, bin, run, app, dmg, elf.

  • STEP 19

On the left sidebar, click Libraries. Click the + button to add your first library. Type in the name of the library, then click the + button. Follow the instructions in the image below.

Gameyfin UGREEN NAS Set up 12

  • STEP 20

Scroll down the list until you find the games folder. Click on the games folder, then click Select. Follow the instructions in the image below.

Gameyfin UGREEN NAS Set up 13

  • STEP 21

Select the option Scan after creation, then click Add. Follow the instructions in the image below.

Gameyfin UGREEN NAS Set up 14

  • STEP 22

Wait a few minutes until your games library is scanned. Your games library at a glance!

Gameyfin UGREEN NAS Set up 15

Enjoy Gameyfin!

Note: If you want to run the Gameyfin container over HTTPS, check out How to Run Docker Containers Over HTTPS on Your UGREEN NAS. At STEP 7, remember to remove the # in front of APP_URL and type in your Domain or NO-IP DDNS URLĀ  with https at the beginning.
šŸ†™Note/Update/Container: How to Update Your Docker Containers on UGREEN NAS Using Portainer.
šŸ³Note: How to Create Docker Shortcuts on Desktop.
šŸ†•Note: How to Update Portainer to the latest version.

This post was updated on Saturday / September 13th, 2025 at 12:26 AM

šŸ§” I Need Your Help!