e3fee2cf46
Prior to this commit, the Odoo documentation was mainly split between
two repositories: odoo/odoo/doc and odoo/documentation-user. Some bits
of documentation were also hosted elsewhere (e.g., wiki, upgrade, ...).
This was causing several problems among which:
- The theme, config, Makefile, and similar technical resources had to
be duplicated. This resulted in inconsistent layout, features, and
build environments from one documentation to another.
- Some pages did not fit either documentation as they were relevant
for both users and developers. Some were relevant to neither of the
two (e.g., DB management).
- Cross-doc references had to be absolute links and they broke often.
- Merging large image files in the developer documentation would bloat
the odoo/odoo repository. Some contributions had to be lightened to
avoid merging too many images (e.g., Odoo development tutorials).
- Long-time contributors to the user documentation were chilly about
going through the merging process of the developer documentation
because of the runbot, mergebot, `odoo-dev` repository, etc.
- Some contributors would look for the developer documentation in the
`odoo/documentation-user` repository.
- Community issues about the user documentation were submitted on the
`odoo/odoo` repository and vice-versa.
Merging all documentations in one repository will allow us to have one
place, one theme, one work process, and one set of tools (build
environment, ...) for all of the Odoo docs.
As this is a good opportunity to revamp the layout of the documentation,
a brand new theme replaces the old one. It features a new way to
navigate the documentation, centered on the idea of always letting the
reader know what is the context (enclosing section, child pages, page
structure ...) of the page they are reading. The previous theme would
quickly confuse readers as they navigated the documentation and followed
cross-application links.
The chance is also taken to get rid of all the technical dangling parts,
performance issues, and left-overs. Except for some page-specific JS
scripts, the Odoo theme Sphinx extension is re-written from scratch
based on the latest Sphinx release to benefit from the improvements and
ease future contributions.
task-2351938
task-2352371
task-2205684
task-2352544
Closes #945
186 lines
6.3 KiB
ReStructuredText
186 lines
6.3 KiB
ReStructuredText
|
|
.. _db_premise:
|
|
|
|
===============================
|
|
On-premises Database management
|
|
===============================
|
|
|
|
Register a database
|
|
===================
|
|
|
|
To register your database, you just need to enter your Subscription Code in the
|
|
banner in the App Switcher. Make sure you do not add extra spaces before or after
|
|
your subscription code. If the registration is successful, it will turn green and
|
|
will provide you with the Expiration Date of your freshly-registered database. You
|
|
can check this Epiration Date in the About menu (Odoo 9) or in the Settings Dashboard
|
|
(Odoo 10).
|
|
|
|
Registration Error Message
|
|
--------------------------
|
|
|
|
If you are unable to register your database, you will likely encounter this
|
|
message:
|
|
|
|
.. image:: media/error_message_sub_code.png
|
|
: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?
|
|
|
|
* Check if your subscription details get the tag "In Progress" on
|
|
your `Odoo Account
|
|
<https://accounts.odoo.com/my/subscription>`__ or with your Account Manager
|
|
|
|
* Have you already linked a database with your subscription reference?
|
|
|
|
* You can link only one database per subscription.
|
|
(Need a test or a development database? `Find a partner
|
|
<https://www.odoo.com/partners>`__)
|
|
|
|
* You can unlink the old database yourself on your `Odoo Contract
|
|
<https://accounts.odoo.com/my/subscription>`__ with the button "Unlink database"
|
|
|
|
.. image:: media/unlink_single_db.png
|
|
:align: center
|
|
|
|
|
|
A confirmation message will appear; make sure this is the correct database as
|
|
it will be deactivated shortly:
|
|
|
|
.. image:: media/unlink_confirm_enterprise_edition.png
|
|
:align: center
|
|
|
|
|
|
* Do you have the updated version of Odoo 9?
|
|
|
|
* From July 2016 onward, Odoo 9 now automatically change the uuid of a
|
|
duplicated database; a manual operation is no longer required.
|
|
|
|
* If it's not the case, you may have multiple databases sharing the same
|
|
UUID. Please check on your `Odoo Contract
|
|
<https://accounts.odoo.com/my/subscription>`__, a short message will appear
|
|
specifying which database is problematic:
|
|
|
|
.. image:: media/unlink_db_name_collision.png
|
|
: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>`.
|
|
|
|
For your information, we identify database with UUID. Therefore, each database
|
|
should have a distinct UUID to ensure that registration and invoicing proceed
|
|
effortlessly for your and for us.
|
|
|
|
* Check your network and firewall settings
|
|
|
|
* The Update notification must be able to reach Odoo's subscription
|
|
validation servers. In other words, make sure that the Odoo server is able
|
|
to open outgoing connections towards:
|
|
|
|
* services.odoo.com on port 443 (or 80)
|
|
* services.openerp.com on port 443 (or 80) for older deployments
|
|
|
|
* 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
|
|
-----------------------------------
|
|
|
|
If you have more users in your local database than provisionned in your
|
|
Odoo Enterprise subscription, you may encounter this message:
|
|
|
|
.. image:: media/add_more_users.png
|
|
: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.
|
|
|
|
or
|
|
|
|
* **Deactivate users** as explained in this `Documentation
|
|
<https://www.odoo.com
|
|
/documentation/user/12.0/db_management/documentation.html#deactivating-users>`__
|
|
and **Reject** the upsell quotation.
|
|
|
|
Once your database has the correct number of users, the expiration message
|
|
will disappear automatically after a few days, when the next verification occurs.
|
|
We understand that it can be a bit frightening to see the countdown,
|
|
so you can :ref:`force an Update Notification <force_ping>` to make the message disappear
|
|
right away.
|
|
|
|
Database expired error message
|
|
------------------------------
|
|
|
|
If your database reaches its expiration date before your renew your subscription,
|
|
you will encounter this message:
|
|
|
|
.. image:: media/database_expired.png
|
|
: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
|
|
only when the payment arrives, which can take a few days. Credit card payments are
|
|
processed immediately.
|
|
* Contact our `Support <https://www.odoo.com/help>`__
|
|
|
|
None of those solutions worked for you? Please contact our
|
|
`Support <https://www.odoo.com/help>`__
|
|
|
|
|
|
.. _force_ping:
|
|
|
|
.. _duplicate_premise:
|
|
|
|
Duplicate a database
|
|
====================
|
|
|
|
You can duplicate your database by accessing the database manager on your
|
|
server (<odoo-server>/web/database/manager). In this page, you can easily
|
|
duplicate your database (among other things).
|
|
|
|
.. image:: media/db_manager.gif
|
|
:align: center
|
|
|
|
|
|
When you duplicate a local database, it is **strongly** advised to change
|
|
the duplicated database's uuid (Unniversally Unique Identifier), since this
|
|
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.
|
|
|
|
The database uuid is currently accessible from the menu **Settings > Technical
|
|
> System Parameters**, we advise you to use a
|
|
`uuid generator <https://www.uuidgenerator.net>`__ or to use the unix command
|
|
``uuidgen`` to generate a new uuid. You can then simply replace it like any
|
|
other record by clicking on it and using the edit button.
|
|
|
|
.. image:: media/db_uuid.png
|
|
:align: center
|