Compare commits

...

276 Commits

Author SHA1 Message Date
Tom Aarab (toaa) 303477b659 [IMP] ecommerce: add custom anchors, links and "see also" sections
This commit adds custom anchors, links and new see also sections

task-3212218
2023-03-01 18:12:14 +01:00
Jonathan Castillo (jcs) 5fd3092ad3 [IMP] accounting: new version of cash discount
task-2834752

closes odoo/documentation#3683

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-02-28 18:13:33 +01:00
Antoine Vandevenne (anv) 34bc63d2bc [ADD] extensions/cards: add an extension to implement cards
The extension adds two new directive:
- `cards` is the row container for one or more `card` directives.
- `card` is the implementation of a Bootstrap card that accepts a
  `target` argument for the href of the card, a `large` option to render
  the card on two columns, a `tag` option to display a single arbitrary
  tag on the card, and arbitrary content that is shown in the card
  body.

task-3141419

closes odoo/documentation#3685

X-original-commit: 72e636da5f
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-02-28 10:55:05 +01:00
Jonathan Castillo (jcs) 178bce67bf [IMP] accounting: add custom anchors to tax_return.rst headings
closes odoo/documentation#3679

X-original-commit: 91fadf0ff6
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-02-27 14:08:03 +01:00
Odoo Translation Bot dc0eb3ccb8 [I18N] Update translation terms from Transifex 2023-02-26 00:40:30 +01:00
Timothy Kukulka (tiku) 4bd9a4ef8e [MOV] Misc: Move Portal doc to Misc
closes odoo/documentation#3632

X-original-commit: d690314ba5
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Timothy Kukulka (tiku) <tiku@odoo.com>
2023-02-24 18:03:52 +01:00
John Holton (hojo) 3744d13e31 [FIX] Odoo.sh: correct content error
closes odoo/documentation#3667

X-original-commit: 033f6de839
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2023-02-24 13:53:55 +01:00
Sam Lieber (sali) a1d2c7a6c8 [ADD] l10n: Ecuador fiscal localization
task-3164933

closes odoo/documentation#3485

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-02-24 11:28:10 +01:00
Antoine Vandevenne (anv) 3dc6bb83c1 [MOV] developer/cli: move "Command-line interface (CLI)" to the reference dir
task-2991663

closes odoo/documentation#3655

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-02-23 14:33:17 +01:00
Antoine Vandevenne (anv) 73f976e679 [MOV] developer/api/extract_api: move "Extract API" to the reference dir
task-2991663

Part-of: odoo/documentation#3655
2023-02-23 14:33:17 +01:00
Antoine Vandevenne (anv) 95ed856446 [MOV] developer/api/external_api: move "External API" to the reference dir
task-2991663

Part-of: odoo/documentation#3655
2023-02-23 14:33:17 +01:00
Antoine Vandevenne (anv) b817e16a4c [MOV] developer/api/iap: move "In-App Purchase" to the howtos dir
task-2991663

Part-of: odoo/documentation#3655
2023-02-23 14:33:16 +01:00
Antoine Vandevenne (anv) 2701d91db0 [MOV] developer/iot: move "Internet of things" the howtos dir
task-2991663

Part-of: odoo/documentation#3655
2023-02-23 14:33:16 +01:00
Antoine Vandevenne (anv) 9561c9abf8 [IMP] tutorials/*: hide outdated tutorials
*: backend, web, website

task-2991663

Part-of: odoo/documentation#3655
2023-02-23 14:33:16 +01:00
Antoine Vandevenne (anv) 2d469bccbc [MOV] howto/web: move "Customizing the webclient" to the tutorials dir
task-2991663

Part-of: odoo/documentation#3655
2023-02-23 14:33:16 +01:00
Antoine Vandevenne (anv) 58f2174c49 [MOV] howto/website: move "Building a website" to the tutorials dir
task-2991663

Part-of: odoo/documentation#3655
2023-02-23 14:33:15 +01:00
Antoine Vandevenne (anv) 642c4839f7 [MOV] howtos/backend: move "Building a module" to the tutorials dir
task-2991663

Part-of: odoo/documentation#3655
2023-02-23 14:33:15 +01:00
Antoine Vandevenne (anv) 9c5ea316ff [MOV] howtos/discover_js_framework/*: move "Discover the JS Framework" to the tutorials dir
task-2991663

Part-of: odoo/documentation#3655
2023-02-23 14:33:15 +01:00
Antoine Vandevenne (anv) a8c78a80ba [MOV] tutorials/getting_started/*: promote advanced chapters to independent tutorials
task-2991663

Part-of: odoo/documentation#3655
2023-02-23 14:33:15 +01:00
Antoine Vandevenne (anv) 4f4e346953 [MOV] howto/rdtraining: move "Getting started" to the tutorials dir
This commit also replaces references to the "Building a module"
tutorial by references to the "Getting started" tutorial.

task-2991663

Part-of: odoo/documentation#3655
2023-02-23 14:33:14 +01:00
Antoine Vandevenne (anv) 73ce4d6cd8 [ADD] developer/tutorials: add a directory for developer tutorials
task-2991663

Part-of: odoo/documentation#3655
2023-02-23 14:33:14 +01:00
Xavier cf67ac8504 [ADD] Spreadsheet/Reporting/Search
Task ID: 3053800

closes odoo/documentation#3000

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-02-23 14:32:59 +01:00
“Chiara 3a4af92667 [ADD] Accounting: Italian warning
closes odoo/documentation#3652

Taskid: 3201538
X-original-commit: eea1aec26b
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
Signed-off-by: chiaraprattico <chpr@odoo.com>
2023-02-22 18:14:44 +01:00
Tom Aarab (toaa) 470e74492f [ADD] eCommerce: shipping page
Added a shipping page to the eCommerce section. Forward to master.

closes odoo/documentation#3229

Taskid: 3111638
Signed-off-by: Aarab Tom (toaa) <toaa@odoo.com>
2023-02-20 18:38:18 +01:00
Donatienne Pirlot 1db61fca8f [IMP] accounting: updating the doc related to vendor bill to payment
closes odoo/documentation#3240

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-02-20 11:56:35 +01:00
tsm-odoo 8b92b734b2 [FIX] deploy: add set_headers, fixing wrong $host value
closes odoo/documentation#3628

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-02-20 10:53:18 +01:00
Odoo Translation Bot a721fe6c4d [I18N] Update translation terms from Transifex 2023-02-19 00:40:45 +01:00
KC (ksc) f28ecbdcff [ADD] events: added complete documentation
closes odoo/documentation#3595

X-original-commit: b76b3fa3f3
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Kevin Scannell (ksc) <ksc@odoo.com>
2023-02-17 23:17:40 +01:00
Donatienne Pirlot 8d6e656701 [IMP] accounting: update cheat sheet
This PR change the cheat sheet of the accounting documentation.
Change done:
* Change name of the file: memento to cheat_sheet
* Adding explanation to the doc (Ex: Invoices and bills status)
* Correcting some sentences

closes odoo/documentation#3623

Task-id: 2847663
X-original-commit: 2fa9de17e1
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-02-17 22:16:41 +01:00
Jonathan Castillo (jcs) d04a61fc40 [IMP] install/maintain: add section about search engine indexation
task-3179504

closes odoo/documentation#3618

X-original-commit: 2fccceb964
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-02-17 16:32:28 +01:00
Jonathan Castillo (jcs) bab84c61a0 [FIX] legal: RST cleanup (headings delimiters characters)
This commit changes the characters used as heading delimiters in the
/legal/ folder of the documentation. This makes it easier for writers to
figure out the heading order as all other files in this repository use
the same order of heading delimiters characters.

closes odoo/documentation#3614

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-02-17 16:32:23 +01:00
Tom Aarab (toaa) d43a9b2598 [ADD] eCommerce: new price management page
Current documentation doesn't feature any pricing management info.
Forward to master.

closes odoo/documentation#3046

Taskid: 3086649
Signed-off-by: Aarab Tom (toaa) <toaa@odoo.com>
2023-02-17 10:55:29 +01:00
Brandon Seltenrich (BRSE) f25fc40dde [IMP] inventory: update automated inventory valuation
closes odoo/documentation#3604

X-original-commit: aaa1de94bd
Signed-off-by: Brandon Seltenrich (brse) <brse@odoo.com>
2023-02-17 00:28:12 +01:00
LoredanaLrpz 6618683216 [IMP] pos: rename & redo receipt page (structure, text, images)
Task ID: 3005121

Do not merge for Odoo 16 - configuration flow to modify

closes odoo/documentation#3570

X-original-commit: 295d29effd
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Perazzo Loredana (lrpz) <lrpz@odoo.com>
2023-02-16 21:47:22 +01:00
Donatienne Pirlot 817ad955af [IMP] sign: secured authentication info added
closes odoo/documentation#3430

Id: 3084552
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-02-16 10:05:34 +01:00
LoredanaLrpz 403f54d1df [IMP] knowledge: h3 titles improvement and one typo fixed
Task ID: 3189032

closes odoo/documentation#3590

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-02-15 19:50:58 +01:00
luvi 7a9d807bcc [ADD] web: add core components documentation
Those components were added during the Owl rewrite of the webclient
that happened in 16.0. Unfortunately, there was still no documentation
for them.

This commits fixes that by adding documentation for the Notebook and
the Colorlist components.

closes odoo/documentation#3580

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-02-15 13:52:53 +01:00
Jonathan Castillo (jcs) 17319f92b2 [FIX] *: RST cleanup
RST cleanup to comply with the RST guidelines. This is required so we
can use "make test", as there are currently hundreds of errors. For now,
it is unusable because of the oldest code in this repo.

closes odoo/documentation#3581

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-02-15 12:51:21 +01:00
Amelia Williams 18b000602b [FIX] 02_setup: remove gramatical error
closes odoo/documentation#3579

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-02-15 11:46:43 +01:00
Sam Lieber (sali) d623956da5 [IMP] marketing: sms pricing and faq doc updates
closes odoo/documentation#3564

X-original-commit: 1591e1f087
Signed-off-by: Zachary Straub <zst@odoo.com>
2023-02-15 03:17:26 +01:00
Tom Aarab (toaa) 4db98bd840 [ADD] ecommerce: cross and upselling page
Adding a cross/upselling page for the ecommerce section. Forward to
master.

closes odoo/documentation#3367

Taskid: 3142720
Signed-off-by: Aarab Tom (toaa) <toaa@odoo.com>
2023-02-14 17:04:07 +01:00
LoredanaLrpz bfa4ee56fd [IMP] pos: invoice issuance via qr code on receipts
Task ID: 3100959

closes odoo/documentation#3411

Signed-off-by: Perazzo Loredana (lrpz) <lrpz@odoo.com>
2023-02-13 20:31:51 +01:00
Mahmoud Metwally 7913fd7bdd [FW][FIX] developer/howtos: typos and phrasing
closes odoo/documentation#3555

Forward-port-of: odoo/documentation#3541
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2023-02-13 14:53:07 +01:00
Victor Feyens a3068e1a2f [FIX] *: typos
closes odoo/documentation#3550

X-original-commit: 831cf23be9
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2023-02-13 14:53:04 +01:00
Victor Feyens c517053aaf [ADD] tests: add sphinxlint checkers for headings
task-2801043

X-original-commit: ad768c33aa
Part-of: odoo/documentation#3550
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-02-13 14:53:04 +01:00
Jonathan Castillo (jcs) ecbb755471 [MOV] finance: move fiscal localisation pages and merge /overview/
The content written in the fiscal localisation pages are not only for
Accounting, but also for other apps such as Payroll and Point of Sales.
This commit moves the content to the "Finance" level, to better reflect
this reality, and merges the pages in the /overview/ folder in the main
category page.

closes odoo/documentation#3546

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-02-13 14:52:59 +01:00
Jonathan Castillo (jcs) 26ddeef42c [FIX] *: first small clean of the code
Friday afternoon cleanup. This is required so we can use "make test", as
there are currently hundreds of errors. For now, it is unusable because
of the oldest code in this repo.

closes odoo/documentation#3540

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-02-13 11:37:15 +01:00
Odoo Translation Bot 6f50fabf83 [I18N] Update translation terms from Transifex 2023-02-13 08:13:25 +01:00
“Chiara 543158ff12 [IMP] accounting/l10n: Italian Localization
closes odoo/documentation#3527

Taskid: 3067241
X-original-commit: ec0fae4992
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-02-10 11:01:52 +01:00
Martin Trigaux 566449f3d4 [I18N] migrate to the nex transifex API
Tansifex is deprecating it's client and switches to a go-based
solution in its API v3

The new client is still backward compatible with the old format but
the v2 API is going to be phased out.
See https://github.com/transifex/cli to install the deplyments using
the tx client

This PR is the result of the "tx migrate" command

closes odoo/documentation#3525

X-original-commit: 9abf788c31
Related: odoo/enterprise#36898
Related: odoo/odoo#112350
Signed-off-by: Martin Trigaux (mat) <mat@odoo.com>
2023-02-10 08:41:57 +01:00
Donatienne Pirlot 778b739a57 [ADD] accounting: localization page for uk
closes odoo/documentation#3517

X-original-commit: 0550374968
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Pirlot Donatienne (dopi) <dopi@odoo.com>
2023-02-09 16:40:06 +01:00
Tom Aarab (toaa) 6b45da21c1 [ADD] ecommerce: new payment providers page
Adding a documentation on payment providers specifically for the
ecommerce section.

closes odoo/documentation#3346

Taskid: 3138597
Signed-off-by: Aarab Tom (toaa) <toaa@odoo.com>
2023-02-09 13:01:58 +01:00
Tom Aarab (toaa) 17ee191156 [ADD] eCommerce: checkout process page
Adding new page on checkout process for eCommerce. Forward to master.

closes odoo/documentation#3192

Taskid: 3110554
Signed-off-by: Aarab Tom (toaa) <toaa@odoo.com>
2023-02-09 08:12:58 +01:00
Jason Aerts 1689b80470 [ADD] project: project creation and management
Adding a project creation and management page for the project app. Forward to master.

closes odoo/documentation#3244

Taskid: 3117349
Signed-off-by: Perazzo Loredana (lrpz) <lrpz@odoo.com>
2023-02-08 16:27:40 +01:00
luvi fc79df42fd [FIX] web: fix wrong ActionSwiper documentation
Since 16.0, the documentation for this component was no longer
correct, since the component was moved to web during the refactor
of the webclient views. This commit also adds documentation of
props that were introduced during the refactor, already present
in 16.0.

closes odoo/documentation#3504

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-02-08 15:24:35 +01:00
Martin Trigaux 734c0ee6ef [IMP] conf: add names for newly activated languages
closes odoo/documentation#3499

Signed-off-by: Martin Trigaux (mat) <mat@odoo.com>
2023-02-07 17:35:39 +01:00
Tom Aarab (toaa) 9049013dde [ADD] Sales: new page on eWallets and gift cards programs
Adding a new page on eWallets and gift cards programs for the Sales app
documentation.

closes odoo/documentation#3241

Taskid: 3086636
Signed-off-by: Aarab Tom (toaa) <toaa@odoo.com>
2023-02-07 12:54:59 +01:00
Tom Aarab (toaa) d09e6a83aa [ADD] eCommerce: add to cart page
Adding add to cart page to the eCommerce section. Forward to master.

closes odoo/documentation#3175

Taskid: 3099603
Signed-off-by: Aarab Tom (toaa) <toaa@odoo.com>
2023-02-07 11:49:35 +01:00
Zachary Straub (ZST) afc9a024f8 [FIX] Quality: add missing/cutoff content
closes odoo/documentation#3489

X-original-commit: 591e80deb7
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Signed-off-by: Zachary Straub <zst@odoo.com>
2023-02-06 20:31:22 +01:00
Tom Aarab (toaa) bd13d34bd6 [IMP] ecommerce: updated variants page
Previous page was mostly on the sales app. New page focuses on ecommerce
with :ref: to sales. Forward to master.

closes odoo/documentation#3299

Taskid: 3121379
Signed-off-by: Aarab Tom (toaa) <toaa@odoo.com>
2023-02-06 18:33:00 +01:00
Odoo Translation Bot 550c26010a [I18N] Update translation terms from Transifex 2023-02-05 00:40:48 +01:00
Julien Van Roy e2b4e8ad84 [IMP] accounting/electronic_invoicing: add a-nz einvoicing format
Since commit
https://github.com/odoo/odoo/commit/9431dddd7c13ae130e7af29936307d22459d543f,
the 'A-NZ BIS Billing 3.0' format is available for australian and new
zealand companies.

closes odoo/documentation#3382

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-02-03 14:58:46 +01:00
Tom Aarab (toaa) 5329cff046 [ADD] eCommerce: add product page
Adding a product page for the eCommerce section, currently does not
exist. V16, forward to master.

closes odoo/documentation#3112

Taskid: 2903859
Signed-off-by: Aarab Tom (toaa) <toaa@odoo.com>
2023-02-03 14:58:44 +01:00
Mahmoud Metwally e6269ae56e [FW][FIX] developer/javascript_reference: typos and phrasing
closes odoo/documentation#3474

Forward-port-of: odoo/documentation#3470
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2023-02-02 17:27:02 +01:00
Sam Lieber (sali) 230796dd96 [ADD] Quality: configure quality control checks
closes odoo/documentation#3465

X-original-commit: ec1ddb34b1
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
2023-02-01 22:05:21 +01:00
Zachary Straub (ZST) fdf47bf106 [IMP] inventory: add a note on default warehouses
closes odoo/documentation#3459

X-original-commit: e5069dbf72
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-02-01 18:19:45 +01:00
Tom Aarab (toaa) 029b5a183b [IMP] ecommerce: updated catalog page
Updated catalog page. Forward to master.

closes odoo/documentation#2971

Taskid: 3071640
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-02-01 18:19:42 +01:00
Donatienne Pirlot dc490cf482 [MOV] purchase: moving doc page from accounting to purchase
Moving the Manage vendor bills page from the accounting app to the purchase app as it is
more relevant.

closes odoo/documentation#3454

Taskid: 2687652
X-original-commit: b5febf2299
Signed-off-by: Zachary Straub <zst@odoo.com>
2023-01-31 23:33:51 +01:00
thkl-odoo d06371c30b [IMP] install/maintain: clarification in the upgrade SLA
The Service Level Agreement has to be updated. Any additional line of
code, without using studio, in standard modules is not supposed to be
covered by the upgrade team. It is slightly different than the point
telling "development of custom modules"

closes odoo/documentation#3448

X-original-commit: f469e4ef81
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-01-31 21:47:16 +01:00
Martin Trigaux 0e74a3daf7 [I18N] *: export 16.0 translations 2023-01-31 11:31:39 +01:00
Melanie Nguyen (meng) df5d0a3cfb [IMP] sales: fix returns and refunds
closes odoo/documentation#3435

X-original-commit: 2fb777e3e8
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Melanie Nguyen (meng) <meng@odoo.com>
2023-01-30 22:17:23 +01:00
Simon Goffin d81513ed1c [FIX] content: The outlook add-in URL
The outlook add-in URL was not updated

opw:3131547

closes odoo/documentation#3409

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-30 11:30:27 +01:00
Sam Lieber (sali) 6f5a97705d [ADD] inventory: setup sendcloud shipping
closes odoo/documentation#2864

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-30 09:59:12 +01:00
Odoo Translation Bot 454153bfa7 [I18N] Update translation terms from Transifex 2023-01-29 00:40:39 +01:00
Jonathan Castillo (jcs) 14154737d2 [IMP] accounting: update how to get api keys for silverfin integration
task 2918697

closes odoo/documentation#3426

X-original-commit: 9a0bf7bb0e
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-01-27 14:37:57 +01:00
avg-odoo dd241b171d [IMP] install/maintain: update content of upgrade SLA
The maintenance fees cover the maintenance of the custom code (whoever
did it) and are not specifically dedicated to custom code written by
Odoo development teams

closes odoo/documentation#3420

X-original-commit: 92de7ccb2d
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-01-26 23:16:38 +01:00
KC (ksc) 28237e3835 [IMP] surveys:update get started docs
closes odoo/documentation#3414

X-original-commit: 3cf6e25f06
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Kevin Scannell (ksc) <ksc@odoo.com>
2023-01-26 22:17:14 +01:00
Mathieu (mano) 620387b9e8 [IMP] toctrees: redesign and new card component
The goal of this commit is to propose a first step towards a new
`.. card::` directive for the toctrees. This is a first design
proposition for this new card component in raw html for the fallback
page `howtos.rst`

The long term objective is to redesign the toctrees by implementing card
components, clearer toctree list design and custom html pages.

Related to task-3059229

closes odoo/documentation#3406

X-original-commit: 53035435f9
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-26 18:14:09 +01:00
Donatienne Pirlot 4f5bc3026e [IMP] : accounting : manage a financial budget documentation
closes odoo/documentation#3399

X-original-commit: 78d3cf489a
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Pirlot Donatienne (dopi) <dopi@odoo.com>
2023-01-26 08:17:44 +01:00
Jess Rogers (jero) b34e8b6344 [IMP] helpdesk: close_ticket.rst cleanup
closes odoo/documentation#3386

X-original-commit: 8396c2a4ad
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Jessica Rogers (jero) <jero@odoo.com>
2023-01-24 20:02:22 +01:00
Nishant Jain (niai) 8245b99acb [ADD] accounting/l10n: add section about E-waybill (India)
closes odoo/documentation#3393

X-original-commit: 97e914b340
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-01-24 18:56:41 +01:00
Victor Feyens 55a96bbe51 [ADD] finance: explain how to disable online invoice payment
closes odoo/documentation#3383

Related: odoo/odoo#110177
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-23 16:48:16 +01:00
LoredanaLrpz 8796ff1310 [ADD] knowledge: main, editing and properties pages
Task ID: 3035887

closes odoo/documentation#2838

Signed-off-by: Perazzo Loredana (lrpz) <lrpz@odoo.com>
2023-01-23 16:47:45 +01:00
Odoo Translation Bot d8140d6cba [I18N] Update translation terms from Transifex 2023-01-22 00:40:41 +01:00
LoredanaLrpz 38c3897f85 [IMP] POS: improve and update the barcode page (text & screenshots)
Task ID: 3004918

closes odoo/documentation#3365

X-original-commit: 8138b95b0b
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Perazzo Loredana (lrpz) <lrpz@odoo.com>
2023-01-20 17:13:13 +01:00
nle-odoo 420c066e01 [FIX] developer/guidelines: odoo addons import order
The example for import order is a little confusing since it is wrong.

closes odoo/documentation#3379

X-original-commit: f7b1f66b8c
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Nicolas Lempereur (nle) <nle@odoo.com>
2023-01-20 16:08:15 +01:00
Antoine Vandevenne (anv) 4c1a09a908 [IMP] supported_versions: add end of support dates for SaaS versions
closes odoo/documentation#3366

X-original-commit: ebce333c73
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-19 18:50:26 +01:00
pedrambiria cb9ca25a63 [FIX] productivity/outlook: correct link for plugin installation
Forward-port of a8c58815f3 for 16.0+

closes odoo/documentation#3349

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2023-01-19 17:51:06 +01:00
Martin Trigaux 759bd325c8 [I18N] *: update 16.0 source terms 2023-01-19 16:41:37 +01:00
Jonathan Castillo (jcs) 4df31a2c77 [ADD] accounting: configuration of silverfin integration
task-2918697

closes odoo/documentation#3357

X-original-commit: 7f6535dcc8
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-01-18 19:56:50 +01:00
fdardenne a70665ef34 [FIX] developer: remove merge text in chapter 6
closes odoo/documentation#3348

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-18 11:49:18 +01:00
Sam Lieber (sali) 5b9d1cba2a [FW][ADD] maintain: connect office365 with azure oauth
closes odoo/documentation#3347

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-18 11:49:15 +01:00
Wesley Kao (weka) 481dbf8988 [IMP] MRP: edited semi-finished products user doc
closes odoo/documentation#3337

X-original-commit: 79e08557d3
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-17 10:22:40 +01:00
Ray Carnes 527c9469cd [IMP] sales: update portal.rst
Removed old and probably not needed image of the dashboard showing the Contacts App

closes odoo/documentation#3343

X-original-commit: 4d3a10e8cd
Signed-off-by: Zachary Straub <zst@odoo.com>
2023-01-16 21:37:37 +01:00
Xavier BOL (xbo) f51633fdd5 [IMP] backend: add groups_draggable option in kanban view
Related PR: odoo/odoo#97447

task-2941335

closes odoo/documentation#3312

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-16 10:03:46 +01:00
Odoo Translation Bot 6adb717521 [I18N] Update translation terms from Transifex 2023-01-15 00:40:33 +01:00
Donatienne Pirlot 3ddc0eaada [ADD] accounting: add documentation related to the Kenyan localization
closes odoo/documentation#3329

Id: 3089195
X-original-commit: cc0285144a
Signed-off-by: Pirlot Donatienne (dopi) <dopi@odoo.com>
2023-01-13 16:51:41 +01:00
Martin Trigaux a523721181 [I18N] *: update source terms 2023-01-13 15:30:06 +01:00
Martin Trigaux e277b542aa [IMP] conf: prepare for building documentation in Romanian 2023-01-13 15:20:01 +01:00
stefanorigano (SRI) 2ca32b40bc [IMP] scss: update, improve preexisting content
Add a new content focused on SCSS and user-interface.

- SCSS coding guidelines: regroup information already available (eg [1])
  or based on "oral tradition".
  The aim is not to establish new rules, ~99% of the current codebase
  is already compliant.

- SCSS inheritance: explain how SCSS assets management works in odoo.
  For example, people still find confusing that overrides are defined
  *before* the variable to customize.

- SCSS optimization tips: suggestions to lean SCSS code. Based on SCSS
  optimization task's know-how [2].

- CSS variables: explain how this feature is commonly used in odoo to
  adapt layout & design without raw CSS overrides.

- UI Icons: Add link to fontAwesome4 library . Replace the picture of
  odoo icons with the actual font (90kb image VS 15Kb font)

[1] https://github.com/odoo/odoo/wiki/SCSS-coding-guidelines
[2] https://www.odoo.com/web#id=2704984&menu_id=4720&cids=1&model=project.task&view_type=form

task-3090800

closes odoo/documentation#3093

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-12 18:19:27 +01:00
Antoine Vandevenne (anv) 42f6840586 [CLN] remove files for saas-15.1 and saas-15.3
closes odoo/documentation#3323

X-original-commit: b6b5b9257b
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-12 17:12:00 +01:00
fdardenne 54628b4f5b [IMP] developer: JavaScript tutorial: chapter 3-7
This commit adds the chapter 3,4,5,6 and 7 of the JavaScript web
framework tutorial.

This new tutorial allows people to discover Owl and the building blocks
of the Odoo JavaScript framework.

closes odoo/documentation#3222

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Géry Debongnie <ged@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-12 16:00:50 +01:00
Elisabeth Dickinson 8b7df4edc8 [IMP] odoo_theme: Fix alerts and accordions colors
closes odoo/documentation#3319

X-original-commit: 8aebb79237
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-12 08:48:45 +01:00
Elisabeth Dickinson 5b9d73bd9d [IMP] odoo_theme: Fix text-dark on homepage
While doing the changes on the text-dark issue, we noticed the
homepage's text color isn't aligned with the rest of the website.
`.text-muted` was too light, so we changed it to `.text-dark`.

X-original-commit: ee2390fdaf
Part-of: odoo/documentation#3319
2023-01-12 08:48:45 +01:00
Elisabeth Dickinson b5a464a8d9 [IMP] odoo-theme: Revert $dark color variable to initial $gray-900
This was changed to get a good text/background contrast on the
alert-dark (Exercise).
By doing so, the .text-dark class generated by BS from the $dark
theme-color was gray instead of the intended near-black color.

By changing the variable, the contrast issue with the alert was back,
to solve this we directly override the alert's background color instead.

X-original-commit: 32c9e59ae6
Part-of: odoo/documentation#3319
2023-01-12 08:48:44 +01:00
Olivier Dony d4de89f2e6 [CHG] legal: partnership contract v10 (update SH commission)
Version not bumped for ES translation, since it needs other updates
first
2023-01-09 11:55:23 +01:00
Olivier Dony 43614ec5ef [FIX] legal: show license for Odoo 16 2023-01-09 11:43:39 +01:00
Odoo Translation Bot a9ff6c7c39 [I18N] Update translation terms from Transifex 2023-01-08 00:40:36 +01:00
Sam Lieber (sali) 087291adc8 [ADD] maintain: setup mailjet api
closes odoo/documentation#3306

X-original-commit: 197a1cc932
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
2023-01-06 16:55:48 +01:00
Antoine Vandevenne (anv) 800857d67e [FIX] odoo_theme: re-enable redirect fallback logic
closes odoo/documentation#3300

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-06 10:30:02 +01:00
Odoo's Mergebot ad3228abc0 [MERGE] odoo_theme: SCSS code clean up
In order to reduce the size of our css files:
Some unused or repeated code was found and removed.
Variables have been cleaned up, the way the admonitions (alerts) were created has been modified,

Expanding the use of BS variables in order to reduce repeated code and to stay consistent in the general design.
Sphinx was updated which made some changes in the DOM, breaking some of the CSS:
the literals for example, these have been fixed in this PR.
The font sizes were breaking the typescale, this has been fixed by modifying the typescale
rather than hardcoding font sizes.

closes odoo/documentation#3293

Forward-port-of: odoo/documentation#3290
Forward-port-of: odoo/documentation#3225
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-05 10:06:24 +01:00
Elisabeth Dickinson 33a6cca3bf [IMP][CSS] Replace text-decoration on link with BS override 2023-01-05 09:48:42 +01:00
Elisabeth Dickinson 9392d28758 [IMP][CSS] Reorder styles according to styles guidelines 2023-01-05 09:48:42 +01:00
Elisabeth Dickinson b0decaa8c4 [IMP] fix typo 2023-01-05 09:48:42 +01:00
Elisabeth Dickinson 3c344bcb77 [IMP] icon fixes 2023-01-05 09:48:42 +01:00
Elisabeth Dickinson 87ab86bac4 [IMP][CSS] Fix unresponsive font-size on alert text
By removing $font-size-sm on the alerts, the text is bigger. The title
text and its icon have been increased as well.
2023-01-05 09:48:42 +01:00
Elisabeth Dickinson 0831592eba [IMP][CSS] Remove browser prefixes and unnecessary mixins 2023-01-05 09:48:42 +01:00
Elisabeth Dickinson b503fdc6f4 [IMP][CSS] Fix literals in alerts containing tabs 2023-01-05 09:48:42 +01:00
Elisabeth Dickinson f3573dbfae [IMP][CSS] Fix data indentation 2023-01-05 09:48:42 +01:00
Elisabeth Dickinson 1f95fc014b [IMP][CSS] Fix alignment on modal btn-close 2023-01-05 09:48:42 +01:00
Elisabeth Dickinson 41f0464dce [IMP] Indentation fix 2023-01-05 09:48:41 +01:00
Elisabeth Dickinson 0f5110785f [REM] Removal of changelog
The idea was not developed and it has since been decided not to do it.
2023-01-05 09:48:41 +01:00
Elisabeth Dickinson b108feec5d [IMP][CSS] Use BS font-weight variables and fix
Instead of redefining font-weights, we override the BS variables and add
one extra font-weight in the newly-introduced extended utilities file.
After this change all the variables needed replacing and some tweaking
was needed to get the same or closely similar result as before this
change.

By doing so the font-weight classes in the typography file were obsolete
and hence removed.
Some other font-weight issues which were already there have been fixed
in this commit too.
2023-01-05 09:48:41 +01:00
Elisabeth Dickinson 9b7ec0fa11 [IMP][CSS] Fix color variable issue 2023-01-05 09:48:41 +01:00
Elisabeth Dickinson d01888d0be [IMP][CSS] Revamp of the .o_spoiler element to use same code as alerts 2023-01-05 09:48:41 +01:00
Elisabeth Dickinson 1638484a82 [IMP][CSS]Change order of imported scss files
The aim of this cleanup is to use as many bootstrap classes, functions
and utilities as possible to reduce the amount of extra code.
Instead of redefining variables, BS variables are overridden in the
bootstrap_overridden file.

In order to be able to reuse these overridden variables within our own
custom variable file — and after consultation with SRI — it was
determined that the variables.scss file should come after the bootstrap
files in the order of importation, unlike the order of odoo website's
scss files.

Changes to variables in bootstrap_overridden have been made to adapt to
the new structure.
2023-01-05 09:48:41 +01:00
Elisabeth Dickinson 3d73e4c5b4 [IMP][CSS] Use CSS variables to style different alert types
CSS variables avoid having to repeat code for each alert type.
Also remove the need to add "tip" to the theme-colors (no need for "tip"
styled buttons, badges etc, especially as tips use the primary color) by
styling `.alert-tip` with customized copy of BS alert mechanism.

In order to be able to modify the icons with a CSS variable,
the `content` attribute has been removed from the `o-inline-icon` mixin.
Code where this mixin is called in other places has been adapted.
2023-01-05 09:48:41 +01:00
Elisabeth Dickinson 4f0713af54 [IMP][CSS] Place overrides in bootstrap_overridden file 2023-01-05 09:48:41 +01:00
Elisabeth Dickinson 637ea4b337 [IMP][CSS] Clean up the file according to conventions
Includes reordering styles, renaming variables ($o-*),
re-indenting lines, removing commented code
2023-01-05 09:48:41 +01:00
Elisabeth Dickinson 8ab91d242b [IMP][CSS] Set gray background to it's original darker color 2023-01-05 09:48:41 +01:00
Elisabeth Dickinson 4d3442cca4 [IMP][CSS] Improve literals styling (o_code, .sig-*) 2023-01-05 09:48:41 +01:00
Elisabeth Dickinson 179e5c6ccd [IMP][CSS] Update _sphinx_basic.css after update of Sphinx
Note: Some code is commented instead of being deleted.
This allows us to keep track of what should be commented out in future
versions of Sphinx' basic CSS.
2023-01-05 09:48:41 +01:00
Elisabeth Dickinson 1806ace2ef [IMP][CSS] Remove repetitive or unnused CSS 2023-01-05 09:48:41 +01:00
Elisabeth Dickinson bceba8c55d [IMP][CSS] Improve margins on headings and sections 2023-01-05 09:48:41 +01:00
Elisabeth Dickinson e36bd9b924 [IMP][CSS] Replace margin and padding values with variables 2023-01-05 09:48:41 +01:00
Elisabeth Dickinson 8febda41af [IMP][CSS] Revamp modal to use all BS classes and variables 2023-01-05 09:48:41 +01:00
Elisabeth Dickinson 3146d394c4 [IMP][CSS] Rescale heading fonts 2023-01-05 09:48:41 +01:00
Elisabeth Dickinson 559d542a0d [IMP][CSS] Cleanup font variables 2023-01-05 09:48:41 +01:00
Elisabeth Dickinson ff2b57a127 [IMP][CSS] Cleanup admonitions (alerts) 2023-01-05 09:48:41 +01:00
Elisabeth Dickinson 6e36a01099 [IMP][CSS] Cleanup color variables 2023-01-05 09:48:41 +01:00
Elisabeth Dickinson e342ffb989 [IMP][CSS] update literals styles (.o_code, .sig-*) 2023-01-05 09:48:41 +01:00
Antoine Vandevenne (anv) 7b0b941b97 [IMP] odoo_theme: add the class o_code on literals
The SCSS that styles the `literal`, `code`, `file`, and `command` roles
is excessively complex because the traduction from RST to HTML is not
consistent from one role to another: some use `<code>` elements, some
have the `code` class, some wrap the literal with a `span` element.

This commit sets the `o_code` class on all of these roles' parent node
at translation time to allow simplifying the SCSS target.
2023-01-05 09:48:41 +01:00
Mahmoud Metwally 9705552a6b Update qweb.rst
closes odoo/documentation#3288

X-original-commit: 8cde1f7b74
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-04 15:10:00 +01:00
Sam Lieber (sali) 1b701dc6f3 [FIX] maintain: correct cname definition
closes odoo/documentation#3280

X-original-commit: 96cbb2375b
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-01-03 23:43:05 +01:00
Jason (jaae) b00c3c8246 [IMP] project: adding description to app page
closes odoo/documentation#3273

X-original-commit: cfaf4386c2
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-01-03 21:00:21 +01:00
Mahmoud Metwally 9c9c20110c [FIX] rdtraining: fix writing errors
closes odoo/documentation#3266

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-03 19:07:18 +01:00
Antoine Vandevenne (anv) b16202dcde [FIX] odoo_theme: handle non-TOC pages when expanding top menu entries
Trying to "expand" those pages lead to a crash that prevented the menu
to be shown at all.

Incidentally, this commit also handles menus built with `make fast`.

closes odoo/documentation#3263

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-03 19:07:05 +01:00
Antoine Vandevenne (anv) da19dab578 [IMP] odoo_theme: scroll the active menu entry into view
In large and deeply nested TOCs like finance/accounting/fiscal_localizations/localizations/...
the user had to constantly scroll the menu to the menu entry they just
clicked because the expanded menu would not fit entirely on the page.
With this commit, the active menu entry is scrolled into view each time
the page is reloaded.

The previous behavior was also the reason for expanding the top menu
entries on only the homepage. Thanks to the scroll, they now always
expand.

Part-of: odoo/documentation#3263
2023-01-03 19:07:05 +01:00
Antoine Vandevenne (anv) 0d0e4ac4df [IMP] README: remove version from links and rephrase explanations
task-2897123

closes odoo/documentation#3260

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-03 13:27:06 +01:00
Antoine Vandevenne (anv) 784fc69d47 [IMP] contributing/documentation: rewrite the contribution guide
This commit restructures the contributing/documentation page to re-use
content introduced with the contributing/development page and to
display the two ways to contribute (github vs git) in content tabs
rather than sections.

The guide is simplified and updated to delegate long explanations to
other pages or websites, remove useless images and focus on getting
users ready to contribute.

task-2897123

Part-of: odoo/documentation#3260
2023-01-03 13:27:06 +01:00
Antoine Vandevenne (anv) 8d94f66d81 [ADD] contributing/development: add a guide to contribute to the codebase
In addition, this commit extracts the git guidelines from the coding
guidelines. This helps link the git guidelines and unclutter the coding
guidelines, which should focus on only the programming languages.

task-2897123

Part-of: odoo/documentation#3260
2023-01-03 13:27:05 +01:00
LoredanaLrpz 4b258e1401 [IMP] pos: update tip info, remove and update screenshots
closes odoo/documentation#3059

Taskid: 3005150
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-02 17:08:04 +01:00
Martin Trigaux 293e749298 [I18N] general: update source terms 2023-01-02 10:05:04 +01:00
Odoo Translation Bot cf03645815 [I18N] Update translation terms from Transifex 2023-01-01 00:40:39 +01:00
Michelle Vu (mivu) 883814c50e [IMP] Calendar: Outlook sync warning
If committed, this will add a more elaborate warning on what users must
do before syncing Odoo Calendar and Outlook Calendar. It also removes
mentions of the import/export process and archiving events, as these
methods will not prevent email spam from Outlook.

closes odoo/documentation#3233

X-original-commit: 5979a772e6
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Michelle (mivu) <mivu@odoo.com>
2022-12-27 22:12:37 +01:00
Antoine Vandevenne (anv) b1efc8aad2 [FIX] odoo_theme: update the aria attributes when scrolling the page TOC
The 'aria-expanded' attribute was not correctly updated on the `i` tag
when the user scrolled through the page TOC. This caused a minor issue
where an arrow (`i`) that was collapsed manually with a click would no
longer automatically expand afterward.

task-3106339

closes odoo/documentation#3238

X-original-commit: f068065d39
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-12-27 13:10:41 +01:00
Antoine Vandevenne (anv) 899479c18d [IMP] odoo_theme: expand top level menu items on the homepage
When the user browses the homepage, it might be hard to figure out
where they want to go next. Expanding the top-level menu items could
help them with that.

task-3106339

X-original-commit: 5526f1ea07
Part-of: odoo/documentation#3238
2022-12-27 13:10:41 +01:00
Odoo Translation Bot abe3f8f3d6 [I18N] Update translation terms from Transifex 2022-12-25 00:40:38 +01:00
Martin Trigaux 6a56842e1f [I18N] *: export 16.0 source terms 2022-12-23 10:35:59 +01:00
oco-odoo bf2d3d9ed2 [IMP] accounting: full documentation of the new report engine
Engine report for accounting.

closes odoo/documentation#2784

Taskid: 3042880
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-12-21 16:55:24 +01:00
Sam Lieber (sali) b8a1829fb6 [IMP] general: add notes about dev mode toggle
closes odoo/documentation#3210

X-original-commit: 54b903e512
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
2022-12-19 19:44:06 +01:00
LoredanaLrpz 4070f64467 [IMP] POS: upgrade the getting started page for 16.0
Task ID: 3090486

closes odoo/documentation#3218

X-original-commit: fb5c128fb7
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Perazzo Loredana (lrpz) <lrpz@odoo.com>
2022-12-19 17:45:55 +01:00
Odoo Translation Bot a74557c3ba [I18N] Update translation terms from Transifex 2022-12-18 00:40:13 +01:00
Antoine Vandevenne (anv) 3b80d99db7 [FIX] legal: fix path to PDF version of legal agreements
closes odoo/documentation#3215

X-original-commit: 94cbce843b
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-12-16 18:02:43 +01:00
Zachary Straub (ZST) 73566a9a77 [IMP] email: add mail.default.from_filter
closes odoo/documentation#3209

X-original-commit: df041b1212
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Signed-off-by: Zachary Straub <zst@odoo.com>
2022-12-15 20:12:40 +01:00
Victor Feyens d3dbed98c2 [FIX] core: latex build
* latest droid package does not allow \usepackage{droid} anymore,
replace it with the right package

See https://github.com/MiKTeX/miktex-packaging/issues/136

* remove reference to package texlive-generic-recommended since
it's not available nor necessary since ubuntu 20.04.

closes odoo/documentation#3203

X-original-commit: 816f437064
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-12-15 18:56:55 +01:00
fdardenne 1bd7e803e0 [IMP] developer: JavaScript tutorial: enhance chapter 1
This commit adds several small information on chapter 1 of the training
 owl:

- 1.1 How to get to the playground controller
- 1.2 Add a reference on sub component
- 1.4 How to activate the dev mode in owl

closes odoo/documentation#3177

Signed-off-by: Dardenne Florent (dafl) <dafl@odoo.com>
2022-12-14 17:56:07 +01:00
Tom Aarab (toaa) adf0596a5f [IMP] odoo.sh: Python libraries and packages
Added a note on packages and extensions support

closes odoo/documentation#3187

Taskid: 2836438
X-original-commit: b1f92ba879
Signed-off-by: Aarab Tom (toaa) <toaa@odoo.com>
2022-12-13 09:02:09 +01:00
LoredanaLrpz 6b6104f081 [ADD] pos: Stripe payment terminal + link to doc in payment provider
Task ID: 2574495

closes odoo/documentation#2891

Signed-off-by: Perazzo Loredana (lrpz) <lrpz@odoo.com>
2022-12-12 19:10:38 +01:00
Horacio Tellez 924e6a2339 [FIX] rdtraining: remove outdated line about journal_id in chapter 14
In chapter 14 there was a line pointing to how to deduce a default journal for an `account.move` record.
This is no longer needed as the journal is automatically deduced using the `move_type`. Also, the link
point to an outdated line of code that causes an error.

closes odoo/documentation#3182

X-original-commit: 67a75a3e11
Signed-off-by: Horacio Tellez Perez (hote) <hote@odoo.com>
2022-12-12 09:55:44 +01:00
Odoo Translation Bot a527413acf [I18N] Update translation terms from Transifex 2022-12-11 00:40:16 +01:00
Valentin Vallaeys (vava) b2d0ab29a5 [FIX] developer: better definition for oe_inline
closes odoo/documentation#3171

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-12-09 15:19:04 +01:00
Antoine Vandevenne (anv) fa2d0f6363 [IMP] conf.py, *: interpolate the version and releases in the content
This commit replaces hard-coded occurrences of the version and of the
last, current and next releases' version with placeholders interpolated
at build time to avoid manually updating these after each freeze.

task-2917614

closes odoo/documentation#3166

X-original-commit: 12e1085199
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-12-09 10:40:06 +01:00
KC (ksc) f2acac5cae [ADD] marketing automation: added 'getting started' section and docs to round out documentation
closes odoo/documentation#3161

X-original-commit: 4f6b03dc5b
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-12-08 17:46:59 +01:00
fdardenne c5c6daef22 [IMP] developer: JavaScript tutorial: chapter 2
This commit adds the chapter 2 of the JavaScript tutorial.

This new tutorial allows people to discover Owl and the building blocks
of the Odoo JavaScript framework.

closes odoo/documentation#3105

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Géry Debongnie <ged@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-12-08 16:43:13 +01:00
Antoine Vandevenne (anv) 6472593cc0 [IMP] contributing: list the ways to contribute to Odoo
task-2897123

closes odoo/documentation#3154

X-original-commit: a309372d83
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-12-08 15:39:14 +01:00
Donatienne Pirlot da49f6f3e4 [IMP] accounting: different ways to record a payment
closes odoo/documentation#3147

X-original-commit: 7a57fb3c81
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-12-08 12:29:09 +01:00
Morgane (morm) a52a9eef2d [IMP] documentation: legal page design
Prior to this commit, the terms and conditions were displayed in a table
with all the languages and it was not practical for the futur, with many
more languages.

task-3073198

closes odoo/documentation#3136

X-original-commit: d7b69d802a
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-12-07 18:44:34 +01:00
jopa-odoo f9db0854b7 [IMP] legal/fr: fix typos, spellcheck French translation
No changes to actual contents/semantics.

closes odoo/documentation#3135

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-12-07 18:44:31 +01:00
Zachary Straub (ZST) 2f93f2ae7e [IMP] CRM: updating flow and screenshots about lead mining
Task: 2543815
Cherry pick from #998

Omitted changes proposed in the **track_leads** directory (e.g. `lead_scoring.rst` + image folder). Both the content and image updates were already pushed from another PR so what was proposed on #998 was outdated and no longer necessary.

What’s left over are the original proposed changes in #998, within the **acquire_leads** directory which include updates to `lead_mining.rst` and corresponding image files.

On top of these proposals, I went ahead and made the following changes:

- renamed the image files in the asset directory, since they were using outdated naming convention (e.g. LM1.png, LM6.png, LM7.png)
- cleaned up rst formatting issues (headings, line breaks, added guilabels, etc.)
- rewrote document so content was more concise + followed content guidelines. You can see the first version of proposals here to compare the changes made.

closes odoo/documentation#3130

X-original-commit: 2416a2e5e9
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Zachary Straub <zst@odoo.com>
2022-12-07 17:43:56 +01:00
“Chiara fcba85bc71 [ACC] accounting: Forecasting bills
closes odoo/documentation#3126

Tasikd: 3069519
X-original-commit: 939d40c16d
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: chiaraprattico <chpr@odoo.com>
2022-12-07 12:42:32 +01:00
“Chiara 0c5769cc87 [IMP] accounting: tax return
closes odoo/documentation#3116

X-original-commit: 1db9968faa
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: chiaraprattico <chpr@odoo.com>
2022-12-07 09:33:03 +01:00
Melanie Nguyen (meng) db4f26f0db [IMP] mail plugins: gmail plugin updates
Updated to reflect how to download Gmail Plugin from Google Workspace Marketplace for Odoo Online users; added new images

Closes Odoo Task 3001713

closes odoo/documentation#3110

X-original-commit: 88e00bf021
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-12-07 09:32:59 +01:00
Donatienne Pirlot 64e952bbe1 [IMP] sign: update the documentation related to sign app
closes odoo/documentation#2923

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-12-06 17:36:43 +01:00
Sam Lieber (sali) 39e7282e32 [IMP] accounting/l10n: AR update documentation
closes odoo/documentation#3106

X-original-commit: efb165d791
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-12-06 16:24:09 +01:00
Morgane (morm) 898fdf15ae [FIX] documentation: tabs responsiveness
Prior of this commit, the tabs were not responsive in the documentation

closes odoo/documentation#3080

X-original-commit: c9a001d22b
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-12-06 14:37:03 +01:00
“Chiara 88149f5b56 [IMP] accounting: SEPA
closes odoo/documentation#3099

Taskid: 2890089
X-original-commit: 5628762fae
Signed-off-by: Platteau Xavier (xpl) <xpl@odoo.com>
Signed-off-by: chiaraprattico <chpr@odoo.com>
2022-12-06 08:52:58 +01:00
Odoo Translation Bot 7a949a914c [I18N] Update translation terms from Transifex 2022-12-04 00:40:34 +01:00
Tom Aarab (toaa) 3c95e8596e [IMP] paypal: typo update
V14 has a dedicated "Fees" tab for PayPal, current documentation does not reflect that.

closes odoo/documentation#3086

Taskid: 3089273
X-original-commit: d774094e87
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
Signed-off-by: Aarab Tom (toaa) <toaa@odoo.com>
2022-12-03 00:36:16 +01:00
LoredanaLrpz 8ae05b9a4b [IMP] POS: improve the page - update text and screenshots
closes odoo/documentation#3048

Taskid: 3004917
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-12-02 23:39:00 +01:00
Tom Aarab (toaa) a1f4c3704b [IMP] Payment providers: advertise and document the "demo" provider
New page to document the new features of the demo payment provider, and
modifications to related pages

task id: 2982367

closes odoo/documentation#2736

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-12-02 22:45:22 +01:00
LoredanaLrpz 1197494895 [IMP] pos: update and improve the page and screenshots
closes odoo/documentation#3072

Taskid: 3062150
X-original-commit: f2b8645a3c
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Perazzo Loredana (lrpz) <lrpz@odoo.com>
2022-12-02 14:38:00 +01:00
“Chiara 068a3e7dcb [IMP] accounting: update payments by check
closes odoo/documentation#3067

Taskid: 3062532
X-original-commit: 528d16c611
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: chiaraprattico <chpr@odoo.com>
2022-12-02 11:38:16 +01:00
fdardenne 62051b643f [ADD] developer: add a tutorial on Owl
This commit adds the introduction and the chapter 1 of the new
Owl/JavaScript framework tutorial.

This new tutorial allows people to discover Owl and the building blocks
of the Odoo JavaScript framework.

closes odoo/documentation#2845

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Géry Debongnie <ged@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-12-01 18:04:17 +01:00
Jonathan Castillo (jcs) a895603a16 [IMP] contribution: typo in documentation.rst
closes odoo/documentation#3055

X-original-commit: f0fa7a2e22
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-11-30 16:01:27 +01:00
Sam Lieber (sali) e4bb11b1f8 [ADD] discuss: specific email server from
closes odoo/documentation#2992

X-original-commit: ce1d0b216d
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
2022-11-30 16:01:01 +01:00
Antoine Vandevenne (anv) 828568afba [IMP] contributing/documentation: suggest to clone with ssh
GitHub requires users to "use token-based authentication for all
authenticated operations", for example `git push`. See
https://github.blog/2020-12-15-token-authentication-requirements-for-git-operations/

This commit suggests new contributors to clone the repository with SSH
so that the remote URL is automatically configured with the SSH
protocol.

task-3036845

closes odoo/documentation#3041

X-original-commit: dfb7801484
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-11-29 15:44:58 +01:00
Wesley Kao (weka) 2af0557a19 [IMP] MRP: updated Kits doc rst content
Went through the existing kits documentation and changed a lot of the
content, as much of it was outdated. Also replaced the images with new
ones.

closes odoo/documentation#2996

X-original-commit: 426b66ec7b
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: weka-odoo <weka@odoo.com>
2022-11-28 19:19:32 +01:00
Odoo Translation Bot 96f3b947d6 [I18N] Update translation terms from Transifex 2022-11-27 00:40:34 +01:00
“Chiara d8f9c121ff [IMP] accounting: batch payments sdd
Forward to 16.0

closes odoo/documentation#3035

X-original-commit: fe2d694aff
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: chiaraprattico <chpr@odoo.com>
2022-11-25 12:46:50 +01:00
Ivan Kropotkin 17bb126cab [FW][FIX] developer/reference: code example
closes odoo/documentation#3027

Forward-port-of: odoo/documentation#2943
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-11-25 03:52:51 +01:00
Donatienne Pirlot 84e900f0f3 [IMP] Documents: improve and update the Documents documentation
closes odoo/documentation#2887

Id: 2899532
Signed-off-by: Pirlot Donatienne (dopi) <dopi@odoo.com>
2022-11-25 01:23:52 +01:00
Victor Feyens b2121b7891 [FIX] developer/*: code blocks linting & fixes
invalid xml
invalid python
correct indentation

closes odoo/documentation#3001

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-11-24 21:38:37 +01:00
Victor Feyens 387cf15e7f [FIX] developer/*: consistent code-block language specification
Part-of: odoo/documentation#3001
2022-11-24 21:38:37 +01:00
Loan (lse) a13d93cb93 [IMP] point_of_sale: Adyen Event URLs configuration
Add more details as of how to set Adyen Event URLs.
This is important to configure as it is necessary to
receive a callback from Adyen terminal when a transaction
have been done.

OPW-3041117
OPW-3041117

closes odoo/documentation#3021

X-original-commit: aa9126b037
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-11-23 21:41:51 +01:00
Jeff Nyalik e44a8c49bb [FIX] rdtraining: fix typo
Kind of a typo here " it will not possible" to "it will not be possible"

closes odoo/documentation#3016

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-11-23 18:39:58 +01:00
Tori (vpk) ec85d1e843 [ADD] Sales: new doc about returns and refunds
Task Number: 2514789

closes odoo/documentation#2988

X-original-commit: be0a995e21
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-11-23 18:39:52 +01:00
Donatienne Pirlot 06e1272491 [IMP] upgrade: updating screenshots and process steps
closes odoo/documentation#3014

X-original-commit: f0f6083ee5
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-11-22 20:12:08 +01:00
william-andre 025e365a9b [IMP] cli: suggest auto complete script
Add a hint to how to build autocompletion values for odoo-bin

closes odoo/documentation#3008

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-11-22 16:13:38 +01:00
Victor Feyens e9c26512e6 [IMP] developer/howtos: deprecate themes tutorial
This tutorial was already outdated in 13.0 (but
supposedly working).

In 14.0+, a lot of changes happened in website logic,
especially for 'website option definitions', breaking
the existing theme tutorial.

Considering the fact that a new tutorial is being made,
and that fixing the whole existing tutorial would be
a big work, it will be kept, but hidden as 'most things
being said still make sense'.

closes odoo/documentation#3005

X-original-commit: 9cc60baf46
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-11-21 20:12:45 +01:00
Odoo Translation Bot b035e4ddc9 [I18N] Update translation terms from Transifex 2022-11-20 00:40:35 +01:00
Victor Feyens 568e8a28fa [FIX] developer/mobile: use spaces and not tabs for indentation
closes odoo/documentation#2983

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-11-18 20:30:01 +01:00
Victor Feyens 1b811f8de8 [FIX] *: unbalanced literal markups
Part-of: odoo/documentation#2983
2022-11-18 20:30:01 +01:00
Victor Feyens c367974170 [FIX] *: remove trailing whitespaces
Part-of: odoo/documentation#2983
2022-11-18 20:30:01 +01:00
Victor Feyens 968ed0a17a [FIX] *: enforce 1 newline on files end
Part-of: odoo/documentation#2983
2022-11-18 20:30:00 +01:00
Wesley Kao (weka) 2785e845df [IMP] MRP: updated bills of materials rst content
Reviewed the 15.0 doc for Bills of Materials and made some edits to
clean up inconsistencies and made minor wording changes.

closes odoo/documentation#2964

X-original-commit: 1645e8c3da
Signed-off-by: Zachary Straub <zst@odoo.com>
2022-11-17 21:08:58 +01:00
Victor Feyens 31f9b8a56d [CLN] core: upgrade to python 3.6
& sort imports

closes odoo/documentation#2975

X-original-commit: 57784a2f90
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-11-17 17:20:55 +01:00
Martin Trigaux 258695b5ee [I18N] *: export 16.0 source terms 2022-11-17 10:30:02 +01:00
Donatienne Pirlot ded5983ebb [IMP] accounting: update the doc related to internal transfers
closes odoo/documentation#2950

Id: 2901915
X-original-commit: d36bacb54a
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Pirlot Donatienne (dopi) <dopi@odoo.com>
2022-11-15 18:32:56 +01:00
jopa-odoo 5f5912bb5f [IMP] Legal: Update Dutch translation
Update of the Dutch translation of Odoo Enterprise Subscription agreemnt
2022-11-15 17:53:04 +01:00
Donatienne Pirlot e381c454a2 [IMP] accounting: ai powered document digitization page updated
ID: 2989846

If you feel that it might help a future reader to understand your commit

closes odoo/documentation#2751

Signed-off-by: Pirlot Donatienne (dopi) <dopi@odoo.com>
2022-11-15 14:10:01 +01:00
Donatienne Pirlot cc65809ec5 [ADD] accounting: provide information on the tax carryover feature
closes odoo/documentation#2889

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-11-15 10:34:40 +01:00
Julien Castiaux 67cb3acd6a [FIX] deploy.rst: nginx config for static files
In case of a source install the various places where static files can be
found are spread on the filesystem. The previous configuration sample
used custom internal locations but it turns out that it is only possible
to `try_files` on filesystem paths and on "named location (@ ones)".

This commit fixes the configuration sample so that it works for the
given situation where community and enterprise has been cloned from git.

task-3049538

closes odoo/documentation#2902

Signed-off-by: Julien Castiaux <juc@odoo.com>
2022-11-14 17:54:09 +01:00
Christophe Monniez 62f9a96972 [FIX] install: update 15.0 references to 16.0
closes odoo/documentation#2848

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-11-14 15:07:36 +01:00
Loan (lse) 3ee58b5816 [IMP] iot: Add part regarding screen
Add  more details as of how to connect a screen to the IoT box
and how it can be used.

OPW-2962462

closes odoo/documentation#2939

X-original-commit: 21edc4fcc7
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-11-14 14:06:10 +01:00
Odoo Translation Bot 2dc4cb3c3d [I18N] Update translation terms from Transifex 2022-11-13 00:40:28 +01:00
Tom Aarab (toaa) adbf2aa7cc [IMP] accounting: updated chart of accounts v15
Creating account groups part was outdated.

task id: 2950820

closes odoo/documentation#2932

X-original-commit: 60ad93ea31
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Aarab Tom (toaa) <toaa@odoo.com>
2022-11-10 15:37:26 +01:00
Tom Aarab (toaa) accafb84ad [IMP] TaxCloud: updated doc
Changed out-of-date function and updated doc/changed grammar. Forward up to 16 (16 exluded)

task id: 2909436

closes odoo/documentation#2907

X-original-commit: 7cf109db1e
Signed-off-by: Platteau Xavier (xpl) <xpl@odoo.com>
2022-11-08 11:47:04 +01:00
Tom Aarab (toaa) 20cc128956 [IMP] accounting: updated multiple payments page
Previous page was based on V13. Forward up to 16.

closes odoo/documentation#2918

Taskid: 3045197
X-original-commit: e4839ea7e9
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-11-07 14:43:47 +01:00
Tom Aarab (toaa) dd4b9fbdd9 [IMP] accounting: updated bank statement page
Previous version used V13 screenshots.

task - 2902004

closes odoo/documentation#2913

X-original-commit: de7fddab6c
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-11-07 11:03:17 +01:00
Odoo Translation Bot a0e17f02fb [I18N] Update translation terms from Transifex 2022-11-06 00:40:28 +01:00
Chong Wang (cwg) f2fd03b8fc [IMP] orm/changelog: store translations in jsonb
closes odoo/documentation#2801

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-11-03 14:42:10 +01:00
Xavier 837c342b87 [ADD] Studio: PDF reports
closes odoo/documentation#2894

Id: 2978638
X-original-commit: 5ad9d5eb0b
Signed-off-by: Platteau Xavier (xpl) <xpl@odoo.com>
2022-11-02 20:17:04 +01:00
“Chiara 9b88280cc2 [IMP] accounting: Bank Synchronization: automatic import
closes odoo/documentation#2899

X-original-commit: 7fb5a21d64
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-11-02 18:51:55 +01:00
Odoo Translation Bot f0af8214ee [I18N] Update translation terms from Transifex 2022-10-30 00:40:31 +02:00
Antoine Vandevenne (anv) cdb4b9398c [IMP] extensions/spoilers: add an extension for spoilers
It is often needed in developer tutorials to show excerpts of code for
examples and solutions. This takes quite some page space and, for the
latter, it is not always desired to show the final code result right
after the exercise objective.

This commit adds a spoiler feature to the documentation to allow hiding
content until the reader wants to display it.

The feature relies on the new `.. spoiler:: Button label` directive.

task-3036845

closes odoo/documentation#2876

X-original-commit: 4d7a88639a
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Morgan Meganck <morm@odoo.com>
Co-authored-by: Stefano Rigano <sri@odoo.com>
2022-10-28 15:51:21 +02:00
stefanorigano (SRI) 9b695ca9c3 [IMP] odoo_theme: add default BS functions
Prior to this change it was not possible to use Bootstrap default SCSS
functions in 'bootstrap_overridden.scss'.

This commit mirrors odoo framework's architecture, injecting bootstrap
'_functions.scss' at the beginning of the documentation's SCSS "bundle".

Commit preparatory to the introduction of the 'Spoiler' documentation
component.

task-3036845

X-original-commit: 1691e8970b
Part-of: odoo/documentation#2876
2022-10-28 15:51:20 +02:00
Donatienne Pirlot 9f723e83ae [IMP] accounting: update and improve the cash basis taxes documentation
closes odoo/documentation#2871

Id: 2381690
X-original-commit: 8770938a97
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-10-28 15:51:17 +02:00
Donatienne Pirlot f0ea16abf3 [IMP] accounting: update the bank accounts documentation
ID:2607774

closes odoo/documentation#2880

X-original-commit: 285252d1fd
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-10-28 13:18:09 +02:00
Olivier Dony 11b4f790d0 [IMP] legal: OE v10a - clarified wording for Section 5.1
The "(at that time") wording could be confusing - the goal was really to
refer to the price at the time of the deviation, not the price at the
conclusion of the agreement. This should be clearer.

Validated with SBR.
2022-10-27 18:14:13 +02:00
Victor Feyens c8ab8908da [FIX] developer/guidelines: do not mention deprecated xml tags
act_window & report xml tags have been deprecated by
https://github.com/odoo/odoo/commit/6835aeb0de6895f7f4d6b23e0b4654465ef21d6a
two years ago, we should avoid mentioning them in the guidelines.

Furthermore, in 17.0 they won't be available anymore.

closes odoo/documentation#2861

X-original-commit: 758463edd4
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-10-25 18:59:54 +02:00
Victor Feyens 1225c93112 [FIX] developer/cli: remove unsupported cli options
Removed by https://github.com/odoo/odoo/commit/c0647b5c527440cf9f94b51f1c9a9c4d1f3b508e

Fixes odoo/odoo#104060

closes odoo/documentation#2856

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-10-25 18:59:51 +02:00
Zachary Straub (ZST) edf9e1ac62 [IMP] inventory: thd batch updates
closes odoo/documentation#2854

X-original-commit: ac3ec17266
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-10-25 18:59:49 +02:00
niyasraphy 3f34c3874c [IMP] report_barcode function: parameter type to barcode_type
https://github.com/odoo/odoo/commit/ee324e8374536cebca4d7302210b07e8f33d3852

closes odoo/documentation#2843

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-10-24 16:52:54 +02:00
Christophe Monniez 1c2d59b280 [FIX] install: update installation from the nightly debian repo
As the `apt-key` command will is deprecated and will be removed in the
next Debian release, it's time to update the documentation.

closes odoo/documentation#2840

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-10-24 15:54:46 +02:00
Odoo Translation Bot e113fbd7f3 [I18N] Update translation terms from Transifex 2022-10-23 00:40:44 +02:00
Jonathan Castillo (jcs) 9b69e0d77e [IMP] *: Remove "SaaS" to keep only the "Odoo Online" appellation
task-3034812

closes odoo/documentation#2836

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-10-21 16:19:58 +02:00
Jonathan Castillo (jcs) 2c17b6fb4a [IMP] *: consistency for the use of "Odoo Online" (and SaaS)
task-3034812

Part-of: odoo/documentation#2836
2022-10-21 16:19:58 +02:00
nbe-odoo 87392b7262 [FIX] website: rst and file organization for plausible.rst
- external links
- notes
- indentation
- media filenames
- images compression
- images alt tags
- light content improvement

closes odoo/documentation#2820

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Co-authored-by: Nicolas Bebawi (nbe) <nbe@odoo.com>
Co-authored-by: Jonathan Castillo (jcs) <jcs@odoo.com>
2022-10-20 15:44:12 +02:00
zzk2000 fc39619be4 [FIX] administration/install: Odoo 16 distribution link
closes odoo/documentation#2817

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-10-20 15:44:10 +02:00
tsm-odoo 9ed3575f19 [IMP] install: add $connection_upgrade map documentation
Before this commit, following the install documentation to setup
the odoochat server would fail. This was due to the fact that the
documentation about how to define the `$connection_upgrade` variable
was missing.

This PR fixes this issue.

closes odoo/documentation#2807

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-10-20 15:44:07 +02:00
Olivier Dony 3f9a2f97d7 [IMP] legal: make PDF links relative
This way we don't need to update the links nor risk a desynchronization
between the version of the PDF and the HTML.

Previously version 15.0 and 16.0 still referenced the 14.0 PDFs
(which are the same at the moment, but still...)
2022-10-19 19:11:17 +02:00
Olivier Dony 0b36e6b567 [FIX] legal: enterprise terms FR fall 2022 pricing typo 2022-10-19 18:53:17 +02:00
“Friederike 99de3b637c [FIX] legal: enterprise terms DE translation update (v9c) 2022-10-19 18:53:17 +02:00
Elias 90513b30dc [FIX] developer/howtos/rdtraining: Update warning message
Update warning output for missing access rules.
Also reflect up-to-date contents of res.country.state.csv.

closes odoo/documentation#2825

X-original-commit: e21dbd01c9
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-10-18 12:53:39 +02:00
Victor Feyens 93b383e95d [FIX] *: Odoo 16 requires postgresql 12
Update the minimal version in the installation doc
Make all postgresql docs references target the v12 documentation
Fix some non http links on the way

closes odoo/documentation#2821

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-10-17 23:02:34 +02:00
Odoo Translation Bot 5d2d52181b [I18N] Update translation terms from Transifex 2022-10-17 18:40:22 +02:00
Olivier Dony 590d505c67 [FIX] legal: fixup for 8a62493495
Missing small change
2022-10-13 12:10:25 +02:00
Olivier Dony 8a62493495 [CHG] legal: enterprise terms for fall 2022 pricing
- removal of "per app" notion
- addition of "subscription plan" notion
2022-10-13 11:50:39 +02:00
Antoine Vandevenne (anv) a70f74dba8 [IMP] supported_version: release 16.0 and deprecate 13.0
closes odoo/documentation#2813

X-original-commit: 3c61d24b1d
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-10-11 21:21:48 +02:00
Demesmaeker 91f3859a53 [IMP] sale_amazon: support all marketplaces
task-2939972

closes odoo/documentation#2749

Related: odoo/enterprise#31387
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-10-11 13:10:45 +02:00
Victor Feyens 7c42ab8eaf [IMP] developer/orm: environment documentation
Move Environment explanation to the class docstring and autogenerate the
doc

Add documentation on some util methods.

closes odoo/documentation#2798

Related: odoo/odoo#102896
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-10-10 18:03:50 +02:00
Victor Feyens b7f5b3e04b [FIX] developer/iap: wrong :class: element
Part-of: odoo/documentation#2798
2022-10-10 18:03:49 +02:00
Antoine Vandevenne (anv) 7696235acb [IMP] reference/payment: auto-document the method _get_removal_values
Task - 3002532

closes odoo/documentation#2799

Related: odoo/odoo#102265
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-10-10 17:00:20 +02:00
Antoine Vandevenne (anv) 668ac2c650 [ADD] reference/standard_modules: API reference for the payment engine
task-2804999

closes odoo/documentation#2782

Related: odoo/odoo#101756
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-10-07 20:12:06 +02:00
Xavier-Do 811510fbcb [ADD] developer/reference: add a reference page on performance
closes odoo/documentation#2793

X-original-commit: 4d8e3f9785
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Xavier Dollé (xdo) <xdo@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-10-06 13:13:02 +02:00
Julien Van Roy 1387c5e8c3 [IMP] accounting/electronic_invoicing: update factur-x usage
Update Factur-X mentions and screenshot.

task-2957808
https://github.com/odoo/odoo/pull/99699

closes odoo/documentation#2693

Related: odoo/odoo#99699
Related: odoo/enterprise#31851
Signed-off-by: Julien Van Roy <juvr@odoo.com>
2022-10-06 02:49:03 +02:00
Denis Ledoux 0bdf714112 [IMP] developer/reference: move model view related methods out of orm
The model method `get_views` and `get_view` are moved
from `odoo/models.py` to `odoo/addons/base/models/ir_ui_view.py`.

The documentation is updated accordingly,
to put the documentation related to `get_views` in the
views chapter of the documentation.

closes odoo/documentation#2760

Related: odoo/odoo#101200
Signed-off-by: Denis Ledoux (dle) <dle@odoo.com>
2022-10-04 15:18:03 +02:00
Martin Trigaux 733501a186 [I18N] *: export 16.0 source terms 2022-10-04 14:53:47 +02:00
Aleksander 508b089f68 [FW][IMP] howtos/rdtraining: give the meaning of "ACL"
closes odoo/documentation#2778

Forward-port-of: odoo/documentation#2774
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-10-01 15:11:40 +02:00
Jonathan Quique (jqu) e74d239907 [IMP] email_communication: can't use Odoo STMP with another mail server
Customer may want to use their own SMTP for email marketing, and Odoo default SMTP for everything else. There is no good way to do this. Previously we suggested adding Odoo SMTP as an outgoing email server but we don't want to share credentials anymore.
R&D is working on a solution (e.g. showing the Odoo default email server in the list rather than keeping it as an "hidden feature") but for the time being, if you use an outgoing email server, you give up using the Odoo default SMTP.

closes odoo/documentation#2770

X-original-commit: 7b21e6001b
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-09-29 18:28:39 +02:00
Wesley Kao (weka) 26cf8a0583 [IMP] MRP: updated Variants BOM Management rst content
closes odoo/documentation#2763

X-original-commit: b3d5e928aa
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-09-27 19:43:46 +02:00
Jonathan Castillo (jcs) 81352e98b2 [IMP] website: register domain name menu path
closes odoo/documentation#2765

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-09-27 16:13:03 +02:00
Fabrice Henrion 4de66e2cd9 [FIX] accounting: grammar fix in ponto
closes odoo/documentation#2758

X-original-commit: dad110c7cc
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-09-23 12:34:30 +02:00
Xavier-Do 406f3aac18 [FIX]: fix odoo_version detection
Right now if the version is not "final (and not alpha)"
documentation will say 16.0beta != 16.0

closes odoo/documentation#2746

Related: odoo/odoo#100648
2022-09-21 16:02:05 +02:00
Victor Feyens c765ea9bad [REL] freeze 16.0 branch 2022-09-21 08:45:37 +02:00
1966 changed files with 950224 additions and 145607 deletions
+19 -14
View File
@@ -1,63 +1,68 @@
[main]
host = https://www.transifex.com
type = PO
[odoo-14-doc.applications]
[o:odoo:p:odoo-16-doc:r:administration]
file_filter = locale/<lang>/LC_MESSAGES/administration.po
source_file = locale/sources/administration.pot
source_lang = en
[o:odoo:p:odoo-16-doc:r:applications]
file_filter = locale/<lang>/LC_MESSAGES/applications.po
source_file = locale/sources/applications.pot
source_lang = en
[odoo-14-doc.finance]
[o:odoo:p:odoo-16-doc:r:finance]
file_filter = locale/<lang>/LC_MESSAGES/finance.po
source_file = locale/sources/finance.pot
source_lang = en
[odoo-14-doc.general]
[o:odoo:p:odoo-16-doc:r:general]
file_filter = locale/<lang>/LC_MESSAGES/general.po
source_file = locale/sources/general.pot
source_lang = en
[odoo-14-doc.index]
[o:odoo:p:odoo-16-doc:r:index]
file_filter = locale/<lang>/LC_MESSAGES/index.po
source_file = locale/sources/index.pot
source_lang = en
[odoo-14-doc.inventory_and_mrp]
[o:odoo:p:odoo-16-doc:r:inventory_and_mrp]
file_filter = locale/<lang>/LC_MESSAGES/inventory_and_mrp.po
source_file = locale/sources/inventory_and_mrp.pot
source_lang = en
[odoo-14-doc.marketing]
[o:odoo:p:odoo-16-doc:r:marketing]
file_filter = locale/<lang>/LC_MESSAGES/marketing.po
source_file = locale/sources/marketing.pot
source_lang = en
[odoo-14-doc.productivity]
[o:odoo:p:odoo-16-doc:r:productivity]
file_filter = locale/<lang>/LC_MESSAGES/productivity.po
source_file = locale/sources/productivity.pot
source_lang = en
[odoo-14-doc.sales]
[o:odoo:p:odoo-16-doc:r:sales]
file_filter = locale/<lang>/LC_MESSAGES/sales.po
source_file = locale/sources/sales.pot
source_lang = en
[odoo-14-doc.services]
[o:odoo:p:odoo-16-doc:r:services]
file_filter = locale/<lang>/LC_MESSAGES/services.po
source_file = locale/sources/services.pot
source_lang = en
[odoo-14-doc.theme]
[o:odoo:p:odoo-16-doc:r:theme]
file_filter = locale/<lang>/LC_MESSAGES/sphinx.po
source_file = locale/sources/sphinx.pot
source_lang = en
[odoo-14-doc.user_settings]
[o:odoo:p:odoo-16-doc:r:user_settings]
file_filter = locale/<lang>/LC_MESSAGES/settings.po
source_file = locale/sources/settings.pot
source_lang = en
[odoo-14-doc.websites]
[o:odoo:p:odoo-16-doc:r:websites]
file_filter = locale/<lang>/LC_MESSAGES/websites.po
source_file = locale/sources/websites.pot
source_lang = en
source_lang = en
+6 -2
View File
@@ -26,7 +26,7 @@ SOURCE_DIR = content
HTML_BUILD_DIR = $(BUILD_DIR)/html
ifdef VERSIONS
HTML_BUILD_DIR := $(HTML_BUILD_DIR)/master
HTML_BUILD_DIR := $(HTML_BUILD_DIR)/16.0
endif
ifneq ($(CURRENT_LANG),en)
HTML_BUILD_DIR := $(HTML_BUILD_DIR)/$(CURRENT_LANG)
@@ -42,6 +42,7 @@ help:
@echo " html to build the documentation to HTML"
@echo " fast to build the documentation to HTML with shallow menu (faster)"
@echo " clean to delete the build files"
@echo " test to run the guidelines tests"
clean:
@echo "Cleaning build files..."
@@ -55,7 +56,7 @@ html: $(HTML_BUILD_DIR)/_static/style.css
# To call *after* `make html`
# Binary dependencies (Debian): texlive-fonts-recommended texlive-latex-extra
# texlive-generic-recommended texlive-fonts-extra
# texlive-fonts-extra
latexpdf:
@echo "Starting build..."
$(SPHINX_BUILD) -c $(CONFIG_DIR) -b latex $(SPHINXOPTS) $(SOURCE_DIR) $(BUILD_DIR)/latex
@@ -82,3 +83,6 @@ fast: html
static: $(HTML_BUILD_DIR)/_static/style.css
cp -r extensions/odoo_theme/static/* $(HTML_BUILD_DIR)/_static/
cp -r static/* $(HTML_BUILD_DIR)/_static/
test:
python tests/rst_style.py $(SOURCE_DIR)
+13 -23
View File
@@ -4,43 +4,33 @@
### Requirements
- [Git](https://www.odoo.com/documentation/master/contributing/documentation.html#install-git)
- [Python 3.7 or 3.8](https://www.odoo.com/documentation/master/contributing/documentation.html#python)
- Python dependencies listed in the file [`requirements.txt`](https://github.com/odoo/documentation/tree/master/requirements.txt).
- [Make](https://www.odoo.com/documentation/master/contributing/documentation.html#make)
- A local copy of the [odoo/odoo repository in master](https://github.com/odoo/odoo/tree/master) (Optional)
- Git
- Python 3.6, 3.7, or 3.8
- Python dependencies listed in the file `requirements.txt`.
- Make
- A local copy of the [odoo/odoo repository](https://github.com/odoo/odoo) (optional)
### Instructions
1. In a terminal, navigate to the root directory and compile the documentation to HTML with the
following command:
```sh
make
```
1. In a terminal, navigate to the root directory of the documentation and build it `make`.
Additional commands are available with `make help`.
2. Open the file `documentation/_build/html/index.html` in your web browser to display the render.
3. See [this guide](https://www.odoo.com/documentation/master/contributing/documentation.html#preview-your-changes)
2. Open the file `documentation/_build/html/index.html` in your web browser.
3. See [this guide](https://www.odoo.com/documentation/latest/contributing/documentation.html)
for more detailed instructions.
Optional: to fully build the developer documentation with inline docstrings for documented Python
functions, place your local copy of the `odoo/odoo` repository in the root directory. Alternatively,
create a symbolic link with `odoo` as link name. If the Odoo sources are not found, a warning will
be shown.
Optional: place your local copy of the `odoo/odoo` repository in the parent directory or in the root
directory of the documentation to build the latter with the documented Python docstrings.
## Contribute to the documentation
For contributions to the content of the documentation, please refer to the
[Introduction Guide](https://www.odoo.com/documentation/master/contributing/documentation.html).
[Introduction Guide](https://www.odoo.com/documentation/latest/contributing/documentation.html).
To **report a content issue**, **request new content** or **ask a question**, use the
[repository's issue tracker](https://github.com/odoo/documentation-user/issues) as usual.
[repository's issue tracker](https://github.com/odoo/documentation/issues).
## Learn More
To learn more about Odoo, in addition to the documentation, have a look at
[the official eLearning](https://odoo.com/slides) and
[Scale-up, The Business Game](https://www.odoo.com/page/scale-up-business-game).
[Scale-up, The Business Game](https://www.odoo.com/page/scale-up-business-game).
+1 -1
View File
@@ -16,4 +16,4 @@
# [REM] = Removal
# [REF] = Refactoring (restructuring)
# [MOV] = Move/rename
#
#
+39 -9
View File
@@ -1,14 +1,14 @@
import re
import os
import re
import shutil
import sys
from pathlib import Path
import docutils
import sphinx
from pygments.lexers import JsonLexer, XmlLexer
from sphinx.ext import graphviz
from sphinx.util import logging
import sphinx
_logger = logging.getLogger(__name__)
@@ -19,10 +19,24 @@ _logger = logging.getLogger(__name__)
project = 'Odoo'
copyright = 'Odoo S.A.'
# `version` if the version info for the project being documented, acts as replacement for |version|,
# `version` is the version info for the project being documented, acts as replacement for |version|,
# also used in various other places throughout the built documents.
# `release` is the full version, including alpha/beta/rc tags. Acts as replacement for |release|.
version = release = 'master'
version = release = '16.0'
# `current_branch` is the technical name of the current branch.
# E.g., saas-15.4 -> saas-15.4; 12.0 -> 12.0, master -> master (*).
current_branch = version
# `current_version` is the Odoo version linked to the current branch.
# E.g., saas-15.4 -> 15.4; 12.0 -> 12; master -> master (*).
current_version = current_branch.replace('saas-', '').replace('.0', '')
# `current_major_branch` is the technical name of the major branch before the current branch.
# E.g., saas-15.4 -> 15.0; 12.0 -> 12.0; master -> master (*).
current_major_branch = re.sub(r'\.\d', '.0', current_branch.replace('saas-', ''))
# `current_major_version` is the Odoo version linked to the current major branch.
# E.g., saas-15.4 -> 15; 12.0 -> 12; master -> master (*).
current_major_version = current_major_branch.replace('.0', '')
# (*): We don't care for master.
# The minimal Sphinx version required to build the documentation.
needs_sphinx = '3.0.0'
@@ -61,8 +75,14 @@ add_function_parentheses = True
#=== Extensions configuration ===#
source_read_replace_vals = {
'BRANCH': current_branch,
'CURRENT_BRANCH': current_branch,
'CURRENT_VERSION': current_version,
'CURRENT_MAJOR_BRANCH': current_major_branch,
'CURRENT_MAJOR_VERSION': current_major_version,
'GITHUB_PATH': f'https://github.com/odoo/odoo/blob/{version}',
'GITHUB_ENT_PATH': f'https://github.com/odoo/enterprise/blob/{version}',
'OWL_PATH': f'https://github.com/odoo/owl/blob/master',
}
# Add extensions directory to PYTHONPATH
@@ -95,7 +115,7 @@ else:
import odoo.addons
odoo.addons.__path__.append(str(odoo_dir) + '/addons')
from odoo import release as odoo_release # Don't collide with Sphinx's 'release' config option
odoo_version = odoo_release.version.replace('~', '-') # Change saas~XX.Y to saas-XX.Y
odoo_version = '.'.join(str(s) for s in odoo_release.version_info[:2]).replace('~', '-') # Change saas~XX.Y to saas-XX.Y
odoo_version = 'master' if 'alpha' in odoo_release.version else odoo_version
if release != odoo_version:
_logger.warning(
@@ -145,6 +165,12 @@ extensions = [
# Content tabs
'sphinx_tabs.tabs',
# Cards
'cards',
# Spoilers
'spoilers',
# Strange html domain logic used in memento pages
'html_domain',
]
@@ -187,6 +213,7 @@ sphinx.transforms.i18n.docname_to_domain = (
# is populated. If a version is passed to `versions` but is not listed here, it will not be shown.
versions_names = {
'master': "Master",
'16.0': "Odoo 16",
'saas-15.2': "Odoo Online",
'15.0': "Odoo 15",
'14.0': "Odoo 14",
@@ -200,10 +227,13 @@ languages_names = {
'en': 'EN',
'es': 'ES',
'fr': 'FR',
'it': 'IT',
'nl': 'NL',
'pt_BR': 'PT',
'ro': 'RO',
'uk': 'UA',
'zh_CN': 'ZH',
'zh_CN': 'ZH (CN)',
'zh_TW': 'ZH (TW)'
}
# The directory in which files holding redirect rules used by the 'redirects' extension are listed.
@@ -274,7 +304,7 @@ latex_documents = [
('legal/terms/i18n/partnership_tex_fr',
'odoo_partnership_agreement_fr.tex', 'Odoo Partnership Agreement (FR)', '', 'howto'),
('legal/terms/i18n/terms_of_sale_fr', 'terms_of_sale_fr.tex',
u'Conditions Générales de Vente Odoo', '', 'howto'),
'Conditions Générales de Vente Odoo', '', 'howto'),
('legal/terms/i18n/enterprise_tex_nl', 'odoo_enterprise_agreement_nl.tex',
'Odoo Enterprise Subscription Agreement (NL)', '', 'howto'),
@@ -310,7 +340,6 @@ def source_read_replace(app, docname, source):
result = result.replace(f"{{{key}}}", app.config.source_read_replace_vals[key])
source[0] = result
def setup(app):
# Generate all alternate URLs for each document
app.add_config_value('project_root', None, 'env')
@@ -398,8 +427,9 @@ def _generate_alternate_urls(app, pagename, templatename, context, doctree):
The entry 'language' is added by Sphinx in the rendering context.
"""
_current_lang = app.config.language or 'en'
# Replace the context value by its translated description ("Français" instead of "french")
# Replace the context value by its upper-cased value ("FR" instead of "fr")
context['language'] = languages_names.get(_current_lang)
context['language_code'] = _current_lang
# If the list of languages is not set, assume that the project has no alternate language
_provided_languages = app.config.languages and app.config.languages.split(',') or []
+42 -43
View File
@@ -97,7 +97,7 @@ Configuration sample
* Allow tcp connection on localhost
* Allow tcp connection from 192.168.1.x network
in ``/etc/postgresql/9.5/main/pg_hba.conf`` set:
in ``/etc/postgresql/<YOUR POSTGRESQL VERSION>/main/pg_hba.conf`` set:
.. code-block:: text
@@ -105,7 +105,7 @@ in ``/etc/postgresql/9.5/main/pg_hba.conf`` set:
host all all 127.0.0.1/32 md5
host all all 192.168.1.0/24 md5
in ``/etc/postgresql/9.5/main/postgresql.conf`` set:
in ``/etc/postgresql/<YOUR POSTGRESQL VERSION>/main/postgresql.conf`` set:
.. code-block:: text
@@ -172,7 +172,7 @@ in Odoo the db_sslmode control the ssl security of the connection
with value chosen out of 'disable', 'allow', 'prefer', 'require', 'verify-ca'
or 'verify-full'
`PostgreSQL Doc <https://www.postgresql.org/docs/current/static/libpq-ssl.html>`_
`PostgreSQL Doc <https://www.postgresql.org/docs/12/static/libpq-ssl.html>`_
.. _builtin_server:
@@ -290,6 +290,10 @@ in ``/etc/nginx/sites-enabled/odoo.conf`` set:
upstream odoochat {
server 127.0.0.1:8072;
}
map $http_upgrade $connection_upgrade {
default upgrade;
'' close;
}
# http -> https
server {
@@ -305,12 +309,6 @@ in ``/etc/nginx/sites-enabled/odoo.conf`` set:
proxy_connect_timeout 720s;
proxy_send_timeout 720s;
# Add Headers for odoo proxy mode
proxy_set_header X-Forwarded-Host $host;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_set_header X-Real-IP $remote_addr;
# SSL parameters
ssl_certificate /etc/ssl/nginx/server.crt;
ssl_certificate_key /etc/ssl/nginx/server.key;
@@ -336,6 +334,11 @@ in ``/etc/nginx/sites-enabled/odoo.conf`` set:
# Redirect requests to odoo backend server
location / {
# Add Headers for odoo proxy mode
proxy_set_header X-Forwarded-Host $host;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_set_header X-Real-IP $remote_addr;
proxy_redirect off;
proxy_pass http://odoo;
}
@@ -388,7 +391,7 @@ The solutions to support livechat/motifications in a WSGI application are:
* Deploy a threaded version of Odoo (instead of a process-based preforking
one) and redirect only requests to URLs starting with ``/websocket/`` to
that Odoo, this is the simplest and the websocket URL can double up as the cron
that Odoo, this is the simplest and the websocket URL can double up as the cron
instance.
* Deploy an evented Odoo via ``odoo-gevent`` and proxy requests starting
with ``/websocket/`` to
@@ -406,61 +409,56 @@ a static HTTP server.
Serving static files
--------------------
Odoo static files are located in each module's :file:`static/` folder, so static files can be served
Odoo static files are located in each module's :file:`static/` folder, so static files can be served
by intercepting all requests to :samp:`/{MODULE}/static/{FILE}`, and looking up the right module
(and file) in the various addons paths.
.. example::
Say Odoo has been installed via the **debian packages** for Community and Enterprise, the addons
paths is :file:`/usr/lib/python3/dist-packages/odoo/addons`. Using the above NGINX (https)
configuration, the following location block should be added to serve static files via NGINX.
Say Odoo has been installed via the **debian packages** for Community and Enterprise and the
:option:`--addons-path <odoo-bin --addons-path>` is ``'/usr/lib/python3/dist-packages/odoo/addons'``.
Using the above NGINX (https) configuration, the following location block should be added to
serve static files via NGINX.
.. code-block:: nginx
location @odoo {
# copy-paste the content of the / location block
}
# Serve static files right away
location ~ ^/[^/]+/static/.+$ {
# Add Headers for odoo proxy mode
proxy_set_header X-Forwarded-Host $host;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_set_header X-Real-IP $remote_addr;
root /usr/lib/python3/dist-packages/odoo/addons;
try_files $uri @odoo;
expires 24h;
}
.. example::
Say Odoo has been installed via the **source**, and the two git repositories for Community and
Enterprise has been cloned in :file:`/opt/odoo` and :file:`/opt/odoo-enterprise` respectively.
The addons paths is ``/opt/odoo/odoo,/opt/odoo/addons,/opt/odoo-enterprise``. Using the above
NGINX (https) configuragion, the following location block should be added to serve static files
via NGINX.
Say Odoo has been installed via the **source**. The two git repositories for Community and
Enterprise have been cloned in :file:`/opt/odoo/community` and :file:`/opt/odoo/enterprise`
respectively and the :option:`--addons-path <odoo-bin --addons-path>` is
``'/opt/odoo/community/odoo/addons,/opt/community/addons,/opt/odoo/enterprise'``.
Using the above NGINX (https) configuration, the following location block should be added to
serve static files via NGINX.
.. code-block:: nginx
location @odoo {
# copy-paste the content of the / location block
}
# Serve static files right away
location ~ ^/[^/]+/static/.+$ {
try_files /static-base$uri /static-addons$uri /static-enterprise$uri @odoo$uri;
root /opt/odoo;
try_files /community/odoo/addons$uri /community/addons$uri /enterprise$uri @odoo;
expires 24h;
}
location /static-base {
internal;
alias /opt/odoo/odoo/addons;
}
location /static-addons {
internal;
alias /opt/odoo/addons;
}
location /static-enterprise {
internal;
alias /opt/odoo-enterprise;
}
.. warning::
The actual NGINX configuration you need is highly dependent on your own installation. The two
@@ -489,7 +487,7 @@ X-Sendfile and X-Accel).
- The X-Accel extension for NGINX **does** require the following additionnal configuration:
.. code-block:: nginx
location /web/filestore {
internal;
alias /path/to/odoo/data-dir/filestore;
@@ -614,6 +612,7 @@ security-related topics:
Blocking Brute Force Attacks
----------------------------
For internet-facing deployments, brute force attacks on user passwords are very common, and this
threat should not be neglected for Odoo servers. Odoo emits a log entry whenever a login attempt
is performed, and reports the result: success or failure, along with the target login and source IP.
@@ -741,8 +740,8 @@ Here are the supported browsers:
.. _socat: http://www.dest-unreach.org/socat/
.. _PostgreSQL connection settings:
.. _listen to network interfaces:
https://www.postgresql.org/docs/9.6/static/runtime-config-connection.html
https://www.postgresql.org/docs/12/static/runtime-config-connection.html
.. _use an SSH tunnel:
https://www.postgresql.org/docs/9.6/static/ssh-tunnels.html
https://www.postgresql.org/docs/12/static/ssh-tunnels.html
.. _WSGI: https://wsgi.readthedocs.org/
.. _POSBox: https://www.odoo.com/page/point-of-sale-hardware#part_2
@@ -4,19 +4,22 @@ Email gateway
The Odoo mail gateway allows you to inject directly all the received emails in Odoo.
Its principle is straightforward: your SMTP server executes the "mailgate" script for every new incoming email.
Its principle is straightforward: your SMTP server executes the "mailgate" script for every new
incoming email.
The script takes care of connecting to your Odoo database through XML-RPC, and send the emails via
the `MailThread.message_process()` feature.
Prerequisites
-------------
- Administrator access to the Odoo database.
- Your own mail server such as Postfix or Exim.
- Technical knowledge on how to configure an email server.
For Postfix
-----------
In you alias config (:file:`/etc/aliases`):
.. code-block:: text
@@ -33,6 +36,7 @@ In you alias config (:file:`/etc/aliases`):
For Exim
--------
.. code-block:: text
*: |/odoo-directory/addons/mail/static/scripts/odoo-mailgate.py -d <database-name> -u <userid> -p <password>
+31 -32
View File
@@ -33,7 +33,7 @@ Editions
========
There are two different Editions_ of Odoo: the Community and Enterprise versions.
Using the Enterprise version is possible on our SaaS_ and accessing the code is
Using the Enterprise version is possible on `Odoo Online`_ and accessing the code is
restricted to Enterprise customers and partners. The Community version is freely
available to anyone.
@@ -55,17 +55,17 @@ around and try things out with no commitment.
Demo_ instances require no local installation, just a web browser.
SaaS
----
Odoo Online
-----------
Trivial to start with, fully managed and migrated by Odoo S.A., Odoo's SaaS_
Trivial to start with, fully managed and migrated by Odoo S.A., `Odoo Online`_
provides private instances and starts out free. It can be used to discover and
test Odoo and do non-code customizations (i.e. incompatible with custom modules
or the Odoo Apps Store) without having to install it locally.
Can be used for both testing Odoo and long-term production use.
Like demo_ instances, SaaS_ instances require no local installation, a web
Like demo_ instances, `Odoo Online`_ instances require no local installation, a web
browser is sufficient.
@@ -146,13 +146,13 @@ Repository
.. group-tab:: Debian/Ubuntu
Odoo S.A. provides a repository that can be used with Debian and Ubuntu distributions. It can
be used to install *Odoo Community Edition* by executing the following commands **as root**:
be used to install *Odoo Community Edition* by executing the following commands:
.. code-block:: console
# wget -O - https://nightly.odoo.com/odoo.key | apt-key add -
# echo "deb http://nightly.odoo.com/15.0/nightly/deb/ ./" >> /etc/apt/sources.list.d/odoo.list
# apt-get update && apt-get install odoo
$ wget -q -O - https://nightly.odoo.com/odoo.key | sudo gpg --dearmor -o /usr/share/keyrings/odoo-archive-keyring.gpg
$ echo 'deb [signed-by=/usr/share/keyrings/odoo-archive-keyring.gpg] https://nightly.odoo.com/{CURRENT_MAJOR_BRANCH}/nightly/deb/ ./' | sudo tee /etc/apt/sources.list.d/odoo.list
$ sudo apt-get update && sudo apt-get install odoo
You can then use the usual `apt-get upgrade` command to keep your installation up-to-date.
@@ -163,7 +163,7 @@ Repository
.. code-block:: console
$ sudo dnf config-manager --add-repo=https://nightly.odoo.com/15.0/nightly/rpm/odoo.repo
$ sudo dnf config-manager --add-repo=https://nightly.odoo.com/{CURRENT_MAJOR_BRANCH}/nightly/rpm/odoo.repo
$ sudo dnf install -y odoo
$ sudo systemctl enable odoo
$ sudo systemctl start odoo
@@ -183,8 +183,8 @@ Distribution package
<download_>`_.
.. note::
Odoo 15.0 'deb' package currently supports `Debian 11 (Bullseye)`_, `Ubuntu 20.04 (Focal)`_
or above.
Odoo {CURRENT_MAJOR_VERSION} 'deb' package currently supports `Debian 11 (Bullseye)`_,
`Ubuntu 22.04 (Jammy)`_ or above.
Next, execute the following commands **as root**:
@@ -224,13 +224,13 @@ Distribution package
<download_>`_.
.. note::
Odoo 15.0 'rpm' package supports Fedora 34.
Odoo {CURRENT_MAJOR_VERSION} 'rpm' package supports Fedora 36.
Once downloaded, the package can be installed using the 'dnf' package manager:
.. code-block:: console
$ sudo dnf localinstall odoo_15.0.latest.noarch.rpm
$ sudo dnf localinstall odoo_{CURRENT_MAJOR_BRANCH}.latest.noarch.rpm
$ sudo systemctl enable odoo
$ sudo systemctl start odoo
@@ -242,9 +242,8 @@ Source install
The source "installation" is really about not installing Odoo, and running it directly from source
instead.
This can be more convenient for module developers as the Odoo source is more easily accessible
than using packaged installation (for information or to build this documentation and have it
available offline).
It can be more convenient for module developers as the Odoo source is more easily accessible than
using packaged installation.
It also makes starting and stopping Odoo more flexible and explicit than the services set up by the
packaged installations, and allows overriding settings using
@@ -280,8 +279,8 @@ Git
The following requires `Git <git_>`_ to be installed on your machine and that you have basic
knowledge of Git commands. To clone a Git repository, you must choose between cloning with HTTPS or
SSH. If you do not know the difference between the two, the best option is most likely HTTPS. If you
are following the :doc:`Getting started </developer/howtos/rdtraining>` developer tutorial, or plan
on contributing to Odoo source code, choose SSH.
are following the :doc:`Getting started </developer/tutorials/getting_started>` developer tutorial,
or plan on contributing to Odoo source code, choose SSH.
.. note::
**The Enterprise Git repository does not contain the full Odoo source code**. It is only a
@@ -432,7 +431,7 @@ PostgreSQL
.. group-tab:: Windows
Odoo uses PostgreSQL as database management system. `Download and install PostgreSQL
<https://www.postgresql.org/download/windows/>`_ (supported version: 10.0 and later).
<https://www.postgresql.org/download/windows/>`_ (supported version: 12.0 and later).
By default, the only user is `postgres` but Odoo forbids connecting as `postgres`, so you need
to create a new PostgreSQL user:
@@ -452,7 +451,7 @@ PostgreSQL
.. group-tab:: Linux
Odoo uses PostgreSQL as database management system. Use your package manager to download and
install PostgreSQL (supported version: 10.0 and later).
install PostgreSQL (supported version: 12.0 and later).
It can be achieved by executing the following:
@@ -475,7 +474,7 @@ PostgreSQL
.. group-tab:: Mac OS
Odoo uses PostgreSQL as database management system. Use `postgres.app
<https://postgresapp.com>`_ to download and install PostgreSQL (supported version: 10.0 and
<https://postgresapp.com>`_ to download and install PostgreSQL (supported version: 12.0 and
later).
.. tip::
@@ -547,7 +546,7 @@ Dependencies
.. tab:: Debian/Ubuntu
For Debian-based systems, the packages are listed in the `debian/control
<https://github.com/odoo/odoo/blob/master/debian/control>`_ file of the Odoo sources.
<{GITHUB_PATH}/debian/control>`_ file of the Odoo sources.
On Debian/Ubuntu, the following commands should install the required packages:
@@ -712,7 +711,7 @@ just logged into your own Odoo database!
<odoo-bin -r>` CLI argument.
.. seealso::
:doc:`The exhaustive list of CLI arguments for odoo-bin </developer/cli>`.
:doc:`The exhaustive list of CLI arguments for odoo-bin </developer/reference/cli>`.
.. _setup/install/docker:
@@ -726,24 +725,24 @@ official Odoo `docker image <https://hub.docker.com/_/odoo/>`_ page.
.. _demo: https://demo.odoo.com
.. _docker: https://www.docker.com
.. _download: https://www.odoo.com/page/download
.. _Ubuntu 20.04 (Focal): http://releases.ubuntu.com/20.04/
.. _Ubuntu 22.04 (Jammy): https://releases.ubuntu.com/22.04/
.. _EPEL: https://fedoraproject.org/wiki/EPEL
.. _PostgreSQL: http://www.postgresql.org
.. _PostgreSQL: https://www.postgresql.org
.. _the official installer:
.. _install pip:
https://pip.pypa.io/en/latest/installing.html#install-pip
.. _Quilt: http://en.wikipedia.org/wiki/Quilt_(software)
.. _saas: https://www.odoo.com/page/start
.. _Quilt: https://en.wikipedia.org/wiki/Quilt_(software)
.. _Odoo Online: https://www.odoo.com/page/start
.. _the wkhtmltopdf download page: https://github.com/wkhtmltopdf/wkhtmltopdf/releases/tag/0.12.5
.. _UAC: http://en.wikipedia.org/wiki/User_Account_Control
.. _wkhtmltopdf: http://wkhtmltopdf.org
.. _UAC: https://en.wikipedia.org/wiki/User_Account_Control
.. _wkhtmltopdf: https://wkhtmltopdf.org
.. _pip: https://pip.pypa.io
.. _macports: https://www.macports.org
.. _homebrew: http://brew.sh
.. _homebrew: https://brew.sh
.. _wheels: https://wheel.readthedocs.org/en/latest/
.. _virtualenv: https://pypi.python.org/pypi/virtualenv
.. _virtualenvwrapper: https://virtualenvwrapper.readthedocs.io/en/latest/
.. _pywin32: http://sourceforge.net/projects/pywin32/files/pywin32/
.. _pywin32: https://sourceforge.net/projects/pywin32/files/pywin32/
.. _community-repository: https://github.com/odoo/odoo
.. _enterprise-repository: https://github.com/odoo/enterprise
.. _Editions: https://www.odoo.com/pricing#pricing_table_features
+3 -1
View File
@@ -7,10 +7,12 @@ Maintain
.. toctree::
maintain/domain_names
maintain/azure_oauth
maintain/google_oauth
maintain/mailjet_api
maintain/update
maintain/enterprise
maintain/hosting_changes
maintain/online
maintain/odoo_online
maintain/on_premise
maintain/supported_versions
@@ -0,0 +1,216 @@
=======================================================
Connect Microsoft Outlook 365 to Odoo using Azure OAuth
=======================================================
Odoo is compatible with Microsoft's Azure OAuth for Microsoft 365. In order to send and receive
secure emails from a custom domain, all that is required is to configure a few settings on the
Azure platform and on the back end of the Odoo database. This configuration works with either a
personal email address or an address created by a custom domain.
.. seealso::
`Microsoft Learn: Register an application with the Microsoft identity platform
<https://learn.microsoft.com/azure/active-directory/develop/quickstart-register-app>`_
Setup in Microsoft Azure Portal
===============================
Create a new application
------------------------
To get started, go to `Microsoft's Azure Portal <https://portal.azure.com/>`_. Log in with the
:guilabel:`Microsoft Outlook Office 365` account if there is one, otherwise log in with the
personal :guilabel:`Microsoft account`. A user with administrative access to the Azure Settings
will need to connect and perform the following configuration. Next, navigate to the section
labeled :guilabel:`Manage Azure Active Directory`.
Now, click on :guilabel:`Add (+)`, located in the top menu, and then select :guilabel:`App
registration`. On the :guilabel:`Register an application` screen, rename the :guilabel:`Name` to
`Odoo` or something recognizable. Under the :guilabel:`Supported account types` section select
:guilabel:`Accounts in any organizational directory (Any Azure AD directory - Multitenant) and
personal Microsoft accounts (e.g. Skype, Xbox)`.
Under the :guilabel:`Redirect URL` section, select :guilabel:`Web` as the platform, and then input
`https://<odoo base url>/microsoft_outlook/confirm` in the :guilabel:`URL` field. The Odoo base URL
is the canonical domain at which your Odoo instance can be reached in the URL field.
.. example::
*mydatabase.odoo.com*, where *mydatabase* is the actual prefix of the database's subdomain,
assuming it's hosted on Odoo.com
After the URL has been added to the field, :guilabel:`Register` the application so it is created.
API permissions
---------------
The :guilabel:`API permissions` should be set next. Odoo will need specific API permissions to be
able to read (IMAP) and send (IMAP) emails in the Microsoft 365 setup. First, click the
:guilabel:`API permissions` link, located in the left menu bar. Next, click on the :guilabel:`(+)
Add a Permission` button and select :guilabel:`Microsoft Graph` under :guilabel:`Commonly Used
Microsoft APIs`. After, select the :guilabel:`Delegated Permissions` option.
In the search bar, search for the following :guilabel:`Deregulated permissions` and click
:guilabel:`Add permissions` for each one:
- :guilabel:`SMTP.Send`
- :guilabel:`IMAP.AccessAsUser.All`
.. note::
The :guilabel:`User.Read` permission will be added by default.
.. image:: azure_oauth/permissions.png
:align: center
:alt: API permissions needed for Odoo integration are listed under the Microsoft Graph.
Assign users and groups
=======================
After adding the API permissions, navigate back to the :guilabel:`Overview` of the
:guilabel:`Application` in the top of the left sidebar menu.
Now, add users to this application. Under the :guilabel:`Essentials` overview table, click on the
link labeled :guilabel:`Managed Application in Local Directory`, or the last option on the bottom
right-hand side of the table.
.. image:: azure_oauth/managed-application.png
:align: center
:alt: Add users/groups by clicking the Managed application in local directory link for the
created application.
In the left sidebar menu, select :guilabel:`Users and Groups`. Next, click on :guilabel:`(+) Add
User/Group`. Depending on the account, either a :guilabel:`Group` and a :guilabel:`User` can be
added, or only :guilabel:`Users`. Personal accounts will only allow for :guilabel:`Users` to be
added.
Under :guilabel:`Users` or :guilabel:`Groups`, click on :guilabel:`None Selected` and add the users
or group of users that will be sending emails from the :guilabel:`Microsoft account` in Odoo.
:guilabel:`Add` the users/groups, click :guilabel:`Select`, and then :guilabel:`Assign` them to the
application.
Create credentials
------------------
Now that the Microsoft Azure app is set up, credentials need to be created for the Odoo setup.
These include the :guilabel:`Client ID` and :guilabel:`Client Secret`. To start, the
:guilabel:`Client ID` can be copied from the :guilabel:`Overview` page of the app. The
:guilabel:`Client ID` or :guilabel:`Application ID` is located under the :guilabel:`Display Name`
in the :guilabel:`Essentials` overview of the app.
.. image:: azure_oauth/application-id.png
:align: center
:alt: Application/Client ID located in the Overview of the app.
Next, the :guilabel:`Client Secret Value` needs to be retrieved. To get this value, click on
:guilabel:`Certificates & Secrets` in the left sidebar menu. Then, a :guilabel:`Client Secret`
needs to be produced. In order to do this, click on the :guilabel:`(+) New Client Secret` button.
A window on the right will populate with a button labeled :guilabel:`Add a client secret`. Under
:guilabel:`Description`, type in `Odoo Fetchmail` or something recognizable, and then set the
:guilabel:`expiration date`.
.. important::
A new :guilabel:`Client Secret` will need to be produced and configured if the first one
expires. In this event, there could be an interruption of service, so the expiration date should
be noted and set to the furthest possible date.
Next, click on :guilabel:`Add` when these two values are entered. A :guilabel:`Client Secret Value`
and :guilabel:`Secret ID` will be created. It is important to copy the :guilabel:`Value` or
:guilabel:`Client Secret Value` into a notepad as it will become encrypted after leaving this page.
The :guilabel:`Secret ID` is not needed.
.. image:: azure_oauth/secretvalue.png
:align: center
:alt: Client Secret Value or Value in the app's credentials.
After these steps, the following items should be ready to be set up in Odoo:
- A client ID (:guilabel:`Client ID` or :guilabel:`Application ID`)
- A client secret (:guilabel:`Value` or :guilabel:`Client Secret Value`)
This completes the setup on the :guilabel:`Microsoft Azure Portal` side.
Setup in Odoo
=============
Enter Microsoft Outlook credentials
-----------------------------------
First, open the Odoo database and navigate to the :guilabel:`Apps` module. Then, remove the
:guilabel:`Apps` filter from the search bar and type in `Outlook`. After that, install the module
called :guilabel:`Microsoft Outlook`.
Next, navigate to :menuselection:`Settings --> General Settings`, and under the :guilabel:`Discuss`
section, ensure that the checkbox for :guilabel:`Custom Email Servers` is checked. This populates
a new option for :guilabel:`Outlook Credentials`.
:guilabel:`Save` the progress.
Then, copy and paste the :guilabel:`Client ID` (Application ID) and :guilabel:`Client Secret
(Client Secret Value)` into the respective fields and :guilabel:`Save` the settings.
.. image:: azure_oauth/outlookcreds.png
:align: center
:alt: Outlook Credentials in Odoo General Settings.
Configure outgoing email server
-------------------------------
On the :guilabel:`General Settings` page, under the :guilabel:`Custom Email Servers` setting,
click the :guilabel:`Outgoing Email Servers` link to configure the Microsoft account.
Then, create a new email server and check the box for :guilabel:`Outlook`. Next, fill in the
:guilabel:`Name` (it can be anything) and the Microsoft Outlook email :guilabel:`Username`.
If the :guilabel:`From Filter` field is empty, enter either a :ref:`domain or email address
<email_communication/default_from>`.
Then, cick on :guilabel:`Connect your Outlook account`.
A new window from Microsoft opens to complete the :guilabel:`authorization process`. Select the
appropriate email address that is being configured in Odoo.
.. image:: azure_oauth/verify-outlook.png
:align: center
:alt: Permission page to grant access between newly created app and Odoo.
Then, allow Odoo to access the Microsoft account by clicking on :guilabel:`Yes`. After this, the
page will navigate back to the newly configured :guilabel:`Outgoing Mail Server` in Odoo. The
configuration automatically loads the :guilabel:`token` in Odoo, and a tag stating
:guilabel:`Outlook Token Valid` appears in green.
.. image:: azure_oauth/outlook-token.png
:align: center
:alt: Valid Outlook Token indicator.
Finally, click :guilabel:`Test Connection`. A confirmation message should appear. The Odoo database
can now send safe, secure emails through Microsoft Outlook using OAuth authentication.
Multiple user configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~
Each user should have a separate server set up. The :guilabel:`from-filter` should be set so that
only the user's email is sent from that server. In other words, only a user with an email address
that matches the set :guilabel:`from-filter` is able to use this server.
After setting the :guilabel:`from-filter`, set up a fallback email account to allow for the sending
of :guilabel:`notifications`. The fallback email must be configured as a :guilabel:`general
transactional server`. The :guilabel:`mail.default.from` system parameter must be set to the
:guilabel:`username` of the general transactional server account. For more information see
:ref:`Use a default email address <email_communication/default>`.
.. note::
The :guilabel:`System Parameters` can be accessed by activating
:doc:`../../applications/general/developer_mode` in the :menuselection:`Settings --> Technical
--> Parameters --> System Parameters` menu.
Configure incoming email server
-------------------------------
The incoming account should be configured in a similar way to the outgoing email account. Navigate
to the :guilabel:`Incoming Mail Servers` in the :guilabel:`Technical Menu` and :guilabel:`Create` a
new configuration. Check or Select the button next to :guilabel:`Outlook Oauth Authentication` and
enter the :guilabel:`Microsoft Outlook username`. Click on :guilabel:`Connect your Outlook
account`. Odoo will state: :guilabel:`Outlook Token Valid` Now :guilabel:`Test and Confirm` the
account. The account should be ready to receive email to the Odoo database.
.. seealso::
:doc:`../../applications/general/email_communication/email_servers`
Binary file not shown.

After

Width:  |  Height:  |  Size: 54 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 38 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 47 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 23 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 64 KiB

@@ -17,7 +17,7 @@ You can use a custom domain name to access your Odoo database and websites:
``odoo.com`` for both the URL and the emails (e.g., ``https://example.odoo.com``).
.. important::
Odoo offers a :ref:`free custom domain name <domain-name/odoo-register>` to all Odoo Online
Odoo offers a :ref:`free custom domain name <domain-name/odoo-register>` to all Odoo Online
databases for one year. Visitors can then access your website with an address such as
``www.example.com`` rather than the default ``example.odoo.com``.
@@ -45,6 +45,36 @@ All domain names are referenced in the **Domain Name System**, or **DNS**, which
directory for the Internet. There are many DNS servers, so any modification to the DNS can take up
to 72 hours to propagate worldwide on all servers.
.. _domain-name/indexing:
Indexing of domain names by search engines
------------------------------------------
Search engines, such as Google and Bing, rely on web crawlers (:dfn:`robots that explore and analyze
the web`) to index all websites and their related domain names. These crawlers discover new URLs
thanks to links on known web pages. As a result, search engines should index domain names
automatically after a while, as long as their URLs are mentioned elsewhere on the Internet.
Improving the appearance and positioning of web pages on search engines is a practice named "Search
Engine Optimization" (SEO).
.. tip::
Adding relevant content, optimizing metadata, and building high-quality backlinks can all help
improve a website's search engine visibility.
Some search engines provide tools for web admins, such as
`Google Search Console <https://search.google.com/search-console>`_ and
`Bing Webmaster Tools <https://www.bing.com/webmasters>`_, to help you analyze and improve your
page ranking. To use these services, you must prove that you are the owner of your domain name. One
way to verify the ownership of your domain name is by adding a DNS record. You can do this for
:ref:`domain names registered with Odoo <domain-name/odoo-manage>` and for domain names managed by
other providers.
.. seealso::
- :doc:`/applications/websites/website/optimize/seo`
- `Google Search Console Help - Verify your site ownership <https://support.google.com/webmasters/answer/9008080>`_
- `Bing Webmaster Tools - Add and Verify site <https://www.bing.com/webmasters/help/add-and-verify-site-12184f8b>`_
.. _domain-name/odoo-register:
Register a free domain name with Odoo
@@ -62,11 +92,11 @@ database manager.
- This offer doesn't include any mailbox. However, you can :ref:`configure your MX records
<domain-name/odoo-manage>` to use your own email server or solution such as Google Workspace.
To do so, go to :menuselection:`Website --> Go to website --> Promote --> Domain Name`.
Alternatively, open your `database manager <https://www.odoo.com/my/databases>`_, click on the
:guilabel:`settings` button next to your database, then on :guilabel:`Domain names`.
To do so, go to :menuselection:`Website --> Domain Name`. Alternatively, open your `database manager
<https://www.odoo.com/my/databases>`_, click on the :guilabel:`settings` button next to your
database, then on :guilabel:`Domain names`.
.. image:: domain_names/register-promote.png
.. image:: domain_names/register-menu.png
:align: center
:alt: Clicking on Domain Names from an Odoo website
@@ -125,8 +155,8 @@ that you proceed with the following actions in this order:
Add a CNAME record
------------------
A **CNAME record** is a type of DNS record that points to the IP address of another website rather
than to directly to an IP address.
A **CNAME record** is a type of DNS record that points to the domain of another website rather than
directly to an IP address.
You need a CNAME record that points to your Odoo database. The requirements are detailed in your
database manager.
@@ -151,7 +181,7 @@ database manager.
#. Open the **DNS zone** management page for the domain name you want to configure.
#. Create a **CNAME record** pointing to the address of your database.
While Odoo suggests creating a CNAME record for your ``www.`` subdomain (``www.example.com``, you
While Odoo suggests creating a CNAME record for your ``www.`` subdomain (``www.example.com``), you
can of course use any domain name of your choice, with any subdomain (e.g.,
``anything.example.com``).
@@ -324,7 +354,7 @@ In the :guilabel:`Domain` field, fill in the web address of your website (e.g.,
If both addresses are already indexed, it may take some time before Google removes the indexation
of the second address. You may also try using the `Google Search Console
<https://search.google.com/search-console/welcome>`_ to fix this.
<https://search.google.com/search-console>`_ to fix this.
.. note::
If you have multiple websites and companies on your database, make sure that you select the
Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 38 KiB

@@ -41,7 +41,7 @@ On Linux, using an installer
.. code-block:: console
$ sudo dpkg -i <path_to_enterprise_deb>
* Update your database to the enterprise packages using
.. code-block:: console
@@ -123,7 +123,7 @@ server in Odoo. The configuration automatically loads the token in Odoo, and a t
:align: center
:alt: Configure Outgoing Email Servers in Odoo.
Finally, save the settings and :guilabel:`Test the Connection`. A confirmation message should
Finally, save the settings and :guilabel:`Test the Connection`. A confirmation message should
appear. The Odoo database can now send safe, secure emails through Google using OAuth
authentication.
@@ -85,4 +85,3 @@ From Odoo.sh to on-premises
1. Grab a :ref:`backup of your Odoo.sh production database <odoo_sh_branches_backups>`.
2. Restore it from the database manager on your local server.
@@ -0,0 +1,218 @@
===========
Mailjet API
===========
Odoo is compatible with Mailjet's :abbr:`API (Application Programming Interface)` for mass mailing.
Set up a dedicated mass mailing server through Mailjet by configuring settings in the Mailjet
account and the Odoo database. In some circumstances, settings need to be configured on the custom
domain's :abbr:`DNS (Domain Name System)` settings as well.
Set up in Mailjet
=================
Create API credentials
----------------------
To get started, sign in to the `Mailjet Account Information <https://app.mailjet.com/account>`_
page. Next, navigate to the :guilabel:`Senders & Domains` section and click on :guilabel:`SMTP and
SEND API Settings`.
.. image:: mailjet_api/api-settings.png
:align: center
:alt: SMTP and Send API Settings link in the Senders & Domains section of Mailjet.
Then, copy the :abbr:`SMTP (Simple Mail Transfer Protocol)` configuration settings onto a notepad.
They can be found under the :guilabel:`Configuration (SMTP only)` section. The :abbr:`SMTP (Simple
Mail Transfer Protocol)` configuration settings include the server address, the security option
needed (Use :abbr:`SSL (Secure Sockets Layer)`/:abbr:`TLS (Transport Layer Security)`), and the
port number. The settings are needed to configure Mailjet in Odoo, which is covered in the
:ref:`last section <maintain/mailjet-api/odoo-setup>`.
.. seealso::
`Mailjet: How can I configure my SMTP parameters?
<https://documentation.mailjet.com/hc/articles/360043229473>`_
.. important::
Odoo blocks `port 25` on Odoo Online and Odoo.sh databases. :ref:`See reference here
<email_servers/restriction>`.
.. image:: mailjet_api/smtp-config.png
:align: center
:alt: SMTP configuration from Mailjet.
Next, click on the button labeled :guilabel:`Retrieve your API credentials` to retrieve the Mailjet
API credentials.
Then, click on the eye icon to reveal the :guilabel:`API key`. Copy this key to a notepad, as this
serves as the :guilabel:`Username` in the Odoo configuration. Next, click on the
:guilabel:`Generate Secret Key` button to generate the :guilabel:`Secret Key`. Copy this key to a
notepad, as this serves as the :guilabel:`Password` in the Odoo configuration.
Add verified sender address(es)
-------------------------------
The next step is to add a sender address or a domain to the Mailjet account settings so that the
email address or domain is approved to send emails using Mailjet's servers. First, navigate to the
`Mailjet Account Information <https://app.mailjet.com/account>`_ page. Next, click on the
:guilabel:`Add a Sender Domain or Address` link under the :guilabel:`Senders & Domains` section.
.. image:: mailjet_api/add-domain-email.png
:align: center
:alt: Add a sender domain or address in the Mailjet interface.
Determine if a sender's email address or the entire domain needs to be added to the Mailjet
settings. It may be easier to configure the domain as a whole if :abbr:`DNS (Domain Name System)`
access is available. Jump to the :ref:`Add a domain <maintain/mailjet-api/add-domain>` section for
steps on adding the domain.
.. note::
Either all email addresses of the Odoo database users who are sending emails using Mailjet's
servers need to be configured or the domain(s) of the users' email addresses can be configured.
By default, the email address originally set up in the Mailjet account is added as a trusted
sender. To add another email address, click on the button labeled :guilabel:`Add a sender address`.
Then, add the email address that is configured to send from the custom domain.
At minimum the following email addresses should be set up in the provider and verified in Mailjet:
- notifications\@yourdomain.com
- bounce\@yourdomain.com
- catchall\@yourdomain.com
.. note::
Replace `yourdomain` with the custom domain for the Odoo database. If there isn't one, then use
the :guilabel:`mail.catchall.domain` system parameter.
After that, fill out the :guilabel:`Email Information` form, making sure to select the appropriate
email type: transactional email or mass emails. After completing the form, an activation email is
sent to the email address and the trusted sender can be activated.
It is recommended to set up the :abbr:`SPF (Sender Policy Framework)`/:abbr:`DKIM (DomainKeys
Identified Mail)`/:abbr:`DMARC (Domain-based Message Authentication, Reporting, and
Conformance)` settings on the domain of the sender.
.. seealso::
`Mailjet's SPF/DKIM/DMARC documentation <https://documentation.mailjet.com/hc/articles/
360042412734-Authenticating-Domains-with-SPF-DKIM>`_
.. important::
If the database is not using a custom domain, then in order to verify the sender's address, a
temporary alias (of the three email addresses mentioned above) should be set up in Odoo CRM to
create a lead. Then, the database is able to receive the verification email and verify the
accounts.
.. _maintain/mailjet-api/add-domain:
Add a domain
------------
By adding an entire domain to the Mailjet account, all the sender addresses related to that domain
are automatically validated for sending emails using Mailjet servers. First, navigate to the
`Mailjet Account Information <https://app.mailjet.com/account>`_ page. Next, click on
:guilabel:`Add a Sender Domain or Address` link under the :guilabel:`Senders & Domains` section.
Then, click on :guilabel:`Add domain` to add the custom domain.
.. note::
The domain needs to be added to the Mailjet account and then validated through the :abbr:`DNS
(Domain Name System)`.
After that, fill out the :guilabel:`Add a new Domain` page on Mailjet and click
:guilabel:`Continue`.
After adding the domain, a validation page will populate. Unless the Odoo database is on-premise
(in which case, choose :guilabel:`Option 1`), choose :guilabel:`Option 2: Create a DNS Record`.
Copy the TXT record information to a notepad and then navigate to the domain's :abbr:`DNS (Domain
Name System)` provider to complete validation.
.. image:: mailjet_api/host-value-dns.png
:align: center
:alt: The TXT record information to input on the domain's DNS.
Setup in the domain's DNS
~~~~~~~~~~~~~~~~~~~~~~~~~
After getting the TXT record information from the Mailjet account, add a TXT record to the domain's
:abbr:`DNS (Domain Name System)`. This process varies depending on the :abbr:`DNS (Domain Name
System)` provider. Consult the provider for specific configuration processes. The TXT record
information consists of the :guilabel:`Host` and :guilabel:`Value`. Paste these into
the corresponding fields in the TXT record.
Return to Mailjet account information
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
After adding the TXT record to the domain's :abbr:`DNS (Domain Name System)`, navigate back to the
Mailjet account. Then, navigate to :menuselection:`Account Information --> Add a Sender Domain or
Address`, click the gear icon next to :guilabel:`Domain`, and select :guilabel:`Validate`.
This action can also be done by going to the `Sender domains & addresses <https://app.mailjet.com/
account/sender>`_ page on the Mailjet account information and clicking on :guilabel:`Manage`.
Next, click :guilabel:`Check Now` to validate the TXT record that was added on the domain. A
success screen will appear if the domain is configured correctly.
.. image:: mailjet_api/check-dns.png
:align: center
:alt: Check DNS record in Mailjet.
After successfully setting up the domain, there is an option to :guilabel:`Authenticate this domain
(SPF/DKIM)`. This button populates :abbr:`SPF (Sender Policy Framework)` & :abbr:`DKIM (DomainKeys
Identified Mail) records to input into the :abbr:`DNS (Domain Name System)` provider.
.. seealso::
`Mailjet's SPF/DKIM/DMARC documentation <https://documentation.mailjet.com/hc/articles/
360042412734-Authenticating-Domains-with-SPF-DKIM>`_
.. image:: mailjet_api/authenticate.png
:align: center
:alt: Authenticate the domain with SPF/DKIM records in Mailjet.
.. _maintain/mailjet-api/odoo-setup:
Set up in Odoo
==============
To complete the setup, navigate to the Odoo database and go to the :guilabel:`Settings`. With
:ref:`developer-mode` turned on, go to the :menuselection:`Technical Menu --> Email --> Outgoing
Mail Servers`. Then, create a new outgoing server configuration by clicking on the
:guilabel:`Create` button.
Next, input the `SMTP server` (in-v3.mailjet.com), `port number` (587 or 465), and `Security
(SSL/TLS)` that was copied earlier from the Mailjet account. They can also be found `here
<https://app.mailjet.com/account/setup>`_. It is recommended to use :abbr:`SSL (Secure Sockets
Layer)`/:abbr:`TLS (Transport Layer Security)` even though Mailjet may not require it.
For the :guilabel:`Username`, input the :guilabel:`API KEY`. For the :guilabel:`Password`, input
the :guilabel:`SECRET KEY` that was copied from the Mailjet account to the notepad earlier. These
settings can be found on :menuselection:`Mailjet --> Account Settings --> SMTP and SEND API
Settings`.
Then, if the Mailjet server is used for mass emailing, set the :guilabel:`Priority` value higher
than that of any transactional email server(s). Finally, save the settings and :guilabel:`Test the
Connection`.
.. image:: mailjet_api/server-settings.png
:align: center
:alt: Odoo outgoing email server settings.
.. important::
In order for the notifications feature to work using Mailjet, there are three settings that need
to be set in Odoo.
#. The :guilabel:`From Filter` needs to be set on the server configuration. It is recommended
to set it as a domain and not a full email address. It should match the domain in the two
proceeding steps. More information can be referenced :ref:`here
<email_servers/outgoing-email-server>`.
#. The :guilabel:`mail.default.from` system parameter must have the value
`notifications\@yourdomain.com`.
#. The :guilabel:`mail.default.from_filter` system parameter must have the value
`yourdomain.com`. Replace `yourdomain` with the custom domain for the Odoo database. If there
isn't one, then use the :guilabel:`mail.catchall.domain` system parameter.
For more information see :ref:`Using a default email address <email_communication/default>`.
The :guilabel:`System Parameters` can be accessed by activating
:doc:`../../applications/general/developer_mode` in the :menuselection:`Settings --> Technical
--> Parameters --> System Parameters` menu.
Once the setup is complete, the Odoo database is ready to use the Mailjet email server for mass
mailing or transactional emails!
Binary file not shown.

After

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 35 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 38 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

@@ -1,18 +1,18 @@
=================================
Online (SaaS) database management
=================================
===============================
Odoo Online database management
===============================
To manage a database, sign in to https://www.odoo.com and access the `database management page
<https://www.odoo.com/my/databases>`_ by clicking on the user icon, then on *My Databases*.
.. image:: online/my-databases.png
.. image:: odoo_online/my-databases.png
:align: center
:alt: Clicking on the user icon opens a drop-down menu. "My databases" button is highlighted.
.. note::
Make sure you are connected as the administrator of the database you want to manage.
.. image:: online/dropdown-menu.png
.. image:: odoo_online/dropdown-menu.png
:align: right
:alt: Clicking on the gear icon opens the drop-down menu.
@@ -20,17 +20,17 @@ Open the drop-down menu next to the database you want to manage by clicking on t
Several actions are available:
- :ref:`online/upgrade`
- :ref:`online/duplicate`
- :ref:`online/rename`
- :ref:`online/download`
- :ref:`online/domains`
- :ref:`online/tags`
- :ref:`online/delete`
- :ref:`online/contact-support`
- :ref:`online/users`
- :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`
.. _online/upgrade:
.. _odoo_online/upgrade:
Upgrade
=======
@@ -56,7 +56,7 @@ upgrade to the latest version (e.g., 13.0 to 15.1).
- :doc:`../upgrade`
- :doc:`supported_versions`
.. _online/duplicate:
.. _odoo_online/duplicate:
Duplicate
=========
@@ -69,14 +69,14 @@ operations.
orders, etc.) are disabled by default on the duplicated database.
- Duplicate databases expire automatically after 15 days.
.. _online/rename:
.. _odoo_online/rename:
Rename
======
Rename the database and its URL.
.. _online/download:
.. _odoo_online/download:
Download
========
@@ -87,7 +87,7 @@ Download instantly a ZIP file with a backup of the database.
Databases are backed up daily according to the `Odoo Cloud SLA
<https://www.odoo.com/cloud-sla>`_.
.. _online/domains:
.. _odoo_online/domains:
Domains
=======
@@ -97,14 +97,14 @@ Configure custom domains to access the database via another URL.
.. seealso::
- :doc:`domain_names`
.. _online/tags:
.. _odoo_online/tags:
Tags
====
Add tags to sort your databases out. You can search the tags in the search bar.
.. _online/delete:
.. _odoo_online/delete:
Delete
======
@@ -118,7 +118,7 @@ Delete a database instantly.
Read carefully the warning message that pops up and proceed only if you fully understand the
implications of deleting a database:
.. image:: online/delete.png
.. image:: odoo_online/delete.png
:align: center
:alt: A warning message is prompted before deleting a database.
@@ -129,7 +129,7 @@ implications of deleting a database:
needed, please get in touch with `Odoo Support <https://www.odoo.com/help>`_.
- To delete your account, please get in touch with `Odoo Support <https://www.odoo.com/help>`_.
.. _online/contact-support:
.. _odoo_online/contact-support:
Contact Support
===============
@@ -137,7 +137,7 @@ Contact Support
Access the Odoo `support page <https://www.odoo.com/help>`_ with your database's details already
pre-filled.
.. _online/users:
.. _odoo_online/users:
Invite / Remove Users
=====================
@@ -145,7 +145,7 @@ Invite / Remove Users
To invite users, fill out the email address of the new user and click on *Invite*. To add multiple
users, click on *Add more users*.
.. image:: online/invite-users.png
.. image:: odoo_online/invite-users.png
:align: center
:alt: Clicking on "Add more users" adds additional email fields.

Before

Width:  |  Height:  |  Size: 19 KiB

After

Width:  |  Height:  |  Size: 19 KiB

Before

Width:  |  Height:  |  Size: 5.5 KiB

After

Width:  |  Height:  |  Size: 5.5 KiB

Before

Width:  |  Height:  |  Size: 6.0 KiB

After

Width:  |  Height:  |  Size: 6.0 KiB

Before

Width:  |  Height:  |  Size: 9.6 KiB

After

Width:  |  Height:  |  Size: 9.6 KiB

+18 -26
View File
@@ -19,12 +19,12 @@ If you are unable to register your database, you will likely encounter this
message:
.. image:: on_premise/error_message_sub_code.png
:align: center
:alt: Something went wrong while registering your database,
you can try again or contact Odoo Help
:align: center
:alt: Something went wrong while registering your database, you can try again or contact Odoo
Help
Solutions
'''''''''
~~~~~~~~~
* Do you have a valid Enterprise subscription?
@@ -42,15 +42,13 @@ Solutions
<https://accounts.odoo.com/my/subscription>`__ with the button "Unlink database"
.. image:: on_premise/unlink_single_db.png
:align: center
:align: center
A confirmation message will appear; make sure this is the correct database as
it will be deactivated shortly:
.. image:: on_premise/unlink_confirm_enterprise_edition.png
:align: center
:align: center
* Do you have the updated version of Odoo 9?
@@ -63,8 +61,7 @@ Solutions
specifying which database is problematic:
.. image:: on_premise/unlink_db_name_collision.png
:align: center
:align: center
In this case, you need to change the UUID on your test databases to solve this
issue. You will find more information about this in :ref:`this section <duplicate_premise>`.
@@ -85,8 +82,6 @@ Solutions
* Once you activated your database, you must keep these ports open, as the
Update notification runs once a week.
Error message due to too many users
-----------------------------------
@@ -94,16 +89,15 @@ If you have more users in your local database than provisionned in your
Odoo Enterprise subscription, you may encounter this message:
.. image:: on_premise/add_more_users.png
:align: center
:alt: This database will expire in X days, you
have more users than your subscription allows
:align: center
:alt: This database will expire in X days, you have more users than your subscription allows
When the message appears you have 30 days before the expiration.
The countdown is updated everyday.
Solutions
'''''''''
~~~~~~~~~
- **Add more users** on your subscription: follow the link and Validate
the upsell quotation and pay for the extra users.
@@ -123,15 +117,14 @@ If your database reaches its expiration date before your renew your subscription
you will encounter this message:
.. image:: on_premise/database_expired.png
:align: center
:alt: This database has expired.
:align: center
:alt: This database has expired.
This **blocking** message appears after a non-blocking message that lasts 30 days.
If you fail to take action before the end of the countdown, the database is expired.
Solutions
'''''''''
~~~~~~~~~
* Renew your subscription: follow the link and renew your subscription - note that
if you wish to pay by Wire Transfer, your subscription will effectively be renewed
@@ -142,7 +135,6 @@ Solutions
None of those solutions worked for you? Please contact our
`Support <https://www.odoo.com/help>`__
.. _force_ping:
.. _duplicate_premise:
@@ -155,8 +147,7 @@ server (<odoo-server>/web/database/manager). In this page, you can easily
duplicate your database (among other things).
.. image:: on_premise/db_manager.gif
:align: center
:align: center
When you duplicate a local database, it is **strongly** advised to change
the duplicated database's uuid (Unniversally Unique Identifier), since this
@@ -164,8 +155,9 @@ uuid is how your database identifies itself with our servers. Having two
databases with the same uuid could result in invoicing problems or registration
problems down the line.
.. note:: From July 2016 onward, Odoo 9 now automatically change the uuid of a
duplicated database; a manual operation is no longer required.
.. note::
From July 2016 onward, Odoo 9 now automatically change the uuid of a duplicated database; a
manual operation is no longer required.
The database uuid is currently accessible from the menu :menuselection:`Settings --> Technical -->
System Parameters`, we advise you to use a `uuid generator <https://www.uuidtools.com>`_ or to
@@ -173,4 +165,4 @@ use the unix command ``uuidgen`` to generate a new uuid. You can then simply rep
other record by clicking on it and using the edit button.
.. image:: on_premise/db_uuid.png
:align: center
:align: center
@@ -8,8 +8,9 @@ Supported versions
Odoo provides support and bug fixing **for the 3 last major versions** of Odoo.
.. note::
Odoo releases intermediary versions called **Online versions** on the :doc:`Odoo Online <online>`
hosting every two months. Odoo Online users can then benefit from the latest features of Odoo.
Odoo releases intermediary versions called **Online versions** on the :doc:`Odoo Online
<odoo_online>` hosting every two months. Odoo Online users can then benefit from the latest
features of Odoo.
- Admins of Odoo Online databases are invited to :doc:`upgrade <../upgrade>` them regularly.
- Online versions are *not* released for Odoo.sh and On-Premise installations.
@@ -25,15 +26,17 @@ This matrix shows the support status of every version.
+-----------------+-------------+----------+-------------+----------------+------------------------+
| | Odoo Online | Odoo.sh | On-Premise | Release date | End of support |
+=================+=============+==========+=============+================+========================+
| Odoo saas~15.2 | |green| | N/A | N/A | March 2022 | |
| **Odoo 16.0** | |green| | |green| | |green| | October 2022 | October 2025 (planned) |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| Odoo saas~15.1 | |red| | N/A | N/A | February 2022 | |
| Odoo saas~15.2 | |green| | N/A | N/A | March 2022 | January 2023 |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| Odoo saas~15.1 | |red| | N/A | N/A | February 2022 | July 2022 |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| **Odoo 15.0** | |green| | |green| | |green| | October 2021 | October 2024 (planned) |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| **Odoo 14.0** | |green| | |green| | |green| | October 2020 | October 2023 (planned) |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| **Odoo 13.0** | |green| | |green| | |green| | October 2019 | October 2022 (planned) |
| **Odoo 13.0** | |red| | |red| | |red| | October 2019 | October 2022 |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| Odoo saas~12.3 | |red| | N/A | N/A | August 2019 | |
+-----------------+-------------+----------+-------------+----------------+------------------------+
@@ -104,6 +104,7 @@ and you're all set.
Source Install (Tarball)
------------------------
If you have originally installed Odoo with the "tarball" version (source code archive), you have
to replace the installation directory with a newer version. First download the latest tarball
from Odoo.com. They are updated daily and include the latest security fixes (see step #1)
@@ -123,6 +124,7 @@ Finally, restart the Odoo service or reboot the machine, and you are all set.
Source Install (Github)
-----------------------
If you have originally installed Odoo with a full Github clone of the official repositories, the
update procedure requires you to pull the latest source code via git.
Change into the directory for each repository (the main Odoo repository, and the Enterprise
+2 -2
View File
@@ -1,8 +1,8 @@
:nosearch:
=================
========
Advanced
=================
========
.. toctree::
:titlesonly:
@@ -1,7 +1,7 @@
==================================
==========
Containers
==================================
==========
Overview
========
@@ -17,7 +17,7 @@ The platform will take care to install these dependencies in your containers.
`The pip requirements specifiers <https://pip.pypa.io/en/stable/reference/pip_install/#requirement-specifiers>`_
documentation can help you write a :file:`requirements.txt` file.
To have a concrete example,
check out the `requirements.txt file of Odoo <https://github.com/odoo/odoo/blob/14.0/requirements.txt>`_.
check out the `requirements.txt file of Odoo <{GITHUB_PATH}/requirements.txt>`_.
The :file:`requirements.txt` files of submodules are taken into account as well. The platform
looks for :file:`requirements.txt` files in each folder containing Odoo modules: Not in the module folder itself,
@@ -167,16 +167,16 @@ In the above commands, the argument:
* ``--stop-after-init`` will immediately shutdown the server instance after it completed the operations you asked.
More options are available and detailed in the
:doc:`CLI documentation </developer/cli>`.
:doc:`CLI documentation </developer/reference/cli>`.
You can find in the logs (*~/logs/odoo.log*) the addons path used by Odoo.sh to run your server.
Look for "*odoo: addons paths*":
::
2018-02-19 10:51:39,267 4 INFO ? odoo: Odoo version 13.0
2018-02-19 10:51:39,267 4 INFO ? odoo: Odoo version {BRANCH}
2018-02-19 10:51:39,268 4 INFO ? odoo: Using configuration file at /home/odoo/.config/odoo/odoo.conf
2018-02-19 10:51:39,268 4 INFO ? odoo: addons paths: ['/home/odoo/data/addons/13.0', '/home/odoo/src/user', '/home/odoo/src/enterprise', '/home/odoo/src/themes', '/home/odoo/src/odoo/addons', '/home/odoo/src/odoo/odoo/addons']
2018-02-19 10:51:39,268 4 INFO ? odoo: addons paths: ['/home/odoo/data/addons/{BRANCH}', '/home/odoo/src/user', '/home/odoo/src/enterprise', '/home/odoo/src/themes', '/home/odoo/src/odoo/addons', '/home/odoo/src/odoo/odoo/addons']
**Be careful**, especially with your production database.
Operations that you perform running this Odoo server instance are not isolated:
@@ -1,9 +1,9 @@
.. _odoosh-advanced-frequent_technical_questions:
==================================
============================
Frequent Technical Questions
==================================
============================
"Scheduled actions do not run at the exact time they were expected"
-------------------------------------------------------------------
@@ -29,4 +29,3 @@ We advise that:
- Your scheduled actions should be
`idempotent <https://stackoverflow.com/a/1077421/3332416>`_: they must not
cause side-effects if they are started more often than expected.
@@ -1,9 +1,9 @@
.. _odoosh-advanced-submodules:
==================================
==========
Submodules
==================================
==========
Overview
========
@@ -64,7 +64,7 @@ On Github, you can get the repository URL with the *Clone or download* button of
.. _odoosh-advanced-submodules-withgit:
With Git (advanced)
---------------------
-------------------
In a terminal, in the folder where your Git repository is cloned,
checkout the branch in which you want to add a submodule:
@@ -1,8 +1,8 @@
:nosearch:
=================
===========
Get started
=================
===========
.. toctree::
:titlesonly:
@@ -1,7 +1,6 @@
==================================
========
Branches
==================================
========
Overview
========
@@ -14,7 +13,7 @@ The branches view gives you an overview of the different branches your repositor
.. _odoosh-gettingstarted-branches-stages:
Stages
===============
======
Odoo.sh offers three different stages for your branches: production, staging and development.
@@ -27,6 +26,7 @@ You can change the stage of a branch by drag and dropping it into the stage sect
Production
----------
This is the branch holding the code on which your production database runs.
There can be only one production branch.
@@ -42,7 +42,7 @@ instance will be held temporarily unavailable for maintenance reason.
This method is equivalent to perform an upgrade of the module through the Apps menu,
or through the :code:`-u` switch of
:doc:`the command line </developer/cli>`.
:doc:`the command line </developer/reference/cli>`.
In the case the changes in the commit prevent the server to restart,
or if the modules update fails,
@@ -59,6 +59,7 @@ will automatically be set back to the development stage after 30 days.
Staging
-------
Staging branches are meant to test your new features using the production data without compromising
the actual production database with test records. They will create databases that are neutralized
duplicates of the production database.
@@ -83,9 +84,9 @@ The unit tests are not performed as, in Odoo, they currently rely on the demo da
production database. In the future, if Odoo supports to run the unit tests without the demo data,
Odoo.sh will then consider running the tests on staging databases.
Development
-----------
Development branches create new databases using the demo data to run the unit tests.
The installed modules are the ones included in your branches. You can change this list of modules
to install in your :ref:`project Settings <odoosh-gettingstarted-settings-modules-installation>`.
@@ -107,6 +108,7 @@ After that, they can be automatically garbage collected to make room for new dat
Merging your branches
---------------------
You can merge your branches easily by drag and dropping them into each other.
.. image:: branches/interface-branches-merge.png
@@ -147,10 +149,11 @@ If you test configuration changes in staging branches, and want them to be appli
.. _odoosh-gettingstarted-branches-tabs:
Tabs
=============
====
History
-------
An overview of your branch history:
* The messages of the commits and their authors,
@@ -168,6 +171,7 @@ When an operation is successful, you can access the database thanks to the *conn
Mails
-----
This tab contains the mail catcher. It displays an overview of the emails sent by your database.
The mail catcher is available for your development and
staging branches as the emails of your production database are really sent instead of being intercepted.
@@ -178,6 +182,7 @@ staging branches as the emails of your production database are really sent inste
Shell
-----
A shell access to your container. You can perform basic linux commands (:code:`ls`, :code:`top`)
and open a shell on your database by typing :code:`psql`.
@@ -187,13 +192,13 @@ and open a shell on your database by typing :code:`psql`.
You can open multiple tabs and drag-and-drop them to arrange the layout as you wish,
for instance side by side.
.. Note::
Long running shell instances are not guaranteed. Idle shells can be
disconnected at anytime in order to free up resources.
Editor
------
An online integrated development environment (IDE) to edit the source code.
You can also open terminals, Python consoles and even Odoo Shell consoles.
@@ -205,6 +210,7 @@ for instance side by side.
Monitoring
----------
This link contains various monitoring metrics of the current build.
.. image:: branches/interface-branches-monitoring.png
@@ -217,6 +223,7 @@ On the graphs, annotations help you relate to changes on the build (database imp
Logs
----
A viewer to have a look to your server logs.
.. image:: branches/interface-branches-logs.png
@@ -240,6 +247,7 @@ The fetching is automatically stopped after 5 minutes. You can restart it using
Backups
-------
A list of the backups available for download and restore, the ability to perform a manual backup and to import a
database.
@@ -259,16 +267,16 @@ This server only keeps one month of backups: 7 daily and 4 weekly backups.
Dedicated backup servers keep the same backups, as well as 3 additional monthly backups.
To restore or download one of these monthly backups, please `contact us <https://www.odoo.com/help>`_.
If you merge a commit updating the version of one or several modules (in :file:`__manifest__.py`), or their linked python
dependencies (in :file:`requirements.txt`), then Odoo.sh performs a backup automatically (flagged with type Update in the list),
as either the container will be changed by the installation of new pip packages, either the database itself will be
changed with the module update triggered afterwards. In these two cases, we are doing a backup as it may potentially
If you merge a commit updating the version of one or several modules (in :file:`__manifest__.py`), or their linked python
dependencies (in :file:`requirements.txt`), then Odoo.sh performs a backup automatically (flagged with type Update in the list),
as either the container will be changed by the installation of new pip packages, either the database itself will be
changed with the module update triggered afterwards. In these two cases, we are doing a backup as it may potentially
break things.
If you merge a commit that only changes some code without the above-mentioned modifications, then no backup is done
by Odoo.sh, as neither the container nor the database is modified so the platform considers this safe enough. Of course,
as an extra precaution, you can make a backup manually before making big changes in your production sources in case
something goes wrong (those manual backups are available for about one week). To avoid abuse, we limit manual backups
If you merge a commit that only changes some code without the above-mentioned modifications, then no backup is done
by Odoo.sh, as neither the container nor the database is modified so the platform considers this safe enough. Of course,
as an extra precaution, you can make a backup manually before making big changes in your production sources in case
something goes wrong (those manual backups are available for about one week). To avoid abuse, we limit manual backups
to 5 per day.
The *import database* feature accepts database archives in the format provided by:
@@ -398,14 +406,13 @@ settings to increase the deliverability of your outgoing emails.
The configuration steps are explained in the documentation about :ref:`SPF
<email_communication/spf_compliant>` and :ref:`DKIM <email_communication/dkim_compliant>`.
.. Warning::
Forgetting to configure your SPF or DKIM to authorize Odoo as a sending host can lead to the
delivery of your emails as spam in your contacts inbox.
Shell commands
==============
In the top right-hand corner of the view, different shell commands are available.
.. image:: branches/interface-branches-shellcommands.png
@@ -418,6 +425,7 @@ such as ``<URL>``, ``<PATH>``, ...
Clone
-----
Download the Git repository.
.. code-block:: bash
@@ -433,6 +441,7 @@ The *run* button is not available for this command, as it is meant to be used on
Fork
----
Create a new branch based on the current branch.
.. code-block:: bash
@@ -449,6 +458,7 @@ Uploads the new branch *feature-1* on your remote repository.
Merge
-----
Merge the current branch in another branch.
.. code-block:: bash
@@ -465,8 +475,10 @@ Uploads the changes you just added in the *master* branch on your remote reposit
SSH
---
Setup
~~~~~
In order to use SSH, you have to set up your profile SSH public key (if it is not already done).
To do so, follow these steps:
@@ -506,7 +518,6 @@ you'll be granted ssh access to the build.
Long running ssh connections are not guaranteed. Idle connections will be
disconnected in order to free up resources.
Submodule
---------
@@ -1,17 +1,18 @@
.. _odoosh-gettingstarted-builds:
==================================
======
Builds
==================================
======
Overview
========
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.
(`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.
.. image:: builds/interface-builds.png
:align: center
@@ -28,13 +29,13 @@ A successful build is highlighted in green.
A build is considered failed if errors come up during its creation.
A failed build is highlighted in red.
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.
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.
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
======
@@ -48,14 +49,15 @@ If this build is successful, this database is considered as the production datab
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 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 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, 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.
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.
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.
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
-------
@@ -63,18 +65,17 @@ Staging
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 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:
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 are close to what the production looks like,
so you do not make your tests with outdated data,
* staging builds use databases that are close to what the production looks like, so you do not make
your tests with outdated data,
* 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.
* 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.
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.
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
-----------
@@ -86,30 +87,30 @@ as they are meant to raise errors if something wrong occurs.
If all tests pass, and there is no error, the build will be considered successful.
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.
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 will always appear first,
and then the other branches are ordered by last build created. You can filter out the branches.
The production branch will always appear first, and then the other branches are ordered by last
build created. You can filter out the branches.
.. image:: builds/interface-builds-branches.png
:align: center
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 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.
.. image:: builds/interface-builds-build.png
:align: center
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 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.
.. _odoosh-gettingstarted-builds-download-dump:
@@ -118,6 +119,6 @@ in the dropdown menu of the *Connect* 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 <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.
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.
@@ -1,9 +1,9 @@
.. _odoosh-gettingstarted-create:
==================================
===================
Create your project
==================================
===================
Deploy your platform
====================
@@ -16,7 +16,8 @@ Go to `Odoo.sh <https://www.odoo.sh/>`_ and hit the *Deploy your platform* butto
Sign in with Github
===================
Sign in with your Github account. If you do not have an account yet, hit the *Create an account* link.
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
@@ -33,34 +34,44 @@ Odoo.sh basically needs:
* 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 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.
* 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.
Submit your project
===================
Choose if you want to start from scratch by creating a new repository, or if you want to use an existing repository.
Choose if you want to start from scratch by creating a new repository, or if you want to use an
existing repository.
Then, choose a name or select the repository you want to use.
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.
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.
Enter your *subscription code*. This is also called *subscription referral*, *contract number* or *activation code*.
Enter your *subscription code*. This is also called *subscription referral*, *contract number* or
*activation code*.
It should be the code of your Enterprise subscription that includes Odoo.sh.
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 the full amount as back commission.
Contact your sales representative or account manager in order to get it.
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.
When submitting the form, if you are notified your subscription is not valid, it either means:
* 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).
* it is neither a partnership subscription or an enterprise subscription (e.g. an online
subscription).
In case of doubt with your subscription, please contact the `Odoo support <https://www.odoo.com/help>`_.
In case of doubt with your subscription, please contact the `Odoo support
<https://www.odoo.com/help>`_.
.. image:: create/deploy-form.png
:align: center
@@ -68,7 +79,8 @@ In case of doubt with your subscription, please contact the `Odoo support <https
You're done !
=============
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.
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.
.. image:: create/deploy-done.png
:align: center
@@ -88,9 +100,10 @@ If you use community or custom modules, add them in a branch in your Github repo
Databases hosted on the Odoo.com online platform do not have any custom modules.
Users of these databases can therefore skip this step.
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, ...).
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,
...).
For community modules available in public Git repositories,
you can also consider to add them using :ref:`Submodules <odoosh-advanced-submodules>`.
@@ -111,7 +124,8 @@ Access the URL :file:`/web/database/manager` of your on-premise database and dow
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>`.
You will need the master password of your database server. If you do not have it, contact your system administrator.
You will need the master password of your database server. If you do not have it, contact your
system administrator.
.. image:: create/create-import-onpremise-backup.png
:align: center
@@ -124,64 +138,68 @@ Choose a zip including the filestore as the backup format.
Odoo Online databases
~~~~~~~~~~~~~~~~~~~~~
`Access your databases manager <https://accounts.odoo.com/my/databases/manage>`_ and download a backup of your database.
`Access your databases manager <https://accounts.odoo.com/my/databases/manage>`_ and download a
backup of your database.
.. image:: create/create-import-online-backup.png
:align: center
:align: center
.. Warning::
Saas releases (e.g. *saas-**) are not supported on Odoo.sh.
Online versions (e.g. *saas-**) are not supported on Odoo.sh.
Upload the backup
-----------------
Then, in your Odoo.sh project, in the backups tab of your production branch, import the backup you just downloaded.
Then, in your Odoo.sh project, in the backups tab of your production branch, import the backup you
just downloaded.
.. image:: create/create-import-production.png
:align: center
Once the backup imported, you can access the database using the *Connect* button in the history of the branch.
Once the backup imported, you can access the database using the *Connect* button in the history of
the branch.
.. image:: create/create-import-production-done.png
:align: center
:align: center
Check your outgoing email 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).
:menuselection:`Settings --> Technical --> Outgoing Mail Servers` (:ref:`Developer mode
<developer-mode>` must be activated).
After the import of your database,
all outgoing email servers are disabled so you use the Odoo.sh email server provided by default.
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 stay) closed. If you want to connect to an external SMTP server, you should use ports 465 and 587.
.. warning::
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 your scheduled actions
----------------------------
All scheduled actions are disabled after the import.
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, ...).
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 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`.
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 your subscription
--------------------------
Your subscription is unlinked after the import.
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.
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 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 <../../maintain/on_premise>` for 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
<../../maintain/on_premise>` for instructions.
@@ -1,14 +1,14 @@
==================================
=================
Your first module
==================================
=================
Overview
========
This chapter helps you to create your first Odoo module and deploy it in your Odoo.sh project.
This tutorial requires :ref:`you created a project on Odoo.sh <odoosh-gettingstarted-create>`, and you know your Github repository's URL.
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.
@@ -27,7 +27,7 @@ Create the development branch
=============================
From Odoo.sh
-------------
------------
In the branches view:
@@ -43,20 +43,18 @@ In the branches view:
.. |pic2| image:: first_module/firstmodule-development-fork.png
:width: 45%
Once the build created, you can access the editor and browse to the folder *~/src/user* to access
to the code of your development branch.
.. image:: first_module/firstmodule-development-editor.png
:align: center
:align: center
.. image:: first_module/firstmodule-development-editor-interface.png
:align: center
:align: center
From your computer
------------------
Clone your Github repository on your computer:
.. code-block:: bash
@@ -72,7 +70,6 @@ Create a new branch:
$ git checkout -b feature-1 master
Create the module structure
===========================
@@ -95,8 +92,8 @@ Or, from your computer, if you have an :ref:`installation of Odoo <setup/install
$ ./odoo-bin scaffold my_module ~/src/odoo-addons/
If you do not want to bother installing Odoo on your computer,
you can also :download:`download this module structure template <first_module/my_module.zip>` in which you replace every occurrences of
*my_module* to the name of your choice.
you can also :download:`download this module structure template <first_module/my_module.zip>` in
which you replace every occurrences of *my_module* to the name of your choice.
The below structure will be generated:
@@ -119,11 +116,11 @@ The below structure will be generated:
├── templates.xml
└── views.xml
.. Warning::
.. warning::
Do not use special characters other than the underscore ( _ ) for your module name, not even an hyphen ( - ).
This name is used for the Python classes of your module,
and having classes name with special characters other than the underscore is not valid in Python.
Do not use special characters other than the underscore ( _ ) for your module name, not even an
hyphen ( - ). This name is used for the Python classes of your module, and having classes name
with special characters other than the underscore is not valid in Python.
Uncomment the content of the files:
@@ -141,7 +138,7 @@ Uncomment the content of the files:
the manifest of your module, including for instance its title, description and data files to load.
You just need to uncomment the access control list data file:
.. code-block:: xml
.. code-block:: python
# 'security/ir.model.access.csv',
@@ -149,7 +146,7 @@ Manually
--------
If you want to create your module structure manually,
you can follow :doc:`Build an Odoo module </developer/howtos/backend>` to understand
you can follow the :doc:`/developer/tutorials/getting_started` tutorial to understand
the structure of a module and the content of each file.
Push the development branch
@@ -180,8 +177,8 @@ The above command is explained in the section
<odoosh-gettingstarted-online-editor-push>` of the
:ref:`Online Editor <odoosh-gettingstarted-online-editor>`
chapter.
It includes the explanation regarding the fact you will be prompted to type your username and password,
and what to do if you use the two-factor authentication.
It includes the explanation regarding the fact you will be prompted to type your username and
password, and what to do if you use the two-factor authentication.
Or, from your computer terminal:
@@ -217,11 +214,11 @@ Once the database ready, you can access it by clicking the *Connect* button.
:align: center
If your Odoo.sh project is configured to install your module automatically,
you will directly see it amongst the database apps. Otherwise, it will be available in the apps to install.
you will directly see it amongst the database apps. Otherwise, it will be available in the apps to
install.
You can then play around with your module, create new records and test your features and buttons.
Test with the production data
=============================
@@ -232,23 +229,24 @@ you can test it with the production data using a staging branch.
You can either:
* Make your development branch a staging branch, by drag and dropping it onto the *staging* section title.
* Make your development branch a staging branch, by drag and dropping it onto the *staging* section
title.
.. image:: first_module/firstmodule-test-devtostaging.png
:align: center
:align: center
* Merge it in an existing staging branch, by drag and dropping it onto the given staging branch.
.. image:: first_module/firstmodule-test-devinstaging.png
:align: center
:align: center
You can also use the :code:`git merge` command to merge your branches.
This will create a new staging build, which will duplicate the production database and make it run using a server
updated with your latest changes of your branch.
This will create a new staging build, which will duplicate the production database and make it run
using a server updated with your latest changes of your branch.
.. image:: first_module/firstmodule-test-mergedinstaging.png
:align: center
:align: center
Once the database ready, you can access it using the *Connect* button.
@@ -257,11 +255,13 @@ Once the database ready, you can access it using the *Connect* button.
Install your module
-------------------
Your module will not be installed automatically, you have to install it from the apps menu.
Indeed, the purpose of the staging build is to test the behavior of your changes as it would be on your production,
and on your production you would not like your module to be installed automatically, but on demand.
Your module will not be installed automatically, you have to install it from the apps menu. Indeed,
the purpose of the staging build is to test the behavior of your changes as it would be on your
production, and on your production you would not like your module to be installed automatically, but
on demand.
Your module may not appear directly in your apps to install either, you need to update your apps list first:
Your module may not appear directly in your apps to install either, you need to update your apps
list first:
* Activate the :ref:`developer mode <developer-mode>`
* in the apps menu, click the *Update Apps List* button,
@@ -307,14 +307,16 @@ you have to install it manually as explained in the
Add a change
============
This section explains how to add a change in your module by adding a new field in a model and deploy it.
This section explains how to add a change in your module by adding a new field in a model and deploy
it.
From the Odoo.sh editor,
* browse to your module folder *~/src/user/my_module*,
* then, open the file *models/models.py*.
Or, from your computer,
* use the file browser of your choice to browse to your module folder *~/src/odoo-addons/my_module*,
* use the file browser of your choice to browse to your module folder
*~/src/odoo-addons/my_module*,
* then, open the file *models/models.py* using the editor of your choice,
such as *Atom*, *Sublime Text*, *PyCharm*, *vim*, ...
@@ -350,8 +352,8 @@ and modify a view stored in database.
In order to be applied in existing databases, such as your production database,
these changes requires the module to be updated.
If you would like the update to be performed automatically by the Odoo.sh platform when you push your changes,
increase your module version in its manifest.
If you would like the update to be performed automatically by the Odoo.sh platform when you push
your changes, increase your module version in its manifest.
Open the module manifest *__manifest__.py*.
@@ -367,7 +369,8 @@ with
'version': '0.2',
The platform will detect the change of version and trigger the update of the module upon the new revision deployment.
The platform will detect the change of version and trigger the update of the module upon the new
revision deployment.
Browse to your Git folder.
@@ -412,12 +415,12 @@ Or, from your computer terminal:
The platform will then create a new build for the branch *feature-1*.
.. image:: first_module/firstmodule-test-addachange-build.png
:align: center
:align: center
Once you tested your changes, you can merge your changes in the production branch, for instance by drag-and-dropping the
branch on the production branch in the Odoo.sh interface. As you increased the module version in the manifest,
the platform will update the module automatically and your new field will be directly available.
Otherwise you can manually update the module within the apps list.
Once you tested your changes, you can merge your changes in the production branch, for instance by
drag-and-dropping the branch on the production branch in the Odoo.sh interface. As you increased the
module version in the manifest, the platform will update the module automatically and your new field
will be directly available. Otherwise you can manually update the module within the apps list.
Use an external Python library
==============================
@@ -425,10 +428,18 @@ Use an external Python library
If you would like to use an external Python library which is not installed by default,
you can define a *requirements.txt* file listing the external libraries your modules depends on.
.. note::
- It is not possible to install or upgrade system packages on an Odoo.sh database (e.g., apt
packages). However, under specific conditions, packages can be considered for installation.
This also applies to **Python modules** requiring system packages for their compilation, and
**third-party Odoo modules**.
- **PostgreSQL extensions** are not supported on Odoo.sh.
- For more information, consult our `FAQ <https://www.odoo.sh/faq#install_dependencies>`_.
The platform will use this file to automatically install the Python libraries your project needs.
The feature is explained in this section by using the `Unidecode library <https://pypi.python.org/pypi/Unidecode>`_ in
your module.
The feature is explained in this section by using the `Unidecode library
<https://pypi.python.org/pypi/Unidecode>`_ in your module.
Create a file *requirements.txt* in the root folder of your repository
@@ -442,8 +453,8 @@ Add
unidecode
Then use the library in your module, for instance to remove accents from characters in the name field of your
model.
Then use the library in your module, for instance to remove accents from characters in the name
field of your model.
Open the file *models/models.py*.
@@ -1,9 +1,9 @@
.. _odoosh-gettingstarted-online-editor:
==================================
=============
Online Editor
==================================
=============
Overview
========
@@ -120,24 +120,23 @@ In this last command,
.. image:: online-editor/interface-editor-commit-push.png
:align: center
.. Note::
The SSH Github remote is not used because your SSH private key
is not hosted in your build containers (for obvious security concerns)
nor forwarded through an SSH Agent (as you access this editor through a web browser)
and you therefore cannot authenticate yourself to Github using SSH.
You have to use the HTTPS remote of your Github repository to push your changes,
which is added automatically named as *https* in your Git remotes.
You will be prompted to enter your Github username and password.
If you activated the two-factor authentication on Github,
you can create a
`personal access token <https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/>`_
and use it as password. Granting the ``repo`` permission suffices.
.. note::
The SSH Github remote is not used because your SSH private key
is not hosted in your build containers (for obvious security concerns)
nor forwarded through an SSH Agent (as you access this editor through a web browser)
and you therefore cannot authenticate yourself to Github using SSH.
You have to use the HTTPS remote of your Github repository to push your changes,
which is added automatically named as *https* in your Git remotes.
You will be prompted to enter your Github username and password.
If you activated the two-factor authentication on Github,
you can create a `personal access token
<https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/>`_
and use it as password. Granting the ``repo`` permission suffices.
.. Note::
The Git source folder *~/src/user* is not checked out on a branch but rather on a detached revision:
This is because builds work on specific revisions rather than branches.
In other words, this means you can have multiple builds on the same branch, but on different revisions.
.. note::
The Git source folder *~/src/user* is not checked out on a branch but rather on a detached revision:
This is because builds work on specific revisions rather than branches.
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 <odoosh-gettingstarted-branches-tabs-settings>`,
@@ -166,12 +165,11 @@ You can also open an Odoo Shell console to play around
with the Odoo registry and model methods of your database. You can also directly read or write
on your records.
.. Warning::
In an Odoo Console, transactions are automatically committed.
This means, for instance, that changes in records are applied effectively in the database.
If you change the name of a user, the name of the user is changed in your database
as well.
You therefore should use Odoo consoles carefully on production databases.
.. warning::
In an Odoo Console, transactions are automatically committed.
This means, for instance, that changes in records are applied effectively in the database.
If you change the name of a user, the name of the user is changed in your database as well.
You therefore should use Odoo consoles carefully on production databases.
You can use *env* to invoke models of your database registry, e.g. :code:`env['res.users']`.
@@ -196,4 +194,4 @@ You can also use
to display graphs.
.. image:: online-editor/interface-editor-console-odoo-graph.png
:align: center
:align: center
@@ -1,7 +1,6 @@
==================================
========
Settings
==================================
========
Overview
========
@@ -21,8 +20,8 @@ The name of your project.
This defines the address that will be used to access your production database.
Addresses of your staging and development builds are derived from this name and assigned automatically.
However, when you change your project name, only future builds will use the new name.
Addresses of your staging and development builds are derived from this name and assigned
automatically. However, when you change your project name, only future builds will use the new name.
.. _odoosh-gettingstarted-settings-collaborators:
@@ -39,10 +38,10 @@ There are two levels of users:
* Admin: has access to all features of Odoo.sh.
* User: does not have access to the project settings nor to the production and staging databases.
The user group is meant for developers who can make modifications in your code but are not allowed to access the
production data.
Users of this group cannot connect to the production and staging databases using the *1-click connect* feature,
but they can of course use their regular account on these databases if they have one, using their regular credentials.
The user group is meant for developers who can make modifications in your code but are not allowed
to access the production data. Users of this group cannot connect to the production and staging
databases using the *1-click connect* feature, but they can of course use their regular account on
these databases if they have one, using their regular credentials.
In addition, they cannot use the webshell nor have access to the server logs.
@@ -90,7 +89,8 @@ Allow public access to your development builds.
.. image:: settings/interface-settings-public.png
:align: center
If activated, this option exposes the Builds page publicly, allowing visitors to connect to your development builds.
If activated, this option exposes the Builds page publicly, allowing visitors to connect to your
development builds.
In addition, visitors have access to the logs, shell and mails of your development builds.
@@ -98,11 +98,11 @@ Production and staging builds are excluded, visitors can only see their status.
.. _odoosh-gettingstarted-settings-modules-installation:
Custom domains
==============
To configure additional domains please refer to the corresponding branch's :ref:`settings tab <odoosh-gettingstarted-branches-tabs-settings>`.
To configure additional domains please refer to the corresponding branch's :ref:`settings tab
<odoosh-gettingstarted-branches-tabs-settings>`.
.. _odoosh-gettingstarted-settings-submodules:
@@ -112,10 +112,10 @@ Submodules
Configure the deploy keys for the private repositories you use
as submodules in your branches to allow Odoo.sh to download them.
.. Warning::
These settings are required for **private repositories** only.
If you are looking on how to set up your submodules,
instructions are available in the chapter :ref:`Submodules <odoosh-advanced-submodules>` of this documentation.
.. warning::
These settings are required for **private repositories** only. If you are looking on how to set
up your submodules, instructions are available in the chapter :ref:`Submodules
<odoosh-advanced-submodules>` of this documentation.
.. image:: settings/interface-settings-submodules.png
:align: center
@@ -130,7 +130,8 @@ To configure the deploy key for a private repository, proceed as follows:
* in the input, paste the SSH URL of your private sub-repository and click on *Add*,
* e.g. *git@github.com:USERNAME/REPOSITORY.git*
* it can be another Git server than Github, such as Bitbucket, Gitlab or even your own self-hosted server
* it can be another Git server than Github, such as Bitbucket, Gitlab or even your own self-hosted
server
* copy the public key,
@@ -157,8 +158,9 @@ Storage size is computed as follows:
* the size of the disk files available in your container: database filestore, sessions storage directory...
.. Warning::
In case you want to analyze disk usage, you can run the tool `ncdu <https://dev.yorhel.nl/ncdu/man>`_ in your Web Shell.
.. warning::
In case you want to analyze disk usage, you can run the tool `ncdu
<https://dev.yorhel.nl/ncdu/man>`_ in your Web Shell.
Should your production database size grow to exceed what's provisioned in your subscription, it
will automatically be synchronized with it.
@@ -191,7 +193,8 @@ add more, it will automatically be synchronized with your subscription.
Activation
==========
Shows the status of the project's activation. You can change the project's activation code if needed.
Shows the status of the project's activation. You can change the project's activation code if
needed.
.. image:: settings/interface-settings-activation.png
:align: center
@@ -1,12 +1,12 @@
==================================
======
Status
==================================
======
Overview
========
The status page shows statistics regarding the servers your project uses. It includes the servers availability.
The status page shows statistics regarding the servers your project uses. It includes the servers
availability.
.. image:: status/interface-status.png
:align: center
+2 -2
View File
@@ -1,8 +1,8 @@
:nosearch:
=================
========
Overview
=================
========
.. toctree::
:titlesonly:
@@ -1,7 +1,6 @@
==============================
=======================
Introduction to Odoo.sh
==============================
=======================
.. youtube:: QuNsa9n9PMg
:align: right
+9 -9
View File
@@ -12,7 +12,7 @@ Upgrade
.. toctree::
:titlesonly:
upgrade/online_hosting
upgrade/odoo_online
upgrade/odoo_sh
upgrade/on_premise
upgrade/faq
@@ -22,8 +22,8 @@ An upgrade is switching to a newer version of Odoo (e.g., Odoo 14.0 to Odoo 15.0
An upgrade does not cover:
* Changing :ref:`editions <upgrade-faq/editions-change>` (i.e., Community to Enterprise edition)
* Switching :ref:`hosting type <upgrade-faq/hosting-types-switch>` (i.e., On-Premise to Online or
Odoo.sh)
* Switching :ref:`hosting type <upgrade-faq/hosting-types-switch>` (i.e., On-Premise to Odoo Online
or Odoo.sh)
* Migration from another ERP to Odoo
.. note:: |assistance-contact|
@@ -54,7 +54,7 @@ The upgrade process in a nutshell:
newly upgraded database (this is done automatically on Odoo Online).
.. seealso::
- :doc:`Upgrade process for Odoo Online (SaaS) <upgrade/online_hosting>`
- :doc:`Upgrade process for Odoo Online <upgrade/odoo_online>`
- :doc:`Upgrade process for Odoo.sh <upgrade/odoo_sh>`
- :doc:`Upgrade process for On-Premise <upgrade/on_premise>`
@@ -225,15 +225,14 @@ Service Level Agreement
What is covered by the Enterprise Licence?
------------------------------------------
Databases hosted on Odoos Cloud platforms (Saas and Odoo.sh) or On-Premise (Self-Hosting) enjoy the
following services at all times.
Databases hosted on Odoo's Cloud platforms (Odoo Online and Odoo.sh) or On-Premise (Self-Hosting)
enjoy the following services at all times.
The upgrade of:
* standard applications
* Studio customization (as long as the :guilabel:`Studio` app is still active)
* customizations done by our consulting and developer services *if* they are covered by a
Maintenance of Customisations subscription
* customizations *if* they are covered by a "Maintenance of Customizations" subscription
The Upgrade Service is limited to your database's technical conversion and adaptation (standard
modules and data) to make it compatible with the targeted version.
@@ -244,6 +243,7 @@ What upgrading does NOT cover
* The cleaning of pre-existing data & configuration while upgrading
* Any new developments and/or upgrades of your own :ref:`custom modules
<upgrade-faq/custom-modules>`
* Lines of code added to standard modules that are not created with Odoo Studio.
* `Training <https://www.odoo.com/learn>`_ on the latest version
You can get more information about your Enterprise Licence on our :ref:`Odoo Enterprise Subscription
@@ -254,4 +254,4 @@ Agreement <upgrade>` page.
.. seealso::
- :doc:`upgrade/faq`
- :doc:`odoo_sh`
- :doc:`maintain/supported_versions`
- :doc:`maintain/supported_versions`
+4 -4
View File
@@ -108,8 +108,8 @@ community or enterprise edition. It is required to have an enterprise subscripti
.. _upgrade-faq/hosting-types-switch:
Switching the hosting types (Self-Hosting vs. Online Hosting - SaaS vs. Cloud Platform - Odoo.sh)
=================================================================================================
Switching the hosting types (On-premise vs. Odoo Online vs. Odoo.sh)
====================================================================
An upgrade does not cover a change of `Hosting types <https://www.odoo.com/page/hosting-types>`_.
@@ -151,8 +151,8 @@ features and improvements made in each version.
How long is my test available for
=================================
An Odoo Online (SaaS) test database is available for one month by default. We can extend this trial
period upon request. For Odoo.sh or on-premise, there is no restriction.
An Odoo Online test database is available for one month by default. We can extend this trial period
upon request. For Odoo.sh or on-premise, there is no restriction.
How many tests to perform before upgrading to production?
=========================================================
@@ -1,6 +1,6 @@
==================
Odoo Online (SaaS)
==================
===========
Odoo Online
===========
Requesting a test upgrade
=========================
@@ -8,18 +8,20 @@ Requesting a test upgrade
#. Go to your `database manager <https://www.odoo.com/my/databases/>`_
#. Click on your profile icon and select *My Databases*.
.. image:: online_hosting/accessing-my-databases.png
.. image:: odoo_online/accessing-my-databases.png
:alt: Selecting My Databases under my profile
#. Click on the action settings icon next to your main database and select the *Upgrade* option.
#. Click on the up arrow button next to your main database name to proceed to the test upgrade.
.. image:: online_hosting/upgrade-option.png
.. image:: odoo_online/upgrade-option.png
:alt: Selecting the action settings icon
#. In the pop-up message that will appear, select Test Upgrade.
#. In the pop-up message that appears, select the target version and then :guilabel:`Test` as
purpose.
.. image:: online_hosting/select-test-upgrade.png
:alt: Selecting test upgrade
.. note::
The :guilabel:`Production` purpose doesn't appear if you didn't test your upgraded database at
least once.
#. This triggers the automated upgrade process. A confirmation email is then sent to you with the
the link to the upgraded database or to provide information if the upgrade failed.

Before

Width:  |  Height:  |  Size: 3.4 KiB

After

Width:  |  Height:  |  Size: 3.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.1 KiB

@@ -56,4 +56,4 @@ Depending on your contract, the upgrade of your custom modules can be done
#. by yourself.
#. by your Partner.
#. by Odoo (if you hold a subscription to 'Maintenance of Customizations').
#. by Odoo (if you hold a subscription to 'Maintenance of Customizations').
Binary file not shown.

Before

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 5.4 KiB

+3 -2
View File
@@ -4,11 +4,12 @@
Finance
=======
.. toctree::
finance/accounting
finance/expenses
finance/documents
finance/sign
finance/payment_providers
finance/spreadsheet
finance/payment_providers
finance/fiscal_localizations
+1 -2
View File
@@ -16,7 +16,7 @@ accounts, smart matching suggestions, etc.
.. seealso::
- `Odoo Tutorials: Accounting <https://www.odoo.com/slides/accounting-19>`_
- :doc:`Accounting Cheat Sheet <accounting/getting_started/memento>`
- :doc:`Accounting Cheat Sheet <accounting/getting_started/cheat_sheet>`
.. toctree::
@@ -29,4 +29,3 @@ accounts, smart matching suggestions, etc.
accounting/taxation
accounting/reporting
accounting/others
accounting/fiscal_localizations
@@ -2,71 +2,61 @@
Bank statements
===============
Importing your bank statements in Odoo Accounting allows you to keep track of the financial
movements that occur on your bank accounts and reconcile them with the transactions recorded in your
accounting.
Importing your bank statements allows you to keep track of your bank account transactions and
reconcile them with the ones recorded in Odoo.
We recommend you use bank synchronization for more efficiency. Please read the related
documentation: :doc:`bank_synchronization`.
We recommend using :doc:`the bank synchronization feature <bank_synchronization>` for more
efficiency. However, if you do not want to use it or if your bank is not yet supported, other
options exist:
However, if you don't want to use bank synchronization or if your bank is not a supported
institution, you still have other options:
#. Import the bank statement files delivered by your bank
#. Register the bank statements manually
- Import the bank statement files delivered by your bank;
- Register the bank statements manually.
Import bank statements files
============================
Odoo supports multiple file formats to import bank statements:
- SEPA recommended Cash Management format (CAMT.053)
- Comma-separated values (.CSV)
- Open Financial Exchange (.OFX)
- Quicken Interchange Format (.QIF)
- Belgium: Coded Statement of Account (.CODA)
- SEPA recommended Cash Management format (CAMT.053);
- Comma-separated values (.CSV);
- Open Financial Exchange (.OFX);
- Quicken Interchange Format (.QIF);
- Belgium: Coded Statement of Account (.CODA).
To import them, go to :menuselection:`Accounting --> Overview --> Bank`, click on *Import
Statements*, or on the three dots, and then on *Import Statement*.
To import a file, go to the Accounting dashboard and click on :guilabel:`Import (Statements)` under
the :guilabel:`Bank` window, or click on the drop-down menu (:guilabel:`⋮`) button and then on
:guilabel:`Import Statement`.
.. image:: bank_statements/bank-statements-01.png
.. image:: bank_statements/bank-overview.png
:align: center
:alt: Import a bank statement file in Odoo Accounting
Next, select the file you want to import and click on *Import*.
Next, select the file you want to import and click on :guilabel:`Upload`.
Odoo opens an **import widget** to help you set the **Formatting Options** and **map** the
different columns you want to import.
Once the file uploaded, the **import widget** helps you set formatting options and **map** the
different columns you want to import. You also can :guilabel:`test` the bank statement file before
importing it to your database.
.. image:: bank_statements/bank-statements-02.png
.. image:: bank_statements/import-bank-statement.png
:align: center
:alt: Register bank statements manually in Odoo Accounting
.. note::
Quicken Interchange Format (.QIF) is an older file format that is no longer supported since 2005.
If possible, prefer OFX files over QIF.
Register bank statements manually
=================================
If needed, you can also record your bank statements manually.
If needed, you can also record your bank statements manually. To do so, go to the
:guilabel:`Accounting dashboard` and click on the :guilabel:`Create Statements` under the
:guilabel:`Bank` window. Alternatively, you can click the drop-down menu (:guilabel:`⋮`) button, and
then :guilabel:`New Statement`.
To do so, go to :menuselection:`Accounting --> Overview --> Bank`, click on *Create Statements*, or
on the three dots, and then on *New Statement*.
Add a new line for each transaction written on the original bank statement.
To ease the reconciliation process, make sure to fill out the *Partner* field. You can also write
the payments references in the *Label* field.
To ease the reconciliation process, make sure to fill out the :guilabel:`Partner` field. You can
also type in the payments references in the :guilabel:`Label` field. Add a new line for each
transaction written on the original bank statement.
.. image:: bank_statements/bank-statements-03.png
:align: center
:alt: Register bank statements manually in Odoo Accounting
.. note::
The *Ending Balance* and the *Computed Balance* should have the same amount. If it is not the
case, make sure that there is no mistake in the transactions amounts.
.. seealso::
* :doc:`bank_synchronization`
.. todo:: add doc link to new documentation about reconciliation
The **Ending Balance** and the **Computed Balance** should have the same amount. If this is not
the case, make sure there are no mistakes in the transactions amounts.
Binary file not shown.

After

Width:  |  Height:  |  Size: 5.4 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 6.1 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

@@ -1,18 +1,15 @@
======================================
Bank synchronization: Automatic import
Bank synchronization: automatic import
======================================
Odoo can synchronize directly with your bank institution to get all bank statements imported
automatically into your database.
To check if your bank is compatible with Odoo, go to `Odoo Accounting Features
<https://www.odoo.com/page/accounting-features>`_, and click on *See list of supported institutions*.
<https://www.odoo.com/page/accounting-features>`_, and click on
:guilabel:`See list of supported institutions`.
.. image:: bank_synchronization/online-sync-doc.png
:align: center
:alt: Checking a bank's compatibility with Odoo
More than 20,000 institutions around the world are supported.
Odoo supports more than 25,000 institutions around the world.
To connect to the banks, Odoo uses multiple web-services:
@@ -20,9 +17,7 @@ To connect to the banks, Odoo uses multiple web-services:
- **Yodlee**: Worldwide
- **Salt Edge**: Europe (:doc:`more information <saltedge>`)
- **Ponto**: Europe (:doc:`more information <ponto>`)
.. important::
- Bank synchronization is not available for trial databases.
- **EnableBanking**: Scandinavian countries
Configuration
=============
@@ -38,49 +33,50 @@ following address:
- https://production.odoofin.com/
First Synchronization
First synchronization
---------------------
You can start synchronization either by going to :menuselection:`Accounting --> Configuration
--> Add a Bank Account` or via the configuration bar on the accounting dashboard.
You can start synchronization either by going to the Accounting app and
:menuselection:`Accounting Dashboard --> Configuration --> Banks: Add a Bank Account`.
Now you can search for your bank institution. Select it and follow the steps to synchronize with it.
.. note::
If you have any issues during your first synchronization, please verify that your
web browser doesn't block pop-ups and that your adblocker is disabled.
web browser doesn't block pop-ups and that your ad-blocker is disabled.
During your first synchronization, you will be asked for a phone number to secure your account.
The reason we ask for such information is that we don't want your data falling into the wrong
hands. Therefore, if we detect suspicious activity on your account, we block all requests coming
from your account, and you need to reactivate it using that phone number.
The third-party provider may request more information in order to connect with your bank institution.
.. important::
When choosing the date for the first bank statement synchronization, pick the date when you
start recording accounting transaction on your Odoo accounting database. For example, if you
import your closing balance in Odoo on the 31/12/2022 and you start recording accounting
transactions on the 01/01/2023, your synchronization date should be 01/01/2023.
You must provide a phone number during your first synchronization to secure your account. We ask for
such information because we don't want your data falling into the wrong hands. Therefore, if we
detect suspicious activities on your account, we block all requests coming from your account, and
you need to reactivate it using that phone number.
The third-party provider may request more information in order to connect with your
bank institution.
This information is not stored on Odoo's servers.
By default, transactions fetched from an online source are grouped inside the same statement, and
one bank statement is created per month. You can change the bank statement creation periodicity
in your journal settings.
You can find all your synchronizations by going to :menuselection:`Accounting --> Configuration -->
Online Synchronization`.
You can find all your synchronizations by going to :menuselection:`Accounting Dashboard -->
Configuration --> Accounting: Online Synchronization`.
Synchronize manually
--------------------
After your first synchronization, the created journals are synchronized by default every 12 hours.
If you wish, you can synchronize manually by clicking on the *Synchronize Now* button on the
dashboard.
If you wish, you can synchronize manually by clicking on the :guilabel:`Synchronize Now` button on
the dashboard.
.. image:: bank_synchronization/online-sync-sync-now-dashboard.png
:align: center
:alt: Synchronize Now Button
Or you can go to :menuselection:`Accounting --> Configuration --> Online Synchronization`,
select your institution and then click on the *Fetch Transactions* button.
.. image:: bank_synchronization/online-sync-form-view.png
:align: center
:alt: Online Synchronization Form view
Or you can go to :menuselection:`Accounting Dashboard --> Configuration -->
Accounting: Online Synchronization`, select your institution and then click on the
:guilabel:`fetch transactions` button.
.. important::
Some institutions do not allow transactions to be fetched automatically. For such institutions,
@@ -95,14 +91,14 @@ Synchronization in error
------------------------
To report a connection error to the `Odoo support <https://www.odoo.com/help>`_, go to
:menuselection:`Accounting --> Configuration --> Online Synchronization`, select the connection
that failed, and copy the error description and the reference.
:menuselection:`Accounting Dashboard--> Configuration --> Accounting: Online Synchronization`,
select the connection that failed, and copy the error description and the reference.
Synchronization disconnected
----------------------------
If your connection with the proxy is disconnected, you can reconnect with the proxy using the
*Reconnect* button.
:guilabel:`Fetch Account` button.
.. note::
This disconnection can be caused by the Odoo support. In this case, please contact the `support
@@ -121,24 +117,19 @@ Users who have created a database before December 2020 need to install the new m
use the new functionalities.
To do so, go to :menuselection:`Apps --> Update Apps List`, remove the default filter in the search
bar and type: **account_online_synchronization**. You can then click on the *Install* button to
install the new module.
.. image:: bank_synchronization/online-sync-module.png
:align: center
:alt: Installation button of the account_online_synchronization module
bar and type `account_online_synchronization`. You can then click on :guilabel:`Install`.
Finally, make sure all your users refresh their Odoo page by pressing CTRL+F5.
.. Note::
- All previous synchronizations are disconnected during the installation and won't work anymore.
You can find them directly in the synchronization menu (:menuselection:`Accounting -->
Configuration --> Online Synchronization`). It is not possible to resynchronize these
connections; you have to make new ones.
- Please do not uninstall *account_online_sync* which is the previous module for online
- You can find them directly in the synchronization menu
(:menuselection:`Accounting Dashboard --> Configuration -->
Accounting: Online Synchronization`). It is not possible to resynchronize these connections;
you have to make new ones.
- Do not uninstall `account_online_sync`, which is the previous module for online
synchronization. The new one overrides it.
- By default *account_online_synchronization* is installed automatically with Accounting.
- By default, `account_online_synchronization` is installed automatically with Accounting.
FAQ
===
@@ -148,14 +139,15 @@ The synchronization is not working in real-time. Is that normal?
The process is not intended to work in real-time as third party providers synchronize your accounts
at different intervals. To force the synchronization and fetch the statements, go to your
*Accounting dashboard*, and click on the *Synchronize Now* button. You can also synchronize and
fetch transactions through :menuselection:`Accounting --> Configuration --> Online Synchronization`.
Some providers only allow one refresh per day, so it is possible that clicking on *Synchronize Now*
does not get your latest transactions if you already performed such action earlier in the day.
:guilabel:`Accounting Dashboard`, and click on the :guilabel:`Synchronize Now` button. You can also
synchronize and fetch transactions through :menuselection:`Accounting Dashboard -->
Configuration --> Accounting: Online Synchronization`. Some providers only allow one refresh per
day, so it is possible that clicking on :guilabel:`Synchronize Now` does not get your latest
transactions if you already performed such action earlier in the day.
A transaction can be visible on your bank account, but not be fetched if it has the status
*Pending*. Only transactions with the *Posted* status will be retrieved. If it is not *Posted* yet,
you will have to wait until the status changes.
A transaction can be visible on your bank account but not be fetched if it has the status
:guilabel:`Pending`. Only transactions with the :guilabel:`Posted` status will be retrieved. If the
transaction is not **Posted** yet, you will have to wait until the status changes.
Is the Online Bank Synchronization feature included in my contract?
-------------------------------------------------------------------
@@ -188,8 +180,9 @@ Why don't I see any transactions?
---------------------------------
During your first synchronization, you selected the bank accounts you decided to synchronize with
Odoo. If you didn't synchronize any of your accounts, you can go to :menuselection:`Accounting -->
Configuration --> Online Synchronization` to click on the *Fetch Accounts* button on the connection.
Odoo. If you didn't synchronize any of your accounts, you can go to
:menuselection:`Accounting Dashboard --> Configuration --> Accounting: Online Synchronization` to
click on the :guilabel:`Fetch Account` button on the connection.
There may also be no new transactions.
@@ -199,9 +192,9 @@ database, please `submit a support ticket <https://www.odoo.com/help>`_.
How can I update my bank credentials?
-------------------------------------
You can update your credentials by going to :menuselection:`Accounting --> Configuration --> Online
Synchronization`, open the connection you want to update your credentials and click on the *Update
Credentials* button.
You can update your credentials by going to :menuselection:`Accounting Dashboard -->
Configuration --> Accounting: Online Synchronization`,open the connection you want to update your
credentials and click on the :guilabel:`Update Credentials` button.
.. seealso::
* :doc:`bank_statements`
Binary file not shown.

Before

Width:  |  Height:  |  Size: 28 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.1 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 6.4 KiB

@@ -64,8 +64,8 @@ Link your Ponto account with your Odoo database
#. Finish the flow.
.. note::
You have to authorize all the accounts you want to access in Odoo but, Odoo will filter the
accounts based on the institution you selected at the second step.
You have to authorize all the accounts you want to access in Odoo, but Odoo will filter the
accounts based on the institution you selected in the second step.
Update your synchronization credentials
---------------------------------------
@@ -80,12 +80,12 @@ FAQ
I have an error when I try to delete my synchronization within Odoo
-------------------------------------------------------------------
Odoo can't permanently delete the connection you have created with the banking institution. However,
it can revoke the consent you gave so that Odoo won't be able to access your account anymore. The
error you are seeing is probably a message telling you that the consent was revoked, but the record
could not be deleted as it still exists within Salt edge. If you want to remove the connection
completely, please connect to your `Salt Edge account <https://www.saltedge.com/dashboard>`_
and manually delete your synchronization. Once this is done, you can go back to Odoo to delete the
Odoo can't permanently delete the connection you have created with the banking institution. However,
it can revoke the consent you gave so that Odoo won't be able to access your account anymore. The
error you are seeing is probably a message telling you that the consent was revoked, but the record
could not be deleted as it still exists within Salt edge. If you want to remove the connection
completely, please connect to your `Salt Edge account <https://www.saltedge.com/dashboard>`_
and manually delete your synchronization. Once this is done, you can go back to Odoo to delete the
record.
I have an error saying that I have already synchronized this account
@@ -7,4 +7,4 @@ Miscellaneous
.. toctree::
:titlesonly:
misc/interbank
misc/interbank
@@ -1,132 +1,147 @@
================================================
Do a bank wire transfer from one bank to another
================================================
=================
Internal transfer
=================
A company might have several bank accounts or cash registers. Within
odoo it is possible to handle internal transfers of money with only a
couple of clicks.
We will take the following example to illustrate. My company has two
bank accounts and I want to transfer 50.000 euros from one of our bank
accounts to the another one.
In Odoo, internal money transfers can be made in a few clicks. You need at least either two bank
accounts, two cash journals, or one bank account and one cash journal.
Configuration
=============
Check your Chart of Accounts and default transfer account
---------------------------------------------------------
An internal transfer account is automatically created on your database based on your company's
localization and depending on your countrys legislation. If needed, the default :guilabel:`Internal
transfer account` can be modified by going to :menuselection:`Accounting app --> Configuration -->
Settings` and then under the :guilabel:`Default Accounts` section.
To handle internal transfers you need a transfer account in your charts
of account. Odoo will generate an account automatically based on the
country of your chart of account. To configure your chart of accounts and
check the default transfer account go into the accounting module settings,
select :menuselection:`Configuration --> Settings`.
.. note::
At least two bank accounts are needed to make internal transfers. Refer to
:doc:`Bank and cash accounts section <../setup/bank_accounts>` to see how to add an additional
bank account to your database.
Your chart of accounts will be pre-installed depending on the country
specified during your registration, it cannot be changed.
Register an internal transfer from one bank to another
======================================================
.. image:: interbank/interbank04.png
:align: center
The default transfer account will automatically be generated as well
depending on your country's legislation. If necessary it can be modified
from the same page.
.. image:: interbank/interbank05.png
:align: center
Create a second bank account / Journal
--------------------------------------
Before we can register an internal transfer we need to add a new bank to
our accounting dashboard. To do so enter the accounting module, click on
:menuselection:`Configuration --> Bank Accounts`. Create a new bank account. You should
fill in the **Account Number**. You can also create and edit your bank to
specify your bank's details.
.. image:: interbank/interbank03.png
:align: center
By saving the changes you now have 2 bank accounts.
.. image:: interbank/interbank06.png
:align: center
Register an internal transfer from one bank to another.
=======================================================
We will now transfer 50.000 euros from our **Bank** to our **Bank BE57 0633
9533 1498** account.
Let's say you have two bank accounts registered on your database and you want to transfer 1,000 USD
from Bank A to Bank B.
Log an internal transfer
------------------------
The first step is to register the internal payment. To do so go into
your accounting dashboard, click on the **more** button of one of your banks
and select :menuselection:`New --> Internal transfer`.
From the Accounting Dashboard, click on the drop-down selection button (:guilabel:`⋮`) on one of
your banks. In the :guilabel:`New` column click on :guilabel:`Internal Transfer` and enter the
information related to the transfer.
.. image:: interbank/interbank01.png
.. image:: interbank/internal_transfer.png
:align: center
Create a new payment. The payment type will automatically be set to
internal transfer. Select the **Bank** you want to transfer to, specify the
**Amount** and add a **Memo** if you wish.
:alt: Fill in the information related to your internal transfer
.. note::
The memo is important if you wish to automatically reconcile (see `Import bank statements and
reconcile`_).
Fill in the :guilabel:`Memo` field for automatic reconciliation.
.. image:: interbank/interbank02.png
:guilabel:`Save` and :guilabel:`Confirm` to register your internal transfer. The money is now booked
in the transfer account and another payment is **automatically** created in the destination journal
(Bank B).
Bank journal (Bank A)
~~~~~~~~~~~~~~~~~~~~~
.. list-table::
:header-rows: 1
:stub-columns: 1
* - **Account**
- **Debit**
- **Credit**
* - Outstanding Payments account
-
- $1,000
* - **Internal transfer account**
- **$1,000**
-
Automated booking - Bank journal (BANK B)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. list-table::
:header-rows: 1
:stub-columns: 1
* - **Account**
- **Debit**
- **Credit**
* - Outstanding Receipts account
- $1,000
-
* - **Internal transfer account**
-
- **$1,000**
.. note::
There are one outstanding payment and one outstanding receipt pending in your two bank account
journals, because the bank statement confirming the sending and receiving of the money has not
been booked yet.
.. image:: interbank/outstanding-payments-receipts.png
:align: center
:alt: Outstanding Payments/Receipts pending bank statement booking
Save and confirm the changes to register the payment.
.. _interbank/import-and-reconcile:
In terms of accounting the money is now booked in the transfer account.
We'll need to import bank statements to book the money in the final
accounts.
Import bank statements and reconcile
Manage and reconcile bank statements
------------------------------------
Note that the bank balance computed by Odoo is different that the last
statement of your bank.
The next step is to book the bank statements to finalize the transaction by creating,
:doc:`importing <../feeds/bank_statements>`, or :doc:`synchronizing <../feeds/bank_synchronization>`
your :guilabel:`Transactions lines`. Fill in the :guilabel:`Ending balance` and click on the
:guilabel:`Reconcile` button.
.. image:: interbank/interbank11.png
.. image:: interbank/transactions-line.png
:align: center
:alt: Transaction lines to be filled in prior to reconciliation
That is because we did not import the bank statement confirming the
receiving and sending of the money. It's thus necessary to import your
bank statement and reconcile the payment with the correct bank statement
line. Once you receive your bank statements click the **new statement**
button of the corresponding bank to import them.
.. seealso::
- :doc:`../reconciliation/use_cases`
.. image:: interbank/interbank07.png
In the next window, choose counterparts for the payment - in this example, the outstanding payment
account - then click :guilabel:`Validate`.
.. image:: interbank/bank-reconciliation.png
:align: center
:alt: Reconcile your payment
Fill in your **Transactions line**. Once done, Odoo will display a **Computed
Balance**. that computed balance is the theorical end balance of your
bank account. If it's corresponding to the bank statement, it means that no errors were
made. Fill in the **Ending balance** and click on the **Reconcile** button.
Bank journal entry
~~~~~~~~~~~~~~~~~~
.. image:: interbank/interbank10.png
:align: center
.. list-table::
:header-rows: 1
:stub-columns: 1
The following window will open:
* - **Account**
- **Debit**
- **Credit**
* - Outstanding Payment
- $1,000
-
* - Bank Account (BANK A)
-
- **$1,000**
.. image:: interbank/interbank09.png
:align: center
The same steps must be repeated once you receive the bank statement related to Bank B. Book and
reconcile your bank statement lines.
You need to choose counterparts for the payment. Select the correct
bank statement line corresponding to the payment and click on the
**reconcile** button. Close the statement to finish the transaction
Bank journal entry
~~~~~~~~~~~~~~~~~~
.. image:: interbank/interbank08.png
:align: center
.. list-table::
:header-rows: 1
:stub-columns: 1
The same steps will need to be repeated once you receive your second
bank statement. Note that if you specify the same amount and the
same memo in both bank statements and payment transactions then the
reconciliation will happen automatically.
.. image:: interbank/interbank12.png
:align: center
* - **Account**
- **Debit**
- **Credit**
* - Outstanding Receipt
-
- $1,000
* - Bank Account (BANK B)
- **$1,000**
-
Binary file not shown.

After

Width:  |  Height:  |  Size: 56 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.4 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 7.9 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.8 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.9 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 8.0 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.4 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 8.6 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

@@ -8,4 +8,4 @@ Bank reconciliation
:titlesonly:
reconciliation/use_cases
reconciliation/reconciliation_models
reconciliation/reconciliation_models
@@ -126,4 +126,4 @@ line*.
- :doc:`use_cases`
- :doc:`../feeds/bank_synchronization`
- :doc:`../../receivables/customer_invoices/cash_discounts`
- :doc:`../../receivables/customer_invoices/cash_discounts`
@@ -102,4 +102,4 @@ right and validate all related payments :
:align: center
.. seealso::
* :doc:`../feeds/bank_synchronization`
* :doc:`../feeds/bank_synchronization`
@@ -1,95 +1,136 @@
=============
Bank Accounts
=============
You can manage as many **Bank Accounts** as needed on your database. Configuring them well allows
you to make sure that all your banking data is up to date and ready for the reconciliation with your
*Journal Entries*.
In Odoo Accounting, each Bank Account is configured to have a dedicated *Journal* which is
configured to post all entries in a dedicated *Account*.
.. note:: Whenever you add a Bank Account, a dedicated journal and a dedicated account are
automatically created and configured.
Every **Bank Journal** is displayed by default on the **Accounting Overview** in the form of a
convenient card. It includes action buttons that are displayed when appropriate.
.. image:: bank_accounts/bank_accounts_card.png
:align: center
:alt: Bank Journals Cards are displayed on the Accounting Overview in Odoo Accounting
.. _bank_accounts_add:
Add a new Bank Account
======================
Bank and cash accounts
======================
You can either connect your bank account to your Odoo database, or configure your bank account
manually and :doc:`upload the bank statements manually <../feeds/bank_statements>`.
You can manage as many bank or cash accounts as needed on your database. Configuring them well
allows you to have all your banking data up-to-date and ready for :doc:`reconciliation
<../../bank/reconciliation/use_cases>` with your journal entries.
Bank Synchronization
--------------------
Connect your bank account to your database and have your bank statements synced automatically.
To synchronize a new bank account, go to :menuselection:`Accounting --> Configuration`, click on
*Add a Bank Account*, then find your bank in the list, click on *Connect*, and follow the
instructions on-screen.
In Odoo Accounting, each bank account has a dedicated journal set to post all entries in a dedicated
account. Both the journal and the account are automatically created and configured whenever you add
a bank account.
.. note::
:doc:`Click here <../../bank/feeds/bank_synchronization>` for more information about this bank
synchronization.
Cash journals and accounts must be configured manually.
.. image:: bank_accounts/bank_accounts_connect.png
Bank journals are displayed by default on the :guilabel:`Accounting Dashboard` in the form of cards
which include action buttons.
.. image:: bank_accounts/card.png
:align: center
:alt: Select a bank institution in the list and connect it to Odoo Accounting
:alt: Bank journals are displayed on the Accounting Dashboard and contain action buttons
Manual configuration
--------------------
.. _bank_accounts/manage:
If your Bank Institution cant be synchronized automatically, or if you prefer not to sync it with
your database, you may also configure your bank account manually.
Manage your bank and cash accounts
==================================
To add a new bank account manually, go to :menuselection:`Accounting --> Configuration`, click on
*Add a Bank Account*, then on *Create it*, and fill out the form.
Connect your bank for automatic synchronization
-----------------------------------------------
- **Name**: the bank account's name, as displayed on Odoo.
- **Account Number**: your bank account number (IBAN in Europe).
- **Bank**: click on *Create and Edit* to configure the bank's details. Add the bank institution's
name and its Identifier Code (BIC or SWIFT).
- **Code**: this code is your Journal's *Short Code*, as displayed on Odoo. By default, Odoo creates
a new Journal with this Short Code.
- **Journal**: This field is displayed if you have an existing Bank Journal that is not linked yet
to a bank account. If so, then select the *Journal* you want to use to record the financial
transactions linked to this bank account or create a new one by clicking on *Create and Edit*.
.. note::
Odoo detects the bank account type (e.g., IBAN) and enables some features accordingly.
.. image:: bank_accounts/bank_accounts_manual.png
:align: center
:alt: Add manually a new bank account in Odoo Accounting
.. _bank_accounts_configuration:
Advanced configuration
======================
To edit an existing bank account, go to :menuselection:`Accounting --> Configuration --> Bank
Accounts`, and open the bank account you want to modify.
If you need to edit the bank account details, go to the *Bank Account* field and click on the
*External Link* button next to the list arrow. There, you can edit the bank account's number,
Account Holder, Account Holder Name, and your Bank Institution's details by clicking on the
*External Link* next to the *Bank* field. These details are used to register some payments.
You can configure which types of payments are enabled in the **Payment Method Types** section and
how the bank statements are recorded and posted in the **Bank Statements** section.
.. image:: bank_accounts/bank_accounts_configuration.png
:align: center
:alt: Advanced configuration of a bank account in Odoo Accounting
To connect your bank account to your database, go to :menuselection:`Accounting --> Configuration
--> Banks: Add a Bank Account`, select your bank in the list, click on :guilabel:`Connect`, and
follow the instructions.
.. seealso::
* :doc:`../../bank/feeds/bank_synchronization`
* :doc:`../feeds/bank_statements`
* `Odoo Tutorials: Accounting Basics <https://www.odoo.com/r/lsZ>`_
:doc:`../../bank/feeds/bank_synchronization`
Create a bank account
---------------------
If your banking institution is not available in Odoo, or if you don't want to connect your bank
account to your database, you can configure your bank account manually.
To manually add a bank account, go to :menuselection:`Accounting --> Configuration --> Banks:
Add a Bank Account`, click on :guilabel:`Create it` (at the bottom right), and fill out the form.
.. note::
- Odoo automatically detects the bank account type (e.g., IBAN) and enables some features
accordingly.
- A default bank journal is available and can be used to configure your bank account by going to
:menuselection:`Accounting --> Configuration --> Accounting: Journals --> Bank`. Open it and
edit the different fields to match your bank account information.
Create a cash journal
---------------------
To create a new cash journal, go to :menuselection:`Accounting --> Configuration --> Accounting:
Journals`, click on :guilabel:`Create` and select :guilabel:`Cash` in the :guilabel:`Type` field.
For more information on the accounting information fields, read the
:ref:`bank_accounts/configuration` section of this page.
.. note::
A default cash journal is available and can be used straight away. You can review it by going to
:menuselection:`Accounting --> Configuration --> Accounting: Journals --> Cash`.
Edit an existing bank or cash journal
-------------------------------------
To edit an existing bank journal, go to :menuselection:`Accounting --> Configuration --> Accounting:
Journals` and select the journal you want to modify.
.. _bank_accounts/configuration:
Configuration
=============
You can edit the accounting information and bank account number according to your needs.
.. image:: bank_accounts/bank-journal-config.png
:align: center
:alt: Manually configure your bank information
.. seealso::
- :doc:`../../others/multi_currency`
- :doc:`../../bank/feeds/bank_statements`
- :doc:`../../bank/setup/outstanding_accounts`
Suspense account
----------------
Bank statement transactions are posted on the :guilabel:`Suspense Account` until the final
reconciliation allows finding the right account.
Profit and loss accounts
------------------------
The :guilabel:`Profit Account` is used to register a profit when the ending balance of a cash
register differs from what the system computes, while the :guilabel:`Loss Account` is used to
register a loss when the ending balance of a cash register differs from what the system computes.
Currency
--------
You can edit the currency used to enter the statements.
.. seealso::
:doc:`../../others/multi_currency`
Account number
--------------
If you need to **edit your bank account details**, click on the external link arrow next to your
:guilabel:`Account Number`. On the new page, click on the external link arrow next to your
:guilabel:`Bank` and update your bank information accordingly. These details are used when
registering payments.
.. image:: bank_accounts/bank-account-number.png
:align: center
:alt: Edit your bank information
Bank feeds
----------
:guilabel:`Bank Feeds` defines how the bank statements are registered. Three options are available:
- :guilabel:`Undefined yet`, which should be selected when you dont know yet if you will
synchronize your bank account with your database or not.
- :guilabel:`Import (CAMT, CODA, CSV, OFX, QIF)`, which should be selected if you want to import
your bank statement using a different format.
- :guilabel:`Automated Bank Synchronization`, which should be selected if your bank is synchronized
with your database.
.. seealso::
- :doc:`../../bank/feeds/bank_synchronization`
- :doc:`../../bank/feeds/bank_statements`
Binary file not shown.

After

Width:  |  Height:  |  Size: 7.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 7.5 KiB

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