Homepage

Homepage Setup for UGREEN NAS with UGOS

Official Homepage Documentation

Sample Homepage

Homepage Installation on UGREEN NAS with UGOS

1. Go to Control Panel -> Network -> Uncheck Enable multiple gateways
2. Go to App Center on UGOS and install Docker. Alternatively, you can install Portainer or other container management software.
3. Create folders on NAS
   1. Go to Files app and navigate to docker folder
   2. Create a folder and name it homepage
   3. Create two subfolders within homepage and name them: config and icons
4. Docker installation
   1. Add API keys, usernames, and passwords to .env file (see sample file). Upload .env file to /volume1/docker/homepage
      • To find PUID and PGID, open Docker app and on the left hand side, click Project and click Create button. The PUID and PGID should be located in the Compose configuration section
   2. Open Docker app
   3. On the left hand side, click Project and click Create button
      • 
   4. In the name field enter: homepage
   5. In the compose configuration field, paste the following yaml file
      • You must modify HOMEPAGE_ALLOWED_HOSTS: in order to access the homepage. Add domain name, NAS IP and Tailscale IP (if using) as allowed hosts: [NAS IP]:3000,[Tailscale NAS IP]:3000
      • Note: If you plan to also install AdGuard Home, you need to change port to anything except 3000
   6. Click Deploy button
5. Portainer installation
   1. Login to Portainer
   2. On the left hand side, click Home then Live connect
   3. On the left hand side, click Stacks
   4. Click + Add stack button
   5. In the name field enter: homepage
   6. In the compose configuration field, paste the following yaml file
      • You must modify HOMEPAGE_ALLOWED_HOSTS: in order to access the homepage. Add domain name, NAS IP and Tailscale IP (if using) as allowed hosts: [NAS IP]:3000,[Tailscale NAS IP]:3000
      • Note: If you plan to also install AdGuard Home, you need to change port to anything except 3000
   7. Add API keys, usernames, and passwords to .env file (see sample file). Upload .env file by clicking Load variables from .env file
      • To find PUID and PGID, open Docker app and on the left hand side, click Project and click Create button. The PUID and PGID should be located in the Compose configuration section
   8. Click Deploy the stack button
6. Go to [NAS IP]:3000 to view homepage

Customizing Homepage

1. To customize Homepage, you will need to go to the configuration files and modify them. In UGOS, open Files app and navigate to docker/homepage/config
2. Go to Homepage documentation for additional information on how to customize the homepage and add widgets. I have uploaded my settings.