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
426 changed files with 17229 additions and 25961 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

@@ -2,166 +2,168 @@
Odoo Online
===========
`Odoo Online <https://www.odoo.com/trial>`_ offers private databases hosted and managed by Odoo.
Odoo Online databases can be accessed using any web browser and do not require a local installation.
They can be used for long-term production or to thoroughly test Odoo, including customizations that
do not require custom code.
.. tip::
To quickly try out Odoo, shared `demo databases <https://demo.odoo.com>`_ are available for
testing. No registration is required; however, each database is only available for a few hours.
`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 modules from the `Odoo Apps Store
<https://apps.odoo.com/apps>`_.
Odoo Online is incompatible with custom modules or the Odoo App Store.
.. _odoo-online/database-manager:
Odoo Online databases are accessed using any web browser and do not require a local installation.
Database manager
================
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.
To manage an Odoo Online database, open to the `database manager
<https://www.odoo.com/my/databases>`_ and sign in as the database administrator.
.. _odoo_online/database-management:
.. _odoo-online/domain-names:
Database management
===================
Domain names
------------
To manage a database, go to the `database manager <https://www.odoo.com/my/databases>`_ and sign in
as the database administrator.
:doc:`Configure a custom domain name <../applications/websites/website/configuration/domain_names>`
by selecting a database and clicking :icon:`fa-globe` :guilabel:`Domain Names`.
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.
.. tip::
:ref:`Register a domain name for free <domain-name/register>`.
.. image:: odoo_online/database-manager.png
:alt: Accessing the database management options
.. _odoo-online/tags:
- :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`
Tags
----
Add tags to identify and sort databases by selecting a database and clicking :icon:`fa-tags`
:guilabel:`Tags`. In the dialog box, enter a tag, click the :icon:`fa-plus-circle`
(:guilabel:`plus`) button, and click :guilabel:`Save`.
.. tip::
Search for tags in the :icon:`fa-search` search bar at the top right.
.. _odoo-online/hide:
Hide
----
Permanently hide the database from the database manager by selecting it and clicking
:icon:`fa-eye-slash` :guilabel:`Hide`. In the dialog box, click :guilabel:`Yes, I don't need it
anymore`.
.. Note::
It is possible to access a hidden database through its URL.
.. _odoo-online/manage:
Manage
------
Access all other database management options by selecting it and clicking :icon:`fa-gears`
:guilabel:`Manage`.
Switch plans
~~~~~~~~~~~~
Switch `pricing plans <https://www.odoo.com/pricing>`_ by clicking :guilabel:`Switch` under the
desired plan.
.. _odoo-online/upgrade:
.. _odoo_online/upgrade:
Upgrade
~~~~~~~
=======
Launch a :ref:`database upgrade <upgrade-request-test>` by clicking :guilabel:`Upgrade`.
Trigger a database upgrade.
.. note::
This option is only displayed when an upgrade is available.
.. seealso::
For more information about the upgrade process, check out the :ref:`Odoo Online upgrade
documentation <upgrade-request-test>`.
.. _odoo-online/rename:
Rename
~~~~~~
Rename and change the URL of a database by clicking :guilabel:`Rename`. In the dialog box, enter a
:guilabel:`New name` and click :guilabel:`Rename`.
.. _odoo-online/duplicate:
.. _odoo_online/duplicate:
Duplicate
~~~~~~~~~
=========
Create a copy of the database by clicking :guilabel:`Duplicate`. In the dialog box, enter a
:guilabel:`New name` and click :guilabel:`Duplicate`.
Create an exact copy of the database, which can be used to perform testing without compromising
daily operations.
.. important::
- By default, the :guilabel:`For testing purposes` option is enabled. It disables all external
actions (emails, payments, delivery orders, etc.) on the duplicated database.
- Duplicates expire after 15 days.
- A maximum of five duplicates can be created per database. Under extraordinary circumstances,
contact `Odoo Support <https://www.odoo.com/help>`_ to extend the limit.
- 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/download:
.. _odoo_online/rename:
Download a backup
~~~~~~~~~~~~~~~~~
Rename
======
Download a ZIP file containing a database backup by clicking :guilabel:`Download Backup`.
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>`_.
- If the :guilabel:`Download Backup` option is disabled, it means the database is too large to be
downloaded using the database manager. Contact `Odoo Support <https://www.odoo.com/help>`_ to
request an alternative download solution.
- If the :guilabel:`Download` option is disabled, it means your database is too large to be
downloaded through this method. In this case, please contact `Odoo Support
<https://www.odoo.com/help>`_ to request an alternative download solution.
.. _odoo-online/activity-logs:
.. _odoo_online/domains:
View admin activity logs
~~~~~~~~~~~~~~~~~~~~~~~~
View the logs of all actions taken by Odoo employees or the database administrator on the database
by clicking :guilabel:`View Admin Activity Logs`.
.. note::
Actions taken by Odoo employees are typically the result of requests submitted to Odoo support,
done within the context of a quick start project, or necessary to maintain the database.
.. _odoo-online/transfer-ownership:
Transfer ownership
~~~~~~~~~~~~~~~~~~
Create a support ticket to request a database ownership transfer by clicking :guilabel:`Transfer
Ownership`.
.. _odoo-online/delete:
Delete
~~~~~~
Delete the database and close its related subscription by clicking :guilabel:`Delete`. In the dialog
box, click :guilabel:`Delete`.
.. danger::
All the database's data will be deleted instaneously for all users and **cannot be restored**. It
is recommended to :ref:`download a backup <odoo-online/download>` before deleting a database.
.. note::
After deletion, the database's name becomes available to anyone.
.. _odoo-online/web-services:
Web services
Domain names
============
To retrieve a list of all databases displayed under the `database manager
<https://www.odoo.com/my/databases>`_ programmatically, call the `list` method of the
`odoo.database` model via an :doc:`external JSON-2 API <../developer/reference/external_api>` call.
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 an :doc:`external JSON-2 API </developer/reference/external_api>` call.
.. example::
.. code:: python

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.8 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.0 KiB

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

@@ -1,137 +1,124 @@
.. _odoosh-gettingstarted-builds:
======
Builds
======
In Odoo.sh, a build is a database loaded by an Odoo server (`odoo/odoo
<https://github.com/odoo/odoo>`_ and `odoo/enterprise <https://github.com/odoo/enterprise>`_)
running on a specific revision of your project repository in a containerized environment. Its
purpose is to test the proper behavior of the server, the database, and the features associated with
that revision.
.. _odoo-sh/builds/overview:
Overview
========
.. image:: builds/builds-overview.png
:alt: Overiew of the builds
In Odoo.sh, a build is considered as a database loaded by an Odoo server
(`odoo/odoo <https://github.com/odoo/odoo>`_ & `odoo/enterprise
<https://github.com/odoo/enterprise>`_) running on a specific revision of your project repository in
a containerized environment. Its purpose is to test the well-behavior of the server, the database
and the features with this revision.
In the :guilabel:`Builds` overview, a row represents a branch, and a cell within that row represents
a build of that branch.
.. image:: builds/interface-builds.png
:align: center
Most builds are created after pushes to your GitHub repository branches. They can also be created
through other operations, such as importing a database on Odoo.sh or requesting a rebuild for a
branch in your project.
In this view, a row represents a branch, and a cell of a row represents a build of this branch.
Builds can have three possible statuses:
Most of the time, builds are created following pushes on your Github repository branches.
They can be created as well when you do other operations,
such as importing a database on Odoo.sh or asking a rebuild for a branch in your project.
- A build is considered **successful** if no errors or warnings occur during its creation.
Successful builds are highlighted in **green**.
- A build is considered **almost successful** if warnings occur, but there are no errors. Almost
successful builds are highlighted in **yellow**.
- A build is considered **failed** if errors occur during its creation. Failed builds are
highlighted in **red**.
A build is considered successful if no errors or warnings come up during its creation.
A successful build is highlighted in green.
.. note::
Builds do not always create a database from scratch. For instance, when pushing a change on the
production branch, the created build starts the server with your new revision and tries to load
the current production database on it.
A build is considered failed if errors come up during its creation.
A failed build is highlighted in red.
.. _odoo-sh/builds/stages:
If warnings come up during the creation, but there are no errors, the build is considered almost
successful. It is highlighted in yellow to notify the developer warnings were raised.
Builds do not always create a database from scratch. For instance, when pushing a change on the
production branch, the build created just starts the server with your new revision and tries to load
the current production database on it. If no errors come up, the build is considered successful, and
otherwise failed.
Stages
======
.. _odoo-sh/builds/stages/production:
Production
----------
The first build of a production branch creates a database from scratch. If this build is successful,
this database will become the production database of your project.
The first build of a production branch creates a database from scratch.
If this build is successful, this database is considered as the production database of your project.
From then on, pushes to the production branch will create new builds that attempt to load the
database using a server running the new revision.
From then, pushes on the production branch will create new builds that attempt to load the database
using a server running with the new revision.
If the build is successful or almost successful, the production database will run with this build
and its associated revision.
If the build is successful, or has warnings but no errors, the production database will now run with
this build, along with the revision associated to this build.
If the build fails to load or update the database, the previous successful build is reused to load
the database. In that case, the database continues to run using the previous successful revision.
If the build fails to load or update the database, then the previous successful build is re-used to
load the database, and therefore the database will run using a server running with the previous
successful revision.
.. note::
The build used to run the production database is always the first in the builds list. If a build
fails, it is placed after the build currently running the production database.
.. _odoo-sh/builds/stages/staging:
The build used to run the production database is always the first of the builds list. If a build
fails, it is put after the build currently running the production database.
Staging
-------
Staging builds duplicate the production database and attempt to load this copy using the revisions
of the staging branches.
Staging builds duplicate the production database,
and try to load this duplicate with the revisions of the staging branches.
Each time you push a new revision to a staging branch, the resulting build uses a fresh copy of the
production database. Databases are not reused between builds of the same branch. This ensures that:
Each time you push a new revision on a staging branch, the build created uses a new copy of the
production database. The databases are not re-used between builds of the same branch. This ensures:
- Staging builds use databases that closely match the current production state, so your tests are
not performed on outdated data.
- You can freely experiment within a staging database. When you want to start over with a new copy
of the production database, you can request a rebuild.
* staging builds use databases that are close to what the production looks like, so you do not make
your tests with outdated data,
However, this also means that if you make configuration changes in a staging database and do not
apply them in production, those changes will not be present in the next build of the same staging
branch.
* you can play around as much as you want in the same staging database, and you can then ask for a
rebuild when you want to restart with a new copy of the production.
.. _odoo-sh/builds/stages/development:
Nevertheless, this means that if you make configuration changes in staging databases and do not
apply them in the production, they will not be passed on the next build of the same staging branch.
Development
-----------
Development builds create new databases, load the demo data, and run the unit tests.
Development builds create new databases, load the demo data and run the unit tests.
A build will be considered failed if tests fail during installation, as they are designed to raise
errors when something is wrong.
A build will be considered failed and highlighted in red if tests fail during the installation,
as they are meant to raise errors if something wrong occurs.
If all tests pass and no errors occur, the build is considered successful.
If all tests pass, and there is no error, the build will be considered successful.
.. note::
Depending on the list of modules to install and test, a development build can take up to one hour
to be ready. This is due to the large number of tests included in the default Odoo module suite.
.. _odoo-sh/builds/stages/features:
According to the list of modules to install and test, a development build can take up to 1 hour to
be ready. This is due to the large number of tests set in the default Odoo modules suite.
Features
========
The production branch always appears first. Other branches are ordered by the time of their last
created build. The stage highlighted in purple corresponds to the stage selected in the
:guilabel:`Branches` menu.
The production branch will always appear first, and then the other branches are ordered by last
build created. You can filter out the branches.
.. tip::
You can filter branches using the search bar.
.. image:: builds/interface-builds-branches.png
:align: center
.. image:: builds/branches-menu.png
:alt: The branches menu
For each branch, you can access the last build's database using the *Connect* link and jump to the
branch code using the *Github* link. For other branches than the production, you can create a new
build which will use the latest revision of the branch using the link *rebuild*. This last link is
not available when there is already a build in progress for the branch.
For each branch, you can:
.. image:: builds/interface-builds-build.png
:align: center
- Access the latest build's database by clicking :guilabel:`Connect`.
- Jump to the branch's code by clicking :guilabel:`Github`.
- Create a new build by clicking :guilabel:`Rebuild`. It uses the latest revision of the branch (it
is not available if a build is already in progress for that branch).
For each build, you can access the revision changes using the button with the Github icon. You can
access the build's database as the administrator using the *Connect* button. Also, you can access
the database with another user using the *Connect as* button, in the dropdown menu of the *Connect*
button.
For each build, you can:
.. _odoosh-gettingstarted-builds-download-dump:
- View the revision changes by clicking the :icon:`fa-github` (:guilabel:`GitHub`) icon.
- Access the build's database as the administrator by clicking :guilabel:`Connect` or as another
user by clicking the :icon:`fa-caret-down` (:guilabel:`More Actions`) button next to
:guilabel:`Connect` and selecting :guilabel:`Connect as`.
- Access the same tools as in the branches view by clicking the :icon:`fa-caret-down`
(:guilabel:`More Actions`) button next to :guilabel:`Connect` and selecting :guilabel:`Logs`,
:guilabel:`Web Shell`, :guilabel:`Editor`, :guilabel:`Outgoing e-mails` (for the staging and
development stages), :guilabel:`Monitoring`, and :guilabel:`Download DB dump` (for the production
and staging stages).
.. image:: builds/interface-builds-build-dropdown.png
:align: center
.. image:: builds/builds-options.png
:alt: A build's options
.. _odoosh-gettingstarted-builds-dropdown-menu:
In the dropdown menu of the build, you can access the same features than in :ref:`the branches view
<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.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 6.3 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.2 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 32 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.9 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

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,8 +16,8 @@ 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 builds dropdown menu <odoo-sh/builds/stages/features>`
: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.

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