Compare commits

..

1 Commits

Author SHA1 Message Date
Chong Wang (cwg)
69e4bf20fe [IMP] orm: add changelog for ir.config_parameter 2025-11-17 14:17:33 +01:00
209 changed files with 1273 additions and 3278 deletions

View File

@@ -39,8 +39,8 @@ To Odoo Online
To Odoo.sh
----------
Follow the instructions found in :ref:`the Import a database section <odoo-sh/create/import>` of the
Odoo.sh *Create a project* documentation.
Follow the instructions found in :ref:`the Import your database section
<odoo_sh_import_your_database>` of the Odoo.sh *Create your project* documentation.
Transferring an Odoo Online database
====================================
@@ -82,8 +82,8 @@ To Odoo.sh
next to the database name, then selecting :icon:`fa-cloud-download` :guilabel:`Download`. If the
download fails due to the file being too large, `contact Odoo support
<https://www.odoo.com/help>`_.
#. Follow the instructions found in :ref:`the Import a database section <odoo-sh/create/import>` of
the Odoo.sh *Create a project* documentation.
#. Follow the instructions found in :ref:`the Import your database section
<odoo_sh_import_your_database>` of the Odoo.sh *Create your project* documentation.
Transferring an Odoo.sh database
================================
@@ -119,5 +119,5 @@ To Odoo Online
To on-premise
-------------
#. Download a :ref:`backup of your Odoo.sh production database <odoo-sh/branches/tabs/backups>`.
#. Download a :ref:`backup of your Odoo.sh production database <odoo_sh_branches_backups>`.
#. Restore the database from the database manager on your local server using the backup.

View File

@@ -1,16 +1,12 @@
:show-content:
:show-toc:
:nosearch:
=======
Odoo.sh
=======
Odoo.sh is the official cloud platform for hosting and managing Odoo applications. It offers a
range of features such as web shell, module dependencies, continuous integration, and SSH access.
.. toctree::
:titlesonly:
odoo_sh/getting_started
odoo_sh/first_module
odoo_sh/advanced
odoo_sh/overview
odoo_sh/getting_started
odoo_sh/advanced

View File

@@ -1,51 +1,8 @@
:show-content:
:nosearch:
===============
Getting started
===============
Main components
---------------
When working with Odoo.sh, it is important to understand the main components involved. While they
are all interconnected, each one plays a distinct role in the development and deployment of Odoo
applications:
- **GitHub repository**: a version-controlled space where the Odoo applications' source code is
stored. It tracks every change, supports collaboration, and can be either public or private.
.. image:: getting_started/github-repository.png
:alt: Example of a GitHub repository
- **Odoo.sh project**: a Platform as a Service (PaaS) that integrates with GitHub and enables
streamlined development, testing, and deployment of Odoo applications. It includes tools such as
automated backups, staging environments, and continuous integration pipelines.
.. image:: getting_started/odoo-sh-project.png
:alt: Example of an Odoo.sh project
- **Odoo database**: a database stores all the operational data used and generated by Odoo
applications, such as business records, configurations, and user data.
.. image:: getting_started/odoo-database.png
:alt: Example of an Odoo database
Together, they form a cohesive pipeline from code development to a live business use.
User types
----------
Odoo.sh involves different types of users, each with a specific role in the project lifecycle:
- GitHub users: developers with access to the GitHub repository linked to the Odoo.sh project.
Access to the repository does not automatically make someone a collaborator on the Odoo.sh
project.
- Odoo.sh collaborators: individuals managing the Odoo.sh project. Each collaborator must be
linked to a GitHub user. However, collaborators are not the same as database users.
- Database users: end-users of the deployed Odoo database. They interact with the live system but
are not involved in development or project management.
===========
Get started
===========
.. toctree::
:titlesonly:
@@ -56,3 +13,4 @@ Odoo.sh involves different types of users, each with a specific role in the proj
getting_started/status
getting_started/settings
getting_started/online-editor
getting_started/first_module

File diff suppressed because it is too large Load Diff

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 23 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.7 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 51 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 727 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.1 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 66 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 33 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 40 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 27 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 84 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 78 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.3 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.9 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.6 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 33 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.1 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 43 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 759 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 49 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 154 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 403 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 7.8 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 7.4 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 10 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 8.0 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 11 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.7 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 378 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 121 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 8.9 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 46 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 55 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.8 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 79 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 21 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 330 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 46 KiB

View File

@@ -120,5 +120,5 @@ button.
.. _odoosh-gettingstarted-builds-dropdown-menu:
In the dropdown menu of the build, you can access the same features than in :ref:`the branches view
<odoo-sh/branches/tabs>`: *Logs*, *Web Shell*, *Editor*, *Outgoing e-mails*. You also
<odoosh-gettingstarted-branches-tabs>`: *Logs*, *Web Shell*, *Editor*, *Outgoing e-mails*. You also
have the possibility to *Download a dump* of the build's database.

View File

@@ -1,192 +1,205 @@
================
Create a project
================
Deploy a platform
.. _odoosh-gettingstarted-create:
===================
Create your project
===================
Deploy your platform
====================
Go to `Odoo.sh <https://www.odoo.sh/>`_ and hit the *Deploy your platform* button.
.. image:: create/deploy.png
:align: center
Sign in with Github
===================
Sign in with your Github account. If you do not have an account yet, hit the *Create an account*
link.
.. image:: create/github-signin.png
:align: center
Authorize Odoo.sh
=================
#. Visit `Odoo.sh <https://www.odoo.sh>`_ and click :guilabel:`Deploy your platform`.
Grant Odoo.sh the required accesses to your account by clicking the *Authorize* button.
.. image:: create/deploy-button.png
:alt: The Deploy your platform button on Odoo.sh
.. image:: create/github-authorize.png
:align: center
#. Sign in with a `GitHub <https://github.com>`_ account.
Odoo.sh basically needs:
.. image:: create/github-sign-in.png
:alt: Signing in to GitHub
* to know your Github login and email,
* to create a new repository in case you decide to start from scratch,
* to read your existing repositories, including the ones of your organizations, in case you want to
start from an existing repository,
* to create a webhook to be notified each time you push changes,
* to commit changes to make your deployment easier, merging branches or adding new `submodules
<https://git-scm.com/book/en/v2/Git-Tools-Submodules>`_ for example.
#. Authorize Odoo.sh by clicking :guilabel:`Authorize odoo` twice.
Submit your project
===================
.. image:: create/github-authorize.png
:alt: Granting Odoo.sh permissions to perform actions and access data on GitHub
Choose if you want to start from scratch by creating a new repository, or if you want to use an
existing repository.
.. image:: create/github-authorize.png
:alt: Granting Odoo.sh additional permissions to perform actions and access data on GitHub
Then, choose a name or select the repository you want to use.
.. note::
Odoo.sh requests GitHub to:
Choose the Odoo version you want to use. If you plan to import an existing database or an existing
set of applications, you might need to choose the according version. If you start from scratch, use
the latest version.
- Access your GitHub login and email.
- Create a new repository, in case you start from scratch.
- Access existing repositories, including organization ones, in case you start from an
existing repository.
- Create a webhook to notify you each time changes are pushed.
- Commit changes for easier deployment.
Enter your *subscription code*. This is also called *subscription referral*, *contract number* or
*activation code*.
#. Fill in the :guilabel:`Deploy your platform` form and click :guilabel:`Deploy`:
It should be the code of your Enterprise subscription that includes Odoo.sh.
- :guilabel:`Github repository`: to create a new repository, choose :guilabel:`New repository`
and enter a name; to use an existing one, choose :guilabel:`Existing repository` and select it.
- :guilabel:`Odoo Version`: select the major version of Odoo you want to use.
Partners can use their partnership codes to start a trial. Should their clients start a project,
they ought to get an Enterprise subscription including Odoo.sh and use its subscription code. The
partner will get 50% of the amount back as commission. Contact your sales representative or account
manager in order to get it.
.. tip::
- Use the latest major version of Odoo version when creating a new repository. If you are
planning to import an existing database or applications, it might be required that their
versions match.
- If you are starting on Odoo Online and plan to migrate to Odoo.sh later, create your
database using `odoo.com/start-lts <https://www.odoo.com/start-lts>`_ to ensure
compatibility, as minor versions are not supported by Odoo.sh.
When submitting the form, if you are notified your subscription is not valid, it either means:
- :guilabel:`Subscription Code`: enter your Odoo Enterprise subscription code that includes
Odoo.sh. It is also sometimes called the *subscription referral*, *contract number*, or
*activation code*.
* it is not an existing subscription,
* it is not a partnership subscription,
* it is an enterprise subscription, but which does not include Odoo.sh,
* it is neither a partnership subscription or an enterprise subscription (e.g. an online
subscription).
.. tip::
Partners can use their partnership codes to initiate a trial (trial builds are limited to 1
GB storage and two staging). If a client proceeds to start a project, they must subscribe
to an Odoo Enterprise plan that includes Odoo.sh hosting and use their subscription code.
In case of doubt with your subscription, please contact the `Odoo support
<https://www.odoo.com/help>`_.
- :guilabel:`Hosting location`: select the region where your platform will be hosted.
.. image:: create/deploy-form.png
:align: center
.. image:: create/deploy-form.png
:alt: The Deploy your platform form
You're done !
=============
.. _odoo-sh/create/import:
You can start using Odoo.sh. Your first build is about to be created. You will soon be able to
connect to your first database.
Import a database
=================
.. image:: create/deploy-done.png
:align: center
Once your platform is deployed, you can import a database into your Odoo.sh project, provided it
uses a :doc:`supported version <../../supported_versions>` of Odoo.
.. _odoo_sh_import_your_database:
.. note::
Due to `Odoo's backup policy <https://www.odoo.com/cloud-sla>`_, the import process requires
**four times** the size of your database dump in available storage. For example, a 10 GB dump
file will require at least 40 GB of available space. We recommend allocating **more than four
times×** the dump size temporarily, then reducing storage after the import is complete.
Import your database
====================
If your project is a trial created with a partnership code, you can only import database dumps up
to **1 GB** in size.
You can import your database in your Odoo.sh project as long as it is in a :doc:`supported version
</administration/supported_versions>` of Odoo.
Push modules in production
--------------------------
Push your modules in production
-------------------------------
If you are using community or custom modules, add them to a branch in your GitHub repository.
If you use community or custom modules, add them in a branch in your Github repository.
Databases hosted on the Odoo.com online platform do not have any custom modules.
Users of these databases can therefore skip this step.
.. note::
Databases hosted on Odoo Online do not support custom modules.
You can structure your modules as you wish, Odoo.sh will automatically detect the folders containing
Odoo addons. For instance, you can put all your modules folder in the root directory of your
repository, or group the modules in folders by categories that you define (accounting, project,
...).
Odoo.sh automatically detects folders containing Odoo modules. You can organize them however you
prefer. For example, you can place them directly in the root directory of your repository or group
them by category (e.g., `accounting`, `project`, etc.).
For community modules available in public Git repositories,
you can also consider to add them using :ref:`Submodules <odoosh-advanced-submodules>`.
For publicly available community modules, you may also consider using :doc:`submodules
<../advanced/submodules>`.
Then, either :ref:`make this branch the production branch <odoosh-gettingstarted-branches-stages>`,
or :ref:`merge it into your production branch <odoosh-gettingstarted-branches-mergingbranches>`.
Download a backup
-----------------
.. tabs::
On-premise databases
~~~~~~~~~~~~~~~~~~~~
.. group-tab:: On-premise
Access the URL :file:`/web/database/manager` of your on-premise database and download a backup.
Go to `/web/database/manager` on your on-premise Odoo instance and click :icon:`fa-floppy-o`
:guilabel:`Backup`.
.. Warning::
.. image:: create/on-premise-manager.png
:alt: The on-premise web manager interface
If you cannot access the database manager, it may have been disabled by your system administrator.
See the :ref:`database manager security documentation <db_manager_security>`.
Select :guilabel:`zip (includes filestore)` as the :guilabel:`Backup Format`.
You will need the master password of your database server. If you do not have it, contact your
system administrator.
.. image:: create/on-premise-backup.png
:alt: Downloading an on-premise database backup
.. image:: create/create-import-onpremise-backup.png
:align: center
.. note::
- You will need the :guilabel:`Master Password` of your Odoo server. If you do not have it,
contact your system administrator.
- If you cannot access the database manager, it may have been disabled by your system
administrator. Refer to the :ref:`database manager security documentation
<db_manager_security>`.
Choose a zip including the filestore as the backup format.
.. group-tab:: Odoo Online
.. image:: create/create-import-onpremise-backup-dialog.png
:align: center
Log in to your portal account and navigate to the `My Databases page
<https://www.odoo.com/my/databases>`_, and download a backup by clicking the :icon:`fa-gear`
(:guilabel:`gear`) icon, then :icon:`fa-cloud-download` :guilabel:`Download`.
Odoo Online databases
~~~~~~~~~~~~~~~~~~~~~
.. image:: create/odoo-online-backup.png
:alt: Downloading an Odoo Online database backup
`Access your databases manager <https://accounts.odoo.com/my/databases/manage>`_ and download a
backup of your database.
.. warning::
Only major versions of Odoo are compatible with Odoo.sh.
.. image:: create/create-import-online-backup.png
:align: center
.. Warning::
Online versions (e.g. *saas-**) are not supported on Odoo.sh.
Upload the backup
-----------------
In your Odoo.sh project, navigate to the :guilabel:`Backups` tab of your :guilabel:`Production`
branch, and click :guilabel:`Import Database` to upload the backup you previously downloaded.
Then, in your Odoo.sh project, in the backups tab of your production branch, import the backup you
just downloaded.
.. image:: create/import-database.png
:alt: Importing a database backup on Odoo.sh
.. image:: create/create-import-production.png
:align: center
Once the import is complete, you can access the database using the :guilabel:`Connect` button in the
branch's :guilabel:`History` tab.
Once the backup imported, you can access the database using the *Connect* button in the history of
the branch.
.. important::
Importing a backup **overwrites all data** currently in the branch. Consider downloading a manual
backup beforehand if you want to preserve the existing data.
.. image:: create/create-import-production-done.png
:align: center
Check outgoing email servers
----------------------------
Check your outgoing email servers
---------------------------------
Odoo.sh provides a default email server. To use it, ensure that **no outgoing mail server is
enabled** in your database by enabling :ref:`developer mode <developer-mode>` and navigating to
:menuselection:`Settings --> Technical --> Email: Outgoing Mail Servers`
There is a default mail server provided with Odoo.sh.
To use it, there must be no enabled outgoing mail server configured in your database in
:menuselection:`Settings --> Technical --> Outgoing Mail Servers` (:ref:`Developer mode
<developer-mode>` must be activated).
After importing your database, all configured outgoing mail servers are **disabled**, and the
default Odoo.sh server is used.
After the import of your database, all outgoing email servers are disabled so you use the Odoo.sh
email server provided by default.
.. warning::
Port **25** is and will remain closed. If connecting to an external SMTP server, use port **465**
or **587**.
Port 25 is (and will stay) closed. If you want to connect to an external SMTP server, you should
use ports 465 and 587.
Check scheduled actions
-----------------------
Check your scheduled actions
----------------------------
Scheduled actions are **disabled by default** after importing your database. This prevents your
newly imported database from performing potentially disruptive operations such as:
All scheduled actions are disabled after the import.
- sending queued emails,
- triggering mass mailings, or
- syncing with third-party services (e.g., calendars, cloud storage).
This is to prevent your newly imported database to perform actions that could impact your running
production, such as sending the mails remaining in the queue, processing mass mailings, or
third-party services synchronization (Calendars, files hosting, ...).
If you intend to use this imported database in production, **re-enable** only the scheduled actions
you need by enabling :ref:`developer mode <developer-mode>` and going to :menuselection:`Settings
--> Technical --> Automation: Scheduled Actions`.
If you plan to make the imported database your production, enable the scheduled actions you need.
You can check what is enabled in the database of origin and enable the same actions in the imported
database. Scheduled actions are located under :menuselection:`Settings --> Technical --> Automation
--> Scheduled Actions`.
Register the subscription
-------------------------
Register your subscription
--------------------------
After import, the database is considered a **duplicate** and will be unlinked from your enterprise
subscription.
Your subscription is unlinked after the import.
.. note::
You are allowed only one active database per subscription.
The imported database is considered a duplicate by default and the enterprise subscription is
therefore removed, as you can only have one database linked per subscription.
If you intend to make the imported database your production environment:
#. Unlink your previous database from the subscription.
#. Register the new one.
Refer to the :doc:`database registration documentation <../../on_premise>` for step-by-step
instructions.
If you plan to make it your production, unlink your former database from the subscription, and
register the newly imported database. Read the :doc:`database registration documentation
<../../on_premise>` for instructions.

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.9 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 23 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 38 KiB

After

Width:  |  Height:  |  Size: 29 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 13 KiB

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 10 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.9 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 31 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 5.7 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 8.7 KiB

View File

@@ -7,7 +7,7 @@ Overview
This chapter helps you to create your first Odoo module and deploy it in your Odoo.sh project.
This tutorial requires you created a project on Odoo.sh, and
This tutorial requires :ref:`you created a project on Odoo.sh <odoosh-gettingstarted-create>`, and
you know your Github repository's URL.
Basic use of Git and Github is explained.
@@ -85,7 +85,7 @@ From the Odoo.sh editor, in a terminal:
$ odoo-bin scaffold my_module ~/src/user/
Or, from your computer, if you have an installation of Odoo:
Or, from your computer, if you have an :doc:`installation of Odoo <../../on_premise/source>`:
.. code-block:: bash
@@ -304,8 +304,6 @@ you have to install it manually as explained in the
:ref:`above section about installing your module in staging databases
<odoosh-gettingstarted-firstmodule-productiondata-install>`.
.. _odoo-sh/module/add:
Add a change
============

Binary file not shown.

Before

Width:  |  Height:  |  Size: 28 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 51 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 73 KiB

View File

@@ -16,7 +16,7 @@ It also gives you the possibility to open terminals, Python consoles, Odoo Shell
:align: center
You can access the editor of a build through
:ref:`the branches tabs <odoo-sh/branches/tabs>`,
:ref:`the branches tabs <odoosh-gettingstarted-branches-tabs>`,
:ref:`the builds dropdown menu <odoosh-gettingstarted-builds-dropdown-menu>`
or by adding */odoo-sh/editor* to your build domain name
(e.g. *https://odoo-addons-master-1.dev.odoo.com/odoo-sh/editor*).
@@ -139,7 +139,7 @@ In this last command,
In other words, this means you can have multiple builds on the same branch, but on different revisions.
Once your changes are pushed,
according to your :ref:`branch push behavior <odoo-sh/branches/tabs/settings>`,
according to your :ref:`branch push behavior <odoosh-gettingstarted-branches-tabs-settings>`,
a new build may be created. You can continue to work in the editor you pushed from,
as it will have the same revision as the new build that was created, but always make sure to be
in an editor of a build using the latest revision of your branch.

View File

@@ -241,7 +241,7 @@ Custom domains
==============
To configure additional domains please refer to the corresponding branch's :ref:`settings tab
<odoo-sh/branches/tabs/settings>`.
<odoosh-gettingstarted-branches-tabs-settings>`.
.. _odoosh-gettingstarted-settings-submodules:

View File

@@ -0,0 +1,10 @@
:nosearch:
========
Overview
========
.. toctree::
:titlesonly:
overview/introduction

View File

@@ -0,0 +1,10 @@
=======================
Introduction to Odoo.sh
=======================
.. youtube:: QuNsa9n9PMg
:align: right
:width: 700
:height: 394
The documentation will help you go live with your Odoo.sh project in no time.

View File

@@ -97,24 +97,42 @@ be downloaded from the `Odoo download page <https://www.odoo.com/page/download>`
.. tabs::
.. group-tab:: Ubuntu
.. group-tab:: Debian/Ubuntu
.. note::
Odoo {CURRENT_MAJOR_VERSION} 'deb' package currently supports `Ubuntu Noble (24.04LTS)
<https://releases.ubuntu.com/noble>`_.
Odoo {CURRENT_MAJOR_VERSION} 'deb' package currently supports `Debian Bookworm (12)
<https://www.debian.org/releases/bookworm/>`_ and `Ubuntu Jammy (22.04LTS)
<https://releases.ubuntu.com/jammy>`_ or above.
Once downloaded, execute the following commands **as root** to install Odoo as a service,
create the necessary PostgreSQL user, and automatically start the server:
.. code-block:: console
# apt update
# apt install <path_to_installation_package>
# dpkg -i <path_to_installation_package> # this probably fails with missing dependencies
# apt-get install -f # should install the missing dependencies
# dpkg -i <path_to_installation_package>
.. warning::
- The `python3-xlwt` Debian package, needed to export into the XLS format, does not exist
in Debian Buster nor Ubuntu 18.04. If needed, install it manually with the following:
.. code-block:: console
$ sudo pip3 install xlwt
- The `num2words` Python package - needed to render textual amounts - does not exist in
Debian Buster nor Ubuntu 18.04, which could cause problems with the `l10n_mx_edi` module.
If needed, install it manually with the following:
.. code-block:: console
$ sudo pip3 install num2words
.. group-tab:: Fedora
.. note::
Odoo {CURRENT_MAJOR_VERSION} 'rpm' package supports Fedora 42.
Odoo {CURRENT_MAJOR_VERSION} 'rpm' package supports Fedora 38.
Once downloaded, the package can be installed using the 'dnf' package manager:

View File

@@ -4,7 +4,6 @@ Odoo essentials
.. toctree::
essentials/stages
essentials/activities
essentials/reporting
essentials/search

View File

@@ -4,12 +4,12 @@
Odoo rich-text editor
=====================
The Odoo rich-text editor allows for creating and editing rich-text content in HTML fields, such as
the :guilabel:`Internal Notes` and :guilabel:`Description` fields, as well as in the :ref:`Knowledge
articles <knowledge/articles_editing/edit-article>` and the :ref:`Studio report editor
<studio/pdf-reports/report-editor>`, among others. Start typing or use the :ref:`toolbar
<essentials/html_editor/toolbar>` or :ref:`powerbox <essentials/html_editor/commands>` for
formatting and structuring text.
The Odoo rich-text editor allows creating and editing rich-text content in HTML fields, such as the
:guilabel:`Internal Notes` and :guilabel:`Description` fields, as well as in the :ref:`Knowledge
articles <knowledge/articles_editing/edit-article>` and the :ref:`Studio report
editor <studio/pdf-reports/report-editor>`, among others. Start typing or use the
:ref:`toolbar <essentials/html_editor/toolbar>` or :ref:`powerbox
<essentials/html_editor/commands>` for formatting and structuring text.
.. tip::
Hover over any element in the text (header, table, clipboard, etc.) to reveal the
@@ -22,75 +22,51 @@ Text editor toolbar
===================
To edit a word, sentence, or paragraph, select or double-click it to display the text editor
toolbar and apply any of the following standard formatting options:
toolbar and apply any of the following formatting options:
- **Font style**: Define the font style using various options, such as :guilabel:`Header 1 to 6,
- **Font style**: Change the style using various options, such as :guilabel:`Header 1 to 6,
Normal, Paragraph, Code`, and :guilabel:`Quote`.
- **Font size**: Select the preferred font size.
- :icon:`fa-bold` (:guilabel:`Toggle bold`): Put the text in bold.
- :icon:`fa-italic` (:guilabel:`Toggle italic`): Put the text in italics.
- :icon:`fa-underline` (:guilabel:`Toggle underline`): Underline the text.
- :icon:`fa-font` (:guilabel:`Apply Font Color`): Customize the font colors:
- :guilabel:`B`: Put the text in bold.
- :guilabel:`I`: Put the text in italics.
- :guilabel:`U`: Underline the text.
- :guilabel:`S`: Strike through the text.
- :guilabel:`A` and :icon:`fa-paint-brush` :guilabel:`(paintbrush)` to customize the font and
background colors, respectively:
- :guilabel:`Solid`: Select the preferred color from the predefined palette.
- :guilabel:`Custom`: Customize the color palette using the wheel or by configuring the
:guilabel:`hex` code and :guilabel:`RGBA` values.
- :guilabel:`Gradient`: Select a predefined gradient or customize it by choosing
between :guilabel:`Linear` or :guilabel:`Radial` and adjusting the wheel.
- :icon:`fa-trash` (:guilabel:`Reset`): Restore the original font/background color.
- :icon:`fa-link` (:guilabel:`Add a link`): Insert or edit a URL link to a selected text, and
optionally upload an image using its file URL.
- :guilabel:`Odoo AI`: Write a prompt and get AI-generated content. Optionally, click the
AI suggestions instead of writing a prompt.
Click the :icon:`fa-ellipsis-v` (:guilabel:`Expand toolbar`) icon to display additional formatting
options:
- **Font family**: Use the :guilabel:`Default system font` or select a preferred font family for
the text.
- :icon:`fa-strikethrough` (:guilabel:`Toggle strikethrough`): Strike through the text.
- :icon:`fa-paint-brush` :guilabel:`(Apply Background Color)`: Customize the background colors.
- :icon:`fa-eraser` (:guilabel:`Remove Format`): Remove all formatting applied to a selected text.
- :icon:`fa-list-ul` (:guilabel:`Toggle List`): Select the following list options:
- :icon:`fa-list-ul` (:guilabel:`Bulleted list`): Turn the text into a bulleted list.
- :icon:`fa-list-ol` (:guilabel:`Numbered list`): Turn the text into a numbered list.
- :icon:`fa-check-square-o` (:guilabel:`Checklist`): Turn the text into a checklist.
- :icon:`fa-align-left` (:guilabel:`Align text`): Select the following text alignments:
- :icon:`fa-align-left` (:guilabel:`align left`): Align the text on the left.
- :icon:`fa-align-center` (:guilabel:`align center`): Align the text in the center.
- :icon:`fa-align-right` (:guilabel:`align right`): Align the text on the right.
- :icon:`fa-align-justify` (:guilabel:`justify`): Apply straight edges to both text margins.
- :guilabel:`Translate with AI`: Translate the content in the :doc:`installed languages
</applications/general/users/language>` with AI.
- **Font size**: Adjust the size of the text.
- :icon:`fa-list-ul` (:guilabel:`bulleted list`): Turn the text into a bulleted list.
- :icon:`fa-list-ol` (:guilabel:`numbered list`): Turn the text into a numbered list.
- :icon:`fa-check-square-o` (:guilabel:`checklist`): Turn the text into a checklist.
- :icon:`fa-link` (:guilabel:`link`): Insert or edit a URL link to a selected text, and optionally
upload an image using its file URL.
- :guilabel:`Translate`: Translate the content in the :doc:`installed languages
</applications/general/users/language>`.
- :icon:`fa-magic` :guilabel:`AI` (:guilabel:`ChatGPT`): Get AI-generated suggestions and adjust
the tone by clicking buttons such as :guilabel:`Correct, Shorten, Lengthen, Friendly,
Professional`, and :guilabel:`Persuasive`.
.. image:: html_editor/style-and-colors.png
:alt: Text editor's toolbox
.. tip::
- Use the following keyboard shortcuts to apply formatting:
- **Emphasis**: Press `CTRL`/`CMD` + `B`, `CTRL`/`CMD` + `I`, or `CTRL`/`CMD` + `U` to apply
the bold, italics, or underlined effect.
- **Numbered list**: Type `1.`, `1)`, `A.`, or `A)` to start a numbered list.
- **Bulleted list**: Type `*` or `-` to start a bulleted list.
- Click a hyperlinked text and perform one of the following actions: :icon:`fa-clipboard`
(:guilabel:`Copy Link`), :icon:`fa-pencil-square-o` (:guilabel:`Edit Link`), or
:icon:`fa-chain-broken` (:guilabel:`Remove Link`).
Use the following keyboard shortcuts to apply formatting:
- **Emphasis**: Press `CTRL`/`CMD` + `B`, `CTRL`/`CMD` + `I`, or `CTRL`/`CMD` + `U` to apply
the bold, italics, or underlined effect.
- **Numbered list**: Type `1.`, `1)`, `A.`, or `A)` to start a numbered list.
- **Bulleted list**: Type `*` or `-` to start a bulleted list.
.. _essentials/html_editor/commands:
Powerbox commands
=================
Commands enable editing and managing various types of features within the text editor, such as
tables, banners, headers, and more.
To use a command, type `/` to open the powerbox, then enter the command's name or select from
multiple features to insert tables, images, banners, etc.
@@ -112,24 +88,26 @@ multiple features to insert tables, images, banners, etc.
* - Command
- Use
* - :icon:`fa-minus` :guilabel:`Separator`
* - :guilabel:`Separator`
- Insert a horizontal rule separator.
* - :icon:`fa-columns` :guilabel:`2 columns`
* - :guilabel:`2 columns`
- Convert into 2 columns.
* - :icon:`fa-columns` :guilabel:`3 columns`
* - :guilabel:`3 columns`
- Convert into 3 columns.
* - :icon:`fa-columns` :guilabel:`4 columns`
* - :guilabel:`4 columns`
- Convert into 4 columns.
* - :icon:`fa-table` :guilabel:`Table`
* - :guilabel:`Table`
- Insert a table.
* - :icon:`fa-list-ul` :guilabel:`Bulleted list`
* - :guilabel:`Bulleted list`
- Create a bulleted list.
* - :icon:`fa-list-ol` :guilabel:`Numbered list`
* - :guilabel:`Numbered list`
- Create a numbered list.
* - :icon:`fa-check-square-o` :guilabel:`Checklist`
* - :guilabel:`Checklist`
- Create a checklist.
* - :icon:`fa-caret-square-o-right` :guilabel:`Toggle list`
- Hide a group of text under a foldable toggle.
* - :guilabel:`Quote`
- Add a blockquote section.
* - :guilabel:`Code`
- Add a code section.
.. note::
To organize a table, hover over a column or row to reveal the table menu. Click the
@@ -139,44 +117,40 @@ multiple features to insert tables, images, banners, etc.
.. tab:: Banner
.. list-table::
:widths: 30 70
:widths: 20 80
:header-rows: 1
:stub-columns: 1
* - Command
- Use
* - :icon:`fa-info-circle` :guilabel:`Banner Info`
* - :guilabel:`Banner Info`
- Insert an info banner.
* - :icon:`fa-check-circle` :guilabel:`Banner Success`
* - :guilabel:`Banner Success`
- Insert a success banner.
* - :icon:`fa-exclamation-triangle` :guilabel:`Banner Warning`
* - :guilabel:`Banner Warning`
- Insert a warning banner.
* - :icon:`fa-exclamation-circle` :guilabel:`Banner Danger`
* - :guilabel:`Banner Danger`
- Insert a danger banner.
.. tab:: Format
.. list-table::
:widths: 30 70
:widths: 20 80
:header-rows: 1
:stub-columns: 1
* - Command
- Use
* - :icon:`fa-header` :guilabel:`Heading 1`
* - :guilabel:`Heading 1`
- Big section heading.
* - :icon:`fa-header` :guilabel:`Heading 2`
* - :guilabel:`Heading 2`
- Medium section heading.
* - :icon:`fa-header` :guilabel:`Heading 3`
* - :guilabel:`Heading 3`
- Small section heading.
* - :icon:`fa-paragraph` :guilabel:`Text`
* - :guilabel:`Text`
- Paragraph block: Insert a paragraph.
* - :icon:`fa-exchange` :guilabel:`Switch direction`
* - :guilabel:`Switch direction`
- Switch the text's direction.
* - :icon:`fa-quote-right` :guilabel:`Quote`
- Add a blockquote section.
* - :icon:`fa-code` :guilabel:`Code`
- Add a code section.
.. tab:: Media
@@ -187,30 +161,39 @@ multiple features to insert tables, images, banners, etc.
* - Command
- Use
* - :icon:`fa-file-image-o` :guilabel:`Media`
* - :guilabel:`Media`
- :ref:`Insert an image <insert-media>` or icon: :doc:`Search the Unsplash database
</applications/general/integrations/unsplash>` or upload images, documents, or icons.
* - :icon:`fa-upload` :guilabel:`Upload a file`
* - :guilabel:`Clipboard`
- Add a clipboard section to store content and reuse it in other apps.
* - :guilabel:`Upload a file`
- Add a download box: share images, recordings, or documents that internal users can
download.
.. tab:: Navigation
.. list-table::
:widths: 30 70
:widths: 20 80
:header-rows: 1
:stub-columns: 1
* - Command
- Use
* - :icon:`fa-link` :guilabel:`Link`
* - :guilabel:`Link`
- Add a link: Type the label and enter a URL or upload a file, then click
:guilabel:`Apply`.
* - :icon:`fa-link` :guilabel:`Button`
* - :guilabel:`Button`
- Add a button: Type the label, enter a URL or upload a file, select the button style,
type, and size, then click :guilabel:`Apply`.
* - :icon:`fa-bookmark` :guilabel:`Table Of Contents`
* - :guilabel:`Article`
- Insert a shortcut to a :doc:`Knowledge article </applications/productivity/knowledge>`.
* - :guilabel:`Appointment`
- Add a specific appointment: Select one or several appointment type(s) to assign to
relevant users, then click :guilabel:`Insert a link`.
* - :guilabel:`Table Of Content`
- Highlight the structure (headings): Create a table of content based on the headings.
* - :guilabel:`Video Link`
- Insert a video: Copy-paste the video URL (Youtube, Vimeo, Dailymotion, and Youku only).
.. tab:: Widget
@@ -221,19 +204,43 @@ multiple features to insert tables, images, banners, etc.
* - Command
- Use
* - :icon:`fa-smile-o` :guilabel:`Emoji`
* - :guilabel:`Emoji`
- Add an emoji: search for the desired emoji.
* - :icon:`fa-star-o` :guilabel:`3 Stars`
* - :guilabel:`3 Stars`
- Insert a rating of up to 3 stars.
* - :icon:`fa-star` :guilabel:`5 Stars`
* - :guilabel:`5 Stars`
- Insert a rating of up to 5 stars.
.. tab:: AI Tools
.. list-table::
:widths: 20 80
:header-rows: 1
:stub-columns: 1
* - Command
- Use
* - :guilabel:`ChatGPT`
- Generate content with AI.
.. tab:: Basic Block
.. list-table::
:widths: 20 80
:header-rows: 1
:stub-columns: 1
* - Command
- Use
* - :guilabel:`Signature`
- Insert your signature.
.. _insert-media:
Insert media
------------
To insert media, type `/Media` or click the :icon:`fa-file-image-o` :guilabel:`(media)` icon in the
To insert media, type `/Media` or click the :icon:`fa-file-image-o` :guilabel:`(image)` icon in the
tooltip, then choose from the following tabs:
- :guilabel:`Images`
@@ -249,13 +256,7 @@ tooltip, then choose from the following tabs:
- :guilabel:`Add URL`: Copy-paste a valid URL.
- :guilabel:`Upload a document`: Upload a document from a local drive.
- :guilabel:`Icons`: Search for and select one of the available icons.
- :guilabel:`Videos`: Paste a video URL of the following sources: YouTube, Vimeo, Dailymotion, and
Youku. Alternatively, type code to embed a video.
.. note::
When adding a video, use the toggles to enable autoplay or looping, hide player controls or the
fullscreen button, or set a start time.
- :guilabel:`Icons`: Search an icon from the selection in the database.
Media editor toolbar
~~~~~~~~~~~~~~~~~~~~
@@ -263,22 +264,23 @@ Media editor toolbar
After :ref:`inserting an image <insert-media>`, click it to display the media editor toolbar, and
apply any of the following formatting options:
- :icon:`fa-search-plus` (:guilabel:`Preview image`): Preview the image, zoom in or out, rotate it,
print it, or download it. Exit the preview by clicking the :icon:`fa-times` :guilabel:`(close)`
icon in the top right corner.
- :guilabel:`Description`: Edit the image description and tooltip, then click :guilabel:`Apply`.
- :guilabel:`Caption`: Write a caption under 100 characters below the image.
- :icon:`fa-square` (:guilabel:`Rounded`): Apply a rounded shape to the corners of the image.
- :icon:`fa-circle-o` (:guilabel:`Circle`): Apply a circular shape to the image.
- :icon:`fa-sun-o` (:guilabel:`Shadow`): Apply a shadow effect to the image.
- :icon:`fa-picture-o` (:guilabel:`Thumbnail`): Apply a border to the image.
- :icon:`fa-plus-square-o` (:guilabel:`Padding`): Add an image padding and choose from
:guilabel:`Small`, :guilabel:`Medium`, :guilabel:`Large`, or :guilabel:`XL` sizes.
- :guilabel:`Resize`: Restore the image to its default size or set its size to :guilabel:`25%`,
:guilabel:`50%`, or :guilabel:`100%`.
- :icon:`fa-search-plus` (:guilabel:`preview`): Preview the image, zoom in or out, print it or
download it. Exit the preview by clicking the :icon:`fa-times` :guilabel:`(close)` icon in the
top right corner.
- :guilabel:`Description`: Edit the image description and tooltip, then click :guilabel:`Save`.
- :icon:`fa-square` (:guilabel:`rounded`): Apply a rounded shape to the corners of the image.
- :icon:`fa-circle-o` (:guilabel:`circle`): Apply a circular shape to the image.
- :icon:`fa-sun-o` (:guilabel:`shadow`): Apply a shadow effect to the image.
- :icon:`fa-picture-o` (:guilabel:`image`): Apply a border to the image.
- :icon:`fa-plus-square-o` (:guilabel:`padding`): Add an image padding and choose from small,
medium, large, or extra large sizes.
- :guilabel:`Default`: Restore the image to its default size.
- :guilabel:`100%`: Set the image to full size.
- :guilabel:`50%`: Set the image to half its size.
- :guilabel:`25%`: Set the image to a quarter of its size.
- :icon:`fa-object-ungroup` (:guilabel:`object`): Resize and rotate the image. Click the
:icon:`fa-object-ungroup` :guilabel:`(object)` icon a second time to reset the transformation.
- :icon:`fa-crop` (:guilabel:`Crop image`): Crop the image manually or apply the following options:
- :icon:`fa-crop` (:guilabel:`crop`): Crop the image manually or apply the following options:
- Choose from the `Flexible`, `16:9`, `4:3`, `1:1`, or `2:3` aspect ratios.
- Zoom in or out.
@@ -286,21 +288,9 @@ apply any of the following formatting options:
- Flip horizontally or vertically.
- Reset the image.
- :icon:`fa-link` (:guilabel:`Add a link`): Add a link to the image, type the URL, then click
:guilabel:`Apply`. To remove the link, click :icon:`fa-unlink` (:guilabel:`Remove Link`).
- :icon:`fa-exchange` (:guilabel:`Replace`): Replace the image by searching in the :doc:`Unsplash
- :guilabel:`Replace`: Replace the image by searching in the :doc:`Unsplash
</applications/general/integrations/unsplash>` database, adding a URL, or uploading a different
one.
- :icon:`fa-trash` (:guilabel:`Delete`): Delete the image.
Icon editor toolbar
~~~~~~~~~~~~~~~~~~~
After :ref:`inserting an icon <insert-media>`, click it to display the icon editor toolbar, and
apply any of the following formatting options:
- :icon:`fa-font` (:guilabel:`Select Font Color`): Customize the font color.
- :icon:`fa-paint-brush` (:guilabel:`Select Background Color`): Customize the background color.
- :guilabel:`Resize icon`: From :guilabel:`1x` to :guilabel:`5x`.
- :icon:`fa-play` (:guilabel:`Toggle icon spin`): Activate the spin animation.
- :guilabel:`Replace`: Select a different icon.
- :icon:`fa-link` (:guilabel:`link`): Insert a link to the image, type the URL, then click
:guilabel:`Apply`. To remove the link, click the :icon:`fa-chain-broken` :guilabel:`(unlink)` icon.
- :icon:`fa-trash` (:guilabel:`trash`): Remove the image.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 11 KiB

After

Width:  |  Height:  |  Size: 10 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 16 KiB

View File

@@ -121,9 +121,9 @@ accounting and reporting rules, including the following:
:doc:`main currency <accounting/get_started/multi_currency>`, and :doc:`taxes <accounting/taxes>`
apply to all branches.
- Branches can manage their own dedicated journals and related records.
- The parent company manages a common :ref:`fiscal period <accounting/year-end/fiscal-years>`, so
its :ref:`lock and closing dates <accounting/year-end/lock-everything-date>` apply across all
branches. However, branches may set earlier lock dates if needed.
- The parent company manages a common :ref:`fiscal period <year-end/fiscal-years>`, so its
:ref:`lock and closing dates <year-end/lock-everything-date>` apply across all branches. However,
branches may set earlier lock dates if needed.
- The parent company can access all :doc:`reports <accounting/reporting>`, :doc:`invoices
<accounting/customer_invoices>`, :doc:`bills <accounting/vendor_bills>`, etc., from its branches,
while each branch can only view its own data.

View File

@@ -81,13 +81,13 @@ To create an |sdd| mandate:
(:guilabel:`gear`) icon, then select :guilabel:`Mandate form`.
- The :guilabel:`SDD Scheme` depends on the type of customer: Select :guilabel:`CORE` for B2C
customers and :guilabel:`B2B` for B2B customers.
- |sdd| mandates are created automatically for :ref:`online payments made with SDD
<payment_providers/bank_payments/sdd>`.
- |sdd| mandates are created automatically for :doc:`online payments made with SDD
<../../payment_providers/sdd>`.
Once an |sdd| mandate is active, subsequent |sdd| payments can be generated via Odoo and
:ref:`uploaded to your online banking interface <accounting/batch_sdd/XML>`. Customers with an
active |sdd| mandate can also use this payment method for :ref:`online purchases
<payment_providers/bank_payments/sdd>`.
active |sdd| mandate can also use this payment method for :doc:`online purchases
<../../payment_providers/sdd>`.
.. _accounting/batch_sdd/close-revoke-mandate:
@@ -139,7 +139,7 @@ of all posted |sdd| payments to your online banking interface. To do so, follow
.. seealso::
- :doc:`batch`
- :ref:`SEPA Direct Debit for online payments <payment_providers/bank_payments/sdd>`
- :doc:`SEPA Direct Debit for online payments <../../payment_providers/sdd>`
- `SEPA guidelines
<https://www.europeanpaymentscouncil.eu/document-library/implementation-guidelines/sepa-credit-transfer-inter-psp-implementation-guidelines>`_

View File

@@ -19,7 +19,7 @@ Configuration
Make sure your :doc:`payment providers are correctly configured <../../payment_providers>`.
.. note::
By default, :ref:`Wire Transfer <payment_providers/bank_payments/wire_transfer>` is the
By default, ":doc:`Wire Transfer </applications/finance/payment_providers/wire_transfer>`" is the
only payment provider activated, but you still have to fill out the payment details.
To activate the Invoice Online Payment, go to :menuselection:`Accounting --> Configuration -->

Some files were not shown because too many files have changed in this diff Show More