odoo-forge-bundle 0.1.0

package/payload/skills/odoo18-docs/references/docs/administration/odoo_online.md

@@ -0,0 +1,198 @@
+---
+title: "Odoo Online"
+source_url: "https://docs.odoo.sbggai.top/administration/odoo_online.html"
+---
+
+===========
+# Odoo Online
+
+[Odoo Online ](https://www.odoo.com/trial) provides private databases which are fully managed and
+hosted by Odoo. It can be used for long-term production or to test Odoo thoroughly, including
+customizations that don't require code.
+
+> **note**:
+>    Odoo Online is incompatible with custom modules or the Odoo App Store.
+
+Odoo Online databases are accessed using any web browser and do not require a local installation.
+
+To quickly try out Odoo, shared [demo ](https://demo.odoo.com) instances are available. No
+registration is required, but each instance only lives for a few hours.
+
+# Database management
+
+To manage a database, go to the [database manager ](https://www.odoo.com/my/databases) and sign in
+as the database administrator.
+
+All the main database management options are available by clicking the database name, except the
+upgrade option, which can be accessed by clicking the **arrow in a circle** icon next to the
+database name. It is only displayed if an upgrade is available.
+
+.. image:: odoo_online/database-manager.png
+   :alt: Accessing the database management options
+
+- :ref:`odoo_online/upgrade`
+- :ref:`odoo_online/duplicate`
+- :ref:`odoo_online/rename`
+- :ref:`odoo_online/download`
+- :ref:`odoo_online/domains`
+- :ref:`odoo_online/tags`
+- :ref:`odoo_online/delete`
+- :ref:`odoo_online/contact-support`
+- :ref:`odoo_online/users`
+- :ref:`odoo_online/web-services`
+
+.. _odoo_online/upgrade:
+
+# Upgrade
+
+Trigger a database upgrade.
+
+.. seealso::
+   For more information about the upgrade process, check out the :ref:`Odoo Online upgrade
+   documentation <upgrade-request-test>`.
+
+.. _odoo_online/duplicate:
+
+# Duplicate
+
+Create an exact copy of the database, which can be used to perform testing without compromising
+daily operations.
+
+> **important**:
+>    - By checking :guilabel:`For testing purposes`, all external actions (emails, payments, delivery
+     orders, etc.) are disabled by default on the duplicated database.
+   - Duplicated databases expire automatically after 15 days.
+   - A maximum of five duplicates can be made per database. Under extraordinary circumstances,
+     contact [support ](https://www.odoo.com/help) to raise the limit.
+
+.. _odoo_online/rename:
+
+# Rename
+
+Rename the database and its URL.
+
+.. _odoo_online/download:
+
+# Download
+
+Download a ZIP file containing a backup of the database.
+
+> **note**:
+>    Databases are backed up daily as per the [Odoo Cloud Hosting SLA
+   ](https://www.odoo.com/cloud-sla).
+
+.. _odoo_online/domains:
+
+# Domain names
+
+Use a custom :doc:`domain name </applications/websites/website/configuration/domain_names>` to
+access the database via another URL.
+
+> **tip**:
+>    You can :ref:`register a domain name for free <domain-name/register>`.
+
+.. _odoo_online/tags:
+
+# Tags
+
+Add tags to easily identify and sort your databases.
+
+> **tip**:
+>    You can search for tags in the search bar.
+
+.. _odoo_online/delete:
+
+# Delete
+
+Delete a database instantly.
+
+.. danger::
+   Deleting a database means that all data is permanently lost. The deletion is instant and applies
+   to all users. It is recommended to create a backup of the database before deleting it.
+
+Carefully read the warning message and only proceed if the implications of deleting a database are
+fully understood.
+
+.. image:: odoo_online/delete.png
+   :alt: The warning message displayed before deleting a database
+
+> **note**:
+>    - Only an administrator can delete a database.
+   - The database name is immediately made available to anyone.
+   - Deleting a database if it has expired or is linked to a subscription is impossible. In that
+     case, contact [Odoo Support ](https://www.odoo.com/help).
+
+.. _odoo_online/contact-support:
+
+# Contact us
+
+Access the [Odoo.com support page ](https://www.odoo.com/help) with the database's details already
+pre-filled.
+
+.. _odoo_online/users:
+
+# Invite / remove users
+
+To invite users, fill out the new user's email address and click :guilabel:`Invite`. To add multiple
+users, click :guilabel:`Add more users`.
+
+.. image:: odoo_online/invite-users.png
+   :alt: Inviting a user on a database
+
+To remove users, select them and click :guilabel:`Remove`.
+
+.. seealso::
+   - :doc:`/applications/general/users`
+   - :doc:`odoo_accounts`
+
+.. _odoo_online/web-services:
+
+# Web Services
+
+In order to programmatically retrieve the list of the databases displayed in the
+[database manager ](https://www.odoo.com/my/databases), call the method `list` of the model
+`odoo.database` via a :doc:`Web Service </developer/howtos/web_services>` call.
+
+Inspired from the examples provided in the :doc:`Web Services </developer/howtos/web_services>`
+section, this is how to retrieve this list with the library `xmlrpc.client`::
+
+   import xmlrpc.client
+
+   USER = 'user@domain.tld'
+   APIKEY = 'your_apikey'
+
+   root = 'https://www.odoo.com/xmlrpc/'
+   uid = xmlrpc.client.ServerProxy(root + 'common').login('openerp', USER, APIKEY)
+   sock = xmlrpc.client.ServerProxy(root + 'object')
+   databases_list = sock.execute('openerp', uid, APIKEY, 'odoo.database', 'list')
+
+And here is the equivalent example with JSON-RPC::
+
+   import json
+   import random
+   import urllib.request
+
+   USER = 'user@domain.tld'
+   APIKEY = 'your_apikey'
+
+   def json_rpc(url, method, params):
+       data = {
+           'jsonrpc': '2.0',
+           'method': method,
+           'params': params,
+           'id': random.randint(0, 1000000000),
+       }
+       req = urllib.request.Request(url=url, data=json.dumps(data).encode(), headers={
+           "Content-Type": "application/json",
+       })
+       reply = json.loads(urllib.request.urlopen(req).read().decode('UTF-8'))
+       if reply.get('error'):
+           raise Exception(reply['error'])
+       return reply['result']
+
+   def call(url, service, method, *args):
+       return json_rpc(url, 'call', {'service': service, 'method': method, 'args': args})
+
+   url = 'https://www.odoo.com/jsonrpc'
+   uid = call(url, 'common', 'login', 'openerp', USER, APIKEY)
+   databases_list = call(url, 'object', 'execute', 'openerp', uid, APIKEY, 'odoo.database', 'list')

package/payload/skills/odoo18-docs/references/docs/administration/odoo_sh/advanced/containers.md

@@ -0,0 +1,235 @@
+---
+title: ""
+source_url: "https://docs.odoo.sbggai.top/administration/odoo_sh/advanced/containers.html"
+---
+
+# 
+# Containers
+
+# Overview
+
+Each build is isolated within its own container (Linux namespaced container).
+
+The base is an Ubuntu system, where all of Odoo's required dependencies,
+as well as common useful packages, are installed.
+
+If your project requires additional Python dependencies, or more recent releases,
+you can define a :file:`requirements.txt` file in the root of your branches listing them.
+The platform will take care to install these dependencies in your containers.
+[The pip requirements specifiers ](https://pip.pypa.io/en/stable/reference/pip_install/#requirement-specifiers)
+documentation can help you write a :file:`requirements.txt` file.
+To have a concrete example,
+check out the [requirements.txt file of Odoo ]({GITHUB_PATH}/requirements.txt).
+
+The :file:`requirements.txt` files of submodules are taken into account as well. The platform
+looks for :file:`requirements.txt` files in each folder containing Odoo modules: Not in the module folder itself,
+but in their parent folder.
+
+# Directory structure
+
+As the containers are Ubuntu based, their directory structure follows the linux Filesystem Hierarchy Standard.
+[Ubuntu's filesystem tree overview ](https://help.ubuntu.com/community/LinuxFilesystemTreeOverview#Main_directories)
+explains the main directories.
+
+Here are the Odoo.sh pertinent directories:
+
+::
+
+  .
+  ├── home
+  │    └── odoo
+  │         ├── src
+  │         │    ├── odoo                Odoo Community source code
+  │         │    │    └── odoo-bin       Odoo server executable
+  │         │    ├── enterprise          Odoo Enterprise source code
+  │         │    ├── themes              Odoo Themes source code
+  │         │    └── user                Your repository branch source code
+  │         ├── data
+  │         │    ├── filestore           database attachments, as well as the files of binary fields
+  │         │    └── sessions            visitors and users sessions
+  │         └── logs
+  │              ├── install.log         Database installation logs
+  │              ├── odoo.log            Running server logs
+  │              ├── update.log          Database updates logs
+  │              └── pip.log             Python packages installation logs
+  └── usr
+       ├── lib
+       │    ├── python2.7
+       │         └── dist-packages       Python 2.7 standard libraries
+       │    ├── python3
+       │         └── dist-packages       Python 3 standard libraries
+       │    └── python3.5
+       │         └── dist-packages       Python 3.5 standard libraries
+       ├── local
+       │    └── lib
+       │         ├── python2.7
+       │         │    └── dist-packages  Python 2.7 third-party libraries
+       │         └── python3.5
+       │              └── dist-packages  Python 3.5 third-party libraries
+       └── usr
+            └── bin
+                 ├── python2.7           Python 2.7 executable
+                 └── python3.5           Python 3.5 executable
+
+Both Python 2.7 and 3.5 are installed in the containers. However:
+
+* If your project is configured to use Odoo 10.0, the Odoo server runs with Python 2.7.
+* If your project is configured to use Odoo 11.0 or above, the Odoo server runs with Python 3.5.
+
+# Database shell
+
+While accessing a container with the shell, you can access the database using *psql*.
+
+```bash
+
+  odoo@odoo-addons-master-1.odoo.sh:~$ psql
+  psql (9.5.2, server 9.5.11)
+  SSL connection (protocol: TLSv1.2, cipher: ECDHE-RSA-AES256-GCM-SHA384, bits: 256, compression: off)
+  Type "help" for help.
+
+  odoo-addons-master-1=>
+
+**Be careful !**
+[Use transactions ](https://www.postgresql.org/docs/current/static/sql-begin.html) (*BEGIN...COMMIT/ROLLBACK*)
+for every *sql* statements leading to changes
+(*UPDATE*, *DELETE*, *ALTER*, ...), especially for your production database.
+
+The transaction mechanism is your safety net in case of mistake.
+You simply have to rollback your changes to revert your database to its previous state.
+
+For example, it may happen that you forget to set your *WHERE* condition.
+
+```sql
+
+  odoo-addons-master-1=> BEGIN;
+  BEGIN
+  odoo-addons-master-1=> UPDATE res_users SET password = '***';
+  UPDATE 457
+  odoo-addons-master-1=> ROLLBACK;
+  ROLLBACK
+
+In such a case, you can rollback to revert the unwanted changes that you just mistakenly did, and rewrite the statement:
+
+```sql
+
+  odoo-addons-master-1=> BEGIN;
+  BEGIN
+  odoo-addons-master-1=> UPDATE res_users SET password = '***' WHERE id = 1;
+  UPDATE 1
+  odoo-addons-master-1=> COMMIT;
+  COMMIT
+
+However, do not forget to either commit or rollback your transaction after having done it.
+Open transactions may lock records in your tables
+and your running database may wait for them to be released. It can cause a server to hang indefinitely.
+
+In addition, when possible, use your staging databases to test your statements first. It gives you an extra safety net.
+
+# Run an Odoo server
+
+You can start an Odoo server instance from a container shell. You won't be able to access it from the outside world
+with a browser, but you can for instance:
+
+* use the Odoo shell,
+
+```bash
+
+  $  odoo-bin shell
+  >>> partner = env['res.partner'].search([('email', '=', 'asusteK@yourcompany.example.com')], limit=1)
+  >>> partner.name
+  'ASUSTeK'
+  >>> partner.name = 'Odoo'
+  >>> env['res.partner'].search([('email', '=', 'asusteK@yourcompany.example.com')], limit=1).name
+  'Odoo'
+
+* install a module,
+
+```bash
+
+  $  odoo-bin -i sale --without-demo=all --stop-after-init
+
+* update a module,
+
+```bash
+
+  $  odoo-bin -u sale --stop-after-init
+
+* run the tests for a module,
+
+```bash
+
+  $  odoo-bin -i sale --test-enable --log-level=test --stop-after-init
+
+In the above commands, the argument:
+
+* `--without-demo=all` prevents demo data to be loaded for all modules
+* `--stop-after-init` will immediately shutdown the server instance after it completed the operations you asked.
+
+More options are available and detailed in the
+:doc:`CLI documentation </developer/reference/cli>`.
+
+You can find in the logs (*~/logs/odoo.log*) the addons path used by Odoo.sh to run your server.
+Look for "*odoo: addons paths*":
+
+::
+
+  2018-02-19 10:51:39,267 4 INFO ? odoo: Odoo version {BRANCH}
+  2018-02-19 10:51:39,268 4 INFO ? odoo: Using configuration file at /home/odoo/.config/odoo/odoo.conf
+  2018-02-19 10:51:39,268 4 INFO ? odoo: addons paths: ['/home/odoo/data/addons/{BRANCH}', '/home/odoo/src/user', '/home/odoo/src/enterprise', '/home/odoo/src/themes', '/home/odoo/src/odoo/addons', '/home/odoo/src/odoo/odoo/addons']
+
+**Be careful**, especially with your production database.
+Operations that you perform running this Odoo server instance are not isolated:
+Changes will be effective in the database. Always, make your tests in your staging databases.
+
+# Debugging in Odoo.sh
+
+Debugging an Odoo.sh build is not really different than another Python app. This article only explains the specificities and limitations of the Odoo.sh platform, and assumes that you already know how to use a debugger.
+
+.. note:: If you don't know how to debug a Python application yet, there are multiple introductory courses that can be easily found on the Internet.
+
+You can use `pdb`, `pudb` or `ipdb` to debug your code on Odoo.sh.
+As the server is run outside a shell, you cannot launch the debugger directly from your Odoo instance backend as the debugger needs a shell to operate.
+
+- [pdb ](https://docs.python.org/3/library/pdb.html) is installed by default in every container.
+
+- If you want to use [pudb ](https://pypi.org/project/pudb/) or [ipdb ](https://pypi.org/project/ipdb/) you have to install it before.
+
+  To do so, you have two options:
+
+    - temporary (only in the current build):
+
+      ```bash
+
+        $  pip install pudb --user
+
+      or
+
+      ```bash
+
+        $  pip install ipdb --user
+
+    - permanent: add `pudb` or `ipdb` to your project `requirements.txt` file.
+
+
+Then edit the code where you want to trigger the debugger and add this:
+
+```python
+
+  import sys
+  if sys.__stdin__.isatty():
+      import pdb; pdb.set_trace()
+
+The condition :code:`sys.__stdin__.isatty()` is a hack that detects if you run Odoo from a shell.
+
+Save the file and then run the Odoo Shell:
+
+```bash
+
+  $ odoo-bin shell
+
+Finally, *via* the Odoo Shell, you can trigger the piece of code/function/method
+you want to debug.
+
+.. image:: containers/pdb_sh.png
+    :align: center
+    :alt: Console screenshot showing `pdb` running in an Odoo.sh shell.

package/payload/skills/odoo18-docs/references/docs/administration/odoo_sh/advanced/frequent_technical_questions.md

@@ -0,0 +1,60 @@
+---
+title: ""
+source_url: "https://docs.odoo.sbggai.top/administration/odoo_sh/advanced/frequent_technical_questions.html"
+---
+
+
+.. _odoosh-advanced-frequent_technical_questions:
+# 
+# Frequent Technical Questions
+
+## "Scheduled actions do not run at the exact time they were expected"
+
+On the Odoo.sh platform, we cannot guarantee an exact running time for scheduled actions.
+
+This is due to the fact that there might be multiple customers on the same server, and we must guarantee a fair share of the server for every customer. Scheduled actions are therefore implemented slightly differently than on a regular Odoo server, and are run on a *best effort* policy.
+
+> **warning**:
+>     Do not expect any scheduled action to be run more often than every 5 min.
+
+## Are there "best practices" regarding scheduled actions?
+
+**Odoo.sh always limits the execution time of scheduled actions (*aka* crons).**
+Therefore, you must keep this fact in mind when developing your own crons.
+
+We advise that:
+
+- Your scheduled actions should work on small batches of records.
+- Your scheduled actions should commit their work after processing each batch;
+  this way, if they get interrupted by the time-limit, there is no need to start over.
+- Your scheduled actions should be
+  [idempotent ](https://stackoverflow.com/a/1077421/3332416): they must not
+  cause side-effects if they are started more often than expected.
+
+.. _ip-address-change:
+
+## How can I automate tasks when an IP address change occurs?
+
+**Odoo.sh notifies project administrators of IP address changes.**
+Additionally, when the IP address of a production instance changes, an HTTP `GET` request is made
+to the path `/_odoo.sh/ip-change` with the new IP address included as a query string parameter
+(`new`), along with the previous IP address as an additional parameter (`old`).
+
+This mechanism allows custom actions to be applied in response to the IP address change
+(e.g., sending an email, contacting a firewall API, configuring database objects, etc.)
+
+For security reasons, the `/_odoo.sh/ip-change` route is accessible only internally by the platform
+itself and returns a `403` response if accessed through any other means.
+
+Here is a pseudo-implementation example:
+
+```python
+
+    class IPChangeController(http.Controller):
+
+        @http.route('/_odoo.sh/ip-change', auth='public')
+        def ip_change(self, old=None, new=None):
+            _logger.info("IP address changed from %s to %s", old, new)
+            # Then perform whatever action required for your use case, e.g., update an
+            # ir.config_parameter, send an email, contact an external firewall service's API, ...
+            return 'ok'

package/payload/skills/odoo18-docs/references/docs/administration/odoo_sh/advanced/submodules.md

@@ -0,0 +1,109 @@
+---
+title: ""
+source_url: "https://docs.odoo.sbggai.top/administration/odoo_sh/advanced/submodules.html"
+---
+
+
+.. _odoosh-advanced-submodules:
+# 
+# Submodules
+
+# Overview
+
+A [Git submodule ](https://git-scm.com/book/en/v2/Git-Tools-Submodules) allows you to integrate other Git projects
+into your code, without the need to copy-paste all their code.
+
+Indeed, your custom modules can depend on modules from other repositories.
+Regarding Odoo, this feature allows you to add modules from other Git repositories into the branches of your repository.
+Adding these dependencies in your branch through submodules makes the deployment of your code and servers easier,
+as you can clone the repositories added as submodules at the same time you clone your own repository.
+
+Besides, you can choose the branch of the repository added as submodule
+and you have the control of the revision you want.
+It's up to you to decide whether you want to pin the submodule to a specific revision and when you want to update
+to a newer revision.
+
+In Odoo.sh, the submodules give you the possibility to use and depend on modules available in other repositories.
+The platform will detect that you added modules through submodules in your branches
+and add them to your addons path automatically so you can install them in your databases.
+
+If you add private repositories as submodules in your branches,
+you need to configure a deploy key in your Odoo.sh project settings and in your repository settings.
+Otherwise Odoo.sh won't be allowed to download them.
+The procedure is detailed in the chapter :ref:`Settings > Submodules <odoosh-gettingstarted-settings-submodules>`.
+
+# Adding a submodule
+
+## With Odoo.sh (simple)
+
+> **warning**:
+>    For now it is not possible to add **private** repositories with this method. You can nevertheless
+   do so :ref:`with Git <odoosh-advanced-submodules-withgit>`.
+
+On Odoo.sh, in the branches view of your project, choose the branch in which you want to add a submodule.
+
+In the upper right corner, click on the *Submodule* button, and then on *Run*.
+
+.. image:: submodules/advanced-submodules-button.png
+   :align: center
+
+A dialog with a form is shown. Fill the inputs as follows:
+
+* Repository URL: The SSH URL of the repository.
+* Branch: The branch you want to use.
+* Path: The folder in which you want to add this submodule in your branch.
+
+.. image:: submodules/advanced-submodules-dialog.png
+   :align: center
+
+On Github, you can get the repository URL with the *Clone or download* button of the repository. Make sure to *use SSH*.
+
+.. image:: submodules/advanced-submodules-github-sshurl.png
+  :align: center
+
+.. _odoosh-advanced-submodules-withgit:
+
+## With Git (advanced)
+
+In a terminal, in the folder where your Git repository is cloned,
+checkout the branch in which you want to add a submodule:
+
+```bash
+
+  $ git checkout <branch>
+
+Then, add the submodule using the command below:
+
+```bash
+
+  $ git submodule add -b <branch> <git@yourprovider.com>:<username/repository.git> <path>
+
+Replace
+
+* *<git@yourprovider.com>:<username/repository.git>* by the SSH URL of the repository you want to add as submodule,
+* *<branch>* by the branch you want to use in the above repository,
+* *<path>* by the folder in which you want to add this submodule.
+
+Commit and push your changes:
+
+```bash
+
+  $ git commit -a && git push -u <remote> <branch>
+
+Replace
+
+* <remote> by the repository on which you want to push your changes. For a standard Git setup, this is *origin*.
+* <branch> by the branch on which you want to push your changes.
+  Most likely the branch you used :code:`git checkout` on in the first step.
+
+You can read the [git-scm.com documentation ](https://git-scm.com/book/en/v2/Git-Tools-Submodules)
+for more details about the Git submodules.
+For instance, if you would like to update your submodules to have their latest revision,
+you can follow the chapter
+[Pulling in Upstream changes ](https://git-scm.com/book/en/v2/Git-Tools-Submodules#_pulling_in_upstream_changes_from_the_submodule_remote).
+
+# Ignore modules
+
+If you're adding a repository that contains a lot of modules, you may want to ignore some of them in case there are any
+that are installed automatically. To do so, you can prefix your submodule folder with a :code:`.`. The platform will
+ignore this folder and you can hand pick your modules by creating symlinks to them from another folder.

package/payload/skills/odoo18-docs/references/docs/administration/odoo_sh/advanced.md

@@ -0,0 +1,15 @@
+---
+title: ""
+source_url: "https://docs.odoo.sbggai.top/administration/odoo_sh/advanced.html"
+---
+
+:nosearch:
+# 
+# Advanced
+
+.. toctree::
+   :titlesonly:
+
+   advanced/containers
+   advanced/submodules
+   advanced/frequent_technical_questions