Warning, /network/kio-s3/README.md is written in an unsupported language. File is not indexed.

0001 <!--
0002     SPDX-License-Identifier: CC0-1.0
0003     SPDX-FileCopyrightText: 2020 Elvis Angelaccio <elvis.angelaccio@kde.org>
0004 -->
0005 
0006 KIO S3
0007 ======
0008 
0009 A KIO worker for Amazon Simple Storage Service (Amazon S3): https://aws.amazon.com/s3/
0010 
0011 S3 is an object store. It has buckets and objects.
0012 Buckets contain objects, and objects are made of data (usually a file) and metadata (information about the data).
0013 
0014 BUILDING
0015 ========
0016 
0017 The Amazon AWS SDK for C++ is required to build this project: https://github.com/aws/aws-sdk-cpp
0018 In particular the `core` and `s3` SDK components are required.
0019 
0020 USAGE
0021 =====
0022 
0023 1. Configure AWS credentials and region: https://docs.aws.amazon.com/credref/latest/refdocs/overview.html
0024 2. Run `dolphin s3://`.
0025 
0026 The worker supports S3 URIs with the following format:
0027 
0028     s3://mybucket/mykey
0029 
0030 A valid S3 URI has the bucket name as `host` and the key as `path` of the URI.
0031 
0032 FEATURES
0033 ========
0034 
0035 - List S3 buckets and objects
0036 - Upload files and folders to a bucket
0037 - Delete objects from a bucket
0038 - Copy folders or objects within S3
0039 - Move or rename objects within S3
0040 
0041 
0042 KNOW ISSUES
0043 ===========
0044 
0045 - Moving or renaming a folder doesn't work, because folders don't exist in S3.
0046     - *Workaround*: copy the folder and then delete the original folder.
0047 - Since folders don't exist in S3, you can type any garbage URL in the Dolphin navigator bar and the worker will pretend that it's a empty folder.
0048     - *Workaround*: prefer folder browsing using the Dolphin views, instead of manually typing the URLs in the navigation bar.
0049 - Creating an empty folder is currently not supported.
0050     - *Workaround*: create it from the S3 web console.
0051 - Listing a folder with more than 1000 files is currently not supported.