github.com/10XDev/rclone@v1.52.3-0.20200626220027-16af9ab76b2a/docs/content/gui.md (about)

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