Skip to Content

S3 Attachment Storage

by
Odoo

$ 16.00

v 17.0 Third Party 19
Availability
Odoo Online
Odoo.sh
On Premise
Lines of code 117
Technical Name Auto_AWS_S3_Attachments
LicenseLGPL-3
Versions 15.0 16.0 17.0 18.0 19.0
You bought this module and need support? Click here!
Availability
Odoo Online
Odoo.sh
On Premise
Lines of code 117
Technical Name Auto_AWS_S3_Attachments
LicenseLGPL-3
Versions 15.0 16.0 17.0 18.0 19.0
Odoo 15 – 19 CE & EE Odoo SH Ready LGPL-3

S3 Attachment Storage
for Odoo

Transparent S3 reads, writes, and deletes for every Odoo attachment — with automatic local fallback, retry with exponential backoff, and two-phase migration tooling for existing filestores. Odoo never notices. Your disk limit problem disappears.

$16
One-Time
15–19
Odoo Versions
4+
S3 Providers
0
DB Migrations
⚠️

The Problem

Odoo SH instances have a disk limit. As your business grows — invoices, contracts, product images, CAD files — the filestore fills up. When it's full, Odoo stops. You can't just add more disk on SH. You need cloud storage, now.

✅

The Solution

Three overrides on ir.attachment. Odoo calls them — S3 happens behind the scenes. Odoo never notices. If S3 is unreachable, everything falls back to local disk silently. No errors, no downtime, no data loss.

3
Method Overrides
∞
Storage Scale
4+
S3 Providers
0
DB Schema Changes

Three Engines. One Install.

Everything you need to move your Odoo filestore to the cloud — permanently and safely.

☁️
F/01

S3 Storage Engine

Transparent read / write / delete that overrides Odoo's core file methods. Retries up to 3× with exponential backoff and jitter before falling back to local disk.

Works with any S3-compatible provider — configurable endpoint and region.
🚀
F/02

Odoo SH Ready

Credentials stored in ir.config_parameter survive SH builds where environment variables are wiped on every deploy.

Production-only mode blocks staging and dev branches from writing to your live bucket.
🔄
F/03

Migration Tooling

Two-phase cron jobs upload every existing attachment to S3, verify each with a HEAD request, then delete the local copy once confirmed safe.

Batched, resumable, idempotent, and deduplicated by checksum.

Three Overrides on ir.attachment. No Schema Change.

The store_fname field serves as both the local path and the S3 object key — no database migration needed.

OP/01
📖

Read

Tries S3 first. If the key doesn't exist or S3 is unreachable, transparently falls back to the local filesystem. Odoo never sees an error.

Fallback: local disk ✓
OP/02
✍️

Write

Uploads to S3. On S3 failure, falls back to local storage so the attachment is never lost. Retry with exponential backoff before declaring failure.

Fallback: local disk — no data loss ✓
OP/03
🗑️

Delete

Removes the object from S3, then marks any local copy for Odoo's garbage collector. GC cron verifies zero references before final removal.

Safe GC: reference-checked ✓

Key Features

Everything you need. Nothing you don't.

🔒

Automatic Local Fallback

If S3 is unreachable or unconfigured, every operation silently falls back to local disk. Zero errors, zero downtime.
🔁

Retry with Backoff

Three retries with exponential backoff and jitter before declaring failure. Transient S3 hiccups handled gracefully.
🏗️

Production-Only Mode

Staging and dev branches read from S3 but write locally. Your production bucket stays protected.
📦

Two-Phase Migration

Phase 1 uploads, Phase 2 verifies via HEAD then removes local copies. Resumable, idempotent, deduplicated by checksum.
🛡️

SH Build-Proof Credentials

Stored in ir.config_parameter — survive Odoo SH builds where env vars are wiped on every deploy.
⚡

Smart Asset Exclusions

ir.ui.menu icons and CSS/JS assets stay local for page-load speed. Business documents go to S3.
🔍

Safe S3 Garbage Collection

Daily GC cron verifies zero references before removing any S3 object. Content-addressed files are never deleted prematurely.
🔧

Settings UI

All config in Settings → General Settings → S3 Attachment Storage. No .env files, no SSH, no server access needed.
🌐

Any S3-Compatible Provider

Amazon S3, DigitalOcean Spaces, MinIO, Backblaze B2, and more. Configurable endpoint URL — switch providers without code changes.

Supported Providers

Any storage that speaks S3.

🔶

Amazon S3

The industry standard. Leave endpoint empty — boto3 routes to AWS automatically.

No endpoint needed
🌊

DigitalOcean Spaces

Perfect for Odoo SH on DO. Set your region endpoint and you're done in minutes.

S3-compatible
🗄️

MinIO

Run your own private S3-compatible store on-premises. Full data sovereignty.

Self-hosted
🔥

Backblaze B2

S3-compatible at a fraction of AWS pricing. Great for cost-conscious deployments.

Cost efficient
Provider Endpoint URL
Amazon S3 leave empty
DigitalOcean Spaces https://nyc3.digitaloceanspaces.com
MinIO http://minio.internal:9000
Backblaze B2 https://s3.us-west-002.backblazeb2.com

4 Steps. About 5 Minutes.

From install to production S3 storage.

1

Install boto3

Add boto3 to requirements.txt at your repository root. Odoo SH installs it automatically on each build. For self-hosted: pip install boto3.
2

Enter S3 Credentials

Go to Settings → General Settings → S3 Attachment Storage and fill in:

► S3 Bucket    ► Access Key ID
► Secret Access Key    ► Endpoint URL
► Region
3

Enable Production-Only Mode

Check Production Only. Staging and dev builds still read from S3 but write locally — your production bucket stays clean.
4

Migrate Existing Attachments

Activate the two scheduled actions under Settings → Technical → Scheduled Actions. Phase 1 uploads, Phase 2 verifies and removes local copies. Both inactive by default.

See It in Action

From installation to S3 bucket — the full workflow.

Live Demo — S3 Attachment Storage
Live demo of Auto S3 Attachment Storage for Odoo
Odoo Apps — Install Module
Installing Auto S3 Attachment Storage from Odoo Apps

Step 1 — Install  ·  Go to Odoo → Apps → Update App List → Search "S3" → Install.

Settings → General Settings → S3 Attachment Storage
S3 configuration panel in Odoo General Settings

Step 2 — Configure  ·  Enter Bucket, Access Key ID, Secret Access Key, Endpoint URL, and Region. Save.

Any Odoo Module — Attach a File Normally
File attachment in Odoo routed to S3 transparently

Step 3 — Use Normally  ·  Attach any file to any record. Odoo behaves identically — the upload routes to S3 transparently.

Amazon S3 Console — Objects in Bucket
Amazon S3 bucket showing uploaded Odoo attachments

Step 4 — Confirm  ·  Check your S3 bucket — every attachment lands exactly there. Content-addressed, deduplicated, and safe.

Compatibility

Odoo 15 – 19. CE & EE. Odoo SH and self-hosted.

Odoo Versions

15.0 ✓ 16.0 ✓ 17.0 ✓ 18.0 ✓ 19.0 ✓

Edition

Community ✓ Enterprise ✓

Hosting

Odoo SH ✓ Self-hosted ✓

Dependencies

Odoo modulesbase, base_setup
Python (pip)boto3
LicenseLGPL-3

Changelog

What changed and why — every version documented.

v 1.0.3 — Latest Excluded Models, Repair Action, Client Caching
  • Excluded models — ir.ui.menu and ir.ui.view attachments stay local. Menu icons are read on every page load — S3 round-trips were adding noticeable latency.
  • Repair action — new scheduled action rehydrates local copies of excluded-model attachments from S3 for existing installs.
  • S3 client caching — boto3 clients cached at module scope, keyed on the full credential tuple. Credential rotation handled automatically.
  • Simplified read retry — removed the redundant application-level retry loop from _file_read. Boto3 retries internally.
v 1.0.2 Web Assets Stored Locally
  • Excluded mimetypes — CSS, JavaScript, SCSS, and icon files stay on local disk. These assets are served on every page load.
  • Local-first reads — _file_read checks local disk before hitting S3, improving performance for any file with a local copy.
  • Context-aware writes — _file_write routes business documents to S3 and web assets to local disk.
  • Migration cron skips assets — Phase 1 now skips web assets and system resources.
v 1.0.1 S3 Garbage Collection
  • GC cron — a daily scheduled action safely removes orphaned S3 objects. Replaces immediate deletion in _file_delete.
  • Safe delete deferral — _file_delete now defers to the GC cron, which verifies zero references before removing from S3.
v 1.0.0 Initial Release

Transparent S3 attachment storage with automatic local fallback, retry with exponential backoff, two-phase migration tooling, Settings UI, production-only mode, and S3-compatible provider support.

Frequently Asked Questions

Will my existing attachments be moved automatically?

No. Existing attachments stay where they are until you activate the two-phase migration crons. New attachments route to S3 immediately. You control when migration runs.

What happens if S3 goes down or is unreachable?

Operations fall back to local disk silently. Reads try S3 first, then fall back to local. Writes fall back to local after retries. Odoo never surfaces an error — the system keeps working.

Does it work on Odoo SH?

Yes — built for Odoo SH. Credentials are stored in ir.config_parameter so they survive SH builds. Add boto3 to requirements.txt and SH installs it on every deploy.

Does installing this module change the database schema?

No. The store_fname field already exists on ir.attachment and serves as both the local path and S3 object key. No migration, no downtime.

Can I protect my production bucket from staging writes?

Yes. Enable Production Only mode in Settings. Staging and dev branches read from S3 but write new files to local disk — production bucket stays clean.

Can I switch providers later without data loss?

Yes. Update the Endpoint URL and credentials in Settings, then re-run the migration crons to upload everything to the new provider. The read fallback ensures files stay accessible during the transition.
📨

A Real Engineer Reads Every Email

Hit a bug? Migrating a 50 GB filestore? Need a custom provider integration? We respond within 24 business hours.

✉ Email OdooBuilders
🐛
Bug Reports

Investigated and resolved within 24 business hours.
🔧
Customisation

Custom providers, bucket policies, or retention rules.
📢
Free Updates

All purchasers get free updates for their installed version.

© 2024 OdooBuilders  —  S3 Attachment Storage  —  Odoo 15–19 CE & EE  —  License: LGPL-3

Please log in to comment on this module

  • The author can leave a single reply to each comment.
  • This section is meant to ask simple questions or leave a rating. Every report of a problem experienced while using the module should be addressed to the author directly (refer to the following point).
  • If you want to start a discussion with the author or have a question related to your purchase, please use the support page.
There are no ratings yet!
by
Jonathan Torres
on 12/13/24, 3:55 PM

It this module works with filestore files ?, because we have 2 servers on AWS, then I create a Bucket S3 in order to store my filestore databases, which works in Odoo 17.

The intention is always to upload and read the filestore from S3, when I need to create a new server to use Odoo 17, it will not give me an error message about filestore. If you have a demo video, it could be great.

Re:
by
Odoo Builders
on 3/6/25, 10:50 PM Author

yes

Its Good
by
Mukesh Gehlot
on 10/9/24, 5:05 AM

I tried this module and fulfilled all my requirements. I am looking forward to some more custom development for me

by
Mukesh Gehlot
on 10/9/24, 5:05 AM

I tried this module and fulfilled all my requirements. I am looking forward to some more custom development for me