diff --git a/docs/content/amazonclouddrive.md b/docs/content/amazonclouddrive.md index 10b2a00e0..6de0d7c09 100644 --- a/docs/content/amazonclouddrive.md +++ b/docs/content/amazonclouddrive.md @@ -27,16 +27,31 @@ d) Delete remote q) Quit config e/n/d/q> n name> remote -What type of source is it? -Choose a number from below - 1) amazon cloud drive - 2) drive - 3) dropbox - 4) google cloud storage - 5) local - 6) s3 - 7) swift -type> 1 +Type of storage to configure. +Choose a number from below, or type in your own value + 1 / Amazon Cloud Drive + \ "amazon cloud drive" + 2 / Amazon S3 (also Dreamhost, Ceph) + \ "s3" + 3 / Backblaze B2 + \ "b2" + 4 / Dropbox + \ "dropbox" + 5 / Google Cloud Storage (this is not Google Drive) + \ "google cloud storage" + 6 / Google Drive + \ "drive" + 7 / Hubic + \ "hubic" + 8 / Local Disk + \ "local" + 9 / Microsoft OneDrive + \ "onedrive" +10 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH) + \ "swift" +11 / Yandex Disk + \ "yandex" +Storage> 1 Amazon Application Client Id - leave blank normally. client_id> Amazon Application Client Secret - leave blank normally. diff --git a/docs/content/b2.md b/docs/content/b2.md index 2fc8b3aec..d3df2e9a3 100644 --- a/docs/content/b2.md +++ b/docs/content/b2.md @@ -26,19 +26,31 @@ n) New remote q) Quit config n/q> n name> remote -What type of source is it? -Choose a number from below - 1) amazon cloud drive - 2) b2 - 3) drive - 4) dropbox - 5) google cloud storage - 6) swift - 7) hubic - 8) local - 9) onedrive -10) s3 -type> 2 +Type of storage to configure. +Choose a number from below, or type in your own value + 1 / Amazon Cloud Drive + \ "amazon cloud drive" + 2 / Amazon S3 (also Dreamhost, Ceph) + \ "s3" + 3 / Backblaze B2 + \ "b2" + 4 / Dropbox + \ "dropbox" + 5 / Google Cloud Storage (this is not Google Drive) + \ "google cloud storage" + 6 / Google Drive + \ "drive" + 7 / Hubic + \ "hubic" + 8 / Local Disk + \ "local" + 9 / Microsoft OneDrive + \ "onedrive" +10 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH) + \ "swift" +11 / Yandex Disk + \ "yandex" +Storage> 3 Account ID account> 123456789abc Application Key diff --git a/docs/content/drive.md b/docs/content/drive.md index 102640365..5819c3465 100644 --- a/docs/content/drive.md +++ b/docs/content/drive.md @@ -27,13 +27,31 @@ d) Delete remote q) Quit config e/n/d/q> n name> remote -What type of source is it? -Choose a number from below - 1) swift - 2) s3 - 3) local - 4) drive -type> 4 +Type of storage to configure. +Choose a number from below, or type in your own value + 1 / Amazon Cloud Drive + \ "amazon cloud drive" + 2 / Amazon S3 (also Dreamhost, Ceph) + \ "s3" + 3 / Backblaze B2 + \ "b2" + 4 / Dropbox + \ "dropbox" + 5 / Google Cloud Storage (this is not Google Drive) + \ "google cloud storage" + 6 / Google Drive + \ "drive" + 7 / Hubic + \ "hubic" + 8 / Local Disk + \ "local" + 9 / Microsoft OneDrive + \ "onedrive" +10 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH) + \ "swift" +11 / Yandex Disk + \ "yandex" +Storage> 6 Google Application Client Id - leave blank normally. client_id> Google Application Client Secret - leave blank normally. diff --git a/docs/content/dropbox.md b/docs/content/dropbox.md index e1f69591c..f2acc3527 100644 --- a/docs/content/dropbox.md +++ b/docs/content/dropbox.md @@ -28,15 +28,31 @@ d) Delete remote q) Quit config e/n/d/q> n name> remote -What type of source is it? -Choose a number from below - 1) swift - 2) s3 - 3) local - 4) google cloud storage - 5) dropbox - 6) drive -type> 5 +Type of storage to configure. +Choose a number from below, or type in your own value + 1 / Amazon Cloud Drive + \ "amazon cloud drive" + 2 / Amazon S3 (also Dreamhost, Ceph) + \ "s3" + 3 / Backblaze B2 + \ "b2" + 4 / Dropbox + \ "dropbox" + 5 / Google Cloud Storage (this is not Google Drive) + \ "google cloud storage" + 6 / Google Drive + \ "drive" + 7 / Hubic + \ "hubic" + 8 / Local Disk + \ "local" + 9 / Microsoft OneDrive + \ "onedrive" +10 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH) + \ "swift" +11 / Yandex Disk + \ "yandex" +Storage> 4 Dropbox App Key - leave blank normally. app_key> Dropbox App Secret - leave blank normally. diff --git a/docs/content/googlecloudstorage.md b/docs/content/googlecloudstorage.md index 5a282fe5e..439ae876b 100644 --- a/docs/content/googlecloudstorage.md +++ b/docs/content/googlecloudstorage.md @@ -26,15 +26,31 @@ d) Delete remote q) Quit config e/n/d/q> n name> remote -What type of source is it? -Choose a number from below - 1) swift - 2) s3 - 3) local - 4) google cloud storage - 5) dropbox - 6) drive -type> 4 +Type of storage to configure. +Choose a number from below, or type in your own value + 1 / Amazon Cloud Drive + \ "amazon cloud drive" + 2 / Amazon S3 (also Dreamhost, Ceph) + \ "s3" + 3 / Backblaze B2 + \ "b2" + 4 / Dropbox + \ "dropbox" + 5 / Google Cloud Storage (this is not Google Drive) + \ "google cloud storage" + 6 / Google Drive + \ "drive" + 7 / Hubic + \ "hubic" + 8 / Local Disk + \ "local" + 9 / Microsoft OneDrive + \ "onedrive" +10 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH) + \ "swift" +11 / Yandex Disk + \ "yandex" +Storage> 5 Google Application Client Id - leave blank normally. client_id> Google Application Client Secret - leave blank normally. diff --git a/docs/content/hubic.md b/docs/content/hubic.md index a1b1471da..a1c304853 100644 --- a/docs/content/hubic.md +++ b/docs/content/hubic.md @@ -23,28 +23,46 @@ This will guide you through an interactive setup process: ``` n) New remote -d) Delete remote -q) Quit config -e/n/d/q> n +s) Set configuration password +n/s> n name> remote -What type of source is it? -Choose a number from below - 1) amazon cloud drive - 2) drive - 3) dropbox - 4) google cloud storage - 5) local - 6) onedrive - 7) hubic - 8) s3 - 9) swift -type> 7 -Hubic App Client Id - leave blank normally. +Type of storage to configure. +Choose a number from below, or type in your own value + 1 / Amazon Cloud Drive + \ "amazon cloud drive" + 2 / Amazon S3 (also Dreamhost, Ceph) + \ "s3" + 3 / Backblaze B2 + \ "b2" + 4 / Dropbox + \ "dropbox" + 5 / Google Cloud Storage (this is not Google Drive) + \ "google cloud storage" + 6 / Google Drive + \ "drive" + 7 / Hubic + \ "hubic" + 8 / Local Disk + \ "local" + 9 / Microsoft OneDrive + \ "onedrive" +10 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH) + \ "swift" +11 / Yandex Disk + \ "yandex" +Storage> 7 +Hubic Client Id - leave blank normally. client_id> -Hubic App Client Secret - leave blank normally. +Hubic Client Secret - leave blank normally. client_secret> Remote config -If your browser doesn't open automatically go to the following link: http://localhost:53682/auth +Use auto config? + * Say Y if not sure + * Say N if you are working on a remote or headless machine +y) Yes +n) No +y/n> y +If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth Log in and authorize rclone for access Waiting for code... Got code diff --git a/docs/content/onedrive.md b/docs/content/onedrive.md index 7ace844f8..fd557f347 100644 --- a/docs/content/onedrive.md +++ b/docs/content/onedrive.md @@ -22,27 +22,47 @@ Here is an example of how to make a remote called `remote`. First run: This will guide you through an interactive setup process: ``` +No remotes found - make a new one n) New remote -d) Delete remote -q) Quit config -e/n/d/q> n +s) Set configuration password +n/s> n name> remote -What type of source is it? -Choose a number from below - 1) amazon cloud drive - 2) drive - 3) dropbox - 4) google cloud storage - 5) local - 6) onedrive - 7) s3 - 8) swift -type> 6 +Type of storage to configure. +Choose a number from below, or type in your own value + 1 / Amazon Cloud Drive + \ "amazon cloud drive" + 2 / Amazon S3 (also Dreamhost, Ceph) + \ "s3" + 3 / Backblaze B2 + \ "b2" + 4 / Dropbox + \ "dropbox" + 5 / Google Cloud Storage (this is not Google Drive) + \ "google cloud storage" + 6 / Google Drive + \ "drive" + 7 / Hubic + \ "hubic" + 8 / Local Disk + \ "local" + 9 / Microsoft OneDrive + \ "onedrive" +10 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH) + \ "swift" +11 / Yandex Disk + \ "yandex" +Storage> 9 Microsoft App Client Id - leave blank normally. client_id> Microsoft App Client Secret - leave blank normally. client_secret> Remote config +Use auto config? + * Say Y if not sure + * Say N if you are working on a remote or headless machine +y) Yes +n) No +y/n> y If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth Log in and authorize rclone for access Waiting for code... diff --git a/docs/content/s3.md b/docs/content/s3.md index f99d2277f..16dd8a8e4 100644 --- a/docs/content/s3.md +++ b/docs/content/s3.md @@ -19,96 +19,122 @@ This will guide you through an interactive setup process. ``` No remotes found - make a new one n) New remote -q) Quit config -n/q> n +s) Set configuration password +n/s> n name> remote -What type of source is it? -Choose a number from below - 1) amazon cloud drive - 2) b2 - 3) drive - 4) dropbox - 5) google cloud storage - 6) swift - 7) hubic - 8) local - 9) onedrive -10) s3 -11) yandex -type> 10 +Type of storage to configure. +Choose a number from below, or type in your own value + 1 / Amazon Cloud Drive + \ "amazon cloud drive" + 2 / Amazon S3 (also Dreamhost, Ceph) + \ "s3" + 3 / Backblaze B2 + \ "b2" + 4 / Dropbox + \ "dropbox" + 5 / Google Cloud Storage (this is not Google Drive) + \ "google cloud storage" + 6 / Google Drive + \ "drive" + 7 / Hubic + \ "hubic" + 8 / Local Disk + \ "local" + 9 / Microsoft OneDrive + \ "onedrive" +10 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH) + \ "swift" +11 / Yandex Disk + \ "yandex" +Storage> 2 Get AWS credentials from runtime (environment variables or EC2 meta data if no env vars). Only applies if access_key_id and secret_access_key is blank. Choose a number from below, or type in your own value - * Enter AWS credentials in the next step - 1) false - * Get AWS credentials from the environment (env vars or IAM) - 2) true -env_auth> 2 + 1 / Enter AWS credentials in the next step + \ "false" + 2 / Get AWS credentials from the environment (env vars or IAM) + \ "true" +env_auth> 1 AWS Access Key ID - leave blank for anonymous access or runtime credentials. -access_key_id> +access_key_id> access_key AWS Secret Access Key (password) - leave blank for anonymous access or runtime credentials. -secret_access_key> +secret_access_key> secret_key Region to connect to. Choose a number from below, or type in your own value - * The default endpoint - a good choice if you are unsure. - * US Region, Northern Virginia or Pacific Northwest. - * Leave location constraint empty. - 1) us-east-1 - * US West (Oregon) Region - * Needs location constraint us-west-2. - 2) us-west-2 - * US West (Northern California) Region - * Needs location constraint us-west-1. -[..snip..] - 8) ap-northeast-1 - * South America (Sao Paulo) Region - * Needs location constraint sa-east-1. - 9) sa-east-1 - * If using an S3 clone that only understands v2 signatures - eg Ceph - set this and make sure you set the endpoint. -10) other-v2-signature - * If using an S3 clone that understands v4 signatures set this and make sure you set the endpoint. -11) other-v4-signature -region> 3 + / The default endpoint - a good choice if you are unsure. + 1 | US Region, Northern Virginia or Pacific Northwest. + | Leave location constraint empty. + \ "us-east-1" + / US West (Oregon) Region + 2 | Needs location constraint us-west-2. + \ "us-west-2" + / US West (Northern California) Region + 3 | Needs location constraint us-west-1. + \ "us-west-1" + / EU (Ireland) Region Region + 4 | Needs location constraint EU or eu-west-1. + \ "eu-west-1" + / EU (Frankfurt) Region + 5 | Needs location constraint eu-central-1. + \ "eu-central-1" + / Asia Pacific (Singapore) Region + 6 | Needs location constraint ap-southeast-1. + \ "ap-southeast-1" + / Asia Pacific (Sydney) Region + 7 | Needs location constraint ap-southeast-2. + \ "ap-southeast-2" + / Asia Pacific (Tokyo) Region + 8 | Needs location constraint ap-northeast-1. + \ "ap-northeast-1" + / South America (Sao Paulo) Region + 9 | Needs location constraint sa-east-1. + \ "sa-east-1" + / If using an S3 clone that only understands v2 signatures +10 | eg Ceph/Dreamhost + | set this and make sure you set the endpoint. + \ "other-v2-signature" + / If using an S3 clone that understands v4 signatures set this +11 | and make sure you set the endpoint. + \ "other-v4-signature" +region> 1 Endpoint for S3 API. Leave blank if using AWS to use the default endpoint for the region. Specify if using an S3 clone such as Ceph. -endpoint> +endpoint> Location constraint - must be set to match the Region. Used when creating buckets only. Choose a number from below, or type in your own value - * Empty for US Region, Northern Virginia or Pacific Northwest. - 1) - * US West (Oregon) Region. - 2) us-west-2 - * US West (Northern California) Region. -[..snip..] - 8) ap-northeast-1 - * South America (Sao Paulo) Region. - 9) sa-east-1 -location_constraint> 3 + 1 / Empty for US Region, Northern Virginia or Pacific Northwest. + \ "" + 2 / US West (Oregon) Region. + \ "us-west-2" + 3 / US West (Northern California) Region. + \ "us-west-1" + 4 / EU (Ireland) Region. + \ "eu-west-1" + 5 / EU Region. + \ "EU" + 6 / Asia Pacific (Singapore) Region. + \ "ap-southeast-1" + 7 / Asia Pacific (Sydney) Region. + \ "ap-southeast-2" + 8 / Asia Pacific (Tokyo) Region. + \ "ap-northeast-1" + 9 / South America (Sao Paulo) Region. + \ "sa-east-1" +location_constraint> 1 Remote config -------------------- [remote] -env_auth = true -access_key_id = -secret_access_key = -region = us-west-1 -endpoint = -location_constraint = us-west-1 +env_auth = false +access_key_id = access_key +secret_access_key = secret_key +region = us-east-1 +endpoint = +location_constraint = -------------------- y) Yes this is OK e) Edit this remote d) Delete this remote y/e/d> y -Current remotes: - -Name Type -==== ==== -remote s3 - -e) Edit existing remote -n) New remote -d) Delete remote -q) Quit config -e/n/d/q> ``` This remote is called `remote` and can now be used like this diff --git a/docs/content/swift.md b/docs/content/swift.md index 3b7d21ed6..d14aa4f5f 100644 --- a/docs/content/swift.md +++ b/docs/content/swift.md @@ -25,47 +25,68 @@ This will guide you through an interactive setup process. ``` No remotes found - make a new one n) New remote -q) Quit config -n/q> n +s) Set configuration password +n/s> n name> remote -What type of source is it? -Choose a number from below - 1) swift - 2) s3 - 3) local - 4) drive -type> 1 +Type of storage to configure. +Choose a number from below, or type in your own value + 1 / Amazon Cloud Drive + \ "amazon cloud drive" + 2 / Amazon S3 (also Dreamhost, Ceph) + \ "s3" + 3 / Backblaze B2 + \ "b2" + 4 / Dropbox + \ "dropbox" + 5 / Google Cloud Storage (this is not Google Drive) + \ "google cloud storage" + 6 / Google Drive + \ "drive" + 7 / Hubic + \ "hubic" + 8 / Local Disk + \ "local" + 9 / Microsoft OneDrive + \ "onedrive" +10 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH) + \ "swift" +11 / Yandex Disk + \ "yandex" +Storage> 10 User name to log in. user> user_name API key or password. key> password_or_api_key Authentication URL for server. Choose a number from below, or type in your own value - * Rackspace US - 1) https://auth.api.rackspacecloud.com/v1.0 - * Rackspace UK - 2) https://lon.auth.api.rackspacecloud.com/v1.0 - * Rackspace v2 - 3) https://identity.api.rackspacecloud.com/v2.0 - * Memset Memstore UK - 4) https://auth.storage.memset.com/v1.0 - * Memset Memstore UK v2 - 5) https://auth.storage.memset.com/v2.0 - * OVH - 6) https://auth.cloud.ovh.net/v2.0 + 1 / Rackspace US + \ "https://auth.api.rackspacecloud.com/v1.0" + 2 / Rackspace UK + \ "https://lon.auth.api.rackspacecloud.com/v1.0" + 3 / Rackspace v2 + \ "https://identity.api.rackspacecloud.com/v2.0" + 4 / Memset Memstore UK + \ "https://auth.storage.memset.com/v1.0" + 5 / Memset Memstore UK v2 + \ "https://auth.storage.memset.com/v2.0" + 6 / OVH + \ "https://auth.cloud.ovh.net/v2.0" auth> 1 Tenant name - optional -tenant> +tenant> +Region name - optional +region> Storage URL - optional -storage_url> +storage_url> Remote config -------------------- [remote] user = user_name key = password_or_api_key auth = https://auth.api.rackspacecloud.com/v1.0 -tenant = -storage_url = +tenant = +region = +storage_url = -------------------- y) Yes this is OK e) Edit this remote diff --git a/docs/content/yandex.md b/docs/content/yandex.md index 33719d279..76ff03b00 100644 --- a/docs/content/yandex.md +++ b/docs/content/yandex.md @@ -20,28 +20,45 @@ This will guide you through an interactive setup process: ``` No remotes found - make a new one n) New remote -q) Quit config -n/q> n +s) Set configuration password +n/s> n name> remote -What type of source is it? -Choose a number from below - 1) amazon cloud drive - 2) b2 - 3) drive - 4) dropbox - 5) google cloud storage - 6) swift - 7) hubic - 8) local - 9) onedrive -10) s3 -11) yandex -type> 11 +Type of storage to configure. +Choose a number from below, or type in your own value + 1 / Amazon Cloud Drive + \ "amazon cloud drive" + 2 / Amazon S3 (also Dreamhost, Ceph) + \ "s3" + 3 / Backblaze B2 + \ "b2" + 4 / Dropbox + \ "dropbox" + 5 / Google Cloud Storage (this is not Google Drive) + \ "google cloud storage" + 6 / Google Drive + \ "drive" + 7 / Hubic + \ "hubic" + 8 / Local Disk + \ "local" + 9 / Microsoft OneDrive + \ "onedrive" +10 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH) + \ "swift" +11 / Yandex Disk + \ "yandex" +Storage> 11 Yandex Client Id - leave blank normally. client_id> Yandex Client Secret - leave blank normally. client_secret> Remote config +Use auto config? + * Say Y if not sure + * Say N if you are working on a remote or headless machine +y) Yes +n) No +y/n> y If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth Log in and authorize rclone for access Waiting for code...