github.com/artpar/rclone@v1.67.3/docs/content/gui.md (about)

     1  ---
     2  title: "GUI"
     3  description: "Web based Graphical User Interface"
     4  versionIntroduced: "v1.49"
     5  ---
     6  
     7  # GUI (Experimental)
     8  
     9  Rclone can serve a web based GUI (graphical user interface).  This is
    10  somewhat experimental at the moment so things may be subject to
    11  change.
    12  
    13  Run this command in a terminal and rclone will download and then
    14  display the GUI in a web browser.
    15  
    16  ```
    17  rclone rcd --rc-web-gui
    18  ```
    19  
    20  This will produce logs like this and rclone needs to continue to run to serve the GUI:
    21  
    22  ```
    23  2019/08/25 11:40:14 NOTICE: A new release for gui is present at https://github.com/artpar/artpar-webui-react/releases/download/v0.0.6/currentbuild.zip
    24  2019/08/25 11:40:14 NOTICE: Downloading webgui binary. Please wait. [Size: 3813937, Path :  /home/USER/.cache/rclone/webgui/v0.0.6.zip]
    25  2019/08/25 11:40:16 NOTICE: Unzipping
    26  2019/08/25 11:40:16 NOTICE: Serving remote control on http://127.0.0.1:5572/
    27  ```
    28  
    29  This assumes you are running rclone locally on your machine.  It is
    30  possible to separate the rclone and the GUI - see below for details.
    31  
    32  If you wish to check for updates then you can add `--rc-web-gui-update`
    33  to the command line.
    34  
    35  If you find your GUI broken, you may force it to update by add `--rc-web-gui-force-update`.
    36  
    37  By default, rclone will open your browser. Add `--rc-web-gui-no-open-browser`
    38  to disable this feature.
    39  
    40  ## Using the GUI
    41  
    42  Once the GUI opens, you will be looking at the dashboard which has an overall overview.
    43  
    44  On the left hand side you will see a series of view buttons you can click on:
    45  
    46  - Dashboard - main overview
    47  - Configs - examine and create new configurations
    48  - Explorer - view, download and upload files to the cloud storage systems
    49  - Backend - view or alter the backend config
    50  - Log out
    51  
    52  (More docs and walkthrough video to come!)
    53  
    54  ## How it works
    55  
    56  When you run the `rclone rcd --rc-web-gui` this is what happens
    57  
    58  - Rclone starts but only runs the remote control API ("rc").
    59  - The API is bound to localhost with an auto-generated username and password.
    60  - If the API bundle is missing then rclone will download it.
    61  - rclone will start serving the files from the API bundle over the same port as the API
    62  - rclone will open the browser with a `login_token` so it can log straight in.
    63  
    64  ## Advanced use
    65  
    66  The `rclone rcd` may use any of the [flags documented on the rc page](https://rclone.org/rc/#supported-parameters).
    67  
    68  The flag `--rc-web-gui` is shorthand for
    69  
    70  - Download the web GUI if necessary
    71  - Check we are using some authentication
    72  - `--rc-user gui`
    73  - `--rc-pass <random password>`
    74  - `--rc-serve`
    75  
    76  These flags can be overridden as desired.
    77  
    78  See also the [rclone rcd documentation](https://rclone.org/commands/rclone_rcd/).
    79  
    80  ### Example: Running a public GUI
    81  
    82  For example the GUI could be served on a public port over SSL using an htpasswd file using the following flags:
    83  
    84  - `--rc-web-gui`
    85  - `--rc-addr :443`
    86  - `--rc-htpasswd /path/to/htpasswd`
    87  - `--rc-cert /path/to/ssl.crt`
    88  - `--rc-key /path/to/ssl.key`
    89  
    90  ### Example: Running a GUI behind a proxy
    91  
    92  If you want to run the GUI behind a proxy at `/rclone` you could use these flags:
    93  
    94  - `--rc-web-gui`
    95  - `--rc-baseurl rclone`
    96  - `--rc-htpasswd /path/to/htpasswd`
    97  
    98  Or instead of htpasswd if you just want a single user and password:
    99  
   100  - `--rc-user me`
   101  - `--rc-pass mypassword`
   102  
   103  ## Project
   104  
   105  The GUI is being developed in the: [artpar/artpar-webui-react repository](https://github.com/artpar/artpar-webui-react).
   106  
   107  Bug reports and contributions are very welcome :-)
   108  
   109  If you have questions then please ask them on the [rclone forum](https://forum.rclone.org/).
   110  
   111