Skip to content

Commit 8921dd0

Browse files
committed
Strip and change docs where needed
1 parent 8880840 commit 8921dd0

3 files changed

Lines changed: 13 additions & 172 deletions

File tree

docs/2-cloud-storage-providers.md

Lines changed: 0 additions & 118 deletions
Original file line numberDiff line numberDiff line change
@@ -4,37 +4,10 @@ One of the core feature of Flysystem is its ability to interact easily with remo
44
including many cloud storage providers. This bundle provides the same level of support for these
55
cloud providers by providing corresponding adapters in the configuration.
66

7-
* [Azure](#azure)
87
* [AsyncAws S3](#asyncaws-s3)
98
* [AWS S3](#aws-s3)
109
* [DigitalOcean Spaces](#digitalocean-spaces)
1110
* [Scaleway Object Storage](#scaleway-object-storage)
12-
* [Google Cloud Storage](#google-cloud-storage)
13-
* [Rackspace](#rackspace)
14-
* [WebDAV](#webdav)
15-
16-
## Azure
17-
18-
### Installation
19-
20-
```
21-
composer require league/flysystem-azure-blob-storage
22-
```
23-
24-
### Usage
25-
26-
```yaml
27-
# config/packages/flysystem.yaml
28-
29-
flysystem:
30-
storages:
31-
users.storage:
32-
adapter: 'azure'
33-
options:
34-
client: 'azure_client_service' # The service ID of the MicrosoftAzure\Storage\Blob\BlobRestProxy instance
35-
container: 'container_name'
36-
prefix: 'optional/path/prefix'
37-
```
3811

3912
## AsyncAws S3
4013

@@ -93,97 +66,6 @@ as for a AWS storage.
9366
The Scaleway Object Storage is compatible with the AWS S3 API, meaning that you can use the same configuration
9467
as for a AWS storage.
9568
96-
## Dropbox
97-
98-
### Installation
99-
100-
```
101-
composer require spatie/flysystem-dropbox
102-
```
103-
104-
### Usage
105-
106-
```yaml
107-
# config/packages/flysystem.yaml
108-
109-
flysystem:
110-
storages:
111-
users.storage:
112-
adapter: 'dropbox'
113-
options:
114-
client: 'dropbox_client_service' # The service ID of the Spatie\Dropbox\Client instance
115-
prefix: 'optional/path/prefix'
116-
```
117-
118-
## Google Cloud Storage
119-
120-
### Installation
121-
122-
```
123-
composer require superbalist/flysystem-google-storage
124-
```
125-
126-
### Usage
127-
128-
```yaml
129-
# config/packages/flysystem.yaml
130-
131-
flysystem:
132-
storages:
133-
users.storage:
134-
adapter: 'gcloud'
135-
options:
136-
client: 'gcloud_client_service' # The service ID of the Google\Cloud\Storage\StorageClient instance
137-
bucket: 'bucket_name'
138-
prefix: 'optional/path/prefix'
139-
api_url: 'https://storage.googleapis.com'
140-
```
141-
142-
## Rackspace
143-
144-
### Installation
145-
146-
```
147-
composer require league/flysystem-rackspace
148-
```
149-
150-
### Usage
151-
152-
```yaml
153-
# config/packages/flysystem.yaml
154-
155-
flysystem:
156-
storages:
157-
users.storage:
158-
adapter: 'rackspace'
159-
options:
160-
container: 'rackspace_container_service' # The service ID of the OpenCloud\ObjectStore\Resource\Container instance
161-
prefix: 'optional/path/prefix'
162-
```
163-
164-
## WebDAV
165-
166-
### Installation
167-
168-
```
169-
composer require league/flysystem-webdav
170-
```
171-
172-
### Usage
173-
174-
```yaml
175-
# config/packages/flysystem.yaml
176-
177-
flysystem:
178-
storages:
179-
users.storage:
180-
adapter: 'webdav'
181-
options:
182-
client: 'webdav_client_service' # The service ID of the Sabre\DAV\Client instance
183-
prefix: 'optional/path/prefix'
184-
use_stream_copy: false
185-
```
186-
18769
## Next
18870
18971
[Interacting with FTP and SFTP servers](https://github.com/thephpleague/flysystem-bundle/blob/master/docs/3-interacting-with-ftp-and-sftp-servers.md)

docs/4-caching-metadata-in-symfony-cache.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,23 @@ involves an additional overhead on top of the classical slowness of I/O.
1010
When your application needs to scale, you may need to cache metadata in order to
1111
improve performances on this level. To do this, you can use the `cache` adapter.
1212

13-
> *Note:* this adapter caches anything but the file content. This keeps the cache
13+
> *Note:* this adapter caches just the metadata of existing files. This keeps the cache
1414
> small enough to be beneficial and covers all the file system inspection operations.
1515
16+
> *Note:* Earlier versions used different cache driver that was memory heave on systems
17+
> with large number of files. This version suggests lighter version that caches just
18+
> files metadata.
19+
1620
### Installation
1721

1822
```
19-
composer require league/flysystem-cached-adapter
23+
composer require lustmored/flysystem-v2-simple-cache-adapter
2024
```
2125

2226
### Usage
2327

2428
The cache adapter works using a source storage (from which it will read the uncached data)
25-
and a [Symfony cache pool](https://symfony.com/doc/current/reference/configuration/framework.html#pools).
29+
and any [PSR-6 cache item pool interface](https://www.php-fig.org/psr/psr-6/).
2630

2731
Most of the time you are only going to need one of two possibilities:
2832

docs/B-configuration-reference.md

Lines changed: 6 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -11,28 +11,15 @@ flysystem:
1111
prefix: 'optional/path/prefix'
1212

1313
users2.storage:
14-
adapter: 'azure'
15-
options:
16-
client: 'azure_client_service'
17-
container: 'container_name'
18-
prefix: 'optional/path/prefix'
19-
20-
users3.storage:
2114
adapter: 'cache'
2215
options:
2316
store: 'cache.app'
2417
source: 'fs_local'
2518

26-
users4.storage:
19+
users3.storage:
2720
adapter: 'custom_adapter'
2821

29-
users5.storage:
30-
adapter: 'dropbox'
31-
options:
32-
client: 'dropbox_client_service'
33-
prefix: 'optional/path/prefix'
34-
35-
users6.storage:
22+
users4.storage:
3623
adapter: 'ftp'
3724
options:
3825
host: 'ftp.example.com'
@@ -45,15 +32,7 @@ flysystem:
4532
timeout: 30
4633
ignore_passive_address: ~
4734

48-
users7.storage:
49-
adapter: 'gcloud'
50-
options:
51-
client: 'gcloud_client_service'
52-
bucket: 'bucket_name'
53-
prefix: 'optional/path/prefix'
54-
api_url: 'https://storage.googleapis.com'
55-
56-
users8.storage:
35+
users5.storage:
5736
adapter: 'local'
5837
options:
5938
directory: '%kernel.project_dir%/storage'
@@ -67,25 +46,13 @@ flysystem:
6746
public: 0755
6847
private: 0700
6948

70-
users9.storage:
49+
users6.storage:
7150
adapter: 'memory'
7251

73-
users10.storage:
52+
users7.storage:
7453
adapter: 'null'
7554

76-
users11.storage:
77-
adapter: 'rackspace'
78-
options:
79-
container: 'rackspace_container_service'
80-
prefix: 'optional/path/prefix'
81-
82-
users12.storage:
83-
adapter: 'replicate'
84-
options:
85-
source: 'fs_aws'
86-
replica: 'fs_local'
87-
88-
users13.storage:
55+
users8.storage:
8956
adapter: 'sftp'
9057
options:
9158
host: 'example.com'
@@ -95,16 +62,4 @@ flysystem:
9562
privateKey: 'path/to/or/contents/of/privatekey'
9663
root: '/path/to/root'
9764
timeout: 10
98-
99-
users14.storage:
100-
adapter: 'webdav'
101-
options:
102-
client: 'webdav_client_service'
103-
prefix: 'optional/path/prefix'
104-
use_stream_copy: false
105-
106-
users15.storage:
107-
adapter: 'zip'
108-
options:
109-
path: '%kernel.project_dir%/archive.zip'
11065
```

0 commit comments

Comments
 (0)