s3_storage: Revolutionizing Data Storage

Direct, efficient, and secure S3 integration for seamless data management.
Explore the Docs · Report Bug · Request Feature

About s3_storage

s3_storage is a powerful S3 Storage Integration tool designed for Empress Cloud users seeking streamlined data management. This tool provides a direct connection to S3, eliminating middleware and ensuring efficient data migration and restoration between your site and S3.

Key Features

• Direct uploads to S3, bypassing middlewares for swift data transfer.
• Seamless migration of existing data from your site to S3.
• Efficient restoration of data from S3 back to your site.
• Capability to clean data from your site or S3.
• All backups, including database backups, are stored on S3.
• Usage Analytics (Coming Soon).

Technical Stack

s3_storage is powered by:

• Minio
• AWS S3

Getting Started

Prerequisites

• You need to be a Empress Cloud user.
• Install s3_storage from Empress Cloud Marketplace

Installation

1. Install s3_storage from the Empress Cloud Marketplace.
2. Post-installation, you will receive all the necessary keys via email. These keys allow access to all your resources stored on S3. Keep them secure.
3. Enter the keys in the provided doctype.

# Example of how to input your keys
<img width="1376" alt="Screenshot 2022-02-25 at 5 37 43 PM" src="https://user-images.githubusercontent.com/50401596/155713102-22415afd-6775-4034-89f5-d32583050e01.png">

Usage

Use the Storage Integration Backups page (accessible via the Awesomebar!) to take the latest backups. These backups will be stored on S3, and you can download them from the same page.

# Example of how to access your backups
<img width="1428" alt="Screenshot 2022-03-11 at 3 35 56 PM" src="https://user-images.githubusercontent.com/50401596/157846908-d635942c-343d-48a8-99ca-2f6dd1d647e6.png">

Contributing

We welcome and appreciate contributions! Here's how you can contribute:

1. Fork the Project on GitHub.
2. Create your Feature Branch (git checkout -b feature/AmazingFeature).
3. Commit your Changes (git commit -m 'Add some AmazingFeature').
4. Push to the Branch (git push origin feature/AmazingFeature).
5. Open a Pull Request.

License and Acknowledgements

License

This project is under the MIT License. Your contributions are also licensed under the MIT License.

Acknowledgements

Special thanks to the Empress Community for their continuous support and contributions to this project. We also express our gratitude to Minio and AWS S3 for powering our tool.