119 lines
5.1 KiB
Markdown
119 lines
5.1 KiB
Markdown
---
|
|
title: "rclone gui"
|
|
description: "Open the web based GUI."
|
|
versionIntroduced: v1.74
|
|
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/gui/ and as part of making a release run "make commanddocs"
|
|
---
|
|
# rclone gui
|
|
|
|
Open the web based GUI.
|
|
|
|
## Synopsis
|
|
|
|
This command starts an embedded web GUI for rclone and opens it in
|
|
your default browser.
|
|
|
|
This starts an RC API server and a GUI server on separate localhost
|
|
ports, generates login credentials automatically unless --no-auth
|
|
is specified, and opens the browser already authenticated.
|
|
|
|
rclone gui
|
|
|
|
By default rclone gui serves the web GUI that was embedded into the
|
|
rclone binary at build time from https://github.com/rclone/rclone-web/
|
|
You can override this by passing a path to either an unpacked GUI
|
|
directory or a dist.zip archive (e.g. one downloaded from the
|
|
rclone-web releases page):
|
|
|
|
rclone gui ./my-dist/
|
|
rclone gui ./dist.zip
|
|
|
|
This is useful for iterating on the GUI locally without rebuilding
|
|
rclone, or for serving a different GUI release than the one embedded.
|
|
|
|
Use --no-open-browser to skip opening the browser automatically:
|
|
|
|
rclone gui --no-open-browser
|
|
|
|
Use --addr to bind the GUI to a specific address:
|
|
|
|
rclone gui --addr localhost:5580
|
|
|
|
Use --user and --pass to set specific credentials:
|
|
|
|
rclone gui --user admin --pass secret
|
|
|
|
Use --no-auth to disable authentication entirely:
|
|
|
|
rclone gui --no-auth
|
|
|
|
For more help see [the GUI docs](/gui/).
|
|
|
|
|
|
```
|
|
rclone gui [path] [flags]
|
|
```
|
|
|
|
## Options
|
|
|
|
```
|
|
--addr stringArray IPaddress:Port for the GUI server (default auto-chosen localhost port)
|
|
--api-addr stringArray IPaddress:Port for the RC API server (default auto-chosen localhost port)
|
|
--enable-metrics Enable OpenMetrics/Prometheus compatible endpoint at /metrics
|
|
-h, --help help for gui
|
|
--no-auth Don't require auth for the RC API
|
|
--no-open-browser Skip opening the browser automatically
|
|
--pass string Password for RC authentication
|
|
--user string User name for RC authentication
|
|
```
|
|
|
|
Options shared with other commands are described next.
|
|
See the [global flags page](/flags/) for global options not listed here.
|
|
|
|
### RC Options
|
|
|
|
Flags to control the Remote Control API
|
|
|
|
```text
|
|
--rc Enable the remote control server
|
|
--rc-addr stringArray IPaddress:Port or :Port to bind server to (default localhost:5572)
|
|
--rc-allow-origin string Origin which cross-domain request (CORS) can be executed from
|
|
--rc-baseurl string Prefix for URLs - leave blank for root
|
|
--rc-cert string TLS PEM key (concatenation of certificate and CA certificate)
|
|
--rc-client-ca string Client certificate authority to verify clients with
|
|
--rc-enable-metrics Enable the Prometheus metrics path at the remote control server
|
|
--rc-files string Path to local files to serve on the HTTP server
|
|
--rc-htpasswd string A htpasswd file - if not provided no authentication is done
|
|
--rc-job-expire-duration Duration Expire finished async jobs older than this value (default 1m0s)
|
|
--rc-job-expire-interval Duration Interval to check for expired async jobs (default 10s)
|
|
--rc-key string TLS PEM Private key
|
|
--rc-max-header-bytes int Maximum size of request header (default 4096)
|
|
--rc-min-tls-version string Minimum TLS version that is acceptable (default "tls1.0")
|
|
--rc-no-auth Don't require auth for certain methods
|
|
--rc-pass string Password for authentication
|
|
--rc-realm string Realm for authentication
|
|
--rc-salt string Password hashing salt (default "dlPL2MqE")
|
|
--rc-serve Enable the serving of remote objects
|
|
--rc-serve-no-modtime Don't read the modification time (can speed things up)
|
|
--rc-server-read-timeout Duration Timeout for server reading data (default 1h0m0s)
|
|
--rc-server-write-timeout Duration Timeout for server writing data (default 1h0m0s)
|
|
--rc-template string User-specified template
|
|
--rc-user string User name for authentication
|
|
--rc-user-from-header string User name from a defined HTTP header
|
|
--rc-web-fetch-url string URL to fetch the releases for webgui (default "https://api.github.com/repos/rclone/rclone-webui-react/releases/latest")
|
|
--rc-web-gui Launch WebGUI on localhost
|
|
--rc-web-gui-force-update Force update to latest version of web gui
|
|
--rc-web-gui-no-open-browser Don't open the browser automatically
|
|
--rc-web-gui-update Check and update to latest version of web gui
|
|
```
|
|
|
|
## See Also
|
|
|
|
<!-- markdownlint-capture -->
|
|
<!-- markdownlint-disable ul-style line-length -->
|
|
|
|
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.
|
|
|
|
|
|
<!-- markdownlint-restore -->
|