|
| 1 | +:banner: banners/db_management.jpg |
| 2 | + |
| 3 | +.. _db_management/documentation: |
| 4 | + |
| 5 | +============================ |
| 6 | +How to manage your databases |
| 7 | +============================ |
| 8 | + |
| 9 | +As the administrator of your database, you are responsible for its usage. |
| 10 | +This includes the Apps you install as well as the number of users currently |
| 11 | +in use. |
| 12 | + |
| 13 | +Odoo is many things (ERP, CMS, CRM application, e-Commerce backend, etc.) |
| 14 | +but it is *not* a smartphone. You should apply caution when adding/removing |
| 15 | +features (especially Apps) on your database since this may impact your |
| 16 | +subscription amount significantly (or switch you from a free account |
| 17 | +to a paying one on our online platform). |
| 18 | + |
| 19 | +This page contains some information as to how you can manage your Odoo |
| 20 | +instances. The most important section concern the |
| 21 | +:ref:`duplication <duplicate>` of your database: whenever you wish to |
| 22 | +install or remove an App, you should **always** test it first on a duplicate |
| 23 | +of your production database. That way, if something goes wrong, your |
| 24 | +day-to-day business is not impacted. |
| 25 | + |
| 26 | +.. note:: If you have questions about the content of this page or if you |
| 27 | + encounter an issue while carrying out these procedures, please contact |
| 28 | + us through our `support form <https://www.odoo.com/help>`__. |
| 29 | + |
| 30 | +.. note:: Database duplication, renaming, custom DNS, etc. is not available |
| 31 | + to free customers. |
| 32 | + |
| 33 | + |
| 34 | +.. _duplicate: |
| 35 | + |
| 36 | +Duplicating a database (online) |
| 37 | +=============================== |
| 38 | + |
| 39 | +Access the `database management page <https://www.odoo.com/my/databases>`__ |
| 40 | +(you will have to sign in). Next, make sure you are connected as the |
| 41 | +administrator of the database you want to duplicate. After that, click |
| 42 | +on the **Manage Your Databases** button. |
| 43 | + |
| 44 | +.. image:: media/databases.png |
| 45 | + :align: center |
| 46 | + |
| 47 | +In the line of the database you want to duplicate, you will have a few |
| 48 | +buttons. To duplicate your database, just click **Duplicate**. You will |
| 49 | +have to give a name to your duplicate, then click **Duplicate Database**. |
| 50 | + |
| 51 | +.. image:: media/db_buttons.png |
| 52 | + :align: center |
| 53 | + |
| 54 | +.. image:: media/db_duplicate.png |
| 55 | + :align: center |
| 56 | + |
| 57 | +.. danger:: A duplicated database has the same behaviour as a real one: |
| 58 | + |
| 59 | + * Emails are sent |
| 60 | + |
| 61 | + * Payments are processed (in the e-commerce, for example) |
| 62 | + |
| 63 | + * Delivery orders (shipping providers) are sent |
| 64 | + |
| 65 | + * Etc. |
| 66 | + |
| 67 | + It is **strongly** advised to test behaviour using sample |
| 68 | + customers/products (with a `disposable e-mail <http://www.mailinator.com>`__ |
| 69 | + address, for example) |
| 70 | + |
| 71 | +After a few seconds, you will be logged in your duplicated database. |
| 72 | +Notice that the url uses the name you chose for your duplicated |
| 73 | +database. |
| 74 | + |
| 75 | +.. note :: Duplicate databases expire automatically after 15 days. |
| 76 | +
|
| 77 | + .. image:: media/dup_expires.png |
| 78 | + :align: center |
| 79 | +
|
| 80 | +Duplicating a database (on-premise) |
| 81 | +=================================== |
| 82 | + |
| 83 | +You can duplicate your database by accessing the database manager on your |
| 84 | +server (<odoo-server>/web/database/manager). In this page, you can easily |
| 85 | +duplicate your database (among other things). |
| 86 | + |
| 87 | +.. image:: media/db_manager.gif |
| 88 | + :align: center |
| 89 | + |
| 90 | + |
| 91 | +When you duplicate a local database, it is **strongly** advised to change |
| 92 | +the duplicated database's uuid (Unniversally Unique Identifier), since this |
| 93 | +uuid is how your database identifies itself with our servers. Having two |
| 94 | +databases with the same uuid could result in invoicing problems or registration |
| 95 | +problems down the line. |
| 96 | + |
| 97 | +The database uuid is currently accessible from the menu **Settings > Technical |
| 98 | +> System Parameters**, we advise you to use a |
| 99 | +`uuid generator <https://www.uuidgenerator.net>`__ or to use the unix command |
| 100 | +``uuidgen`` to generate a new uuid. You can then simply replace it like any |
| 101 | +other record by clicking on it and using the edit button. |
| 102 | + |
| 103 | +.. image:: media/db_uuid.png |
| 104 | + :align: center |
| 105 | + |
| 106 | +Deactivating Users |
| 107 | +================== |
| 108 | + |
| 109 | +.. note:: Make sure you have sufficient **administrative rights** if |
| 110 | + you want to change the status of any of your users. |
| 111 | + |
| 112 | +In your Odoo instance, click on **Settings**. You will have a section |
| 113 | +showing you the active users on your database. Click on **Manage |
| 114 | +access rights.** |
| 115 | + |
| 116 | ++----------------+----------------+ |
| 117 | +| |settings| | |browse_users| | |
| 118 | ++----------------+----------------+ |
| 119 | + |
| 120 | +You'll then see the list of your users. |
| 121 | + |
| 122 | +.. image:: media/list_users.png |
| 123 | + :align: center |
| 124 | + |
| 125 | +.. note:: The pre-selected filter *Internal Users* shows your paying |
| 126 | + users (different from the *Portal Users* which are free). If you |
| 127 | + remove this filter, you'll get all your users (the ones you pay for |
| 128 | + and the portal ones) |
| 129 | + |
| 130 | +In your list of users, click on the user you want to deactivate. As soon |
| 131 | +as you are on the userform, go with your mouse cursor on the status |
| 132 | +**Active** (top right). Click on Active and you will notice that the |
| 133 | +status will change to **Inactive** immediately. |
| 134 | + |
| 135 | +.. image:: media/deactivate_user.gif |
| 136 | + :align: center |
| 137 | + |
| 138 | + |
| 139 | +The user is now deactivated. |
| 140 | + |
| 141 | +.. danger:: **Never** deactivate the main user (*admin*) |
| 142 | + |
| 143 | +Uninstalling Apps |
| 144 | +================= |
| 145 | + |
| 146 | +.. warning:: Make sure you first test what you are about to do on a |
| 147 | + :ref:`duplicate <duplicate>` of your database before making any |
| 148 | + changes (*especially* installing/uninstalling apps). |
| 149 | + |
| 150 | +In your Odoo instance click on **Settings**; in this app, you will be |
| 151 | +able to see how many applications you have installed. Click on **Browse |
| 152 | +Apps** to access the list of your installed applications. |
| 153 | + |
| 154 | ++----------------+----------------+ |
| 155 | +| |settings| | |browse_apps| | |
| 156 | ++----------------+----------------+ |
| 157 | + |
| 158 | +In your applications' dashboard, you will see all the icons of your |
| 159 | +applications. Click on the application you want to uninstall. Then, on |
| 160 | +the form of the application, click on **Uninstall**. |
| 161 | + |
| 162 | +.. image:: media/uninstall.png |
| 163 | + :align: center |
| 164 | + |
| 165 | +.. danger:: Some applications have dependencies, like Invoicing, eCommerce, |
| 166 | + etc. Therefore, the system will give you a warning message to advise |
| 167 | + you of what is about to be removed. If you uninstall your application, |
| 168 | + all its dependencies will be uninstalled as well (and the data in them |
| 169 | + will permanently disappear). If you are sure you still want to uninstall |
| 170 | + it, then click **Confirm**. |
| 171 | + |
| 172 | +Last, after having checked the warning message (if any), click **Confirm**. |
| 173 | + |
| 174 | +.. image:: media/uninstall_deps.png |
| 175 | + :align: center |
| 176 | + |
| 177 | +You have finished uninstalling your application. |
| 178 | + |
| 179 | +Good to know |
| 180 | +============ |
| 181 | + |
| 182 | +* **Uninstalling apps, managing users, etc. is up to you**: no one else can |
| 183 | + know if your business flow is broken better than you. If we were to uninstall |
| 184 | + applications for you, we would never be able to tell if relevant data had |
| 185 | + been removed or if one of your business flow was broken because we *do not |
| 186 | + know how you work* and therefore cannot validate these kinds of operations. |
| 187 | + |
| 188 | +* **Odoo Apps have dependencies**: this means that you may need to install |
| 189 | + modules that you do not actively use to access some features of Odoo |
| 190 | + you might need. For example, the Website Builder app is needed to be |
| 191 | + able to show your customer their Quotes in a web page. Even though you |
| 192 | + might not need or use the Website itself, it is needed for the Online |
| 193 | + Quotes feature to work properly. |
| 194 | + |
| 195 | +* **Always test app installation/removal on a duplicate** (or on a |
| 196 | + free trial database): that way you can know what other apps may |
| 197 | + be required, etc. This will avoid surprises when uninstalling |
| 198 | + or when receiving your invoices. |
| 199 | + |
| 200 | +.. |settings| image:: media/settings_app.png |
| 201 | +.. |browse_apps| image:: media/browse_apps.png |
| 202 | +.. |browse_users| image:: media/browse_users.png |
0 commit comments