Install, Configure & Use of Rclone

super-embed:
<p class="callout warning">[Ultra.cc](<http://ultra.cc/>) support is unable to provide support for Rclone, this is due to the large volume of variables and different configurations possible with Rclone. The guides found in our documentation will provide the necessary information needed to get started with Rclone. Any further questions can be directed to the <a href="<https://forum.rclone.org/>">Rclone forum</a> or a quick Google search, or you may also be able to find community support for Rclone through our community <a href="<https://discord.ultra.cc>">Discord server</a>.</p>

super-embed:
<p class="callout danger">
Please make yourself aware of the [Ultra.cc](<http://ultra.cc/>) <a href="<https://docs.ultra.cc/policies/terms-of-service#block-2921fb0312cb80cca1bad876bb95b2bf>">Fair Usage Policy</a>. It is very important <b>NOT</b> to mount your cloud storage to any of the premade folders. Do <b>NOT</b> download directly to a Rclone mount from a torrent or nzbget client, as it will create massive instability for both you and everyone else on the server. Always follow the documentation and create a new folder for mounting. It is <em>your</em> responsibility to ensure your usage is within acceptable limits.
</p>

super-embed:
<p class="callout danger">
Please do not mount to any of the default directories such as:
<br><code>downloads</code>
<br><code>files</code>
<br><code>media</code>
<br><code>bin</code>
<br><code>.apps</code>
<br><code>.config</code>
<br><code>www</code>
<br><code>/home/username</code>
<br> or any pre-created directory found on your [Ultra.cc](<http://ultra.cc/>) Slot
</p>

In this guide, we will be going over the installation of Rclone. We'll also cover the basic usages such as setting up a remote and how to copy files between your Ultra service and a remote server.

Installation on your Ultra.cc Service

To begin, make sure you know how to SSH into your service. All Rclone commands are performed via SSH.

Connect to your Ultra service via SSH.
Rclone is pre-installed on all services. However, you should install your own copy of Rclone to keep it up to date with the latest features.
To install Rclone, run the command below; this command will automatically install Rclone to your slot for you.

Rclone stable

curl <https://scripts.ultra.cc/main-v2/MergerFS-Rclone/Installer%20Scripts/rclone-install-stable.sh> | bash

Rclone beta

curl <https://scripts.ultra.cc/main-v2/MergerFS-Rclone/Installer%20Scripts/rclone-install-beta.sh> | bash

You can always check the version of Rclone you have installed with this command:

rclone version

If the version says 1.60.1 (after you have logged back in), then the installation failed, as that is the default version pre-installed on your server.
Once you have installed your own copy of Rclone, you should update it occasionally as new features and bug fixes are released regularly. To update use this command:

rclone selfupdate

Installation on your Local PC

super-embed:
<p class="callout info">
  During this process, an error saying
  <code>Access blocked: This app has not completed the Google verification
    process</code>
  might appear. In this case you need to ensure your account has proper access
  to the app, such as being a verified developer, tester or audience. The latter
  in some cases being a requirement.<br />
  More information can be found here
  <a
    href="<https://developers.google.com/identity/protocols/oauth2/production-readiness/brand-verification?hl=en#projects-used-in-dev-test-stage>"
    >here</a
  >.
</p>

Windows

Download the latest Rclone version.
Extract the compressed zip file to any location of your liking using software like 7zip or WinRAR.
Move rclone.exe to the following folder C:\\Windows\\System32.

MacOS

Open a terminal window.
Install brew with the command given below:

/bin/bash -c "$(curl -fsSL <https://raw.githubusercontent.com/Homebrew/install/master/install.sh>)"

Install sudo and macfuse with brew using the commands below:

brew install macfuse
brew install sudo

Switch to root and finally install Rclone using the commands below:

sudo su
curl <https://rclone.org/install.sh> | sudo bash

Linux

Open a terminal window.
Run the command given below:

curl <https://rclone.org/install.sh> | sudo bash

Configuration

OAuth (Google Drive)

Navigate to Google Developer Console and login to your Google account.
Click Create on the right-hand side of the screen.
On the screen that pops up, enter a Project name and then click Create.
- We recommend against using Rclone in the project name; even just the default will do.

Click Enable APIs and Services, search for Drive and select Google Drive.

Click Enable on the window that pops up.

Click Create Credentials on the top right side of the screen.

Select User data and click Next.

Fill out App name and email addresses as you see fit. Then Save and Continue.

Click Save and Continue again. No need to set Scopes.
Set Application type to Desktop app and then click on Create.

Then you will be given the option to download your credentials and also a link to your credentials page.
You can download them to save them locally, but they will always be visible in your Google account's cloud console.

Click on the credentials page link to go to your Credentials page. Here you will find your credentials under OAuth2.0 Client IDs.

Next we need to Publish the app.
Click on the OAuth consent screen button.

Select the Audience tab and click on the Publish app button.

Click the Confirm button.

Rclone

Now we need to configure a remote to use with Rclone. For this guide, we will be configuring Google Drive. This is the most common remote people tend to use as it offers ample storage capacities for a reasonable price. Should you wish to use a different cloud host, feel free to modify the steps, you take.

Run the command rclone config

kbguides@lw914:~$ rclone config
No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q>

Press n and then Enter. Type the name you wish to use for your remote, and then press Enter once more. Here, we'll use gdrive as our remote name.

kbguides@lw914:~$ rclone config
No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q> n

Enter name for new remote.
name> gdrive

Scroll through the list of supported remotes and pick the one you wish. For this example, we will be using Google Drive, so we will search through the listed remote providers and select the number corresponding with Google Drive.

Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
...
23 / Google Cloud Storage (this is not Google Drive)
   \\ (google cloud storage)
24 / Google Drive
   \\ (drive)
25 / Google Photos
   \\ (google photos)
26 / HTTP
   \\ (http)
...

Storage> 24

Option client_id.
Google Application Client Id
Setting your own is recommended.
See <https://rclone.org/drive/#making-your-own-client-id> for how to create your own.
If you leave this blank, it will use an internal key which is low performance.
Enter a value. Press Enter to leave empty.
client_id>

You will be prompted to enter your client_id that we created earlier in the guide. Please head over to your credentials page in your Google developer console.
Once you have followed the steps in the guide, copy your client ID and paste it into the terminal, next press Enter.

Storage> 24

Option client_id.
Google Application Client Id
Setting your own is recommended.
See <https://rclone.org/drive/#making-your-own-client-id> for how to create your own.
If you leave this blank, it will use an internal key which is low performance.
Enter a value. Press Enter to leave empty.
client_id> 702549500XXXXXXXXXfi2pm42jrr1hXXXXfb2s6.apps.googleusercontent.com

Option client_secret.
OAuth Client Secret.
Leave blank normally.
Enter a value. Press Enter to leave empty.
client_secret>

Open the credentials .json file you downloaded earlier with notepad.
Now copy your client secret value from it, paste it in, and again press Enter.

Storage> 24

Option client_id.
Google Application Client Id
Setting your own is recommended.
See <https://rclone.org/drive/#making-your-own-client-id> for how to create your own.
If you leave this blank, it will use an internal key which is low performance.
Enter a value. Press Enter to leave empty.
client_id> 70254XXXXXXXXXXXXXXXXXXXXXXXmjfb2s6.apps.googleusercontent.com

Option client_secret.
OAuth Client Secret.
Leave blank normally.
Enter a value. Press Enter to leave empty.
client_secret> GOXXXXXXXXXXXXXXXXX6hCx9KNmWymxV

Choose the scope you wish to give to Rclone. Full Access is safe and is likely the most useful one to you, so in this case we will type 1 then press Enter.

Option scope.
Comma separated list of scopes that rclone should use when requesting access from drive.
Choose a number from below, or type in your own value.
Press Enter to leave empty.
 1 / Full access all files, excluding Application Data Folder.
   \\ (drive)
 2 / Read-only access to file metadata and file contents.
   \\ (drive.readonly)
   / Access to files created by rclone only.
 3 | These are visible in the drive website.
   | File authorization is revoked when the user deauthorizes the app.
   \\ (drive.file)
   / Allows read and write access to the Application Data folder.
 4 | This is not visible in the drive website.
   \\ (drive.appfolder)
   / Allows read-only access to file metadata but
 5 | does not allow any access to read or download file content.
   \\ (drive.metadata.readonly)
scope> 1

Unless you know what you are doing, leave the service_account_file blank and press Enter. Then type n to choose to not edit advanced config and press Enter.

Option service_account_file.
Service Account Credentials JSON file path.
Leave blank normally.
Needed only if you want use SA instead of interactive login.
Leading `~` will be expanded in the file name as will environment variables such as `${RCLONE_CONFIG_DIR}`.
Enter a value. Press Enter to leave empty.
service_account_file>

Edit advanced config?
y) Yes
n) No (default)
y/n> n

Type n to choose to not open web browser on the slot as it doesn’t have one.

Use web browser to automatically authenticate rclone with remote?
 * Say Y if the machine running rclone has a web browser you can use
 * Say N if running rclone on a (remote) machine without web browser access
If not sure try Y. If Y failed, try N.

y) Yes (default)
n) No
y/n> n

Next, you will be provided with a Rclone command that you must execute on your local PC.

Option config_token.
For this to work, you will need rclone available on a machine that has
a web browser available.
For more help and alternate methods see: <https://rclone.org/remote_setup/>
Execute the following on the machine with the web browser (same rclone
version recommended):
        rclone authorize "drive" "eyJjbGllbnRfaWQiOiI3MDI1NDk1MXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXzYuYXBwcy5nb29nbGV1c2VyY29udGVudC5jb20iLCJjbGllbnRfc2VjcmV0IjoiR09DU1BYLUQ2OHRJdllTeElwcnhxcDZoQ3g5S05tV3lteFYiLCJzY29wZSI6ImRyaXZlIn0"
Then paste the result.
Enter a value.
config_token>

Copy the rclone authorize "drive" "your_token" command from your Ultra terminal and paste it on your local PC's terminal (run as administrator). This will open your browser automatically.

Choose the Google Drive account you wish to use and continue with the unsafe warning option (can be safely ignored as it is our self published app).

Click Confirm, giving Rclone permission to use it.