Amazon S3 / MinIO Odoo Integration
by faOtools https://faotools.com/apps/19.0/amazon-s3-minio-odoo-integration-19-0-amazon-s3-odoo-1106$ 565.26
| Availability |
Odoo Online
Odoo.sh
On Premise
|
| Odoo Apps Dependencies |
Discuss (mail)
|
| Community Apps Dependencies | Show |
| Lines of code | 10655 |
| Technical Name |
amazon_s3_odoo |
| License | See License tab |
| Website | https://faotools.com/apps/19.0/amazon-s3-minio-odoo-integration-19-0-amazon-s3-odoo-1106 |
| Versions | 17.0 18.0 19.0 |
| Availability |
Odoo Online
Odoo.sh
On Premise
|
| Odoo Apps Dependencies |
Discuss (mail)
|
| Community Apps Dependencies | Show |
| Lines of code | 10655 |
| Technical Name |
amazon_s3_odoo |
| License | See License tab |
| Website | https://faotools.com/apps/19.0/amazon-s3-minio-odoo-integration-19-0-amazon-s3-odoo-1106 |
| Versions | 17.0 18.0 19.0 |
This is the tool to integrate Amazon S3 or/and MinIO features with Odoo folders and files. The app automatically stores Odoo attachments and directories in an Amazon/MinIO S3 bucket and provides access to synced objects through presigned or public web links.
Automatic folders' structure
Decide which Odoo document types should have their own folders trees and synchronize those to Amazon/MinIO S3
Automatic regular sync
Rely on auto-synchronization between Odoo and Amazon S3/MinIO S3 based on scheduled jobs. No manual interaction is required
Bilateral sync
Odoo sends attachments to Amazon/MinIO S3 and retrieves files from there. Binary content is kept in the bucket, while Odoo provides direct access to synced objects
Cloud synchronization history
Control Amazon S3//MinIO S3 sync logs right in Odoo. Export and share those in case of any issues. Be notified of any client disconnections
File manager interface
Manage synced folders and attachments from a single Odoo view. Navigate by directories, search and download files, upload and move attachments to folders
Attachment box
Organize files of any Odoo object in a set of subfolders. Instantly access folders and files in the attachment box and in Amazon S3
How synchronization works
Automatic two-sided sync
-
Configure sync for one or multiple Amazon S3 / MinIO S3 buckets or S3-compatible endpoints
-
Synchronization is bilateral. Updates in Odoo are reflected in Amazon S3 / MinIO S3 (direct sync); changes in Amazon S3 / MinIO S3 modify Odoo folders and attachments (backward sync)
-
Cloud connection with Amazon S3 / MinIO S3 might be reset. In this way, the app assumes getting all synced items back to Odoo (reverse sync)
Queue-based synchronization
-
Once in 15 minutes, the app examines updates in Odoo and Amazon S3 / MinIO S3 to prepare a synchronization queue
-
The connector lists the whole S3 root prefix to track virtual folders and object keys in a stable way during each sync run
-
If the app faces sync failures, it will retry operations afterward. Sync queue processing would not be stopped if there are items not blocked by such failures
Odoo attachments for Amazon S3 / MinIO S3: direct sync
-
Direct sync prepares the virtual folders hierarchy and uploads Odoo attachments to Amazon S3 / MinIO S3
-
Since S3 has no native folders, the app creates empty marker objects to keep empty Odoo directories visible
-
Renaming or moving S3 objects is implemented as copy and delete, following Amazon S3 / MinIO S3 mechanics
Amazon S3 objects for Odoo: backward sync
-
Backward sync checks whether any objects or sub-prefixes are added to Amazon S3 / MinIO S3 folders. If so, the app creates URL attachments or subdirectories inside linked Odoo directories
-
External S3 renames are treated according to S3 nature: old key removed and new key created. Odoo will converge by deleting and recreating the related attachment if required
-
In case of conflicts, direct sync changes are in general considered more important than backward updates
Amazon S3 URLs
Amazon S3 has a specific way to open existing objects. This connector always keeps links on the Amazon S3 side, not as local Odoo download links.
If Use Public URLs is enabled, Odoo saves direct S3 object URLs. Those links work only when the related bucket, prefix, object, CDN, or compatible storage endpoint is publicly accessible.
If Use Public URLs is disabled, Odoo saves AWS Console links to the related bucket object or prefix. Those links are intended for Amazon users: a person opening such a link must be logged in to AWS and must have enough IAM permissions to view the bucket object. If the user has no AWS access, Amazon will not open the file.
The tool depends on the external library 'boto3'. Install this library for your Odoo server through the command:
pip3 install boto3- Turn on the option 'Amazon S3 Sync' (Cloud Storage > Configuration > Configuration). The optional add-on Amazon S3 Odoo Integration is required
- Open the Amazon S3 Console: https://console.aws.amazon.com/s3/
- Create a new bucket or choose an existing one. Copy the exact bucket name: it should be inserted in Odoo into the field 'Bucket'
- Open the bucket details and copy its AWS Region. Insert it in Odoo into the field 'Region' (for example, eu-west-1 or us-east-1)
- Open the AWS IAM Console: https://console.aws.amazon.com/iam/
- Create a new IAM user or choose an existing technical user. This user should have full rights to list, read, create, write, copy, and delete objects within the selected bucket. You can select the full right admin, or create a new policy (see below)
- In the IAM user form, open the tab 'Security credentials' and press 'Create access key'
- On the page 'Access key best practices & alternatives', select the option Application running outside AWS. This is the correct option when your Odoo server connects to S3 by access key from outside AWS, from Odoo.sh, from your own server, or from another hosting provider. If your Odoo is installed on an AWS EC2 instance, you may instead select Application running on an AWS compute service, but the fields copied to Odoo are the same
- Press 'Next'. On the next step, optionally enter a description tag such as Odoo S3 Sync, then press 'Create access key'
- On the final AWS page, copy Access key or Access key ID into the Odoo field 'Access Key'
- Copy Secret access key into the Odoo field 'Secret Key'. Important: AWS shows the secret key only once, so save it before closing the window
- If you use an S3-compatible provider instead of AWS S3, copy the endpoint URL from that provider's admin panel and insert it into Odoo into the field 'Amazon S3 endpoint URL'. For example, MinIO often uses a URL like https://minio.example.com or http://localhost:9000; LocalStack commonly uses http://localhost:4566
- Go to Odoo Cloud Storage > Configuration > Cloud Clients and press 'Create'
- As a reference, introduce any name which would be clear to all users
- As a Cloud client, choose 'Amazon S3'
- As a Root folder name, enter a title that will be used as the parent S3 prefix for all synced folders. For example, 'Odoo' or 'OdooERP'
- Fill in the fields 'Bucket', 'Region', 'Access Key', 'Secret Key', and, if needed, 'Amazon S3 endpoint URL' and addressing style
- Choose whether Odoo should use temporary presigned URLs or public bucket/CDN URLs. For private buckets, keep presigned URLs enabled and set their lifetime in seconds
- Press 'Confirm'. Odoo checks bucket access and creates or verifies the root folder prefix. Amazon S3 - Odoo synchronization is ready to be done
- Apply the newly created cloud client to folder rules and/or manual folders which should be synced to that Amazon S3 bucket
- Await the sync scheduled job to be started. For testing purposes only: trigger integration manually from Cloud Storage > Configuration > Configuration > the button 'Launch sync'.
Useful AWS documentation: creating an S3 bucket, managing IAM access keys.
Bucket policy example
{
"Version": "2012-10-17",
"Statement": [
{
"Sid": "ListObjectsInBucket",
"Effect": "Allow",
"Action": [
"s3:ListBucket"
],
"Resource": "arn:aws:s3:::NAME_OF_YOUR_BUCKET"
},
{
"Sid": "AllObjectActions",
"Effect": "Allow",
"Action": [
"s3:GetObject",
"s3:PutObject",
"s3:DeleteObject"
],
"Resource": "arn:aws:s3:::NAME_OF_YOUR_BUCKET/*"
}
]
}
Create a new AWS IAM user
Specify the IAM user name
Attach permission policies directly
Amazon S3 bucket policy JSON example
Review and name the S3 policy
Select the bucket policy for the user
Review and create the IAM user
Create an access key for the user
Choose the access key use case
Set the access key description tag
Retrieve the access key and secret
Configure the Amazon S3 client in Odoo
Amazon S3 has an important peculiarity: the URL shown in Odoo is always an Amazon-side link.
If Use Public URLs is enabled, Odoo saves a direct S3 object URL. This link works only if the related S3 bucket, prefix, object, CDN, or compatible endpoint is publicly readable. Otherwise, Amazon S3 will show AccessDenied, even if the user is logged in to the AWS console.
For public links, configure the bucket permissions in Amazon S3 and allow public read access for the Odoo prefix. Example bucket policy:
{
"Version": "2012-10-17",
"Statement": [
{
"Sid": "PublicReadOdooPrefix",
"Effect": "Allow",
"Principal": "*",
"Action": "s3:GetObject",
"Resource": "arn:aws:s3:::YOUR_BUCKET_NAME/Odoo/*"
}
]
}
Replace YOUR_BUCKET_NAME with the real bucket name and Odoo/ with the selected root folder prefix. Also make sure that Amazon S3 Block public access settings do not block that bucket policy.
If Use Public URLs is disabled, Odoo saves AWS Console links to the related bucket object or prefix. Such links are useful for Amazon users: the person opening the link must be logged in to AWS and must have IAM access to that bucket object. If the user has no AWS access, Amazon will not open the file.
- Prepare a running MinIO server
- Open the MinIO Console
- Create a new bucket or choose an existing one. Copy the exact bucket name: it should be inserted in Odoo into the field 'Bucket'
- Create access credentials for Odoo. In MinIO, use an access key / secret key pair or a service account that has rights to list, read, create, write, copy, and delete objects within the selected bucket
- Copy the MinIO Access Key into the Odoo field 'Access Key'
- Copy the MinIO Secret Key into the Odoo field 'Secret Key'. Important: save the secret before closing the MinIO page if MinIO shows it only once
- Copy the MinIO S3 API endpoint URL into Odoo into the field 'Amazon S3 endpoint URL'. For example, a local server usually uses http://localhost:9000, while a production server may use https://minio.example.com
- Go to Odoo Cloud Storage > Configuration > Cloud Clients and press 'Create'
- As a reference, introduce any name which would be clear to all users
- As a Cloud client, choose 'MinIO'
- As a Root folder name, enter a title that will be used as the parent MinIO object prefix for all synced folders. For example, 'Odoo' or 'OdooERP'
- Fill in the fields 'Bucket', 'Access Key', 'Secret Key', and 'Amazon S3 endpoint URL'. The field 'Region' is optional for MinIO; if it is empty, Odoo uses us-east-1 for S3-compatible signing
- Keep the addressing style as Path-style. This is the recommended option for MinIO endpoints, especially when the MinIO host does not provide bucket-specific DNS names
- Choose whether Odoo should use direct public MinIO URLs. Enable 'Use Public URLs' only when the bucket, prefix, reverse proxy, or CDN is publicly readable. For private MinIO buckets, leave it disabled
- Press 'Confirm'. Odoo checks bucket access and creates or verifies the root folder prefix. MinIO - Odoo synchronization is ready to be done
- Apply the newly created cloud client to folder rules and/or manual folders which should be synced to that MinIO bucket
- Await the sync scheduled job to be started. For testing purposes only: trigger integration manually from Cloud Storage > Configuration > Configuration > the button 'Launch sync'.
Useful MinIO documentation: https://min.io/docs/minio/linux/administration/identity-access-management.html, https://min.io/docs/minio/linux/reference/minio-server/minio-server.html.
Create a MinIO access key
Copy the new MinIO credentials
Configure the MinIO cloud client in Odoo
The app assumes that the binary content of attachments is kept in Cloud Client instead of the Odoo server. So, such attachments in Odoo become of the URL type, and you may any time access them either from the attachments box or from the Cloud Client.
After the setup, no manual actions are required, as the synchronization is fully automatic. Just decide which Odoo document types should be synced and set up a related model to sync for each of those (Customers, Sale or Purchase Orders, Tasks, Projects, etc.).
Yes, you can. To that goal, prepare a rule for each, and then those apply filters: for example by type of a project.
Try to make filters self-exclusive in order a document can be definitely assigned. For instance, 'customer but not supplier', 'supplier but not customer'. Otherwise, a specific document folder would jump from one model to another.
No. We have strong reasons to avoid real time sync:
Performance issues. In case a sync is real time, each file upload will result in the loading screen.
Conflict issues. If 2 users simultaneously change an item, it might lead to unresolved situations. In case of regular jobs we can fix it afterwards, while in case of real time we would need to save it as some queue, and it will be even more misleading for users.
Functionality issues. In particular, renaming and restructuring of items. In the backward sync the tool strictly relies upon directories' logic, and during each sync 100% of items are checked. In case it is done after each update, it will be thousands of requests per second. If not: changes would be lost.
You may assign your name for models' directories (sale orders, opportunities, suppliers, etc.) for any document type.
For objects' folders (SO-001, John Smith, etc.), the tool relies upon the Odoo method to construct a display name for this document type. However, you can change that by defining the name expression. The exact syntax for Odoo email templates is used.
No, starting from version 15, you should not change scheduled jobs. They are optimized to run every 15 minutes to guarantee the most stable and quick connection.
Ensure that your Odoo server timeouts are set for at least 15 minutes (900 seconds).
If you need to stop sync for a while, do that on a particular cloud client form.
Yes, starting from version 15, you can set up multiple connections. In this way, it is possible to sync some folders to one cloud client and others - to another.
Take into account that it is not any way possible to sync the same folder for a few cloud storages simultaneously.
Yes, depending on your cloud client configuration.
Starting from version 15, the app might be used stand-alone to structure attachments in folders and to provide a file manager interface.
However, if your goal is to establish a connection with one of its cloud clients, you would need at least one optional client-related app to be installed.
When a folder rule changes, the list of folders also changes. So, if a folder no longer matches the conditions of the folder rules - it is removed. If the files have been synced, the reversed sync returns them to Odoo and deletes them from the Cloud Client.
If a document's object doesn't match the conditions of a folder rule, then its folder will not be created. However, if it matches the conditions later, the related folder will be generated.
Odoo file manager: Amazon S3 synced
Odoo objects' folders in Amazon S3
Odoo attachment box synced to the Amazon bucket
Odoo file manager: MinIO S3 synced
Odoo objects' folders in the MinIO bucket
Odoo attachment box synced to MinIO
Odoo folder structure in Amazon storage
Odoo folder structure in MinIO storage
The root folder is in Amazon S3
The root folder is in MinIO
Odoo demonstration databases (live previews)
For this app, we might provide a free personalized demo database.
To demand such a database, press the button "Live Preview" on the top of this page or copy the link https://faotools.com/s/d17muc
You do not need a phone number or credit card to contact us. You should only pass a short email sign-up, which does not take more than 30 seconds.
By your request, we will prepare an individual live preview database, where you can apply any tests and check assumptions for about two weeks.
Bug reporting
If you encounter bugs or inconsistent behavior, do not hesitate to contact us. We guarantee to provide fixes within 60 days of purchase and are intensely interested in improving our tools even after this period.
To send us a bug report, press the "Website" link at the top of this page and push the button "Bug Report" (the tab Support). Alternatively, copy the link https://faotools.com/s/ybn8gr
You do not need a phone number or credit card to contact us. You should only pass a short email sign-up, which does not take more than 30 seconds.
Please include as many details as possible in your request: screenshots, Odoo server logs, a full description of how to reproduce your problem, and so on. Usually, it takes a few business days to prepare a working plan for an issue (if a bug is confirmed) or provide you with guidelines on what should be done (otherwise).
Public features requests and module ideas (free development)
We are strongly motivated to improve our tools and would be grateful for any feedback. If your requirements are of public use and might be efficiently implemented, the team will include those in our to-do list.
Such a to-do list is processed regularly and does not assume extra fees. Although we cannot promise deadlines and final design, it might be a good way to get desired features without investments and risks.
To share ideas, press the "Website" link at the top of this page and push the button "Share Features Ideas" (the tab Support). Alternatively, copy the link https://faotools.com/s/zrsaus
You do not need a phone number or credit card to contact us. You should only pass a short email sign-up, which does not take more than 30 seconds.
Questions and misc issues
Feel free to contact us with any other concerns, doubts, or questions: press the "Website" link at the top of this page and push the button "Raise Question" (the tab Support). Alternatively, copy the link https://faotools.com/s/8wq6f2
You do not need a phone number or credit card to contact us. You should only pass a short email sign-up, which does not take more than 30 seconds.
About the team
faOtools (faotools.com, former odootools.com) is the developers and business analysts team that helps you extend Odoo's potential. Since 2012, we have communicated with end users for whom the software became the primary business tool. As a result, we are proud of the dozens of successful apps that have been developed. We are open to new ideas and challenges to create the best Odoo tools for business needs worldwide.
You may like the tools
The tool to build a deep and structured knowledge base for internal and external use. Knowledge System. KMS. Wiki-like revisions.
The tool to manage your Odoo from your favorite AI chats through MCP. Claude. Any MCP-supporting AI.
198The tool to set up KPI targets and control their fulfillment by periods. KPI dashboards. Dashboard designer. KPI charts
The tool for time-based service management from booking appointments to sales and reviews
The tool to flexibly structure Odoo attachments in folders and synchronize directories with cloud clients: Google Drive, OneDrive/SharePoint, Nextcloud/ownCloud, and Dropbox. DMS. File Manager. Document management system
398The tool to automatically synchronize Odoo attachments with OneDrive files in both ways
487The tool to automatically synchronize Odoo attachments with Google Drive files in both ways
487The tool to automatically synchronize Odoo attachments with ownCloud/Nextcloud files in both ways
487Odoo Proprietary License v1.0 This software and associated files (the "Software") may only be used (executed, modified, executed after modifications) if you have purchased a valid license from the authors, typically via Odoo Apps, or if you have received a written agreement from the authors of the Software (see the COPYRIGHT file). You may develop Odoo modules that use the Software as a library (typically by depending on it, importing it and using its resources), but without copying any source code or material from the Software. You may distribute those modules under the license of your choice, provided that this license is compatible with the terms of the Odoo Proprietary License (For example: LGPL, MIT, or proprietary licenses similar to this one). It is forbidden to publish, distribute, sublicense, or sell copies of the Software or modified copies of the Software. The above copyright notice and this permission notice must be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Please log in to comment on this module