Work on documentation

Author: tgalopin

README.md

@@ -27,9 +27,17 @@ composer require league/flysystem-bundle
 ## Documentation
 
 1. [Getting started](https://github.com/thephpleague/flysystem-bundle/blob/master/docs/1-getting-started.md)
-2. [Caching](https://github.com/thephpleague/flysystem-bundle/blob/master/docs/2-caching.md)
-3. [Using the mount manager](https://github.com/thephpleague/flysystem-bundle/blob/master/docs/3-using-mount-manager.md)
-4. [Configuration reference](https://github.com/thephpleague/flysystem-bundle/blob/master/docs/4-configuration-reference.md)
+2. Cloud storage providers:
+   [Azure](https://github.com/thephpleague/flysystem-bundle/blob/master/docs/2-cloud-storage-providers.md#azure),
+   [AWS S3](https://github.com/thephpleague/flysystem-bundle/blob/master/docs/2-cloud-storage-providers.md#aws),
+   [DigitalOcean Spaces](https://github.com/thephpleague/flysystem-bundle/blob/master/docs/2-cloud-storage-providers.md#digitalocean-spaces),
+   [Scaleway Object Storage](https://github.com/thephpleague/flysystem-bundle/blob/master/docs/2-cloud-storage-providers.md#scaleway-object-storage),
+   [Google Cloud Storage](https://github.com/thephpleague/flysystem-bundle/blob/master/docs/2-cloud-storage-providers.md#google-cloud-storage),
+   [Rackspace](https://github.com/thephpleague/flysystem-bundle/blob/master/docs/2-cloud-storage-providers.md#rackspace),
+   [WebDAV](https://github.com/thephpleague/flysystem-bundle/blob/master/docs/2-cloud-storage-providers.md#webdav)
+3. [Interacting with FTP and SFTP servers](https://github.com/thephpleague/flysystem-bundle/blob/master/docs/3-interacting-with-ftp-and-sftp-servers.md)
+4. [Caching metadata in Symfony cache](https://github.com/thephpleague/flysystem-bundle/blob/master/docs/4-caching-metadata-in-symfony-cache.md)
+5. [Configuration reference](https://github.com/thephpleague/flysystem-bundle/blob/master/docs/5-configuration-reference.md)
 
 ## Security Issues
 

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

@@ -0,0 +1,58 @@
+# Interacting with FTP and SFTP servers
+
+Flysystem is able to interact using the same FilesystemInterface with FTP and SFTP servers.
+To configure this bundle for this usage, you can rely on adapters in the same way you would
+for other storages.
+
+## FTP
+
+### Installation
+
+The FTP adapter is shipped natively by Flysystem and does not need to be installed.
+
+### Usage
+
+```yaml
+# config/packages/flysystem.yaml
+
+flysystem:
+    storages:
+        backup.storage:
+            adapter: 'ftp'
+            options:
+                host: 'ftp.example.com'
+                username: 'username'
+                password: 'password'
+                port: 21
+                root: '/path/to/root'
+                passive: true
+                ssl: true
+                timeout: 30
+```
+
+## SFTP
+
+### Installation
+
+```
+composer require league/flysystem-sftp
+```
+
+### Usage
+
+```yaml
+# config/packages/flysystem.yaml
+
+flysystem:
+    storages:
+        backup.storage:
+            adapter: 'sftp'
+            options:
+                host: 'example.com'
+                port: 22
+                username: 'username'
+                password: 'password'
+                private_key: 'path/to/or/contents/of/privatekey'
+                root: '/path/to/root'
+                timeout: 10
+```

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

@@ -0,0 +1 @@
+# Caching metadata in Symfony cache

docs/4-configuration-reference.md

@@ -0,0 +1,109 @@
+# Configuration reference
+
+```yaml
+flysystem:
+    storages:
+        users1.storage:
+            adapter: 'aws'
+            options:
+                client: 'aws_client_service'
+                bucket: 'bucket_name'
+                prefix: 'optional/path/prefix'
+
+        users2.storage:
+            adapter: 'azure'
+            options:
+                client: 'azure_client_service'
+                container: 'container_name'
+                prefix: 'optional/path/prefix'
+
+        users3.storage:
+            adapter: 'cache'
+            options:
+                store: 'cache.app'
+                source: 'fs_local'
+
+        users4.storage:
+            adapter: 'custom_adapter'
+
+        users5.storage:
+            adapter: 'dropbox'
+            options:
+                client: 'dropbox_client_service'
+                prefix: 'optional/path/prefix'
+
+        users6.storage:
+            adapter: 'ftp'
+            options:
+                host: 'ftp.example.com'
+                username: 'username'
+                password: 'password'
+                port: 21
+                root: '/path/to/root'
+                passive: true
+                ssl: true
+                timeout: 30
+
+        users7.storage:
+            adapter: 'gcloud'
+            options:
+                client: 'gcloud_client_service'
+                bucket: 'bucket_name'
+                prefix: 'optional/path/prefix'
+                api_url: 'https://storage.googleapis.com'
+
+        users8.storage:
+            adapter: 'local'
+            options:
+                directory: '%kernel.project_dir%/storage'
+                lock: 0
+                skip_links: false
+                permissions:
+                    file:
+                        public: 0744
+                        private: 0700
+                    dir:
+                        public: 0755
+                        private: 0700
+
+        users9.storage:
+            adapter: 'memory'
+
+        users10.storage:
+            adapter: 'null'
+
+        users11.storage:
+            adapter: 'rackspace'
+            options:
+                container: 'rackspace_container_service'
+                prefix: 'optional/path/prefix'
+
+        users12.storage:
+            adapter: 'replicate'
+            options:
+                source: 'fs_aws'
+                replica: 'fs_local'
+
+        users13.storage:
+            adapter: 'sftp'
+            options:
+                host: 'example.com'
+                port: 22
+                username: 'username'
+                password: 'password'
+                private_key: 'path/to/or/contents/of/privatekey'
+                root: '/path/to/root'
+                timeout: 10
+
+        users14.storage:
+            adapter: 'webdav'
+            options:
+                client: 'webdav_client_service'
+                prefix: 'optional/path/prefix'
+                use_stream_copy: false
+
+        users15.storage:
+            adapter: 'zip'
+            options:
+                path: '%kernel.project_dir%/archive.zip'
+```