diff --git a/fs_attachment/README.rst b/fs_attachment/README.rst
index bd048c7cff..17cc78b89d 100644
--- a/fs_attachment/README.rst
+++ b/fs_attachment/README.rst
@@ -7,7 +7,7 @@ Base Attachment Object Store
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
- !! source digest: sha256:88c623934cf2676ac173c9beaa37d16d7f9e735d3bb149ea5527494a151224d6
+ !! source digest: sha256:6138d157ac41f158eee22db8c23bd6b5661c7b63855c3f2248566532c6052587
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
@@ -49,10 +49,10 @@ the filename is based on the pattern:
This addon also adds on the attachments 2 new fields to use to retrieve
the file content from a URL:
-- ``Internal URL``: URL to retrieve the file content from the Odoo's
- filestore.
-- ``Filesystem URL``: URL to retrieve the file content from the
- external storage.
+- ``Internal URL``: URL to retrieve the file content from the Odoo's
+ filestore.
+- ``Filesystem URL``: URL to retrieve the file content from the external
+ storage.
Note
@@ -94,144 +94,142 @@ In addition to the common fields available to configure a storage,
specifics fields are available under the section 'Attachment' to
configure the way attachments will be stored in the filesystem.
-- ``Optimizes Directory Path``: This option is useful if you need to
- prevent having too many files in a single directory. It will create a
- directory structure based on the attachment's checksum (with 2 levels
- of depth) For example, if the checksum is ``123456789``, the file
- will be stored in the directory
- ``/path/to/storage/12/34/my_file-1-0.txt``.
-
-- ``Autovacuum GC``: This is used to automatically remove files from
- the filesystem when it's no longer referenced in Odoo. Some storage
- backends (like S3) may charge you for the storage of files, so it's
- important to remove them when they're no longer needed. In some
- cases, this option is not desirable, for example if you're using a
- storage backend to store images shared with others systems (like your
- website) and you don't want to remove the files from the storage
- while they're still referenced into the others systems. This
- mechanism is based on a ``fs.file.gc`` model used to collect the
- files to remove. This model is automatically populated by the
- ``ir.attachment`` model when a file is removed from the database. If
- you disable this option, you'll have to manually take care of the
- records in the ``fs.file.gc`` for your filesystem storage.
-
-- ``Use As Default For Attachment``: This options allows you to declare
- the storage as the default one for attachments. If you have multiple
- filesystem storage configured, you can choose which one will be used
- by default for attachments. Once activated, attachments created
- without specifying a storage will be stored in this default storage.
-
-- ``Force DB For Default Attachment Rules``: This option is useful if
- you want to force the storage of some attachments in the database,
- even if you have a default filesystem storage configured. This is
- specially useful when you're using a storage backend like S3, where
- the latency of the network can be high. This option is a JSON field
- that allows you to define the mimetypes and the size limit below
- which the attachments will be stored in the database.
-
- Small images (128, 256) are used in Odoo in list / kanban views. We
- want them to be fast to read. They are generally < 50KB (default
- configuration) so they don't take that much space in database, but
- they'll be read much faster than from the object storage.
-
- The assets (application/javascript, text/css) are stored in database
- as well whatever their size is:
-
- - a database doesn't have thousands of them
- - of course better for performance
- - better portability of a database: when replicating a production
- instance for dev, the assets are included
-
- The default configuration is:
-
- {"image/": 51200, "application/javascript": 0, "text/css": 0}
-
- Where the key is the beginning of the mimetype to configure and
- the value is the limit in size below which attachments are kept in
- DB. 0 means no limit.
-
- Default configuration means:
-
- - images mimetypes (image/png, image/jpeg, ...) below 50KB are
- stored in database
- - application/javascript are stored in database whatever their size
- - text/css are stored in database whatever their size
-
- This option is only available on the filesystem storage that is used
- as default for attachments.
+- ``Optimizes Directory Path``: This option is useful if you need to
+ prevent having too many files in a single directory. It will create a
+ directory structure based on the attachment's checksum (with 2 levels
+ of depth) For example, if the checksum is ``123456789``, the file will
+ be stored in the directory ``/path/to/storage/12/34/my_file-1-0.txt``.
+
+- ``Autovacuum GC``: This is used to automatically remove files from the
+ filesystem when it's no longer referenced in Odoo. Some storage
+ backends (like S3) may charge you for the storage of files, so it's
+ important to remove them when they're no longer needed. In some cases,
+ this option is not desirable, for example if you're using a storage
+ backend to store images shared with others systems (like your website)
+ and you don't want to remove the files from the storage while they're
+ still referenced into the others systems. This mechanism is based on a
+ ``fs.file.gc`` model used to collect the files to remove. This model
+ is automatically populated by the ``ir.attachment`` model when a file
+ is removed from the database. If you disable this option, you'll have
+ to manually take care of the records in the ``fs.file.gc`` for your
+ filesystem storage.
+
+- ``Use As Default For Attachment``: This options allows you to declare
+ the storage as the default one for attachments. If you have multiple
+ filesystem storage configured, you can choose which one will be used
+ by default for attachments. Once activated, attachments created
+ without specifying a storage will be stored in this default storage.
+
+- ``Force DB For Default Attachment Rules``: This option is useful if
+ you want to force the storage of some attachments in the database,
+ even if you have a default filesystem storage configured. This is
+ specially useful when you're using a storage backend like S3, where
+ the latency of the network can be high. This option is a JSON field
+ that allows you to define the mimetypes and the size limit below which
+ the attachments will be stored in the database.
+
+ Small images (128, 256) are used in Odoo in list / kanban views. We
+ want them to be fast to read. They are generally < 50KB (default
+ configuration) so they don't take that much space in database, but
+ they'll be read much faster than from the object storage.
+
+ The assets (application/javascript, text/css) are stored in database
+ as well whatever their size is:
+
+ - a database doesn't have thousands of them
+ - of course better for performance
+ - better portability of a database: when replicating a production
+ instance for dev, the assets are included
+
+ The default configuration is:
+
+ {"image/": 51200, "application/javascript": 0, "text/css": 0}
+
+ Where the key is the beginning of the mimetype to configure and the
+ value is the limit in size below which attachments are kept in DB.
+ 0 means no limit.
+
+ Default configuration means:
+
+ - images mimetypes (image/png, image/jpeg, ...) below 50KB are stored
+ in database
+ - application/javascript are stored in database whatever their size
+ - text/css are stored in database whatever their size
+
+ This option is only available on the filesystem storage that is used
+ as default for attachments.
It is also possible to use different FS storages for attachments linked
to different resource fields/models. You can configure it either on the
``fs.storage`` directly, or in a server environment file:
-- From the ``fs.storage``: Fields model_ids and field_ids will encode
- for which models/fields use this storage as default storage for
- attachments having these resource model/field. Note that if an
- attachment has both resource model and field, it will first take the
- FS storage where the field is explicitely linked, then is not found,
- the one where the model is explicitely linked.
-- From a server environment file: In this case you just have to provide
- a comma-separated list of models (under the model_xmlids key) or
- fields (under the field_xmlids key). To do so, use the model/field
- XML ids provided by Odoo. See the Server Environment section for a
- concrete example.
+- From the ``fs.storage``: Fields model_ids and field_ids will encode
+ for which models/fields use this storage as default storage for
+ attachments having these resource model/field. Note that if an
+ attachment has both resource model and field, it will first take the
+ FS storage where the field is explicitely linked, then is not found,
+ the one where the model is explicitely linked.
+- From a server environment file: In this case you just have to provide
+ a comma-separated list of models (under the model_xmlids key) or
+ fields (under the field_xmlids key). To do so, use the model/field XML
+ ids provided by Odoo. See the Server Environment section for a
+ concrete example.
Another key feature of this module is the ability to get access to the
attachments from URLs.
-- ``Base URL``: This is the base URL used to access the attachments
- from the filesystem storage itself. If your storage doesn't provide a
- way to access the files from a URL, you can leave this field empty.
-
-- ``Is Directory Path In URL``: Normally the directory patch configured
- on the storage is not included in the URL. If you want to include it,
- you can activate this option.
-
-- ``Use X-Sendfile To Serve Internal Url``: If checked and odoo is
- behind a proxy that supports x-sendfile, the content served by the
- attachment's internal URL will be served by the proxy using the
- filesystem url path if defined (This field is available on the
- attachment if the storage is configured with a base URL) If not, the
- file will be served by odoo that will stream the content read from
- the filesystem storage. This option is useful to avoid to serve files
- from odoo and therefore to avoid to load the odoo process.
-
- To be fully functional, this option requires the proxy to support
- x-sendfile (apache) or x-accel-redirect (nginx). You must also
- configure your proxy by adding for each storage a rule to redirect
- the url rooted at the 'storagge code' to the server serving the
- files. For example, if you have a storage with the code 'my_storage'
- and a server serving the files at the url 'http://myserver.com', you
- must add the following rule in your proxy configuration:
-
- .. code:: nginx
-
- location /my_storage/ {
- internal;
- proxy_pass http://myserver.com;
- }
-
- With this configuration a call to
- '/web/content/ In some cases, you need to store attachment in another system that the
@@ -390,8 +390,8 @@ Note The internal URL is always available, but the filesystem URL is only
@@ -453,23 +453,22 @@ Optimizes Directory Path: This option is useful if you need to
prevent having too many files in a single directory. It will create a
directory structure based on the attachment’s checksum (with 2 levels
-of depth) For example, if the checksum is 123456789, the file
-will be stored in the directory
-/path/to/storage/12/34/my_file-1-0.txt.Base Attachment Object Store
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-!! source digest: sha256:88c623934cf2676ac173c9beaa37d16d7f9e735d3bb149ea5527494a151224d6
+!! source digest: sha256:6138d157ac41f158eee22db8c23bd6b5661c7b63855c3f2248566532c6052587
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
Base Attachment Object Store
Configuration
Autovacuum GC: This is used to automatically remove files from -the filesystem when it’s no longer referenced in Odoo. Some storage +
Autovacuum GC: This is used to automatically remove files from the +filesystem when it’s no longer referenced in Odoo. Some storage backends (like S3) may charge you for the storage of files, so it’s -important to remove them when they’re no longer needed. In some -cases, this option is not desirable, for example if you’re using a -storage backend to store images shared with others systems (like your -website) and you don’t want to remove the files from the storage -while they’re still referenced into the others systems. This -mechanism is based on a fs.file.gc model used to collect the -files to remove. This model is automatically populated by the -ir.attachment model when a file is removed from the database. If -you disable this option, you’ll have to manually take care of the -records in the fs.file.gc for your filesystem storage.
+important to remove them when they’re no longer needed. In some cases, +this option is not desirable, for example if you’re using a storage +backend to store images shared with others systems (like your website) +and you don’t want to remove the files from the storage while they’re +still referenced into the others systems. This mechanism is based on a +fs.file.gc model used to collect the files to remove. This model +is automatically populated by the ir.attachment model when a file +is removed from the database. If you disable this option, you’ll have +to manually take care of the records in the fs.file.gc for your +filesystem storage.Use As Default For Attachment: This options allows you to declare the storage as the default one for attachments. If you have multiple @@ -482,8 +481,8 @@
Small images (128, 256) are used in Odoo in list / kanban views. We want them to be fast to read. They are generally < 50KB (default configuration) so they don’t take that much space in database, but @@ -499,14 +498,14 @@
The default configuration is:
{“image/”: 51200, “application/javascript”: 0, “text/css”: 0}
-Where the key is the beginning of the mimetype to configure and -the value is the limit in size below which attachments are kept in -DB. 0 means no limit.
+Where the key is the beginning of the mimetype to configure and the +value is the limit in size below which attachments are kept in DB. +0 means no limit.
Default configuration means:
Another key feature of this module is the ability to get access to the attachments from URLs.
Base URL: This is the base URL used to access the attachments -from the filesystem storage itself. If your storage doesn’t provide a -way to access the files from a URL, you can leave this field empty.
+Base URL: This is the base URL used to access the attachments from +the filesystem storage itself. If your storage doesn’t provide a way +to access the files from a URL, you can leave this field empty.
Is Directory Path In URL: Normally the directory patch configured on the storage is not included in the URL. If you want to include it, @@ -546,16 +545,16 @@
To be fully functional, this option requires the proxy to support x-sendfile (apache) or x-accel-redirect (nginx). You must also -configure your proxy by adding for each storage a rule to redirect -the url rooted at the ‘storagge code’ to the server serving the -files. For example, if you have a storage with the code ‘my_storage’ -and a server serving the files at the url ‘http://myserver.com’, you -must add the following rule in your proxy configuration:
+configure your proxy by adding for each storage a rule to redirect the +url rooted at the ‘storagge code’ to the server serving the files. For +example, if you have a storage with the code ‘my_storage’ and a server +serving the files at the url ‘http://myserver.com’, you must add the +following rule in your proxy configuration:location /my_storage/ { internal; @@ -563,9 +562,8 @@Configuration
}
With this configuration a call to -‘/web/content/<att.id>/<att.name><att.extension>” for a file stored -in the ‘my_storage’ storage will generate a response by odoo with the -URI +‘/web/content/<att.id>/<att.name><att.extension>” for a file stored in +the ‘my_storage’ storage will generate a response by odoo with the URI /my_storage/<paht_in_storage>/<att.name>-<att.id>-<version><att.extension> in the headers X-Accel-Redirect and X-Sendfile and the proxy will redirect to @@ -576,12 +574,12 @@
Use Filename Obfuscation: If checked, the filename used to store the content into the filesystem storage will be obfuscated. This is -useful to avoid to expose the real filename of the attachments -outside of the Odoo database. The filename will be obfuscated by -using the checksum of the content. This option is to avoid when the -content of your filestore is shared with other systems (like your -website) and you want to keep a meaningful filename to ensure SEO. -This option is disabled by default.
+useful to avoid to expose the real filename of the attachments outside +of the Odoo database. The filename will be obfuscated by using the +checksum of the content. This option is to avoid when the content of +your filestore is shared with other systems (like your website) and +you want to keep a meaningful filename to ensure SEO. This option is +disabled by default.To do so, you can add on your staging instances a new storage and declare it as the default storage to use for attachments. This way, all the new attachments will be stored in this new storage but the -attachments created on the production instance will still be read -from the production storage. Be careful to adapt the configuration of -your storage to the production environment to make it read only. (The -use of server environment files is a good way to do so).
+attachments created on the production instance will still be read from +the production storage. Be careful to adapt the configuration of your +storage to the production environment to make it read only. (The use +of server environment files is a good way to do so). @@ -694,8 +692,8 @@Before this change, when the fs_url was computed the computed value was always reassigned to the fs_url attribute even if the value was the same. In a lot of cases the value was the same and the -reassignment was not necessary. Unfortunately this reassignment has -as side effect to mark the record as dirty and generate a SQL update +reassignment was not necessary. Unfortunately this reassignment has as +side effect to mark the record as dirty and generate a SQL update statement at the end of the transaction. (#307)
@@ -763,17 +761,23 @@Thierry Ducrest <thierry.ducrest@camptocamp.com> Guewen Baconnier -<guewen.baconnier@camptocamp.com> Julien Coux -<julien.coux@camptocamp.com> Akim Juillerat -<akim.juillerat@camptocamp.com> Thomas Nowicki -<thomas.nowicki@camptocamp.com> Vincent Renaville -<vincent.renaville@camptocamp.com> Denis Leemann -<denis.leemann@camptocamp.com> Patrick Tombez -<patrick.tombez@camptocamp.com> Don Kendall <kendall@donkendall.com> -Stephane Mangin <stephane.mangin@camptocamp.com> Laurent Mignon -<laurent.mignon@acsone.eu> Marie Lejeune <marie.lejeune@acsone.eu> -Wolfgang Pichler <wpichler@callino.at> Nans Lefebvre <len@lambdao.dev>
+