Skip to content

Commit b00803d

Browse files
committed
Update docs for 2.0
1 parent daf3edc commit b00803d

5 files changed

Lines changed: 64 additions & 22 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
# flysystem-bundle
22

3-
[![Build Status](https://travis-ci.org/thephpleague/flysystem-bundle.svg?branch=master)](https://travis-ci.org/thephpleague/flysystem-bundle)
43
[![Packagist Version](https://img.shields.io/packagist/v/league/flysystem-bundle.svg?style=flat-square)](https://packagist.org/packages/league/flysystem-bundle)
54
[![Software license](https://img.shields.io/github/license/thephpleague/flysystem-bundle.svg?style=flat-square)](https://github.com/thephpleague/flysystem-bundle/blob/master/LICENSE)
65

@@ -14,6 +13,7 @@ on the execution environment (local files in development, cloud storage in produ
1413

1514
> Note: you are reading the documentation for flysystem-bundle 2.0, which relies on Flysystem 2.X.
1615
> If you use Flysystem 1.X, use [flysystem-bundle 1.X](https://github.com/thephpleague/flysystem-bundle/tree/1.x).
16+
> Read the [Upgrade guide](https://github.com/thephpleague/flysystem-bundle/blob/master/UPGRADE.md) to learn how to upgrade.
1717
1818
## Installation
1919

UPGRADE.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Upgrading from 1.0 to 2.0
22

3-
flysystem-bundle 2.0 introduces Backward Compatibility breaks, meaning you will need to update
3+
flysystem-bundle 2.0 introduces backward incompatible changes, meaning you will need to update
44
the code of your projects to upgrade.
55

66
flysystem-bundle 2.0 relies on Flysystem 2.0, which introduced most of the backward incompatible
@@ -9,9 +9,9 @@ changes. You should read
99

1010
In addition to the library updates, the bundle also changed a bit:
1111

12-
* Following the drop of support for several Cloud providers in Flysystem itself, the bundle no longer
13-
natively supports Azure, Dropbox, Rackspace and WebDAV. If the need arise for community adapters to be
14-
ported to Flysystem 2 and flysystem-bundle 2, we could add them again.
15-
* Following their removal from the main library, null, cache, zip and replicate adapters were removed
16-
from the bundle as well.
17-
* Following the drop of support for plugins in the main library, the bundle does not support them anymore.
12+
* Add official support for PHP 8 ;
13+
* Migration to AsyncAWS 1.0 ;
14+
* Drop support for PHP 7.1 ;
15+
* Drop support for Azure, Dropbox, Rackspace and WebDAV adapters (following the main library) ;
16+
* Drop support for null, cache, zip and replicate adapters (following the main library) ;
17+
* Drop support for plugins ;

docs/2-cloud-storage-providers.md

Lines changed: 52 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ including many cloud storage providers. This bundle provides the same level of s
55
cloud providers by providing corresponding adapters in the configuration.
66

77
* [AsyncAws S3](#asyncaws-s3)
8-
* [AWS S3](#aws-s3)
8+
* [AWS S3](#aws-sdk-s3)
99
* [DigitalOcean Spaces](#digitalocean-spaces)
1010
* [Scaleway Object Storage](#scaleway-object-storage)
1111
* [Google Cloud Storage](#google-cloud-storage)
@@ -15,7 +15,7 @@ cloud providers by providing corresponding adapters in the configuration.
1515
### Installation
1616

1717
```
18-
composer require async-aws/flysystem-s3
18+
composer require league/flysystem-async-aws-s3
1919
```
2020

2121
### Usage
@@ -57,16 +57,6 @@ flysystem:
5757
prefix: 'optional/path/prefix'
5858
```
5959
60-
## DigitalOcean Spaces
61-
62-
The DigitalOcean Spaces are compatible with the AWS S3 API, meaning that you can use the same configuration
63-
as for a AWS storage.
64-
65-
## Scaleway Object Storage
66-
67-
The Scaleway Object Storage is compatible with the AWS S3 API, meaning that you can use the same configuration
68-
as for a AWS storage.
69-
7060
## Google Cloud Storage
7161
7262
### Installation
@@ -90,6 +80,56 @@ flysystem:
9080
prefix: 'optional/path/prefix'
9181
```
9282
83+
## DigitalOcean Spaces
84+
85+
The DigitalOcean Spaces are compatible with the AWS S3 API, meaning that you can use the same configuration
86+
as for a AWS storage. For example:
87+
88+
```yaml
89+
# config/packages/flysystem.yaml
90+
91+
services:
92+
digitalocean_spaces_client:
93+
class: 'AsyncAws\S3\S3Client'
94+
arguments:
95+
- endpoint: '%env(DIGITALOCEAN_SPACES_ENDPOINT)%'
96+
accessKeyId: '%env(DIGITALOCEAN_SPACES_ID)%'
97+
accessKeySecret: '%env(DIGITALOCEAN_SPACES_SECRET)%'
98+
99+
flysystem:
100+
storages:
101+
cdn.storage:
102+
adapter: 'asyncaws'
103+
options:
104+
client: 'digitalocean_spaces_client'
105+
bucket: '%env(DIGITALOCEAN_SPACES_BUCKET)%'
106+
```
107+
108+
## Scaleway Object Storage
109+
110+
The Scaleway Object Storage is compatible with the AWS S3 API, meaning that you can use the same configuration
111+
as for a AWS storage. For example:
112+
113+
```yaml
114+
# config/packages/flysystem.yaml
115+
116+
services:
117+
scaleway_spaces_client:
118+
class: 'AsyncAws\S3\S3Client'
119+
arguments:
120+
- endpoint: '%env(SCALEWAY_SPACES_ENDPOINT)%'
121+
accessKeyId: '%env(SCALEWAY_SPACES_ID)%'
122+
accessKeySecret: '%env(SCALEWAY_SPACES_SECRET)%'
123+
124+
flysystem:
125+
storages:
126+
cdn.storage:
127+
adapter: 'asyncaws'
128+
options:
129+
client: 'scaleway_spaces_client'
130+
bucket: '%env(SCALEWAY_SPACES_BUCKET)%'
131+
```
132+
93133
## Next
94134
95135
[Interacting with FTP and SFTP servers](https://github.com/thephpleague/flysystem-bundle/blob/master/docs/3-interacting-with-ftp-and-sftp-servers.md)

docs/3-interacting-with-ftp-and-sftp-servers.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@ for other storages.
88

99
### Installation
1010

11-
The FTP adapter is shipped natively by Flysystem and does not need to be installed.
11+
```
12+
composer require league/flysystem-ftp
13+
```
1214

1315
### Usage
1416

docs/5-creating-a-custom-adapter.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Creating a custom adapter
22

3-
[Read the associated library documentation](https://flysystem.thephpleague.com/docs/advanced/creating-an-adapter/)
3+
[Read the associated library documentation](https://flysystem.thephpleague.com/v2/docs/advanced/creating-an-adapter/)
44

55
If you have highly specific requirements, you may need to create your own
66
Flysystem adapter. To do so, you first need to create the adapter code itself

0 commit comments

Comments
 (0)