==========================================
Using Django storage system (Experimental)
==========================================

.. note::

   This function is experimental. The API may change frequently.

Django FTP Server supports the Django storage API.

With StorageFS, you can change the storage of the FTP server to various things.

Architecture
============

The following diagram shows how FTP client requests flow through the system when using Django Storage backends:

.. mermaid::

   sequenceDiagram
       participant Client as FTP Client
       participant FTPServer as FTP Server<br>(pyftpdlib)
       participant Authorizer as FTPAccountAuthorizer
       participant Django as Django Auth
       participant StorageFS as StorageFS
       participant Storage as Django Storage<br>(S3, GCS, etc.)

       Client->>FTPServer: Connect
       FTPServer->>Authorizer: validate_authentication()
       Authorizer->>Django: authenticate()
       Django-->>Authorizer: User
       Authorizer-->>FTPServer: OK
       FTPServer-->>Client: 230 Login successful

       Client->>FTPServer: LIST
       FTPServer->>StorageFS: listdir()
       StorageFS->>Storage: listdir()
       Storage-->>StorageFS: files
       StorageFS-->>FTPServer: file list
       FTPServer-->>Client: Directory listing

       Client->>FTPServer: RETR file.txt
       FTPServer->>StorageFS: open()
       StorageFS->>Storage: open()
       Storage-->>StorageFS: file object
       StorageFS-->>FTPServer: file data
       FTPServer-->>Client: File contents

Settings
========

Amazon S3
---------

Example configuration using django-storages::

   # Change FTP server filesystem
   FTPSERVER_FILESYSTEM = 'django_ftpserver.filesystems.StorageFS'

   # Using Amazon S3 storage (django-storages 1.14+)
   STORAGES = {
       "default": {
           "BACKEND": "storages.backends.s3.S3Storage",
           "OPTIONS": {
               "access_key": "(your access key id)",
               "secret_key": "(your secret access key)",
               "bucket_name": "your.storage.bucket",
           },
       },
   }

Google Cloud Storage
--------------------

Example configuration using django-storages::

   # Change FTP server filesystem
   FTPSERVER_FILESYSTEM = 'django_ftpserver.filesystems.StorageFS'

   # Using Google Cloud Storage (django-storages 1.14+)
   STORAGES = {
       "default": {
           "BACKEND": "storages.backends.gcloud.GoogleCloudStorage",
           "OPTIONS": {
               "bucket_name": "your-bucket-name",
               "project_id": "(your project id)",
           },
       },
   }