<h1 class="title">Attachments on S3 storage</h1> <p>This addon allows to store the attachments (documents and assets) on S3 or any other S3-compatible Object Storage.</p> <a name="configuration"></a> <h2>Configuration</h2> <p>Activate S3 storage:</p> <ul class="simple"> <li>Create or set the system parameter with the key <code>ir_attachment.location</code> and the value in the form <code>s3</code>.</li> </ul> <p>Configure accesses with environment variables:</p> <ul class="simple"> <li><code>AWS_HOST</code> (not required if using AWS services)</li> <li><code>AWS_REGION</code> (required if using AWS services)</li> <li><code>AWS_ACCESS_KEY_ID</code></li> <li><code>AWS_SECRET_ACCESS_KEY</code></li> <li><code>AWS_BUCKETNAME</code></li> </ul> <p>Read-only mode:</p> <p>The bucket and the file key are stored in the attachment. So if you change the <code>AWS_BUCKETNAME</code> or the <code>ir_attachment.location</code>, the existing attachments will still be read on their former bucket. But as soon as they are written over or new attachments are created, they will be created on the new bucket or on the other location (db or filesystem). This is a convenient way to be able to read the production attachments on a replication (since you have the credentials) without any risk to alter the production data.</p> <p>This addon must be added in the server wide addons with (<code>--load</code> option):</p> <p><code>--load=web,attachment_s3</code></p> <a name="limitations"></a> <h2>Limitations</h2> <ul class="simple"> <li>You need to call <code>env['ir.attachment'].force_storage()</code> after having changed the <code>ir_attachment.location</code> configuration in order to migrate the existing attachments to S3.</li> </ul>