MirrorSave
/
rclone
mirror of https://github.com/rclone/rclone.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update config walk throughs with new style choice menu

This commit is contained in:
Nick Craig-Wood 2016-02-21 13:39:04 +00:00
parent 95e4d837ef
commit 377986d599
10 changed files with 370 additions and 191 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
docs/content/amazonclouddrive.md
View File

@ -27,16 +27,31 @@ d) Delete remote
q) Quit config q) Quit config
e/n/d/q> n e/n/d/q> n
name> remote name> remote
What type of source is it? Type of storage to configure.
Choose a number from below Choose a number from below, or type in your own value
1) amazon cloud drive 1 / Amazon Cloud Drive
2) drive \ "amazon cloud drive"
3) dropbox 2 / Amazon S3 (also Dreamhost, Ceph)
4) google cloud storage \ "s3"
5) local 3 / Backblaze B2
6) s3 \ "b2"
7) swift 4 / Dropbox
type> 1 \ "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. Amazon Application Client Id - leave blank normally.
client_id> client_id>
Amazon Application Client Secret - leave blank normally. Amazon Application Client Secret - leave blank normally.

38
docs/content/b2.md
View File

@ -26,19 +26,31 @@ n) New remote
q) Quit config q) Quit config
n/q> n n/q> n
name> remote name> remote
What type of source is it? Type of storage to configure.
Choose a number from below Choose a number from below, or type in your own value
1) amazon cloud drive 1 / Amazon Cloud Drive
2) b2 \ "amazon cloud drive"
3) drive 2 / Amazon S3 (also Dreamhost, Ceph)
4) dropbox \ "s3"
5) google cloud storage 3 / Backblaze B2
6) swift \ "b2"
7) hubic 4 / Dropbox
8) local \ "dropbox"
9) onedrive 5 / Google Cloud Storage (this is not Google Drive)
10) s3 \ "google cloud storage"
type> 2 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 ID
account> 123456789abc account> 123456789abc
Application Key Application Key

32
docs/content/drive.md
View File

@ -27,13 +27,31 @@ d) Delete remote
q) Quit config q) Quit config
e/n/d/q> n e/n/d/q> n
name> remote name> remote
What type of source is it? Type of storage to configure.
Choose a number from below Choose a number from below, or type in your own value
1) swift 1 / Amazon Cloud Drive
2) s3 \ "amazon cloud drive"
3) local 2 / Amazon S3 (also Dreamhost, Ceph)
4) drive \ "s3"
type> 4 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. Google Application Client Id - leave blank normally.
client_id> client_id>
Google Application Client Secret - leave blank normally. Google Application Client Secret - leave blank normally.

34
docs/content/dropbox.md
View File

@ -28,15 +28,31 @@ d) Delete remote
q) Quit config q) Quit config
e/n/d/q> n e/n/d/q> n
name> remote name> remote
What type of source is it? Type of storage to configure.
Choose a number from below Choose a number from below, or type in your own value
1) swift 1 / Amazon Cloud Drive
2) s3 \ "amazon cloud drive"
3) local 2 / Amazon S3 (also Dreamhost, Ceph)
4) google cloud storage \ "s3"
5) dropbox 3 / Backblaze B2
6) drive \ "b2"
type> 5 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. Dropbox App Key - leave blank normally.
app_key> app_key>
Dropbox App Secret - leave blank normally. Dropbox App Secret - leave blank normally.

34
docs/content/googlecloudstorage.md
View File

@ -26,15 +26,31 @@ d) Delete remote
q) Quit config q) Quit config
e/n/d/q> n e/n/d/q> n
name> remote name> remote
What type of source is it? Type of storage to configure.
Choose a number from below Choose a number from below, or type in your own value
1) swift 1 / Amazon Cloud Drive
2) s3 \ "amazon cloud drive"
3) local 2 / Amazon S3 (also Dreamhost, Ceph)
4) google cloud storage \ "s3"
5) dropbox 3 / Backblaze B2
6) drive \ "b2"
type> 4 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. Google Application Client Id - leave blank normally.
client_id> client_id>
Google Application Client Secret - leave blank normally. Google Application Client Secret - leave blank normally.

54
docs/content/hubic.md
View File

@ -23,28 +23,46 @@ This will guide you through an interactive setup process:
``` ```
n) New remote n) New remote
d) Delete remote s) Set configuration password
q) Quit config n/s> n
e/n/d/q> n
name> remote name> remote
What type of source is it? Type of storage to configure.
Choose a number from below Choose a number from below, or type in your own value
1) amazon cloud drive 1 / Amazon Cloud Drive
2) drive \ "amazon cloud drive"
3) dropbox 2 / Amazon S3 (also Dreamhost, Ceph)
4) google cloud storage \ "s3"
5) local 3 / Backblaze B2
6) onedrive \ "b2"
7) hubic 4 / Dropbox
8) s3 \ "dropbox"
9) swift 5 / Google Cloud Storage (this is not Google Drive)
type> 7 \ "google cloud storage"
Hubic App Client Id - leave blank normally. 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> client_id>
Hubic App Client Secret - leave blank normally. Hubic Client Secret - leave blank normally.
client_secret> client_secret>
Remote config 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 Log in and authorize rclone for access
Waiting for code... Waiting for code...
Got code Got code

48
docs/content/onedrive.md
View File

@ -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: This will guide you through an interactive setup process:
``` ```
No remotes found - make a new one
n) New remote n) New remote
d) Delete remote s) Set configuration password
q) Quit config n/s> n
e/n/d/q> n
name> remote name> remote
What type of source is it? Type of storage to configure.
Choose a number from below Choose a number from below, or type in your own value
1) amazon cloud drive 1 / Amazon Cloud Drive
2) drive \ "amazon cloud drive"
3) dropbox 2 / Amazon S3 (also Dreamhost, Ceph)
4) google cloud storage \ "s3"
5) local 3 / Backblaze B2
6) onedrive \ "b2"
7) s3 4 / Dropbox
8) swift \ "dropbox"
type> 6 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. Microsoft App Client Id - leave blank normally.
client_id> client_id>
Microsoft App Client Secret - leave blank normally. Microsoft App Client Secret - leave blank normally.
client_secret> client_secret>
Remote config 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 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 Log in and authorize rclone for access
Waiting for code... Waiting for code...

166
docs/content/s3.md
View File

@ -19,96 +19,122 @@ This will guide you through an interactive setup process.
``` ```
No remotes found - make a new one No remotes found - make a new one
n) New remote n) New remote
q) Quit config s) Set configuration password
n/q> n n/s> n
name> remote name> remote
What type of source is it? Type of storage to configure.
Choose a number from below Choose a number from below, or type in your own value
1) amazon cloud drive 1 / Amazon Cloud Drive
2) b2 \ "amazon cloud drive"
3) drive 2 / Amazon S3 (also Dreamhost, Ceph)
4) dropbox \ "s3"
5) google cloud storage 3 / Backblaze B2
6) swift \ "b2"
7) hubic 4 / Dropbox
8) local \ "dropbox"
9) onedrive 5 / Google Cloud Storage (this is not Google Drive)
10) s3 \ "google cloud storage"
11) yandex 6 / Google Drive
type> 10 \ "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. 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 Choose a number from below, or type in your own value
* Enter AWS credentials in the next step 1 / Enter AWS credentials in the next step
1) false \ "false"
* Get AWS credentials from the environment (env vars or IAM) 2 / Get AWS credentials from the environment (env vars or IAM)
2) true \ "true"
env_auth> 2 env_auth> 1
AWS Access Key ID - leave blank for anonymous access or runtime credentials. 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. 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. Region to connect to.
Choose a number from below, or type in your own value Choose a number from below, or type in your own value
* The default endpoint - a good choice if you are unsure. / The default endpoint - a good choice if you are unsure.
* US Region, Northern Virginia or Pacific Northwest. 1 | US Region, Northern Virginia or Pacific Northwest.
* Leave location constraint empty. | Leave location constraint empty.
1) us-east-1 \ "us-east-1"
* US West (Oregon) Region / US West (Oregon) Region
* Needs location constraint us-west-2. 2 | Needs location constraint us-west-2.
2) us-west-2 \ "us-west-2"
* US West (Northern California) Region / US West (Northern California) Region
* Needs location constraint us-west-1. 3 | Needs location constraint us-west-1.
[..snip..] \ "us-west-1"
8) ap-northeast-1 / EU (Ireland) Region Region
* South America (Sao Paulo) Region 4 | Needs location constraint EU or eu-west-1.
* Needs location constraint sa-east-1. \ "eu-west-1"
9) sa-east-1 / EU (Frankfurt) Region
* If using an S3 clone that only understands v2 signatures - eg Ceph - set this and make sure you set the endpoint. 5 | Needs location constraint eu-central-1.
10) other-v2-signature \ "eu-central-1"
* If using an S3 clone that understands v4 signatures set this and make sure you set the endpoint. / Asia Pacific (Singapore) Region
11) other-v4-signature 6 | Needs location constraint ap-southeast-1.
region> 3 \ "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. Endpoint for S3 API.
Leave blank if using AWS to use the default endpoint for the region. Leave blank if using AWS to use the default endpoint for the region.
Specify if using an S3 clone such as Ceph. 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. 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 Choose a number from below, or type in your own value
* Empty for US Region, Northern Virginia or Pacific Northwest. 1 / Empty for US Region, Northern Virginia or Pacific Northwest.
1) \ ""
* US West (Oregon) Region. 2 / US West (Oregon) Region.
2) us-west-2 \ "us-west-2"
* US West (Northern California) Region. 3 / US West (Northern California) Region.
[..snip..] \ "us-west-1"
8) ap-northeast-1 4 / EU (Ireland) Region.
* South America (Sao Paulo) Region. \ "eu-west-1"
9) sa-east-1 5 / EU Region.
location_constraint> 3 \ "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 config
-------------------- --------------------
[remote] [remote]
env_auth = true env_auth = false
access_key_id = access_key_id = access_key
secret_access_key = secret_access_key = secret_key
region = us-west-1 region = us-east-1
endpoint = endpoint =
location_constraint = us-west-1 location_constraint =
-------------------- --------------------
y) Yes this is OK y) Yes this is OK
e) Edit this remote e) Edit this remote
d) Delete this remote d) Delete this remote
y/e/d> y 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 This remote is called `remote` and can now be used like this

71
docs/content/swift.md
View File

@ -25,47 +25,68 @@ This will guide you through an interactive setup process.
``` ```
No remotes found - make a new one No remotes found - make a new one
n) New remote n) New remote
q) Quit config s) Set configuration password
n/q> n n/s> n
name> remote name> remote
What type of source is it? Type of storage to configure.
Choose a number from below Choose a number from below, or type in your own value
1) swift 1 / Amazon Cloud Drive
2) s3 \ "amazon cloud drive"
3) local 2 / Amazon S3 (also Dreamhost, Ceph)
4) drive \ "s3"
type> 1 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 name to log in.
user> user_name user> user_name
API key or password. API key or password.
key> password_or_api_key key> password_or_api_key
Authentication URL for server. Authentication URL for server.
Choose a number from below, or type in your own value Choose a number from below, or type in your own value
* Rackspace US 1 / Rackspace US
1) https://auth.api.rackspacecloud.com/v1.0 \ "https://auth.api.rackspacecloud.com/v1.0"
* Rackspace UK 2 / Rackspace UK
2) https://lon.auth.api.rackspacecloud.com/v1.0 \ "https://lon.auth.api.rackspacecloud.com/v1.0"
* Rackspace v2 3 / Rackspace v2
3) https://identity.api.rackspacecloud.com/v2.0 \ "https://identity.api.rackspacecloud.com/v2.0"
* Memset Memstore UK 4 / Memset Memstore UK
4) https://auth.storage.memset.com/v1.0 \ "https://auth.storage.memset.com/v1.0"
* Memset Memstore UK v2 5 / Memset Memstore UK v2
5) https://auth.storage.memset.com/v2.0 \ "https://auth.storage.memset.com/v2.0"
* OVH 6 / OVH
6) https://auth.cloud.ovh.net/v2.0 \ "https://auth.cloud.ovh.net/v2.0"
auth> 1 auth> 1
Tenant name - optional Tenant name - optional
tenant> tenant>
Region name - optional
region>
Storage URL - optional Storage URL - optional
storage_url> storage_url>
Remote config Remote config
-------------------- --------------------
[remote] [remote]
user = user_name user = user_name
key = password_or_api_key key = password_or_api_key
auth = https://auth.api.rackspacecloud.com/v1.0 auth = https://auth.api.rackspacecloud.com/v1.0
tenant = tenant =
storage_url = region =
storage_url =
-------------------- --------------------
y) Yes this is OK y) Yes this is OK
e) Edit this remote e) Edit this remote

49
docs/content/yandex.md
View File

@ -20,28 +20,45 @@ This will guide you through an interactive setup process:
``` ```
No remotes found - make a new one No remotes found - make a new one
n) New remote n) New remote
q) Quit config s) Set configuration password
n/q> n n/s> n
name> remote name> remote
What type of source is it? Type of storage to configure.
Choose a number from below Choose a number from below, or type in your own value
1) amazon cloud drive 1 / Amazon Cloud Drive
2) b2 \ "amazon cloud drive"
3) drive 2 / Amazon S3 (also Dreamhost, Ceph)
4) dropbox \ "s3"
5) google cloud storage 3 / Backblaze B2
6) swift \ "b2"
7) hubic 4 / Dropbox
8) local \ "dropbox"
9) onedrive 5 / Google Cloud Storage (this is not Google Drive)
10) s3 \ "google cloud storage"
11) yandex 6 / Google Drive
type> 11 \ "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. Yandex Client Id - leave blank normally.
client_id> client_id>
Yandex Client Secret - leave blank normally. Yandex Client Secret - leave blank normally.
client_secret> client_secret>
Remote config 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 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 Log in and authorize rclone for access
Waiting for code... Waiting for code...