extern/rclone
1
0
Fork 0
mirror of https://github.com/rclone/rclone.git synced 2025-01-11 08:49:37 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update remote docs to show correct setup process

Browse Source
This commit is contained in:
emyarod 2017-01-08 21:09:19 -08:00 committed by Nick Craig-Wood
parent 499766f6ab
commit 3c87a0d0dc
11 changed files with 216 additions and 175 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/content/amazonclouddrive.md
View File

@ -31,25 +31,27 @@ Type of storage to configure.
Choose a number from below, or type in your own value Choose a number from below, or type in your own value
1 / Amazon Drive 1 / Amazon Drive
\ "amazon cloud drive" \ "amazon cloud drive"
2 / Amazon S3 (also Dreamhost, Ceph) 2 / Amazon S3 (also Dreamhost, Ceph, Minio)
\ "s3" \ "s3"
3 / Backblaze B2 3 / Backblaze B2
\ "b2" \ "b2"
4 / Dropbox 4 / Dropbox
\ "dropbox" \ "dropbox"
5 / Google Cloud Storage (this is not Google Drive) 5 / Encrypt/Decrypt a remote
\ "crypt"
6 / Google Cloud Storage (this is not Google Drive)
\ "google cloud storage" \ "google cloud storage"
6 / Google Drive 7 / Google Drive
\ "drive" \ "drive"
7 / Hubic 8 / Hubic
\ "hubic" \ "hubic"
8 / Local Disk 9 / Local Disk
\ "local" \ "local"
9 / Microsoft OneDrive 10 / Microsoft OneDrive
\ "onedrive" \ "onedrive"
10 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH) 11 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH)
\ "swift" \ "swift"
11 / Yandex Disk 12 / Yandex Disk
\ "yandex" \ "yandex"
Storage> 1 Storage> 1
Amazon Application Client Id - leave blank normally. Amazon Application Client Id - leave blank normally.
@ -57,6 +59,12 @@ client_id>
Amazon Application Client Secret - leave blank normally. Amazon Application 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...

18
docs/content/b2.md
View File

@ -30,25 +30,27 @@ Type of storage to configure.
Choose a number from below, or type in your own value Choose a number from below, or type in your own value
1 / Amazon Drive 1 / Amazon Drive
\ "amazon cloud drive" \ "amazon cloud drive"
2 / Amazon S3 (also Dreamhost, Ceph) 2 / Amazon S3 (also Dreamhost, Ceph, Minio)
\ "s3" \ "s3"
3 / Backblaze B2 3 / Backblaze B2
\ "b2" \ "b2"
4 / Dropbox 4 / Dropbox
\ "dropbox" \ "dropbox"
5 / Google Cloud Storage (this is not Google Drive) 5 / Encrypt/Decrypt a remote
\ "crypt"
6 / Google Cloud Storage (this is not Google Drive)
\ "google cloud storage" \ "google cloud storage"
6 / Google Drive 7 / Google Drive
\ "drive" \ "drive"
7 / Hubic 8 / Hubic
\ "hubic" \ "hubic"
8 / Local Disk 9 / Local Disk
\ "local" \ "local"
9 / Microsoft OneDrive 10 / Microsoft OneDrive
\ "onedrive" \ "onedrive"
10 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH) 11 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH)
\ "swift" \ "swift"
11 / Yandex Disk 12 / Yandex Disk
\ "yandex" \ "yandex"
Storage> 3 Storage> 3
Account ID Account ID

2
docs/content/crypt.md
View File

@ -61,7 +61,7 @@ Choose a number from below, or type in your own value
Storage> 5 Storage> 5
Remote to encrypt/decrypt. Remote to encrypt/decrypt.
Normally should contain a ':' and a path, eg "myremote:path/to/dir", Normally should contain a ':' and a path, eg "myremote:path/to/dir",
"myremote:bucket" or "myremote:" "myremote:bucket" or maybe "myremote:" (not recommended).
remote> remote:path remote> remote:path
How to encrypt the filenames. How to encrypt the filenames.
Choose a number from below, or type in your own value Choose a number from below, or type in your own value

20
docs/content/drive.md
View File

@ -31,27 +31,29 @@ Type of storage to configure.
Choose a number from below, or type in your own value Choose a number from below, or type in your own value
1 / Amazon Drive 1 / Amazon Drive
\ "amazon cloud drive" \ "amazon cloud drive"
2 / Amazon S3 (also Dreamhost, Ceph) 2 / Amazon S3 (also Dreamhost, Ceph, Minio)
\ "s3" \ "s3"
3 / Backblaze B2 3 / Backblaze B2
\ "b2" \ "b2"
4 / Dropbox 4 / Dropbox
\ "dropbox" \ "dropbox"
5 / Google Cloud Storage (this is not Google Drive) 5 / Encrypt/Decrypt a remote
\ "crypt"
6 / Google Cloud Storage (this is not Google Drive)
\ "google cloud storage" \ "google cloud storage"
6 / Google Drive 7 / Google Drive
\ "drive" \ "drive"
7 / Hubic 8 / Hubic
\ "hubic" \ "hubic"
8 / Local Disk 9 / Local Disk
\ "local" \ "local"
9 / Microsoft OneDrive 10 / Microsoft OneDrive
\ "onedrive" \ "onedrive"
10 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH) 11 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH)
\ "swift" \ "swift"
11 / Yandex Disk 12 / Yandex Disk
\ "yandex" \ "yandex"
Storage> 6 Storage> 7
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.

18
docs/content/dropbox.md
View File

@ -32,25 +32,27 @@ Type of storage to configure.
Choose a number from below, or type in your own value Choose a number from below, or type in your own value
1 / Amazon Drive 1 / Amazon Drive
\ "amazon cloud drive" \ "amazon cloud drive"
2 / Amazon S3 (also Dreamhost, Ceph) 2 / Amazon S3 (also Dreamhost, Ceph, Minio)
\ "s3" \ "s3"
3 / Backblaze B2 3 / Backblaze B2
\ "b2" \ "b2"
4 / Dropbox 4 / Dropbox
\ "dropbox" \ "dropbox"
5 / Google Cloud Storage (this is not Google Drive) 5 / Encrypt/Decrypt a remote
\ "crypt"
6 / Google Cloud Storage (this is not Google Drive)
\ "google cloud storage" \ "google cloud storage"
6 / Google Drive 7 / Google Drive
\ "drive" \ "drive"
7 / Hubic 8 / Hubic
\ "hubic" \ "hubic"
8 / Local Disk 9 / Local Disk
\ "local" \ "local"
9 / Microsoft OneDrive 10 / Microsoft OneDrive
\ "onedrive" \ "onedrive"
10 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH) 11 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH)
\ "swift" \ "swift"
11 / Yandex Disk 12 / Yandex Disk
\ "yandex" \ "yandex"
Storage> 4 Storage> 4
Dropbox App Key - leave blank normally. Dropbox App Key - leave blank normally.

65
docs/content/googlecloudstorage.md
View File

@ -30,27 +30,29 @@ Type of storage to configure.
Choose a number from below, or type in your own value Choose a number from below, or type in your own value
1 / Amazon Drive 1 / Amazon Drive
\ "amazon cloud drive" \ "amazon cloud drive"
2 / Amazon S3 (also Dreamhost, Ceph) 2 / Amazon S3 (also Dreamhost, Ceph, Minio)
\ "s3" \ "s3"
3 / Backblaze B2 3 / Backblaze B2
\ "b2" \ "b2"
4 / Dropbox 4 / Dropbox
\ "dropbox" \ "dropbox"
5 / Google Cloud Storage (this is not Google Drive) 5 / Encrypt/Decrypt a remote
\ "crypt"
6 / Google Cloud Storage (this is not Google Drive)
\ "google cloud storage" \ "google cloud storage"
6 / Google Drive 7 / Google Drive
\ "drive" \ "drive"
7 / Hubic 8 / Hubic
\ "hubic" \ "hubic"
8 / Local Disk 9 / Local Disk
\ "local" \ "local"
9 / Microsoft OneDrive 10 / Microsoft OneDrive
\ "onedrive" \ "onedrive"
10 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH) 11 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH)
\ "swift" \ "swift"
11 / Yandex Disk 12 / Yandex Disk
\ "yandex" \ "yandex"
Storage> 5 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.
@ -61,34 +63,33 @@ Service Account Credentials JSON file path - needed only if you want use SA inst
service_account_file> service_account_file>
Access Control List for new objects. Access Control List for new objects.
Choose a number from below, or type in your own value Choose a number from below, or type in your own value
* Object owner gets OWNER access, and all Authenticated Users get READER access. 1 / Object owner gets OWNER access, and all Authenticated Users get READER access.
1) authenticatedRead \ "authenticatedRead"
* Object owner gets OWNER access, and project team owners get OWNER access. 2 / Object owner gets OWNER access, and project team owners get OWNER access.
2) bucketOwnerFullControl \ "bucketOwnerFullControl"
* Object owner gets OWNER access, and project team owners get READER access. 3 / Object owner gets OWNER access, and project team owners get READER access.
3) bucketOwnerRead \ "bucketOwnerRead"
* Object owner gets OWNER access [default if left blank]. 4 / Object owner gets OWNER access [default if left blank].
4) private \ "private"
* Object owner gets OWNER access, and project team members get access according to their roles. 5 / Object owner gets OWNER access, and project team members get access according to their roles.
5) projectPrivate \ "projectPrivate"
* Object owner gets OWNER access, and all Users get READER access. 6 / Object owner gets OWNER access, and all Users get READER access.
6) publicRead \ "publicRead"
object_acl> 4 object_acl> 4
Access Control List for new buckets. Access Control List for new buckets.
Choose a number from below, or type in your own value Choose a number from below, or type in your own value
* Project team owners get OWNER access, and all Authenticated Users get READER access. 1 / Project team owners get OWNER access, and all Authenticated Users get READER access.
1) authenticatedRead \ "authenticatedRead"
* Project team owners get OWNER access [default if left blank]. 2 / Project team owners get OWNER access [default if left blank].
2) private \ "private"
* Project team members get access according to their roles. 3 / Project team members get access according to their roles.
3) projectPrivate \ "projectPrivate"
* Project team owners get OWNER access, and all Users get READER access. 4 / Project team owners get OWNER access, and all Users get READER access.
4) publicRead \ "publicRead"
* Project team owners get OWNER access, and all Users get WRITER access. 5 / Project team owners get OWNER access, and all Users get WRITER access.
5) publicReadWrite \ "publicReadWrite"
bucket_acl> 2 bucket_acl> 2
Remote config Remote config
Remote config
Use auto config? Use auto config?
* Say Y if not sure * Say Y if not sure
* Say N if you are working on a remote or headless machine or Y didn't work * Say N if you are working on a remote or headless machine or Y didn't work

20
docs/content/hubic.md
View File

@ -30,27 +30,29 @@ Type of storage to configure.
Choose a number from below, or type in your own value Choose a number from below, or type in your own value
1 / Amazon Drive 1 / Amazon Drive
\ "amazon cloud drive" \ "amazon cloud drive"
2 / Amazon S3 (also Dreamhost, Ceph) 2 / Amazon S3 (also Dreamhost, Ceph, Minio)
\ "s3" \ "s3"
3 / Backblaze B2 3 / Backblaze B2
\ "b2" \ "b2"
4 / Dropbox 4 / Dropbox
\ "dropbox" \ "dropbox"
5 / Google Cloud Storage (this is not Google Drive) 5 / Encrypt/Decrypt a remote
\ "crypt"
6 / Google Cloud Storage (this is not Google Drive)
\ "google cloud storage" \ "google cloud storage"
6 / Google Drive 7 / Google Drive
\ "drive" \ "drive"
7 / Hubic 8 / Hubic
\ "hubic" \ "hubic"
8 / Local Disk 9 / Local Disk
\ "local" \ "local"
9 / Microsoft OneDrive 10 / Microsoft OneDrive
\ "onedrive" \ "onedrive"
10 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH) 11 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH)
\ "swift" \ "swift"
11 / Yandex Disk 12 / Yandex Disk
\ "yandex" \ "yandex"
Storage> 7 Storage> 8
Hubic Client Id - leave blank normally. Hubic Client Id - leave blank normally.
client_id> client_id>
Hubic Client Secret - leave blank normally. Hubic Client Secret - leave blank normally.

20
docs/content/onedrive.md
View File

@ -31,27 +31,29 @@ Type of storage to configure.
Choose a number from below, or type in your own value Choose a number from below, or type in your own value
1 / Amazon Drive 1 / Amazon Drive
\ "amazon cloud drive" \ "amazon cloud drive"
2 / Amazon S3 (also Dreamhost, Ceph) 2 / Amazon S3 (also Dreamhost, Ceph, Minio)
\ "s3" \ "s3"
3 / Backblaze B2 3 / Backblaze B2
\ "b2" \ "b2"
4 / Dropbox 4 / Dropbox
\ "dropbox" \ "dropbox"
5 / Google Cloud Storage (this is not Google Drive) 5 / Encrypt/Decrypt a remote
\ "crypt"
6 / Google Cloud Storage (this is not Google Drive)
\ "google cloud storage" \ "google cloud storage"
6 / Google Drive 7 / Google Drive
\ "drive" \ "drive"
7 / Hubic 8 / Hubic
\ "hubic" \ "hubic"
8 / Local Disk 9 / Local Disk
\ "local" \ "local"
9 / Microsoft OneDrive 10 / Microsoft OneDrive
\ "onedrive" \ "onedrive"
10 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH) 11 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH)
\ "swift" \ "swift"
11 / Yandex Disk 12 / Yandex Disk
\ "yandex" \ "yandex"
Storage> 9 Storage> 10
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.

39
docs/content/s3.md
View File

@ -26,25 +26,27 @@ Type of storage to configure.
Choose a number from below, or type in your own value Choose a number from below, or type in your own value
1 / Amazon Drive 1 / Amazon Drive
\ "amazon cloud drive" \ "amazon cloud drive"
2 / Amazon S3 (also Dreamhost, Ceph) 2 / Amazon S3 (also Dreamhost, Ceph, Minio)
\ "s3" \ "s3"
3 / Backblaze B2 3 / Backblaze B2
\ "b2" \ "b2"
4 / Dropbox 4 / Dropbox
\ "dropbox" \ "dropbox"
5 / Google Cloud Storage (this is not Google Drive) 5 / Encrypt/Decrypt a remote
\ "crypt"
6 / Google Cloud Storage (this is not Google Drive)
\ "google cloud storage" \ "google cloud storage"
6 / Google Drive 7 / Google Drive
\ "drive" \ "drive"
7 / Hubic 8 / Hubic
\ "hubic" \ "hubic"
8 / Local Disk 9 / Local Disk
\ "local" \ "local"
9 / Microsoft OneDrive 10 / Microsoft OneDrive
\ "onedrive" \ "onedrive"
10 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH) 11 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH)
\ "swift" \ "swift"
11 / Yandex Disk 12 / Yandex Disk
\ "yandex" \ "yandex"
Storage> 2 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.
@ -85,15 +87,21 @@ Choose a number from below, or type in your own value
/ Asia Pacific (Tokyo) Region / Asia Pacific (Tokyo) Region
8 | Needs location constraint ap-northeast-1. 8 | Needs location constraint ap-northeast-1.
\ "ap-northeast-1" \ "ap-northeast-1"
/ Asia Pacific (Seoul)
9 | Needs location constraint ap-northeast-2.
\ "ap-northeast-2"
/ Asia Pacific (Mumbai)
10 | Needs location constraint ap-south-1.
\ "ap-south-1"
/ South America (Sao Paulo) Region / South America (Sao Paulo) Region
9 | Needs location constraint sa-east-1. 11 | Needs location constraint sa-east-1.
\ "sa-east-1" \ "sa-east-1"
/ If using an S3 clone that only understands v2 signatures / If using an S3 clone that only understands v2 signatures
10 | eg Ceph/Dreamhost 12 | eg Ceph/Dreamhost
| set this and make sure you set the endpoint. | set this and make sure you set the endpoint.
\ "other-v2-signature" \ "other-v2-signature"
/ If using an S3 clone that understands v4 signatures set this / If using an S3 clone that understands v4 signatures set this
11 | and make sure you set the endpoint. 13 | and make sure you set the endpoint.
\ "other-v4-signature" \ "other-v4-signature"
region> 1 region> 1
Endpoint for S3 API. Endpoint for S3 API.
@ -118,7 +126,11 @@ Choose a number from below, or type in your own value
\ "ap-southeast-2" \ "ap-southeast-2"
8 / Asia Pacific (Tokyo) Region. 8 / Asia Pacific (Tokyo) Region.
\ "ap-northeast-1" \ "ap-northeast-1"
9 / South America (Sao Paulo) Region. 9 / Asia Pacific (Seoul)
\ "ap-northeast-2"
10 / Asia Pacific (Mumbai)
\ "ap-south-1"
11 / South America (Sao Paulo) Region.
\ "sa-east-1" \ "sa-east-1"
location_constraint> 1 location_constraint> 1
Canned ACL used when creating buckets and/or storing objects in S3. Canned ACL used when creating buckets and/or storing objects in S3.
@ -167,6 +179,9 @@ secret_access_key = secret_key
region = us-east-1 region = us-east-1
endpoint = endpoint =
location_constraint = location_constraint =
acl = private
server_side_encryption =
storage_class =
-------------------- --------------------
y) Yes this is OK y) Yes this is OK
e) Edit this remote e) Edit this remote

29
docs/content/swift.md
View File

@ -32,27 +32,29 @@ Type of storage to configure.
Choose a number from below, or type in your own value Choose a number from below, or type in your own value
1 / Amazon Drive 1 / Amazon Drive
\ "amazon cloud drive" \ "amazon cloud drive"
2 / Amazon S3 (also Dreamhost, Ceph) 2 / Amazon S3 (also Dreamhost, Ceph, Minio)
\ "s3" \ "s3"
3 / Backblaze B2 3 / Backblaze B2
\ "b2" \ "b2"
4 / Dropbox 4 / Dropbox
\ "dropbox" \ "dropbox"
5 / Google Cloud Storage (this is not Google Drive) 5 / Encrypt/Decrypt a remote
\ "crypt"
6 / Google Cloud Storage (this is not Google Drive)
\ "google cloud storage" \ "google cloud storage"
6 / Google Drive 7 / Google Drive
\ "drive" \ "drive"
7 / Hubic 8 / Hubic
\ "hubic" \ "hubic"
8 / Local Disk 9 / Local Disk
\ "local" \ "local"
9 / Microsoft OneDrive 10 / Microsoft OneDrive
\ "onedrive" \ "onedrive"
10 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH) 11 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH)
\ "swift" \ "swift"
11 / Yandex Disk 12 / Yandex Disk
\ "yandex" \ "yandex"
Storage> 10 Storage> 11
User name to log in. User name to log in.
user> user_name user> user_name
API key or password. API key or password.
@ -74,25 +76,28 @@ Choose a number from below, or type in your own value
auth> 1 auth> 1
User domain - optional (v3 auth) User domain - optional (v3 auth)
domain> Default domain> Default
Tenant name - optional Tenant name - optional for v1 auth, required otherwise
tenant> tenant> tenant_name
Tenant domain - optional (v3 auth) Tenant domain - optional (v3 auth)
tenant_domain> tenant_domain>
Region name - optional Region name - optional
region> region>
Storage URL - optional Storage URL - optional
storage_url> storage_url>
Remote config
AuthVersion - optional - set to (1,2,3) if your auth URL has no version AuthVersion - optional - set to (1,2,3) if your auth URL has no version
auth_version> auth_version>
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
domain = Default
tenant = tenant =
tenant_domain =
region = region =
storage_url = storage_url =
auth_version =
-------------------- --------------------
y) Yes this is OK y) Yes this is OK
e) Edit this remote e) Edit this remote

20
docs/content/yandex.md
View File

@ -27,27 +27,29 @@ Type of storage to configure.
Choose a number from below, or type in your own value Choose a number from below, or type in your own value
1 / Amazon Drive 1 / Amazon Drive
\ "amazon cloud drive" \ "amazon cloud drive"
2 / Amazon S3 (also Dreamhost, Ceph) 2 / Amazon S3 (also Dreamhost, Ceph, Minio)
\ "s3" \ "s3"
3 / Backblaze B2 3 / Backblaze B2
\ "b2" \ "b2"
4 / Dropbox 4 / Dropbox
\ "dropbox" \ "dropbox"
5 / Google Cloud Storage (this is not Google Drive) 5 / Encrypt/Decrypt a remote
\ "crypt"
6 / Google Cloud Storage (this is not Google Drive)
\ "google cloud storage" \ "google cloud storage"
6 / Google Drive 7 / Google Drive
\ "drive" \ "drive"
7 / Hubic 8 / Hubic
\ "hubic" \ "hubic"
8 / Local Disk 9 / Local Disk
\ "local" \ "local"
9 / Microsoft OneDrive 10 / Microsoft OneDrive
\ "onedrive" \ "onedrive"
10 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH) 11 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH)
\ "swift" \ "swift"
11 / Yandex Disk 12 / Yandex Disk
\ "yandex" \ "yandex"
Storage> 11 Storage> 12
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.