github-mirror/rclone
2
0
Fork 0
mirror of https://github.com/rclone/rclone.git synced 2024-11-22 04:41:17 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
31caa019fa
rclone/README.md

144 lines
8.2 KiB
Markdown
Raw Normal View History

docs: Use Adaptive Logo in README
2022-01-27 15:25:25 +08:00
[<img src="https://rclone.org/img/logo_on_light__horizontal_color.svg" width="50%" alt="rclone logo">](https://rclone.org/#gh-light-mode-only)
[<img src="https://rclone.org/img/logo_on_dark__horizontal_color.svg" width="50%" alt="rclone logo">](https://rclone.org/#gh-dark-mode-only)
Version v0.96 - automate the release process
2014-04-25 01:11:08 +08:00
Update references from HTTP to HTTPS where possible
2017-03-29 20:38:34 +08:00
[Website](https://rclone.org) |
[Documentation](https://rclone.org/docs/) |
docs: improve grammar and fix typos (#5361) This alters some comments in source files, but is interested mainly in documentation files and help messages.
2021-11-04 19:50:43 +08:00
[Download](https://rclone.org/downloads/) |
Add Contributing link to readme
2015-12-30 10:02:29 +08:00
[Contributing](CONTRIBUTING.md) |
Update references from HTTP to HTTPS where possible
2017-03-29 20:38:34 +08:00
[Changelog](https://rclone.org/changelog/) |
[Installation](https://rclone.org/install/) |
docs: update logo on website
2019-08-24 19:19:34 +08:00
[Forum](https://forum.rclone.org/)
Initial commit - some small parts working
2012-11-19 01:32:31 +08:00
docs: Update README.md shields for changed CI Signed-off-by: Gary Kim <gary@garykim.dev>
2020-02-01 23:24:36 +08:00
[![Build Status](https://github.com/rclone/rclone/workflows/build/badge.svg)](https://github.com/rclone/rclone/actions?query=workflow%3Abuild)
build: fix up package paths after repo move git grep -l github.com/ncw/rclone | xargs -d'\n' perl -i~ -lpe 's|github.com/ncw/rclone|github.com/rclone/rclone|g' goimports -w `find . -name \*.go`
2019-07-29 01:47:38 +08:00
[![Go Report Card](https://goreportcard.com/badge/github.com/rclone/rclone)](https://goreportcard.com/report/github.com/rclone/rclone)
docs: improve grammar and fix typos (#5361) This alters some comments in source files, but is interested mainly in documentation files and help messages.
2021-11-04 19:50:43 +08:00
[![GoDoc](https://godoc.org/github.com/rclone/rclone?status.svg)](https://godoc.org/github.com/rclone/rclone)
README.md: Add Docker pulls badge
2019-09-02 22:14:45 +08:00
[![Docker Pulls](https://img.shields.io/docker/pulls/rclone/rclone)](https://hub.docker.com/r/rclone/rclone)
drive: Rework token aquisition into config framework and store token in config file
2014-03-16 22:01:17 +08:00
Improved and updated the readme Updated providers list, added links to docs, improved readability
2018-10-11 18:18:36 +08:00
# Rclone
docs: improve grammar and fix typos (#5361) This alters some comments in source files, but is interested mainly in documentation files and help messages.
2021-11-04 19:50:43 +08:00
Rclone *("rsync for cloud storage")* is a command-line program to sync files and directories to and from different cloud storage providers.
Improved and updated the readme Updated providers list, added links to docs, improved readability
2018-10-11 18:18:36 +08:00
## Storage providers
Fix 1fichier link in Readme
2019-10-09 00:36:23 +08:00
* 1Fichier [:page_facing_up:](https://rclone.org/fichier/)
Add Akamai Netstorage as a new backend.
2021-10-15 06:01:46 +08:00
* Akamai Netstorage [:page_facing_up:](https://rclone.org/netstorage/)
s3: Support Alibaba Cloud (Aliyun) OSS The existing s3 backend passed all integration tests with OSS provided `force_path_style = false`. This makes sure that is so and adds documentation and configuration for OSS. Thanks to @luolibin for their work on the OSS backend which we ended up not needing. Fixes #1641 Fixes #1237
2019-01-13 00:46:45 +08:00
* Alibaba Cloud (Aliyun) Object Storage System (OSS) [:page_facing_up:](https://rclone.org/s3/#alibaba-oss)
Improved and updated the readme Updated providers list, added links to docs, improved readability
2018-10-11 18:18:36 +08:00
* Amazon Drive [:page_facing_up:](https://rclone.org/amazonclouddrive/) ([See note](https://rclone.org/amazonclouddrive/#status))
* Amazon S3 [:page_facing_up:](https://rclone.org/s3/)
* Backblaze B2 [:page_facing_up:](https://rclone.org/b2/)
* Box [:page_facing_up:](https://rclone.org/box/)
* Ceph [:page_facing_up:](https://rclone.org/s3/#ceph)
s3: Add ChinaMobile EOS to provider list China Mobile Ecloud Elastic Object Storage (EOS) is a cloud object storage service, and is fully compatible with S3. Fixes #6054
2022-03-24 19:57:00 +08:00
* China Mobile Ecloud Elastic Object Storage (EOS) [:page_facing_up:](https://rclone.org/s3/#china-mobile-ecloud-eos)
s3: Support Cloudflare R2 - fixes #5642
2022-05-06 19:09:29 +08:00
* Cloudflare R2 [:page_facing_up:](https://rclone.org/s3/#cloudflare-r2)
s3: Add ArvanCloud AOS to provider list
2022-04-28 17:42:30 +08:00
* Arvan Cloud Object Storage (AOS) [:page_facing_up:](https://rclone.org/s3/#arvan-cloud-object-storage-aos)
New backend for Citrix Sharefile - Fixes #1543 Many thanks to Bob Droog for organizing a test account and extensive testing.
2019-08-28 05:50:07 +08:00
* Citrix ShareFile [:page_facing_up:](https://rclone.org/sharefile/)
Improved and updated the readme Updated providers list, added links to docs, improved readability
2018-10-11 18:18:36 +08:00
* DigitalOcean Spaces [:page_facing_up:](https://rclone.org/s3/#digitalocean-spaces)
koofr: renamed digistorage to exclude the romania part.
2022-03-08 18:56:53 +08:00
* Digi Storage [:page_facing_up:](https://rclone.org/koofr/#digi-storage)
Improved and updated the readme Updated providers list, added links to docs, improved readability
2018-10-11 18:18:36 +08:00
* Dreamhost [:page_facing_up:](https://rclone.org/s3/#dreamhost)
* Dropbox [:page_facing_up:](https://rclone.org/dropbox/)
filefabric: Implement the Enterprise File Fabric backend Missing features - M-Stream support - Oauth-like flow (soon being changed to oauth)
2020-08-11 22:09:00 +08:00
* Enterprise File Fabric [:page_facing_up:](https://rclone.org/filefabric/)
webdav: add "fastmail" provider for Fastmail Files This provider: - supports the `X-OC-Mtime` header to set the mtime - calculates SHA1 checksum server side and returns it as a `ME:sha1hex` prop To differentiate the new hasMESHA1 quirk, the existing hasMD5 and hasSHA1 quirks for Owncloud have been renamed to hasOCMD5 and hasOCSHA1. Fixes #6837
2023-03-13 12:45:54 +08:00
* Fastmail Files [:page_facing_up:](https://rclone.org/webdav/#fastmail-files)
Improved and updated the readme Updated providers list, added links to docs, improved readability
2018-10-11 18:18:36 +08:00
* FTP [:page_facing_up:](https://rclone.org/ftp/)
* Google Cloud Storage [:page_facing_up:](https://rclone.org/googlecloudstorage/)
* Google Drive [:page_facing_up:](https://rclone.org/drive/)
googlephotos: Backend for accessing Google Photos #369
2019-06-18 00:50:58 +08:00
* Google Photos [:page_facing_up:](https://rclone.org/googlephotos/)
HDFS (Hadoop Distributed File System) implementation - #42 This includes an HDFS docker image to use with the integration tests. Co-authored-by: Ivan Andreev <ivandeex@gmail.com> Co-authored-by: Nick Craig-Wood <nick@craig-wood.com>
2020-09-29 01:29:44 +08:00
* HDFS (Hadoop Distributed Filesystem) [:page_facing_up:](https://rclone.org/hdfs/)
new backend: hidrive - fixes #1069
2022-07-08 01:58:22 +08:00
* HiDrive [:page_facing_up:](https://rclone.org/hidrive/)
Improved and updated the readme Updated providers list, added links to docs, improved readability
2018-10-11 18:18:36 +08:00
* HTTP [:page_facing_up:](https://rclone.org/http/)
backend: add Huawei OBS to s3 provider list
2022-06-07 15:41:46 +08:00
* Huawei Cloud Object Storage Service(OBS) [:page_facing_up:](https://rclone.org/s3/#huawei-obs)
backend/internetarchive: add support for Internet Archive This adds support for Internet Archive (archive.org) Items.
2022-04-12 17:38:44 +08:00
* Internet Archive [:page_facing_up:](https://rclone.org/internetarchive/)
Improved and updated the readme Updated providers list, added links to docs, improved readability
2018-10-11 18:18:36 +08:00
* Jottacloud [:page_facing_up:](https://rclone.org/jottacloud/)
* IBM COS S3 [:page_facing_up:](https://rclone.org/s3/#ibm-cos-s3)
s3: add support for IONOS Cloud Storage
2022-09-15 23:04:34 +08:00
* IONOS Cloud [:page_facing_up:](https://rclone.org/s3/#ionos)
koofr: implemented a backend for Koofr cloud storage service. Implemented a Koofr REST API backend. Added said backend to tests. Added documentation for said backend.
2019-02-22 23:50:04 +08:00
* Koofr [:page_facing_up:](https://rclone.org/koofr/)
s3: add Liara LOS to provider list
2022-12-06 20:25:23 +08:00
* Liara Object Storage [:page_facing_up:](https://rclone.org/s3/#liara-object-storage)
mailru: backend for mail.ru
2019-09-10 04:56:16 +08:00
* Mail.ru Cloud [:page_facing_up:](https://rclone.org/mailru/)
Improved and updated the readme Updated providers list, added links to docs, improved readability
2018-10-11 18:18:36 +08:00
* Memset Memstore [:page_facing_up:](https://rclone.org/swift/)
* Mega [:page_facing_up:](https://rclone.org/mega/)
The memory backend This is a bucket based remote
2018-05-03 23:31:06 +08:00
* Memory [:page_facing_up:](https://rclone.org/memory/)
Improved and updated the readme Updated providers list, added links to docs, improved readability
2018-10-11 18:18:36 +08:00
* Microsoft Azure Blob Storage [:page_facing_up:](https://rclone.org/azureblob/)
* Microsoft OneDrive [:page_facing_up:](https://rclone.org/onedrive/)
* Minio [:page_facing_up:](https://rclone.org/s3/#minio)
* Nextcloud [:page_facing_up:](https://rclone.org/webdav/#nextcloud)
* OVH [:page_facing_up:](https://rclone.org/swift/)
* OpenDrive [:page_facing_up:](https://rclone.org/opendrive/)
Update README.md
2019-02-07 17:58:25 +08:00
* OpenStack Swift [:page_facing_up:](https://rclone.org/swift/)
Improved and updated the readme Updated providers list, added links to docs, improved readability
2018-10-11 18:18:36 +08:00
* Oracle Cloud Storage [:page_facing_up:](https://rclone.org/swift/)
Add a native backend for oracle object storage - fixes #6299
2022-10-13 20:04:56 +08:00
* Oracle Object Storage [:page_facing_up:](https://rclone.org/oracleobjectstorage/)
Improved and updated the readme Updated providers list, added links to docs, improved readability
2018-10-11 18:18:36 +08:00
* ownCloud [:page_facing_up:](https://rclone.org/webdav/#owncloud)
* pCloud [:page_facing_up:](https://rclone.org/pcloud/)
pikpak: new backend Fixes #6429
2023-04-04 23:33:48 +08:00
* PikPak [:page_facing_up:](https://rclone.org/pikpak/)
premiumizeme: new backend for premiumize.me - Fixes #3063
2019-07-06 07:16:57 +08:00
* premiumize.me [:page_facing_up:](https://rclone.org/premiumizeme/)
putio: add new backend
2019-08-06 20:47:52 +08:00
* put.io [:page_facing_up:](https://rclone.org/putio/)
Improved and updated the readme Updated providers list, added links to docs, improved readability
2018-10-11 18:18:36 +08:00
* QingStor [:page_facing_up:](https://rclone.org/qingstor/)
s3: add Qiniu KODO to s3 provider list - fixes #6195
2022-10-13 22:49:22 +08:00
* Qiniu Cloud Object Storage (Kodo) [:page_facing_up:](https://rclone.org/s3/#qiniu)
Improved and updated the readme Updated providers list, added links to docs, improved readability
2018-10-11 18:18:36 +08:00
* Rackspace Cloud Files [:page_facing_up:](https://rclone.org/swift/)
s3: Add RackCorp object storage to providers
2021-11-09 19:46:58 +08:00
* RackCorp Object Storage [:page_facing_up:](https://rclone.org/s3/#RackCorp)
s3: Add Scaleway to s3 documentation
2019-02-02 01:09:57 +08:00
* Scaleway [:page_facing_up:](https://rclone.org/s3/#scaleway)
seafile: New backend for seafile server
2020-04-26 01:55:18 +08:00
* Seafile [:page_facing_up:](https://rclone.org/seafile/)
s3: Add SeaweedFS
2021-06-08 16:59:57 +08:00
* SeaweedFS [:page_facing_up:](https://rclone.org/s3/#seaweedfs)
Improved and updated the readme Updated providers list, added links to docs, improved readability
2018-10-11 18:18:36 +08:00
* SFTP [:page_facing_up:](https://rclone.org/sftp/)
smb: backend to support SMB - fixes #2042
2022-09-30 23:10:57 +08:00
* SMB / CIFS [:page_facing_up:](https://rclone.org/smb/)
s3: Add StackPath Object Storage Support
2020-01-31 07:21:24 +08:00
* StackPath [:page_facing_up:](https://rclone.org/s3/#stackpath)
storj: rename tardigrade backend to storj backend #5616 This adds an alias for backwards compatibility and leaves a stub documentation page to redirect people to the new documentation.
2022-02-05 01:58:04 +08:00
* Storj [:page_facing_up:](https://rclone.org/storj/)
sugarsync: new backend - fixes #622
2019-10-24 19:35:50 +08:00
* SugarSync [:page_facing_up:](https://rclone.org/sugarsync/)
docs: add Tencent COS to s3 provider list - fixes #4468 * add Tencent COS to s3 provider list. Co-authored-by: wjielai <wjielai@tencent.com>
2020-09-08 23:34:25 +08:00
* Tencent Cloud Object Storage (COS) [:page_facing_up:](https://rclone.org/s3/#tencent-cos)
Improved and updated the readme Updated providers list, added links to docs, improved readability
2018-10-11 18:18:36 +08:00
* Wasabi [:page_facing_up:](https://rclone.org/s3/#wasabi)
* WebDAV [:page_facing_up:](https://rclone.org/webdav/)
* Yandex Disk [:page_facing_up:](https://rclone.org/yandex/)
new backend: zoho workdrive - fixes #4533
2020-10-08 06:17:50 +08:00
* Zoho WorkDrive [:page_facing_up:](https://rclone.org/zoho/)
Improved and updated the readme Updated providers list, added links to docs, improved readability
2018-10-11 18:18:36 +08:00
* The local filesystem [:page_facing_up:](https://rclone.org/local/)
docs: improve grammar and fix typos (#5361) This alters some comments in source files, but is interested mainly in documentation files and help messages.
2021-11-04 19:50:43 +08:00
Added some more links for easier finding Expanded the Installation & Docs section with links to the website and added a link to the full list of storage providers and features.
2018-10-18 04:05:57 +08:00
Please see [the full list of all storage providers and their features](https://rclone.org/overview/)
Improved and updated the readme Updated providers list, added links to docs, improved readability
2018-10-11 18:18:36 +08:00
combine: backend to combine multiple remotes in one directory tree Fixes #5600
2022-04-21 00:57:43 +08:00
### Virtual storage providers
These backends adapt or modify other storage providers
* Alias: rename existing remotes [:page_facing_up:](https://rclone.org/alias/)
* Cache: cache remotes (DEPRECATED) [:page_facing_up:](https://rclone.org/cache/)
* Chunker: split large files [:page_facing_up:](https://rclone.org/chunker/)
* Combine: combine multiple remotes into a directory tree [:page_facing_up:](https://rclone.org/combine/)
* Compress: compress files [:page_facing_up:](https://rclone.org/compress/)
* Crypt: encrypt files [:page_facing_up:](https://rclone.org/crypt/)
* Hasher: hash files [:page_facing_up:](https://rclone.org/hasher/)
* Union: join multiple remotes to work together [:page_facing_up:](https://rclone.org/union/)
Improved and updated the readme Updated providers list, added links to docs, improved readability
2018-10-11 18:18:36 +08:00
## Features
Initial commit - some small parts working
2012-11-19 01:32:31 +08:00
Update README.md
2019-02-07 17:58:25 +08:00
* MD5/SHA-1 hashes checked at all times for file integrity
Update config
2014-03-16 01:39:56 +08:00
* Timestamps preserved on files
* Partial syncs supported on a whole file basis
Improved and updated the readme Updated providers list, added links to docs, improved readability
2018-10-11 18:18:36 +08:00
* [Copy](https://rclone.org/commands/rclone_copy/) mode to just copy new/changed files
* [Sync](https://rclone.org/commands/rclone_sync/) (one way) mode to make a directory identical
* [Check](https://rclone.org/commands/rclone_check/) mode to check for file hash equality
Update README.md
2019-02-07 17:58:25 +08:00
* Can sync to and from network, e.g. two different cloud accounts
docs: chunker documentation
2019-08-30 22:18:40 +08:00
* Optional large file chunking ([Chunker](https://rclone.org/chunker/))
compress: finish docs
2020-12-02 08:47:07 +08:00
* Optional transparent compression ([Compress](https://rclone.org/compress/))
Improved and updated the readme Updated providers list, added links to docs, improved readability
2018-10-11 18:18:36 +08:00
* Optional encryption ([Crypt](https://rclone.org/crypt/))
* Optional FUSE mount ([rclone mount](https://rclone.org/commands/rclone_mount/))
operations: enable multi threaded downloads - Fixes #2252 This implements the --multi-thread-cutoff and --multi-thread-streams flags to control multi thread downloading to the local backend.
2019-04-25 00:04:40 +08:00
* Multi-threaded downloads to local disk
docs: consistent capitalization of WebDAV, DLNA, HTTP
2022-06-20 00:59:54 +08:00
* Can [serve](https://rclone.org/commands/rclone_serve/) local or remote files over HTTP/WebDAV/FTP/SFTP/DLNA
drive: Rework token aquisition into config framework and store token in config file
2014-03-16 22:01:17 +08:00
Improved and updated the readme Updated providers list, added links to docs, improved readability
2018-10-11 18:18:36 +08:00
## Installation & documentation
Added some more links for easier finding Expanded the Installation & Docs section with links to the website and added a link to the full list of storage providers and features.
2018-10-18 04:05:57 +08:00
Please see the [rclone website](https://rclone.org/) for:
drive: Rework token aquisition into config framework and store token in config file
2014-03-16 22:01:17 +08:00
Added some more links for easier finding Expanded the Installation & Docs section with links to the website and added a link to the full list of storage providers and features.
2018-10-18 04:05:57 +08:00
* [Installation](https://rclone.org/install/)
* [Documentation & configuration](https://rclone.org/docs/)
* [Changelog](https://rclone.org/changelog/)
* [FAQ](https://rclone.org/faq/)
* [Storage providers](https://rclone.org/overview/)
* [Forum](https://forum.rclone.org/)
* ...and more
Initial commit - some small parts working
2012-11-19 01:32:31 +08:00
Improved and updated the readme Updated providers list, added links to docs, improved readability
2018-10-11 18:18:36 +08:00
## Downloads
* https://rclone.org/downloads/
Initial commit - some small parts working
2012-11-19 01:32:31 +08:00
License
-------
docs: fix typo in license webpage
2022-07-06 11:12:57 +08:00
This is free software under the terms of the MIT license (check the
readme: fix copying link
2018-12-25 20:49:22 +08:00
[COPYING file](/COPYING) included in this package).
Reference in New Issue Copy Permalink