[MOV] documentation structure reorganization

This commit aims to improve the documentation's navigability by
redefining some categories' purposes and titles.

There is a redirection rule for each documentation page moved.
This ensures that users won't have a 404 error message.

task-3217827

closes odoo/documentation#8063

Signed-off-by: Jonathan Castillo (jcs) <jcs@odoo.com>
This commit is contained in:
Jonathan Castillo (jcs)
2024-03-04 12:02:08 +01:00
parent af91b7c2b6
commit bf7fa31503
562 changed files with 644 additions and 643 deletions
+127
View File
@@ -0,0 +1,127 @@
=========================
Two-factor Authentication
=========================
Two-factor authentication ("2FA") is a good way to improve the
security of an account, to make it less likely that an other person
will manage to log in instead of you.
Practically, it means storing a secret inside an *authenticator*
(usually your cell phone) and exchanging a code from the authenticator
when you try to log in.
This means an attacker needs *both* to have guessed (or found) your
password and to access (or steal) your authenticator, a more difficult
proposition than either one or the other.
Requirements
============
.. note:: These lists are just examples, they are not endorsements of
any specific software.
If you don't already have one, you will need to choose an
authenticator.
Phone-based authenticators are the easiest and most common so we will
assume you'll pick and install one on your phone, examples include
`Authy <https://authy.com/>`_, `FreeOTP
<https://freeotp.github.io/>`_, `Google Authenticator
<https://support.google.com/accounts/answer/1066447?hl=en>`_,
`LastPass Authenticator <https://lastpass.com/auth/>`_, `Microsoft
Authenticator
<https://www.microsoft.com/en-gb/account/authenticator?cmp=h66ftb_42hbak>`_,
...; password managers also commonly include :abbr:`2FA (two-factor
authentication)` support e.g. `1Password
<https://support.1password.com/one-time-passwords/>`_, `Bitwarden
<https://bitwarden.com/help/article/authenticator-keys/>`_, ...
For the sake of demonstration we will be using Google Authenticator
(not because it is any good but because it is quite common).
Setting up two-factor authentication
====================================
Once you have your authenticator of choice, go to the Odoo instance
you want to setup :abbr:`2FA (two-factor authentication)`, then open
:guilabel:`Preferences` (or :guilabel:`My Profile`):
.. figure:: 2fa/preferences.png
:align: center
Open the :guilabel:`Account Security` tab, then click the
:guilabel:`Enable two-factor authentication` button:
.. figure:: 2fa/sec_tab.png
:align: center
Because this is a security-sensitive action, you will need to input
your password:
.. figure:: 2fa/sec_enhanced.png
:align: center
After which you will see this screen with a barcode:
.. figure:: 2fa/totp_scan.png
:align: center
In most applications, you can simply *scan the barcode* via the
authenticator of your choice, the authenticator will then take care of
all the setup:
.. figure:: 2fa/scan_barcode.jpg
:align: center
.. note::
If you can not scan the screen (e.g. because you are doing this
set-up on the same phone as the authenticator application), you can
click the provided link, or copy the secret to manually set-up your
authenticator:
.. figure:: 2fa/secret_visible.png
:align: center
.. figure:: 2fa/input_secret.png
:align: center
Once this is done, the authenticator should display a *verification
code* with some useful identifying information (e.g. the domain and
login for which the code is):
.. figure:: 2fa/authenticator.png
:align: center
You can now input the code into the :guilabel:`Verification Code`
field, then click the :guilabel:`Enable two-factor authentication`
button.
Congratulation, your account is now protected by two-factor
authentication!
.. figure:: 2fa/totp_enabled.png
:align: center
Logging in
==========
You should now :guilabel:`Log out` to follow along.
On the login page, input the username and password of the account for
which you set up :abbr:`2FA (two-factor authentication)`, rather than
immediately enter Odoo you will now get a second log-in screen:
.. figure:: 2fa/2fa_input.png
:align: center
Get your authenticator, input the code it provides for the domain and
account, validate, and you're now in.
And that's it. From now on, unless you disable :abbr:`2FA (two-factor
authentication)` you will have a two-step log-in process rather than
the old one-step process.
.. danger:: Don't lose your authenticator, if you do, you will need an
*Odoo Administrator* to disable :abbr:`2FA (two-factor
authentication)` on the account.
Binary file not shown.

After

Width:  |  Height:  |  Size: 6.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 98 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.3 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

@@ -0,0 +1,182 @@
======================================
Microsoft Azure sign-in authentication
======================================
The Microsoft Azure OAuth sign-in authentication is a useful function that allows Odoo users to sign
in to their database with their Microsoft Azure account.
This is particularly helpful if the organization uses Azure Workspace, and wants employees within
the organization to connect to Odoo using their Microsoft Accounts.
.. warning::
Databases hosted on Odoo.com should not use OAuth login for the owner or administrator of the
database as it would unlink the database from their Odoo.com account. If OAuth is set up for that
user, the database will no longer be able to be duplicated, renamed, or otherwise managed from
the Odoo.com portal.
.. seealso::
- :doc:`../../productivity/calendar/outlook`
- :doc:`../email_communication/azure_oauth`
Configuration
=============
Integrating the Microsoft sign-in function requires configuration on Microsoft and Odoo.
Odoo System Parameter
---------------------
First activate the :ref:`developer mode <developer-mode>`, and then go to :menuselection:`Settings
--> Technical --> System Parameters`.
Click :guilabel:`Create` and on the new/blank form that appears, add the following system parameter
`auth_oauth.authorization_header` to the :guilabel:`Key` field, and set the :guilabel:`Value` to
`1`. Then click :guilabel:`Save` to finish.
Microsoft Azure dashboard
-------------------------
Create a new application
~~~~~~~~~~~~~~~~~~~~~~~~
Now that the system parameters in Odoo have been set up, it's time to create a corresponding
application inside of Microsoft Azure. To get started creating the new application, 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 a personal :guilabel:`Microsoft
account`.
.. important::
A user with administrative access to the *Azure Settings* must connect and perform the following
configuration steps below.
Next, navigate to the section labeled :guilabel:`Manage Microsoft Entra ID` (formally *Azure Active
Directory*). The location of this link is usually in the center of the page.
Now, click on the :guilabel:`Add (+)` icon, located in the top menu, and then select :guilabel:`App
registration` from the drop-down menu. On the :guilabel:`Register an application` screen, rename the
:guilabel:`Name` field to `Odoo Login OAuth` or a similarly recognizable title. Under the
:guilabel:`Supported account types` section select the option for :guilabel:`Accounts in this
organizational directory only (Default Directory only - Single tenant)`.
.. warning::
The :guilabel:`Supported account types` can vary by Microsoft account type and end use of the
OAuth. For example: Is the login meant for internal users within one organization or is it meant
for customer portal access? The above configuration is used for internal users in an
organization.
Choose :guilabel:`Personal Microsoft accounts only` if the target audience is meant for portal
users. Choose :guilabel:`Accounts in this organizational directory only (Default Directory only -
Single tenant)` if the target audience is company users.
Under the :guilabel:`Redirect URL` section, select :guilabel:`Web` as the platform, and then input
`https://<odoo base url>/auth_oauth/signin` in the :guilabel:`URL` field. The Odoo base :abbr:`URL
(Uniform Resource Locator)` is the canonical domain at which your Odoo instance can be reached (e.g.
*mydatabase.odoo.com* if you are hosted on Odoo.com) in the :guilabel:`URL` field. Then, click
:guilabel:`Register`, and the application is created.
Authentication
~~~~~~~~~~~~~~
Edit the new app's authentication by clicking on the :guilabel:`Authentication` menu item in the
left menu after being redirected to the application's settings from the previous step.
Next, the type of *tokens* needed for the OAuth authentication will be chosen. These are not
currency tokens but rather authentication tokens that are passed between Microsoft and Odoo.
Therefore, there is no cost for these tokens; they are used merely for authentication purposes
between two :abbr:`APIs (application programming interfaces)`. Select the tokens that should be
issued by the authorization endpoint by scrolling down the screen and check the boxes labeled:
:guilabel:`Access tokens (used for implicit flows)` and :guilabel:`ID tokens (used for implicit and
hybrid flows)`.
.. image:: azure/authentication-tokens.png
:align: center
:alt: Authentication settings and endpoint tokens.
Click :guilabel:`Save` to ensure these settings are saved.
Gather credentials
~~~~~~~~~~~~~~~~~~
With the application created and authenticated in the Microsoft Azure console, credentials will be
gathered next. To do so, click on the :guilabel:`Overview` menu item in the left-hand column. Select
and copy the :guilabel:`Application (client) ID` in the window that appears. Paste this credential
to a clipboard / notepad, as this credential will be used in the Odoo configuration later.
After finishing this step, click on :guilabel:`Endpoints` on the top menu and click the *copy icon*
next to :guilabel:`OAuth 2.0 authorization endpoint (v2)` field. Paste this value in the clipboard /
notepad.
.. image:: azure/overview-azure-app.png
:align: center
:alt: Application ID and OAuth 2.0 authorization endpoint (v2) credentials.
Odoo setup
----------
Finally, the last step in the Microsoft Azure OAuth configuration is to configure some settings in
Odoo. Navigate to :menuselection:`Settings --> Integrations --> OAuth Authentication` and check the
box to activate the OAuth login feature. Click :guilabel:`Save` to ensure the progress is saved.
Then, sign in to the database once the login screen loads.
Once again, navigate to :menuselection:`Settings --> Integrations --> OAuth Authentication` and
click on :guilabel:`OAuth Providers`. Now, select :guilabel:`New` in the upper-left corner and name
the provider `Azure`.
Paste the :guilabel:`Application (client) ID` from the previous section into the :guilabel:`Client
ID` field. After completing this, paste the new :guilabel:`OAuth 2.0 authorization endpoint (v2)`
value into the :guilabel:`Authorization URL` field.
For the :guilabel:`UserInfo URL` field, paste the following :abbr:`URL (Uniform Resource Locator)`:
`https://graph.microsoft.com/oidc/userinfo`
In the :guilabel:`Scope` field, paste the following value: `openid profile email`. Next, the Windows
logo can be used as the CSS class on the login screen by entering the following value: `fa fa-fw
fa-windows`, in the :guilabel:`CSS class` field.
Check the box next to the :guilabel:`Allowed` field to enable the OAuth provider. Finally, add
`Microsoft Azure` to the :guilabel:`Login button label` field. This text will appear next to the
Windows logo on the login page.
.. image:: azure/odoo-provider-settings.png
:align: center
:alt: Odoo provider setup in the Settings application.
:guilabel:`Save` the changes to complete the OAuth authentication setup in Odoo.
User experience flows
---------------------
For a user to log in to Odoo using Microsoft Azure, the user must be on the :menuselection:`Odoo
password reset page`. This is the only way that Odoo is able to link the Microsoft Azure account and
allow the user to log in.
.. note::
Existing users must :ref:`reset their password <users/reset-password>` to access the
:menuselection:`Odoo password reset page`. New Odoo users must click the new user invitation link
that was sent via email, then click on :guilabel:`Microsoft Azure`. Users should not set a new
password.
To sign in to Odoo for the first time using the Microsoft Azure OAuth provider, navigate to the
:menuselection:`Odoo password reset page` (using the new user invitation link). A password reset
page should appear. Then, click on the option labeled :guilabel:`Microsoft Azure`. The page will
redirect to the Microsoft login page.
.. image:: azure/odoo-login.png
:align: center
:alt: Microsoft Outlook login page.
Enter the :guilabel:`Microsoft Email Address` and click :guilabel:`Next`. Follow the process to sign
in to the account. Should :abbr:`2FA (Two Factor Authentication)` be turned on, then an extra step
may be required.
.. image:: azure/login-next.png
:align: center
:alt: Enter Microsoft login credentials.
Finally, after logging in to the account, the page will redirect to a permissions page where the
user will be prompted to :guilabel:`Accept` the conditions that the Odoo application will access
their Microsoft information.
.. image:: azure/accept-access.png
:align: center
:alt: Accept Microsoft conditions for permission access to your account information.
Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 25 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 27 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 28 KiB

Before

Width:  |  Height:  |  Size: 18 KiB

After

Width:  |  Height:  |  Size: 18 KiB

@@ -1,134 +0,0 @@
=========
Companies
=========
A centralized management environment allows you to select multiple companies simultaneously and set
their specific warehouses, customers, equipment, and contacts. It provides you the ability to
generate reports of aggregated figures without switching interfaces, which facilitates daily tasks
and the overall management process.
.. _companies/manage:
Manage companies and records
============================
Go to :menuselection:`Settings --> Manage Companies` and fill in the form with your companys
information. If a *Parent Company* is selected, records are shared between the two companies (as
long as both environments are active).
.. image:: companies/create_js_store_us.png
:align: center
:alt: Overview of a new company's form in Odoo
.. tip::
Activate the :ref:`developer mode <developer-mode>` to choose a *Favicon* for each of your
companies, and easily identify them by the browser tabs. Set your favicons files size to 16x16
or 32x32 pixels. JPG, PNG, GIF, and ICO are extensions accepted.
.. image:: companies/favicon.png
:align: center
:height: 200
:alt: View of a web browser and the favicon for a specific company chosen in Odoo
Switch between or select multiple companies by enabling their selection boxes to activate them. The
grayed company is the one which environment is in use. To switch environments, click on the
companys name. In the example below, the user has access to three companies, two are activated, and
the environment in use is of *JS Store US*.
.. image:: companies/multi_companies_menu_dashboard.png
:align: center
:alt: View of the companies menu through the main dashboard in Odoo
Data such as Products, Contacts, and Equipment can be shared or set to be shown for a specific
company only. To do so, on their forms, choose between:
- *A blank field*: the record is shared within all companies.
- *Adding a company*: the record is visible to users logged in to that specific company.
.. image:: companies/product_form_company.png
:align: center
:alt: View of a product's form emphasizing the company field in Odoo Sales
Employees' access
=================
Once companies are created, manage your employees' :doc:`Access Rights <access_rights>`
for *Multi Companies*.
.. image:: companies/access_rights_multi_companies.png
:align: center
:alt: View of an user form emphasizing the multi companies field under the access rights tabs
in Odoo
| If a user has multiple companies *activated* on his database, and he is **editing** a record,
the editing happens on the record's related company.
| Example: if editing a sale order issued under JS Store US while working on the JS Store Belgium
environment, the changes are applied under JS Store US (the company from which the sale order
was issued).
| When **creating** a record, the company taken into account is:
- The current company (the one active) or,
- No company is set (on products and contacts forms for example) or,
- The company set is the one linked to the document (the same as if a record is being edited).
Documents format
=================
To set documents' formats according to each company, *activate* and *select* the respective one and,
under *Settings*, click on *Configure Document Layout*.
.. image:: companies/document_layout.png
:align: center
:alt: View of the settings page emphasizing the document layout field in Odoo
Inter-Company Transactions
==========================
First, make sure each one of your companies is properly set in relation to:
- :doc:`Chart of Accounts <../../finance/accounting/get_started/chart_of_accounts>`
- :doc:`Taxes <../../finance/accounting/taxes>`
- :doc:`Fiscal Positions <../../finance/accounting/taxes/fiscal_positions>`
- :doc:`Journals <../../finance/accounting/bank>`
- :doc:`Fiscal Localizations <../../finance/fiscal_localizations>`
- :doc:`Pricelists <../../sales/sales/products_prices/prices/pricing>`
Now, activate the *Inter-Company Transactions* option under *Settings*. With the respective company
*activated* and *selected*, choose if you would like operations between companies to be synchronized
at an invoice/bills level or at a sales/purchase orders level.
.. image:: companies/inter_company_transactions.png
:align: center
:alt: View of the settings page emphasizing the inter company transaction field in Odoo
- **Synchronize invoice/bills**: generates a bill/invoice when a company confirms a bill/invoice for
the selected company.
*Example:* an invoice posted on JS Store Belgium, for JS Store US, automatically creates a vendor
bill on the JS Store US, from the JS Store Belgium.
.. image:: companies/invoice_inter_company.png
:align: center
:alt: View of an invoice for JS Store US created on JS Store Belgium in Odoo
- **Synchronize sales/purchase order**: generates a drafted purchase/sales order using the selected
company warehouse when a sales/purchase order is confirmed for the selected company. If instead of
a drafted purchase/sales order you rather have it validated, enable *Automatic Validation*.
*Example:* when a sale order for JS Store US is confirmed on JS Store Belgium, a purchase order
on JS Store Belgium is automatically created (and confirmed if the *Automatic Validation* feature
was enabled).
.. image:: companies/purchase_order_inter_company.png
:align: center
:alt: View of the purchase created on JS Store US from JS Store Belgium in Odoo
.. note::
Products have to be configured as *Can be sold* and must be shared between the companies.
.. tip::
Remember to test all workflows as an user other than the administrator.
.. seealso::
- :doc:`Multi-company Guidelines </developer/howtos/company>`
- :doc:`../../finance/accounting/get_started/multi_currency`
Binary file not shown.

Before

Width:  |  Height:  |  Size: 62 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 23 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 42 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 21 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 45 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 43 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 44 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 68 KiB

@@ -0,0 +1,167 @@
=============================
Google Sign-In Authentication
=============================
The *Google Sign-In Authentication* is a useful function that allows Odoo users to sign in to their
database with their Google account.
This is particularly helpful if the organization uses Google Workspace, and wants employees within
the organization to connect to Odoo using their Google Accounts.
.. warning::
Databases hosted on Odoo.com should not use Oauth login for the owner or administrator of the
database as it would unlink the database from their Odoo.com account. If Oauth is set up for that
user, the database will no longer be able to be duplicated, renamed or otherwise managed from
the Odoo.com portal.
.. seealso::
- :doc:`/applications/productivity/calendar/google`
- :doc:`../email_communication/google_oauth`
.. _google-sign-in/configuration:
Configuration
=============
The integration of the Google sign-in function requires configuration both on Google *and* Odoo.
.. _google-sign-in/api:
Google API Dashboard
--------------------
#. Go to the `Google API Dashboard <https://console.developers.google.com/>`_.
#. Make sure the right project is opened. If there isn't a project yet, click on :guilabel:`Create
Project`, fill out the project name and other details of the company, and click on
:guilabel:`Create`.
.. image:: google/new-project-details.png
:align: center
:alt: Filling out the details of a new project.
.. tip::
Choose the name of the company from the drop-down menu.
.. _google-sign-in/oauth:
OAuth consent screen
~~~~~~~~~~~~~~~~~~~~
#. On the left side menu, click on :menuselection:`OAuth consent screen`.
.. image:: google/consent-selection.png
:align: center
:alt: Google OAuth consent selection menu.
#. Choose one of the options (:guilabel:`Internal` / :guilabel:`External`), and click on
:guilabel:`Create`.
.. image:: google/consent.png
:align: center
:alt: Choice of a user type in OAuth consent.
.. warning::
*Personal* Gmail Accounts are only allowed to be **External** User Type, which means Google
may require an approval, or for *Scopes* to be added on. However, using a *Google WorkSpace*
account allows for **Internal** User Type to be used.
Note, as well, that while the API connection is in the *External* testing mode, then no
approval is necessary from Google. User limits in this testing mode is set to 100 users.
#. Fill out the required details and domain info, then click on :guilabel:`Save and Continue`.
#. On the :menuselection:`Scopes` page, leave all fields as is, and click on :guilabel:`Save and
Continue`.
#. Next, if continuing in testing mode (*External*), add the email addresses being configured under
the :guilabel:`Test users` step by clicking on :guilabel:`Add Users`, and then the
:guilabel:`Save and Continue` button. A summary of the app registration appears.
#. Finally, scroll to the bottom, and click on :guilabel:`Back to Dashboard`.
.. _google-sign-in/credentials:
Credentials
~~~~~~~~~~~
#. On the left side menu, click on :menuselection:`Credentials`.
.. image:: google/credentials-button.png
:align: center
:alt: Credentials button menu.
#. Click on :guilabel:`Create Credentials`, and select :guilabel:`OAuth client ID`.
.. image:: google/client-id.png
:align: center
:alt: OAuth client id selection.
#. Select :guilabel:`Web Application` as the :guilabel:`Application Type`. Now, configure the
allowed pages on which Odoo will be redirected.
In order to achieve this, in the :guilabel:`Authorized redirect URIs` field, enter the database's
domain immediately followed by `/auth_oauth/signin`. For example:
`https://mydomain.odoo.com/auth_oauth/signin`, then click on :guilabel:`Create`.
#. Now that the *OAuth client* has been created, a screen will appear with the :guilabel:`Client ID`
and :guilabel:`Client Secret`. Copy the :guilabel:`Client ID` for later, as it will be necessary
for the configuration in Odoo, which will be covered in the following steps.
.. _google-sign-in/auth-odoo:
Google Authentication on Odoo
-----------------------------
.. _google-sign-in/client-id:
Retrieve the Client ID
~~~~~~~~~~~~~~~~~~~~~~
Once the previous steps are complete, two keys are generated on the Google API Dashboard:
:guilabel:`Client ID` and :guilabel:`Client Secret`. Copy the :guilabel:`Client ID`.
.. image:: google/secret-ids.png
:align: center
:alt: Google OAuth Client ID generated.
.. _google-sign-in/odoo-activation:
Odoo activation
~~~~~~~~~~~~~~~
#. Go to :menuselection:`Odoo General Settings --> Integrations` and activate :guilabel:`OAuth
Authentication`.
.. note::
Odoo may prompt the user to log-in again after this step.
#. Go back to :menuselection:`General Settings --> Integrations --> OAuth Authentication`, activate
the selection and :guilabel:`Save`. Next, return to :menuselection:`General Settings -->
Integrations --> Google Authentication` and activate the selection. Then fill out the
:guilabel:`Client ID` with the key from the Google API Dashboard, and :guilabel:`Save`.
.. image:: google/odoo-client-id.png
:align: center
:alt: Filling out the client id in Odoo settings.
.. note::
Google OAuth2 configuration can also be accessed by clicking on :guilabel:`OAuth Providers`
under the :guilabel:`OAuth Authentication` heading in :menuselection:`Integrations`.
.. _google-sign-in/log-in:
Log in to Odoo with Google
==========================
To link the Google account to the Odoo profile, click on :guilabel:`Log in with Google` when first
logging into Odoo.
.. image:: google/first-login.png
:align: center
:alt: Reset password screen with "Log in with Google" button.
Existing users must :ref:`reset their password <users/reset-password>` to access the
:menuselection:`Reset Password` page, while new users can directly click on :guilabel:`Log in with
Google`, instead of choosing a new password.
.. seealso::
- `Google Cloud Platform Console Help - Setting up OAuth 2.0
<https://support.google.com/cloud/answer/6158849>`_
Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.6 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 27 KiB

Before

Width:  |  Height:  |  Size: 24 KiB

After

Width:  |  Height:  |  Size: 24 KiB

@@ -0,0 +1,55 @@
=================
Sign in with LDAP
=================
- Install the Lightweight Directory Access Protocol (LDAP) module in General Settings.
- Click on **Create** in Setup the :abbr:`LDAP (Lightweight Directory Access Protocol)` Server.
.. image:: ldap/ldap01.png
:align: center
:alt: LDAP Authentication checkbox highlighted in the integrations settings on Odoo.
.. image:: ldap/ldap02.png
:align: center
:alt: Create highlighted in the LDAP server settings.
- Choose the company using the LDAP.
.. image:: ldap/ldap03.png
:align: center
:alt: Select the company drop-down menu highlighted in LDAP setup.
- In **Server Information**, enter the IP address of the server and the port it listens to.
- Tick **Use TLS** if the server is compatible.
.. image:: ldap/ldap04.png
:align: center
:alt: LDAP server settings highlighted in LDAP server setup on Odoo.
- In **Login Information**, enter ID and password of the account used to query the server. If left
empty, the server queries anonymously.
.. image:: ldap/ldap05.png
:align: center
:alt: Login information highlighted in LDAP server setup on Odoo.
- In **Process Parameter**, enter the domain name of the LDAP server in :abbr:`LDAP (Lightweight
Directory Access Protocol)` nomenclature (e.g. ``dc=example,dc=com``).
- In **LDAP filter**, enter ``uid=%s``
.. image:: ldap/ldap06.png
:align: center
:alt: Process parameter highlighted in LDAP server setup on Odoo.
- In **User Information**, tick *Create User* if Odoo should create a User profile the first time
someone logs in with :abbr:`LDAP (Lightweight Directory Access Protocol)`.
- In **Template User**, indicate a template for the new profiles created. If left blanked, the admin
profile will be used as template.
.. image:: ldap/ldap07.png
:align: center
:alt: User information highlighted on LDAP server setup on Odoo.
Binary file not shown.

After

Width:  |  Height:  |  Size: 167 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 38 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 61 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 61 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 61 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 61 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 61 KiB

Before

Width:  |  Height:  |  Size: 22 KiB

After

Width:  |  Height:  |  Size: 22 KiB

@@ -1,152 +0,0 @@
============
Manage users
============
Odoo defines a **user** as someone who has access to a database to perform daily tasks. You can add
as many users as you need and, in order to restrict the type of information each user can access,
rules can be applied. Users and access rights can be added and changed at any point.
.. seealso::
- :doc:`language`
- :doc:`access_rights`
.. _users/add-individual:
Add individual users
====================
Go to :menuselection:`Settings --> Manage Users` and click on *Create*.
.. image:: manage_users/manage-users.png
:align: center
:height: 280
:alt: View of the settings page emphasizing the manage users field in Odoo
| Fill in the form with the needed information. Under the tab
:doc:`Access Rights <access_rights>` choose the group within each application the user can
have access to.
| The list of applications shown is based on the applications installed on the database.
.. image:: manage_users/new_user.png
:align: center
:alt: View of a users form emphasizing the access rights tab in Odoo
When you are done editing the page and have *Saved* it, an invitation email is automatically sent to
the user. The user must click on it to accept the invitation and create a login.
.. image:: manage_users/invitation-email.png
:align: center
:alt: View of a users form with a notification that the invitation email has been sent in Odoo
.. note::
Remember that subscription prices follow the number of users. Refer to our
`pricing page <https://www.odoo.com/pricing>`_
for more information.
With the :ref:`developer mode <developer-mode>` activated, *User Types* can be selected.
.. image:: manage_users/user-type.png
:align: center
:height: 300
:alt: View of a users form in developer mode emphasizing the user type field in Odoo
The *Portal* and *Public* options do not allow you to choose access rights. Members have specific
ones (such as record rules and restricted menus) and usually do not belong to the usual Odoo
groups.
.. _users/deactivate:
Deactivate users
================
Go to :menuselection:`Settings --> Users & Companies --> Users`, open the user you want to
deactivate, click on *Action*, and then on *Archive*.
.. danger::
**Never** deactivate the main user (*admin*).
.. _users/passwords-management:
Passwords management
====================
.. _users/reset-password:
Reset passwords
---------------
.. _users/reset-password-login:
Enable password resets from login page
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
It is possible to enable password resets directly from the login page.
To do so, go to :menuselection:`Settings --> Permissions`, activate **Password Reset** and *Save*.
.. image:: manage_users/password-reset-login.png
:align: center
:alt: Enabling Password Reset in Odoo Settings
.. _users/reset-password-email:
Send reset instructions to users
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Go to :menuselection:`Settings --> Users & Companies --> Users`, select the user out of the list and
click on *Send Password Reset Instructions* on its user form. An email is automatically sent to
them.
.. note::
The *Send Password Reset Instructions* button only appears if the Odoo invitation email has
already been confirmed by the user.
This email contains all the instructions needed to reset the password, along with a link redirecting
the user to an Odoo login page.
.. image:: manage_users/password-email.png
:align: center
:alt: Example of an email with a password reset link for an Odoo account
.. _users/change-password:
Change users passwords
-----------------------
Go to :menuselection:`Settings --> Users & Companies --> Users` and select a user to access its
form. Click on the *Action* button and select *Change Password*.
.. image:: manage_users/change-password.png
:align: center
:alt: Change another user's password on Odoo
Enter a new password and confirm by clicking on *Change Password*.
.. note::
This operation only modifies the password of the users locally and does not affect their odoo.com
account. If you want to change the odoo.com password, you can :ref:`send the password reset
instructions <users/reset-password-email>`.
Click on *Change Password* one more time. You are then redirected to an Odoo login page where you
can reaccess your database using your new password.
.. _users/multi-companies:
Multi Companies
===============
The *Multi Companies* field allows you to set to which of the multiple companies database you hold
the user can have access.
.. note::
Note that if not handled correctly, it may be the source of a lot of inconsistent multi-company
behaviors. Therefore, a good knowledge of Odoo is required. For technical explanations refer
to :doc:`this </developer/howtos/company>` documentation.
.. image:: manage_users/multi-companies.png
:align: center
:height: 300
:alt: View of a users form emphasizing the multi companies field in Odoo
.. seealso::
- :doc:`companies`

Before

Width:  |  Height:  |  Size: 29 KiB

After

Width:  |  Height:  |  Size: 29 KiB

Before

Width:  |  Height:  |  Size: 39 KiB

After

Width:  |  Height:  |  Size: 39 KiB

@@ -1,78 +0,0 @@
========================
Odoo.com account changes
========================
This documentation is dedicated to edits made to an Odoo.com account. The following processes
describe how to delete an Odoo.com account, and how to change the password on an Odoo.com account.
Delete Odoo.com account
=======================
To delete an Odoo.com account, start by clicking the profile icon in the upper-right corner
(represented by the username and icon) to reveal a drop-down menu. From the drop-down menu, select
:guilabel:`My Odoo.com account`, which reveals the user portal.
From the user portal, the delete option can be accessed by going to :menuselection:`My Account -->
Edit Security Settings --> Delete Account`. It can also be accessed by going to
`https://www.odoo.com/my/home <https://www.odoo.com/my/home>`_.
.. danger::
Deleting an Odoo account is irreversible. Be careful performing this action, as the Odoo.com
account is **not** retrievable once deleted.
Upon clicking the :guilabel:`Delete Account` button, a pop-up window appears, requesting
confirmation for the account deletion.
.. image:: odoo_account/delete-account.png
:align: center
:alt: Clicking on the Delete Account button will populate a window verifying the change.
To confirm the deletion, enter the :guilabel:`Password` and the :guilabel:`Login` for the account
being deleted. Then, click the :guilabel:`Delete Account` button to confirm the deletion.
Odoo.com account password change
================================
To change an Odoo.com account password, first login into the Odoo.com user account from the Odoo.com
login page. After logging-in, go to the upper-right corner of the screen, and click the :guilabel:`▼
(down arrow)` icon next to the profile icon. Then, select :guilabel:`My Account`, and a portal
dashboard appears.
To change the Odoo.com password, click on the :guilabel:`Edit Security Settings` link, below the
:menuselection:`Account Security` section. Next, make the necessary changes by typing in the current
:guilabel:`Password`, :guilabel:`New Password`, and verify the new password. Lastly, click on
:guilabel:`Change Password` to complete the password change.
.. note::
If a customer would like to change the login, contact Odoo support `here
<https://www.odoo.com/help>`_.
.. note::
Passwords for Odoo.com users and portal users remain separate, even if the same email address is
used.
Add two-factor authentication
=============================
To add two-factor authentication, login into the Odoo.com user account from the Odoo.com login page.
After logging-in, go to the upper-right corner of the screen, and click the :guilabel:`▼ (down
arrow)` icon next to the :guilabel:`profile icon`. Then, select :guilabel:`My Account`, and a portal
dashboard appears.
If the user would like to turn on two-factor authentication (2FA) for Odoo.com access, click on the
:guilabel:`Edit Security Settings` link below the :menuselection:`Account Security` section.
Click on :guilabel:`Enable two-factor authentication` to turn on :abbr:`2FA (two-factor
authentication)`. Then, confirm the current password in the :guilabel:`Password` field. Next, click
on :guilabel:`Confirm Password`. Following that, activate :abbr:`2FA (two-factor authentication)` in
a :abbr:`2FA (two-factor authentication)` app (Google Authenticator, Authy, etc.), by scanning the
:guilabel:`QR code` or entering a :guilabel:`Verification Code`.
Finally, click on :guilabel:`Enable two-factor authentication` to complete the setup.
.. note::
Under :guilabel:`My Account` Odoo.com users can also access the following:
- :guilabel:`My Partner dashboard`
- :guilabel:`My In-App Services`
- :guilabel:`My Apps Dashboard`
Binary file not shown.

Before

Width:  |  Height:  |  Size: 18 KiB

Before

Width:  |  Height:  |  Size: 19 KiB

After

Width:  |  Height:  |  Size: 19 KiB

Before

Width:  |  Height:  |  Size: 25 KiB

After

Width:  |  Height:  |  Size: 25 KiB

Before

Width:  |  Height:  |  Size: 37 KiB

After

Width:  |  Height:  |  Size: 37 KiB