Installing Grsync in Docker via Portainer on ASUSTOR NAS

Introduction

Grsync is a graphical user interface for rsync, a popular command-line tool used for file synchronization and backup. This guide will walk you through the process of installing Grsync within a Docker container on your ASUSTOR 5202T NAS using Portainer, a user-friendly management interface for Docker.

Prerequisites

Before proceeding, ensure that you have already installed Docker and Portainer on your ASUSTOR NAS. If not, follow these guides to set them up:

Installing Grsync via Docker and Portainer

Step 1: Access Portainer

First, access your Portainer interface by navigating to http://<your_nas_ip>:9000 in your web browser[1].

Step 2: Create a new container

  • Click on "Add Container" in the top-right corner of the screen.
  • In the "Create Container" page, fill in the following details:
    • Name: Grsync (or any name you prefer)
    • Image: Search for and select linuxserver/grsync[2]
    • Ports: Leave this field blank as Grsync doesn't require port mapping.
    • Volumes: Click on "Add Volume" and configure the following:
      • Path: /config (This is where Grsync will store its configuration files)
      • Mode: rw
      • Destination: /config[3]
    • Network: Choose "Bridge"
  • Click on "Advanced Settings" to configure additional options:
    • Under "Environment Variables," add the following variable to set a password for Grsync:
      • Name: PUID
      • Value: Your user ID (you can find this by running id in your NAS's terminal)[4]
    • Click on "Add Volume" again and configure the following:
      • Path: /data (This is where you want Grsync to sync files from/to)
      • Mode: rw
      • Destination: /data[5]
  • Click on "Create" to launch the container.

Step 3: Accessing Grsync

Once the container is up and running, click on its name in the list of containers. In the side panel that appears, click on "Access Container" under the "Actions" section.

  • If you've set a password for Grsync using the PUID environment variable, enter your user ID when prompted[4].
  • You should now see the Grsync interface, and you can start configuring your sync jobs.

Troubleshooting

If you encounter any issues during the installation process, refer to these resources:

Conclusion

By following this guide, you should now have Grsync installed and running within a Docker container on your ASUSTOR 5202T NAS using Portainer. This setup allows you to easily manage file synchronization tasks without needing to install Grsync directly on your NAS.

Sources:
[1] Introducing Portainer - ASUSTOR NAS (Source 10)
[2] linuxserver/grsync Docker Image: https://hub.docker.com/r/linuxserver/grsync
[3] Grsync Configuration Files: https://github.com/Grsync/Grsync/wiki/Configuration-Files
[4] Setting User ID for Docker Containers: https://docs.docker.com/compose/compose-file/#user
[5] Docker Volumes: https://docs.docker.com/storage/volumes/