/frappe-attachments-s3

A frappe app to upload file attachments in doctypes to s3.

Primary LanguagePythonOtherNOASSERTION

Frappe S3 Attachment

Frappe app to make file upload automatically upload and read from s3.

Features.

  1. Upload both public and private files to s3.
  2. Stream files from S3, when file is viewed everytime.
  3. Lets you add S3 credentials (aws key, aws secret, bucket name, folder name) through ui and migrate existing files.
  4. Deletes from s3 whenever a file is deleted in ui.
  5. Files are uploaded categorically in the format. {s3_folder_path}/{year}/{month}/{day}/{doctype}/{file_hash}

Installation.

  1. bench get-app https://github.com/vijendra-tacten/frappe-attachments-s3.git
  2. bench install-app frappe_s3_attachment

Configuration Setup.

  1. Open single doctype "s3 File Attachment"
  2. Enter (Bucket Name, AWS key, AWS secret, S3 bucket Region name, Folder Name) Folder Name- folder name is the default folder path in s3.
  3. Migrate existing files lets all the existing files in private and public folders to be migrated to s3.
  4. Delete From Cloud when selected deletes the file form s3 bucket whenever a file is deleted from ui. By default the Delete from cloud will be unchecked.
S3 Configuration
  1. Permission Overview (Based on requirements)

When createing the bucket make sure that ACL is enabled Objects can be public

The bucket is not public but anyone with appropriate permissions can grant public access to objects.

  1. Block public access (bucket settings)

    • Block all public Access - Off
      • Block public access to buckets and objects granted through new access control lists (ACLs) - Off
      • Block public access to buckets and objects granted through any access control lists (ACLs) - Off
      • Block public access to buckets and objects granted through any access control lists (ACLs) - Off
      • Block public and cross-account access to buckets and objects through any public bucket or access point policies - Off

  2. Bucket policy

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "AddCannedAcl",
            "Effect": "Allow",
            "Principal": {
                "AWS": "arn:aws:iam::<xyz>:user/<S3_USERNAME>"
            },
            "Action": [
                "s3:PutObject",
                "s3:PutObjectAcl"
            ],
            "Resource": "arn:aws:s3:::<BUCKET_NAME>/*",
            "Condition": {
                "StringEquals": {
                    "s3:x-amz-acl": "public-read"
                }
            }
        }
    ]
}

License

MIT