gcs

Google Cloud Storage (GCS) filesystem

This directory contains the Google Cloud Storage implementation for the FTP server using the official github.com/spf13/afero/gcsfs package.

Configuration

The GCS filesystem supports the following configuration parameters:

{
  "version": 1,
  "accesses": [
    {
      "user": "test",
      "pass": "test", 
      "fs": "gcs",
      "params": {
        "bucket": "your-gcs-bucket-name",
        "project_id": "your-project-id",
        "key_file": "/path/to/service-account-key.json"
      }
    }
  ]
}

Parameters

• bucket (required): The GCS bucket name to use
• project_id (optional): Google Cloud Project ID. If not provided, it will use the default project from the environment or service account
• key_file (optional): Path to a service account key JSON file for authentication. If not provided, it will use default credentials (environment variables, metadata service, etc.)

Authentication

The GCS filesystem supports multiple authentication methods:

1. Service Account Key File: Provide the key_file parameter pointing to a JSON service account key file
2. Default Credentials: If key_file is not provided, it will use Google Cloud's default credential chain:
   • Environment variable GOOGLE_APPLICATION_CREDENTIALS
   • User credentials from gcloud auth application-default login
   • Service account attached to the resource (when running on Google Cloud)

Example configurations

With service account key file:

{
  "fs": "gcs",
  "params": {
    "bucket": "my-ftp-bucket",
    "project_id": "my-project-123",
    "key_file": "/etc/gcs-key.json"
  }
}

With default credentials:

{
  "fs": "gcs", 
  "params": {
    "bucket": "my-ftp-bucket"
  }
}

Notes

• GCS doesn't have real directories, so directory operations are emulated
• File permissions and ownership operations are no-ops since GCS doesn't support them
• Seeking to end of file and some advanced file operations are not supported due to GCS limitations