S3 (Optional)
An optional addition here to add S3 or similiar object storage details.
Last updated
An optional addition here to add S3 or similiar object storage details.
Last updated
Utopia integrates with S3 or similar object storage services to enhance its functionality. This integration is particularly useful for two key features: maintenance archiving and API logging.
Choosing Your Setup:
Deciding whether to integrate S3 into your Utopia setup depends on your specific needs. The majority of Docker Utopia installs are for POC and Test purposes, and running maintenance to archive data is not necessary and you can opt to bypass this step for a simpler setup.
1. Maintenance Archiving:
What is it? Maintenance archiving is a process where Utopia automatically transfers older or less frequently accessed data from the main database to a dedicated storage space, known as a 'bucket' in S3 terminology. This helps in managing the database size effectively, ensuring that it doesn't become too large or unwieldy, while still preserving important data records.
How does it work? Utopia can be configured to perform these maintenance tasks on a schedule, known as a 'cron' schedule (a time-based job scheduler in Unix-like operating systems). This involves periodically clearing out system logs and certain data collections, and archiving them into an object storage bucket.
2. API Logging:
What is it? API logging is a feature that records activities and communications that occur with Utopia's Listeners (external API endpoints). These logs are essential for monitoring and debugging interactions with external services.
S3 Requirement: To enable and store these logs, the S3 setup needs to be completed. The logs are stored in a separate S3 bucket, making them easy to access and manage.
Configuring S3 Integration:
Checking the Option: On the configuration page, you'll find an option labeled "Will you be utilizing S3". If you plan to use the S3 features for archiving and logging, ensure this box is checked.
Entering S3 Details: Once checked, input fields will appear where you can enter your S3 details. This includes information such as your S3 access key, secret key, and the names of the buckets you wish to use for archiving and logging.
Bypassing S3 Features: If you choose not to use these S3 features, leave the option unchecked. Utopia will then bypass the maintenance archiving and API logging functions and configure itself accordingly.