Mount a NAS share with Rclone
This page shows how to mount a share from your NAS on your Deployrr server with Rclone. You set it up once in the Rclone menu. The share then mounts on every boot, and your media apps wait for it before they start.
Before you start
Section titled “Before you start”- You have a Basic, Plus or Pro license. If you don’t, Deployrr shows a Requirements Not Met box that says “License - Basic, Plus, or Pro required”.
- You finished the Prerequisites steps. See Quick start.
- You know your NAS IP address (for example
192.168.1.254). - You have a NAS user name and password that can read the share.
- Your server has a working network connection to the NAS.
If your server is a Proxmox LXC container, Rclone works once FUSE is turned on for the container. You do that on the Proxmox host before part 1: see Turn on FUSE for Rclone, or watch Rclone SMB mount on Ubuntu/LXC: Proxmox LXC modifications at 3:29 (manual setup). If Automount ends with “Mount verification failed” in an LXC, check this setting first.
Deployrr does not block the Rclone menu in an LXC. It does block the separate SMB Mount and NFS Mount options. After you choose Yes at their first prompt, they show this message: “SMB mounting is only supported on VPS, Barebones, or Virtual Machine systems. If you are using a Proxmox LXC, then use Bind Mounts or Rclone.” To choose between Rclone and a bind mount, see Add NAS storage, or read UDMS part 09: Your options for remote storage in an unprivileged LXC (manual setup, background only). If Docker itself fails in your LXC, see Docker fails with “failed to create shim task”.
Open the menu with System > Mounts > Rclone. You do the five parts below in this order. Parts 1, 2, 3 and 5 are the menu options Install, SMB Remote, Automount and Delay Media Apps. Part 4 is in System > Folders. The Rclone menu also has Refresh Cache and Uninstall.
1. Install Rclone
Section titled “1. Install Rclone”- Select Install.
- If you see “Rclone is already installed”, go to part 2.
- Read “Would you like to install Rclone?” and choose Yes.
- Wait while Deployrr shows four steps. It can take a few minutes. It may ask for your sudo password.
- Wait for “Rclone installation completed successfully”.
The Install line in the menu now shows the Rclone version and “INSTALLED” in green.
If you see “Failed to install fuse3” or “Failed to install Rclone”, check that your server can reach the internet, then run Install again.
2. Add the SMB remote
Section titled “2. Add the SMB remote”- Select SMB Remote (“Add a Remote SMB Share”).
- Read “Would you like to add an Rclone SMB remote?” and choose Yes.
- Fill in the form:
- Remote Name is a short name you choose, such as
nas. You will see it again in the service name and the log name. - Server IP is the IP address of your NAS, such as
192.168.1.254. - Username is your NAS user name.
- Password is your NAS password.
- Remote Name is a short name you choose, such as
- Select OK.
- Wait for “Remote connection successful” and then “Rclone SMB remote configured successfully”.
Fill in all four fields. If one is empty, Deployrr shows “Incomplete information. Please re-run this step and provide all required details.”
The form does not ask for a share name. (The separate SMB Mount option does. See Mount an SMB or NFS share without Rclone.) You pick the folder you need in part 4.
If the connection test fails, you see one of these messages:
| Message | What to do |
|---|---|
| Incorrect username/password | Check the user name and password, then see the note below the table. |
| Cannot reach remote host - check IP address | Check the NAS IP address and that the NAS is on, then see the note below the table. |
| Remote already defined in config | A remote with this name and IP address already exists. If its earlier test worked, go on to part 3. If the test failed, see the note below the table. |
Deployrr saves the remote before it tests the connection, and keeps it when the test fails. If you run SMB Remote again with the same name and IP, you get “Remote already defined in config” and nothing changes. To try again, either use a different Remote Name, or remove the failed remote first. It is a block that starts with [NAME] in rclone.conf, in the appdata/rclone folder inside your Docker folder:
sudo nano DOCKER_FOLDER/appdata/rclone/rclone.confDelete the lines from [NAME] down to the next [ line (or the end of the file), save, and run SMB Remote again.
The SMB Remote line in the menu now reads “1 remote(s) defined”.
To see the remote and the automount filled in on screen, watch Deployrr 5 walkthrough: Rclone SMB remote and automount at 17:39 (shows Deployrr v5; menus differ in v6).
3. Set up the automount
Section titled “3. Set up the automount”- Select Automount.
- Read “Create an automount for the remote”. The buttons are in an unusual order: Cancel is selected first, so Enter cancels. Press Tab to move to Proceed, then press Enter.
- Read “Select a directory where the Rclone SMB share will be mounted”. Select OK.
- Read the directory browser instructions. Select OK. In the browser, Up and Down move, Spacebar opens a folder, Tab switches to the buttons and Esc cancels. The browser starts at
/, not at your mount folder. - In the browser, pick the mount folder. To make a new folder, type its name at the end of the path, such as
/media/rclone/nas. - Select Select. Then choose Confirm. Deployrr creates the folder if it does not exist.
- Read “Select a directory where Rclone will store its cache”. Select OK.
- Pick the cache folder the same way. Use a folder on a disk with free space. Confirm it.
- In the Update Configuration box, at “Size of Rclone cache in GB (e.g. 256 - number only):”, enter a number only, such as
256. If it is empty, or a folder you picked doesn’t exist, you see “Incomplete or incorrect information. Please try again.” - Wait for “Rclone SMB successfully mounted and configured for auto-start”.
Deployrr stops your media apps during this step. You start them again at the end.
If you see “Mount verification failed”, the mount did not start. The next line gives the path of the log file:
DOCKER_FOLDER/logs/HOSTNAME/rclone-NAME.logDOCKER_FOLDER is your Docker folder, HOSTNAME is your server’s hostname and NAME is the remote name you chose. To read the end of the log, replace those three values and run:
sudo tail -n 30 DOCKER_FOLDER/logs/HOSTNAME/rclone-NAME.logIf you run Automount again and the service exists but is stopped, Deployrr asks “An automount is already configured but not active. Would you like to start it now?” Choose Yes. You see “Rclone service started successfully”, or “Failed to start service. Check” followed by the log path.
If you see “An automount is already defined and active for this remote”, the share is already mounted.
The service is named rclone-NAME.service. You can check it any time:
sudo systemctl status rclone-NAME.serviceReplace NAME with your remote name.
4. Point your apps at the share
Section titled “4. Point your apps at the share”Your NAS shares should appear as folders inside the mount folder. Open the mount folder and look. You pick the folder that holds your media.
- In Deployrr, open System > Folders.
- Select Media Folder 1.
- Choose the folder on the share that holds your media, such as
/media/rclone/nas/MY_SHARE/media. Replace the path with your own. - Set Downloads Folder the same way if your downloads live on the NAS.
At least one media folder is required for the media, downloader and Arr apps. For every folder and which apps use it, see Set your media, downloads and other folders. To let Plex, Jellyfin or Emby use your graphics card, see Set up GPU hardware transcoding.
5. Delay your media apps at boot
Section titled “5. Delay your media apps at boot”Your server can start Docker before the NAS share is mounted. Then media apps write into an empty folder or crash. Delay Media Apps prevents this.
Delay Media Apps works only when the share is mounted now. Finish part 3 first.
- Select Delay Media Apps (“Set Media apps to Start after Rclone”).
- Read the PROBLEM and SOLUTION text. As in Automount, Cancel is selected first. Press Tab to move to Proceed, then press Enter.
- Wait for “Delayed media start script installed successfully”.
From the next boot, your media apps, such as Plex, Jellyfin, Radarr and Sonarr, do not start by themselves. They start once the mount is ready. Deployrr checks every 5 seconds. If the mount is not ready after about 15 minutes, Deployrr stops and removes the media app containers. Your app data stays. Fix the mount, then start them with Tools > Stack Manager > Up. See Apps are stopped or show empty folders after a reboot.
To understand how a start script waits for the mount, watch Rclone SMB mount: the script that starts media apps at 12:14 (manual setup; Deployrr does these steps for you).
The menu shows “DONE” next to Delay Media Apps once it is set up.
Last, start your apps now. Run this Deployrr command:
dcupWithout the aliases, run this. Replace DOCKER_FOLDER and HOSTNAME as before:
sudo docker compose --profile all -f DOCKER_FOLDER/docker-compose-HOSTNAME.yml up -d --build --remove-orphansCheck it worked
Section titled “Check it worked”-
In System > Mounts > Rclone, the Automount line reads “Rclone SMB Share (MOUNT_FOLDER mounted)” with “mounted” in green.
MOUNT_FOLDERis the folder you picked. -
List the mount folder. Replace
MOUNT_FOLDERwith your path. You should see your NAS shares:Terminal window ls MOUNT_FOLDER -
Reboot the server:
Terminal window sudo reboot -
After it is back, check that the service is running. Replace
NAMEwith your remote name:Terminal window sudo systemctl is-active rclone-NAME.serviceIt prints
active. -
Wait a minute, then check that your media apps are running. Run this Deployrr command:
Terminal window dpsWithout the aliases, run
sudo docker ps -a. Your media apps show a status that starts with “Up”.
If the apps run but their library is empty, see Media app shows an empty library.
If the apps do not come back, read the timer logs in the same folder as the Rclone log. Replace the two values as before:
sudo tail -n 20 DOCKER_FOLDER/logs/HOSTNAME/rclone-NAME-timer.logsudo tail -n 20 DOCKER_FOLDER/logs/HOSTNAME/rclone-NAME-timer.errThe .log file says “Media containers started” with a date. The .err file says “Media containers start failed” if the mount never became ready.
Change the mount folder, cache or NAS details
Section titled “Change the mount folder, cache or NAS details”Once the automount is set up, running Automount again only shows, after the confirmation box, “An automount is already defined and active for this remote”, or offers to start it. To change the mount folder, the cache folder or the cache size, you remove the automount service and run Automount again. To use a new NAS address, user name or password, you replace the remote in rclone.conf.
In the commands below, replace NAME, DOCKER_FOLDER and HOSTNAME as in part 3.
Change the mount folder, cache folder or cache size
Section titled “Change the mount folder, cache folder or cache size”-
Back up the service file to your home folder:
Terminal window sudo cp /etc/systemd/system/rclone-NAME.service ~/rclone-NAME.service.bak -
Stop your media apps:
Terminal window sudo docker compose --profile media -f DOCKER_FOLDER/docker-compose-HOSTNAME.yml down -
Stop the mount and remove its service:
Terminal window sudo systemctl stop rclone-NAME.servicesudo systemctl disable rclone-NAME.servicesudo rm /etc/systemd/system/rclone-NAME.servicesudo systemctl daemon-reload -
Run Automount again, as in part 3. Pick the folders and enter the cache size you want now. The size box shows your old value; the folder browser starts at
/. Use an empty mount folder, as in the caution in part 3. -
If you changed the mount folder:
- Run Delay Media Apps again, as in part 5. It writes the new folder into the start script. Without this, the script waits for the old folder at boot and removes your media app containers after about 15 minutes.
- Set your media and downloads folders to paths inside the new mount folder in System > Folders. Then recreate or reinstall the apps that use them, as in part 4.
-
Start your apps with
dcup, or the full command at the end of part 5. -
Do steps 1 and 2 of Check it worked. Reboot only when the share shows up in the new mount folder.
If Automount fails or you cancel it partway, Deployrr may already have saved the new folders. The menu then shows the new folder as “not mounted”, and Delay Media Apps and Refresh Cache stop with a “must be mounted” message. To go back, set up the old values again through the menu:
-
Look up your old folders and cache size in the backup:
Terminal window grep -E 'rclone mount|cache-dir|cache-max-size' ~/rclone-NAME.service.bak -
If the service file exists again (a failed Automount leaves it in place), stop and remove the service again with the commands in step 3 above.
-
Run Automount again with the old mount folder, cache folder and cache size.
-
Start your apps with
dcup.
Rclone no longer uses the old cache folder. You can delete it to free space once the new mount works. Check the path first, and delete only the folder you picked as the old cache.
Use a new NAS address, user name or password
Section titled “Use a new NAS address, user name or password”Keep the same Remote Name. The automount service finds the remote by its name, so it keeps working with the new details. If you pick a new name, Deployrr only knows the new one. Automount then sets up a second service. The old one keeps mounting at every boot, and Uninstall no longer removes it.
-
Back up
rclone.conf:Terminal window sudo cp DOCKER_FOLDER/appdata/rclone/rclone.conf DOCKER_FOLDER/appdata/rclone/rclone.conf.bak -
Delete the
[NAME]block fromrclone.conf, as described in part 2. Do this even if only the IP address changes. Otherwise SMB Remote adds a second block with the same name. -
Run SMB Remote with the same Remote Name and the new details. Type the password again. Wait for “Remote connection successful”.
-
Stop your media apps, restart the mount so it reads the new details, then start your apps:
Terminal window sudo docker compose --profile media -f DOCKER_FOLDER/docker-compose-HOSTNAME.yml downsudo systemctl restart rclone-NAME.servicedcupWithout the aliases, use the full command at the end of part 5 instead of
dcup. -
Do steps 1 and 2 of Check it worked before you reboot.
If the connection test fails, fix the details and repeat steps 2 and 3. To go back to the old details, copy rclone.conf.bak back over rclone.conf and run the commands in step 4 again.
Other options in the Rclone menu
Section titled “Other options in the Rclone menu”- Refresh Cache (“Clear/refresh Rclone Cache”) makes Rclone read the files on your NAS again. Use it when new files do not show up. It needs the share to be mounted. Deployrr asks “Clear cache for remote: NAME?” first. It ends with “Cache refresh operation completed”. If you see “No active mount found for NAME” before that, the refresh did nothing because the mount is not running.
- Uninstall (“Remove everything (Rclone and Startup Scripts, etc.)”) warns that it will uninstall Rclone, unmount all remotes and remove startup scripts. Uninstall is selected first, so pressing Enter starts it. Use Tab to move to Cancel if you don’t mean it. It removes Rclone, fuse3, the
rclone-NAMEservice and the delayed media start, then shows “Rclone uninstalled successfully”. It keepsrclone.confand your mount folder.

