https://github.com/zerodha/frappe-attachments-s3

A frappe app to upload file attachments in doctypes to s3.
https://github.com/zerodha/frappe-attachments-s3

Last synced: 3 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/zerodha/frappe-attachments-s3
• Owner: zerodha
• License: other
• Created: 2018-01-12T13:18:40.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2024-11-04T05:13:03.000Z (5 days ago)
• Last Synced: 2024-11-04T06:19:29.739Z (5 days ago)
• Language: Python
• Size: 61.5 KB
• Stars: 122
• Watchers: 8
• Forks: 140
• Open Issues: 26
• Metadata Files:
  • Readme: README.md
  • License: license.txt

Awesome Lists containing this project

• awesome-frappe - S3 Attachments - Plug an S3 bucket for storing and fetching files in Frappe. (Uncategorized / Uncategorized)

README

        


## 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/zerodhatech/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.

#### License

MIT