Cloud Storage Solutions v.17

To make sure the synchronization works correctly apply proper timeouts to the Odoo configuration file: LIMIT_TIME_CPU, LIMIT_TIME_REAL, LIMIT_TIME_REAL_CRON should be more than 900 seconds.

For Odoo.sh this should not be done, since timeouts are predefined and are not configurable.

Avoid also changing the cron jobs frequency assumed by the app: '[Cloud Storage] Prepare Cloud Folders', '[Cloud Storage] Run / Prepare sync queue'. Those jobs are configured to be run each 15 minutes, and that frequency is used in the algorithms to avoid breaks and data losses. If you need to stop sync for a while, pause particular cloud clients instead.

The tool depends on the external library 'sortedcontainers'. Install this library for your Odoo server through the command:

Python dependency

The tool depends on the external library 'microsoftgraph'. Install this library for your Odoo server through the command:

Configuration and log in

1. Turn on the option 'OneDrive / SharePoint Sync' (cloud Storage > Configuration > Configuration). The optional add-on OneDrive / SharePoint Odoo Integration is required
2. Make sure your Microsoft user has full admin rights for OneDrive / SharePoint you want to connect to Odoo. This user is required only to grant permissions, the user data would not be kept in Odoo, and would not be used afterward. Besides, make sure a Microsoft email address you use does not have a redirection (usually happens when you configure your domain name, while the prime address is still one of Microsoft domains like @outlook.com, @office365, etc.)
3. Go to your Azure Portal: https://portal.azure.com/#blade/Microsoft_AAD_RegisteredApps/ApplicationsListBlade
4. Click 'New registration'
5. Introduce a new name for the application and assign the redirect URI as [YOURODOOSITENAME]/one_drive_token (e.g. https://odootools.com/one_drive_token). As the supported account types choose 'Accounts in any organizational directory (Any Azure AD directory - Multitenant) and personal Microsoft accounts (e.g. Skype, Xbox)'.
6. Go to Certificates & secrets - Click 'New Client Secret'. Save somewhere the secret value
7. Go to Odoo Cloud Storage > Configuration > Cloud Clients press 'Create'
   • As a reference introduce any name which would be clear to all users
   • As a Cloud client choose 'OneDrive' or 'SharePoint' depending on the software you are using
   • As a Root folder name enter a title which would be users as the parent OneDrive directory for all synced folders. For example, 'Odoo' or 'OdooERP'
   • Copy 'Application Client ID' to the 'App client ID'
   • Copy secret value into the field 'App client secret'
   • Insert previously generated redirect URL
   • If you use SharePoint:
     • Go to your SharePoint site and prepare a new documents library (drive). You might use one of the existing ones, e.g. 'Documents'. Odoo folder would be put there afterward, and it would be impossible to move it to another library
     • The SharePoint URL should be of the type https://[URL]/. The last '/' is required - the site name should not be included. For example, https://odootools.sharepoint.com/
     • SharePoint site should be either root (the very root SharePoint site), my_site_name (in that case it is considered as sites/my_site_name) or sites/my_site_name (instead of 'sites' it might be 'teams' and so on). There should be no '/' at the beginning or at the end. For example, sites/odootools
     • As Documents Library use one created in SharePoint
8. Press 'Confirm'. Odoo redirects you to the Microsoft login page. Check in the system, agree with all conditions, and grant all permissions asked
9. After login, OneDrive redirects you back to Odoo. OneDrive - Odoo synchronization is ready to be done
10. Apply the newly created cloud client to folder rules and/or manual folders which should be synced to that OneDrive or SharePoint instance
11. Await the sync scheduled job to be started. For testing purposes only: trigger integration manually from Cloud Storage > Configuration > Configuration > the button 'Launch sync'.

Watch also the configuration video

1. Turn on the option 'Google Drive Sync' (cloud Storage > Configuration > Configuration). The optional add-on Google Drive Odoo Integration is required
2. Go to the Google Developer Console via the url https://console.developers.google.com
3. Select or create a project
4. Find the section 'Dashboard' and press 'ENABLE APIS AND SERVICES'
5. Find Google Drive API and push the button to enable its API
6. Go to 'Credentials' and press the button 'Configure Consent Screen'. As the User Type select 'External' and push 'Create'
7. Add app information
   • As an app name select any suitable
   • As a user support email and developer contact information select your email address
   • Press 'Save and Continue'
8. On the 'Scopes' page just press 'Save and Continue'
9. As Test Users add your GMail email address, then press 'Save and Continue'
10. Then, go to Credentials and push the button 'Create Credentials'
    • 'Web application' as the application type
    • As the authorized redirect URI add the link in a format [YOURODOOSITENAME]/google_drive_token (e.g. https://odootools.com/google_drive_token).
    • Save the app and copy 'Client ID' and 'Client Secret'
11. Go to Odoo Cloud Storage > Configuration > Cloud Clients press 'Create'
    • As a reference introduce any name which would be clear to all users
    • As a Cloud client choose 'Google Drive'
    • As a Root folder name enter a title which would be users as the parent Google Drive directory for all synced folders. For example, 'Odoo' or 'OdooERP'
    • Copy 'Client ID' to the 'App client ID'
    • Copy 'Client Secret' into the field 'App client secret'
    • Insert previously generated redirect URL
    • If you use team drives, check the related box. Make sure you really use team drives. In you Google Drive you should find the item 'Team Drives' in the left sidebar. This feature is available only for business and enterprise tariffs
    • If the option 'Team Drive' is enabled, introduce its name. It should be absolutely the same as you see it in your Google Drive. Make sure that your user has full rights for all Google drives (usually, it is the same user who configures your team Google Drive)
12. Press 'Confirm'. Odoo redirects you to Google login page. Check in the system, agree with all conditions, and grant all permissions asked
13. After login, Google redirects you back to Odoo. Google Drive - Odoo synchronization is ready to be done
14. Apply the newly created cloud client to folder rules and/or manual folders which should be synced to that Google Drive
15. Await the sync scheduled job to be started. For testing purposes only: trigger integration manually from Cloud Storage > Configuration > Configuration > the button 'Launch sync'.

Watch also the configuration video

1. Turn on the option 'Amazon S3 Sync' (Cloud Storage > Configuration > Configuration). The optional add-on Amazon S3 Odoo Integration is required
2. Open the Amazon S3 Console: https://console.aws.amazon.com/s3/
3. Create a new bucket or choose an existing one. Copy the exact bucket name: it should be inserted in Odoo into the field 'Bucket'
4. 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)
5. Open the AWS IAM Console: https://console.aws.amazon.com/iam/
6. 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)
7. In the IAM user form, open the tab 'Security credentials' and press 'Create access key'
8. 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
9. Press 'Next'. On the next step, optionally enter a description tag such as Odoo S3 Sync, then press 'Create access key'
10. On the final AWS page, copy Access key or Access key ID into the Odoo field 'Access Key'
11. 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
12. 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
13. Go to Odoo Cloud Storage > Configuration > Cloud Clients and press 'Create'
14. As a reference, introduce any name which would be clear to all users
15. As a Cloud client, choose 'Amazon S3'
16. 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'
17. Fill in the fields 'Bucket', 'Region', 'Access Key', 'Secret Key', and, if needed, 'Amazon S3 endpoint URL' and addressing style
18. 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
19. Press 'Confirm'. Odoo checks bucket access and creates or verifies the root folder prefix. Amazon S3 - Odoo synchronization is ready to be done
20. Apply the newly created cloud client to folder rules and/or manual folders which should be synced to that Amazon S3 bucket
21. 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: https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-bucket.html, managing IAM access keys: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html.

Bucket policy example

Configuration and log in

1. Turn on the option 'onwCloud / Nextcloud Sync' (cloud Storage > Configuration > Configuration). The optional add-on ownCloud / Nextcloud Odoo Integration is required
2. Go to Odoo Cloud Storage > Configuration > Cloud Clients press 'Create'
3. As a reference introduce any name which would be clear to all users
4. As a Cloud client choose 'Nextcloud' or 'ownCloud' depending on the software you are using
5. As a Root folder name enter a title which would be users as the parent directory for all synced folders. For example, 'Odoo' or 'OdooERP'
6. Enter your ownCloud / Nextcloud full URL
7. Select an ownCloud / Nextcloud user, which has full rights to read, create, write and delete files and folders within a root directory
8. Enter login and password of this user to the fields 'Login' and 'Password'
9. Choose whether you would like to apply public or internal URLs (see below)
10. Press 'Confirm'. Odoo synchronization is ready to be done
11. Apply the newly created cloud client to folder rules and/or manual folders which should be synced to that Nextcloud or ownCloud instance
12. Await the sync scheduled job to be started. For testing purposes only: trigger integration manually from Cloud Storage > Configuration > Configuration > the button 'Launch sync'.

Internal and public URLs

By default links from Odoo to ownCloud / Nextcloud are internal: only authorized users may access them. Optionally make links public (the setting 'Use Public URLs'). Then, URLs would be 'shared', and everybody would access items by a direct link.

Be cautious if you decide to use shared (public) URLs. Although the links would be hardly known by external users, there is a slight chance that they become available as a result of some user actions. Besides, sharing links generation is not fast and might make the synchronization slower.

Watch also the configuration video

1. Turn on the option 'NAS Sync' (Cloud Storage > Configuration > Configuration). The optional add-on NAS Odoo Integration is required
2. Prepare your NAS WebDAV endpoint:
   • Synology: install and enable WebDAV Server in DSM and choose HTTPS where possible
   • QNAP: enable WebDAV for the target shared folder and use HTTPS where possible
   • TrueNAS CORE: enable the WebDAV service; TrueNAS SCALE: install and configure the WebDAV app, since native WebDAV was removed in modern SCALE releases
   • Generic WebDAV: make sure PROPFIND, MKCOL, PUT, GET, MOVE, and DELETE are available
3. If Odoo is hosted outside the local NAS network, make the WebDAV endpoint reachable securely. Prefer a reverse proxy with a valid TLS certificate, a VPN/secure tunnel such as WireGuard, Tailscale, or Cloudflare Tunnel, or a vendor relay such as Synology QuickConnect or QNAP myQNAPcloud. Avoid exposing an administrator interface to the Internet
4. Create a dedicated NAS user with full rights only inside the target shared folder: read, create, write, move, and delete. Do not use an administrator account
5. Go to Odoo Cloud Storage > Configuration > Cloud Clients and press 'Create'
6. As a reference, introduce any name which would be clear to all users
7. As a Cloud client, choose 'Synology NAS', 'QNAP NAS', 'TrueNAS', or 'WebDAV NAS'
8. As a Root folder name, enter a title that will be used as the parent NAS directory for all synced folders. For example, 'Odoo' or 'OdooERP'
9. Enter the full WebDAV URL, login, and password. Optionally define a base path if Odoo should create the root folder inside an existing share or directory
10. Keep 'Verify SSL' enabled for public HTTPS endpoints. Disable it only for a trusted private endpoint with a self-signed certificate
11. Optionally define a browser base URL if NAS files should be opened through a vendor file station URL instead of the raw WebDAV URL
12. Press 'Confirm'. Odoo checks the WebDAV connection and creates or finds the root directory. NAS - Odoo synchronization is ready to be done
13. Apply the newly created cloud client to folder rules and/or manual folders which should be synced to that NAS storage
14. Await the sync scheduled job to be started. For testing purposes only: trigger integration manually from Cloud Storage > Configuration > Configuration > the button 'Launch sync'.

NAS Pre-configuration

NAS systems usually expose files through a local network. If your Odoo server is hosted outside that network, the WebDAV endpoint should be reachable from Odoo through a secure channel. Recommended options are a reverse proxy with a valid HTTPS certificate, a VPN or secure tunnel such as WireGuard, Tailscale, or Cloudflare Tunnel, or a vendor relay such as Synology QuickConnect or QNAP myQNAPcloud. Plain port forwarding is possible but should be treated as the least preferred option.

Use a dedicated NAS user with the minimum required rights to one shared folder: read, create, update, move, and delete. Avoid administrator accounts. Publicly exposed endpoints should always use HTTPS and a valid TLS certificate. The connector has a "Verify SSL" option for trusted self-signed certificates, but it should normally remain enabled.

1. Turn on the option 'Box Sync' (cloud Storage > Configuration > Configuration). The optional add-on Box Odoo Integration is required
2. Create or open a Box developer account and go to the Box Developer Console: https://app.box.com/developers/console
3. Create a Custom App and choose OAuth 2.0 (Authorization Code Grant) as the authentication method
4. Add the redirect URI as [YOURODOOSITENAME]/box_token (e.g. https://faotools.com/box_token). A valid SSL certificate (https) is required
5. Grant the app access to read and write files and folders. Avoid assigning unrelated permissions
6. 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 'Box'
   • As a Root folder name, enter a title that will be used as the parent Box directory for all synced folders. For example, 'Odoo' or 'OdooERP'
   • Copy Box Client ID to the field 'Client ID'
   • Copy Box Client Secret to the field 'Client Secret'
   • Insert previously generated redirect URL
7. Press 'Confirm'. Odoo redirects you to the Box login page. Check in the system, agree with all conditions, and grant all permissions asked
8. After login, Box redirects you back to Odoo. Box - Odoo synchronization is ready to be done
9. Apply the newly created cloud client to folder rules and/or manual folders which should be synced to that Box account
10. Await the sync scheduled job to be started. For testing purposes only: trigger integration manually from Cloud Storage > Configuration > Configuration > the button 'Launch sync'.

Python dependency

The tool depends on the external library 'dropbox'. Install this library for your Odoo server through the command:

Configuration and log in

1. Turn on the option 'Dropbox Sync' (cloud Storage > Configuration > Configuration). The optional add-on Dropbox Odoo Integration is required
2. Follow the URL https://www.dropbox.com/developers/apps/create
3. Choose an API as 'Scoped access'
4. Choose the type of access as 'Full Dropbox'
5. Select any suitable name for the app and push the button 'Create app'
6. Add the redirect URI as [YOURODOOSITENAME]/dropbox_token (e.g. https://faotools.com/dropbox_token). A valid SSL certificate (https) is required
7. Grant permissions to the app: 'Account Info (Read)', 'Files and folders Metadata (Write)', 'Files Content (Write)', 'Collaboration (Write)'. For team DropBox assign also 'Team Data Members', 'Members (Read)'. Make sure no other permissions are assigned.
8. Submit App
9. Go to Odoo Cloud Storage > Configuration > Cloud Clients press 'Create'
   • As a reference introduce any name which would be clear to all users
   • As a Cloud client choose 'Dropbox'
   • As a Root folder name enter a title which would be users as the parent Google Drive directory for all synced folders. For example, 'Odoo' or 'OdooERP'
   • Copy 'App key' to the 'App key'
   • Copy 'App Secret' into the field 'App secret'
   • Insert previously generated redirect URL
   • If you use Dropbox team drives
     • Check the related box
     • Set an email of the Dropbox user. Inside this user folder, all Odoo related items would be created, and only after that they are shared with all other users. Under this user, all files and folders are created, changed, moved, and deleted
10. Press 'Confirm'. Odoo redirects you to the Dropbox login page. Check in the system, agree with all conditions, and grant all permissions asked
11. After login, Dropbox redirects you back to Odoo. Dropbox - Odoo synchronization is ready to be done
12. Apply the newly created cloud client to folder rules and/or manual folders which should be synced to that Dropbox instance
13. Await the sync scheduled job to be started. For testing purposes only: trigger integration manually from Cloud Storage > Configuration > Configuration > the button 'Launch sync'.

Dropbox URLs

Dropbox has a specific way to generate links for existing files and folders. In particular, there are no concepts of internal or private URLs. Instead, each Dropbox item might get so-called shared URLs. Such shared links are either public or team-only. Moreover, the latter feature is available only for the Dropbox business account.

This tool relies upon shared links' mechanics. It means, that each attachment link is either public (all personal Dropbox accounts) or team-only (all business Dropbox accounts).

Sometimes it is considered to be not fully safe. Although website URLs will be hardly known by external users, there is a slight chance that they become available as a result of some user actions. Besides, sharing links generation is not super fast and might make the sync process slower. That is why the feature to switch off sharing URLs is introduced.

If checked, all Dropbox URLs in Odoo will be of type https://www.dropbox.com/home/Odoo/[PATH]. Such links will not work in many cases. Thus, if you need to open Dropbox files/folders from Odoo, be careful with the setting 'No links to Dropbox from Odoo'.

Watch also the configuration video

1. Prepare a running MinIO server
2. Open the MinIO Console
3. Create a new bucket or choose an existing one. Copy the exact bucket name: it should be inserted in Odoo into the field 'Bucket'
4. 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
5. Copy the MinIO Access Key into the Odoo field 'Access Key'
6. 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
7. 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
8. Go to Odoo Cloud Storage > Configuration > Cloud Clients and press 'Create'
9. As a reference, introduce any name which would be clear to all users
10. As a Cloud client, choose 'MinIO'
11. 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'
12. 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
13. 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
14. 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
15. Press 'Confirm'. Odoo checks bucket access and creates or verifies the root folder prefix. MinIO - Odoo synchronization is ready to be done
16. Apply the newly created cloud client to folder rules and/or manual folders which should be synced to that MinIO bucket
17. 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.