summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorChristophe Simonis <chs@odoo.com>2018-07-17 17:48:34 +0200
committerChristophe Simonis <chs@odoo.com>2018-07-17 17:48:34 +0200
commit5b9a51bb1d1f2d8bbb59171f3cea5e4bfd195f5e (patch)
tree8310cc77df4d0e5d5121c3728c462d3b01df7d9f /doc
parent78c8cda97ec71c5f14731b5e9a7fb544fcdb7b49 (diff)
parent44b77d3702b3c2957c1381367ebff01e024d13b9 (diff)
[MERGE] forward port branch 11.0 up to 44b77d3702b
Diffstat (limited to 'doc')
-rw-r--r--doc/cla/individual/rwfnf.md9
-rw-r--r--doc/reference/cmdline.rst7
-rw-r--r--doc/reference/guidelines.rst1
-rw-r--r--doc/setup.rst1
-rw-r--r--doc/setup/install.rst4
-rw-r--r--doc/setup/update.rst151
6 files changed, 163 insertions, 10 deletions
diff --git a/doc/cla/individual/rwfnf.md b/doc/cla/individual/rwfnf.md
new file mode 100644
index 00000000000..0e92424bf9f
--- /dev/null
+++ b/doc/cla/individual/rwfnf.md
@@ -0,0 +1,9 @@
+United Kingdom, 2018-07-15
+
+I hereby agree to the terms of the Odoo Individual Contributor License Agreement v1.0.
+
+I declare that I am authorized and able to make this agreement and sign this declaration.
+
+Signed,
+
+Orya Blumeneld orya@rawrfoods.com https://github.com/rawrfnf
diff --git a/doc/reference/cmdline.rst b/doc/reference/cmdline.rst
index 12cd5f7a9d8..058eac51ddd 100644
--- a/doc/reference/cmdline.rst
+++ b/doc/reference/cmdline.rst
@@ -384,13 +384,6 @@ customize the amount of logging output
In case of conflict between :option:`--log-level` and
:option:`--log-handler`, the latter is used
-translations
-------------
-
-.. option:: --i18n-import
-
-.. option:: --i18n-export
-
emails
------
diff --git a/doc/reference/guidelines.rst b/doc/reference/guidelines.rst
index ae0ab00555d..ec7e3c98cbe 100644
--- a/doc/reference/guidelines.rst
+++ b/doc/reference/guidelines.rst
@@ -222,7 +222,6 @@ Use the following pattern :
*concerned_group* is the short name of the concerned group ('user'
for the 'model_name_group_user', 'public' for public user, 'company'
for multi-company rules, ...).
-* For a group : :samp:`{<model_name>}_group_{<group_name>}` where *group_name* is the name of the group, generally 'user', 'manager', ...
.. code-block:: xml
diff --git a/doc/setup.rst b/doc/setup.rst
index f200108964e..99b4bd3ad51 100644
--- a/doc/setup.rst
+++ b/doc/setup.rst
@@ -9,5 +9,6 @@ Setting Up
setup/install
setup/deploy
+ setup/update
setup/cdn
setup/enterprise
diff --git a/doc/setup/install.rst b/doc/setup/install.rst
index 90e6e4ae089..c1f65abafd1 100644
--- a/doc/setup/install.rst
+++ b/doc/setup/install.rst
@@ -6,7 +6,7 @@
Installing Odoo
===============
-There are mutliple ways to install Odoo, or not install it at all, depending
+There are multiple ways to install Odoo, or not install it at all, depending
on the intended use case.
This documents attempts to describe most of the installation options.
@@ -588,7 +588,7 @@ Docker
======
The full documentation on how to use Odoo with Docker can be found on the
-offcial Odoo `docker image <https://registry.hub.docker.com/_/odoo/>`_ page.
+official Odoo `docker image <https://registry.hub.docker.com/_/odoo/>`_ page.
.. _demo: https://demo.odoo.com
.. _docker: https://www.docker.com
diff --git a/doc/setup/update.rst b/doc/setup/update.rst
new file mode 100644
index 00000000000..7c7b5c06227
--- /dev/null
+++ b/doc/setup/update.rst
@@ -0,0 +1,151 @@
+:banner: banners/installing_odoo.jpg
+
+.. _setup/update:
+
+=============================
+Updating an Odoo installation
+=============================
+
+Introduction
+============
+
+In order to benefit from the latest improvements, security fixes, bug corrections and
+performance boosts, you may need to update your Odoo installation from time to time.
+
+This guide only applies when are using Odoo on your own hosting infrastructure.
+If you are using one of the Odoo Cloud solutions, updates are automatically performed for you.
+
+The terminology surrounding software updates is often confusing, so here are some preliminary
+definitions:
+
+Updating (an Odoo installation)
+ Refers to the process of obtaining the latest revision of the source code for
+ your current Odoo Edition. For example, updating your Odoo Enterprise 11.0 to the
+ latest revision.
+ This does not directly cause any change to the contents of your Odoo database, and
+ can be undone by reinstalling the previous revision of the source code.
+
+Upgrading (an Odoo database)
+ Refers to a complex data processing operation where the structure and contents of your
+ database is permanently altered to make it compatible with a new release of Odoo.
+ This operation is irreversible and typically accomplished via Odoo's
+ `database upgrade service <https://upgrade.odoo.com>`_, when you decide to
+ switch to a newer release of Odoo.
+ Historically, this process has also been known as a "migration" because it involves moving data
+ around inside the database, even though the database may end up at the same physical location
+ after the upgrade.
+
+This page describes the typical steps needed to *update* an Odoo installation to the latest
+version. If you'd like more information about upgrading a database, please visit the
+`Odoo Upgrade page <https://upgrade.odoo.com>`_ instead.
+
+
+In a nutshell
+=============
+
+Updating Odoo is accomplished by simply reinstalling the latest version of your Odoo
+Edition on top of your current installation. This will preserve your data without any alteration,
+as long as you do not uninstall PostgreSQL (the database engine that comes with Odoo).
+
+The main reference for updating is logically our :ref:`installation guide <setup/install>`,
+which explains the common installation methods.
+
+Updating is also most appropriately accomplished by the person who deployed Odoo initially,
+because the procedure is very similar.
+
+.. note:: We always recommend to download a complete new up-to-date Odoo version, rather than
+ manually applying patches, such as the security patches that come with Security
+ Advisories.
+ The patches are mainly provided for installations that are heavily customized, or for
+ technical personnel who prefer to apply minimal changes temporarily while testing a
+ complete update.
+
+
+Step 1: Download an updated Odoo version
+========================================
+
+The central download page is https://www.odoo.com/page/download. If you see a "Buy" link for the
+Odoo Enterprise download, make sure you are logged into Odoo.com with the same login that is
+linked to your Odoo Enterprise subscription.
+
+Alternatively, you can use the unique download link that was included with your Odoo Enterprise
+purchase confirmation email.
+
+.. note:: Downloading an updated version is not necessary if you installed via Github (see below)
+
+
+Step 2: Make a backup of your database
+======================================
+
+The update procedure is quite safe and should not alter you data. However it's always best to take
+a full database backup before performing any change on your installation, and to store it somewhere
+safe, on a different computer.
+
+If you have not disabled the database manager screen (see :ref:`here <security>` why you should), you
+can use it (link at bottom of your database selection screen) to download a backup of your
+database(s). If you disabled it, use the same procedure than for your usual backups.
+
+
+Step 3: Install the updated version
+===================================
+
+Choose the method that matches your current installation:
+
+
+Packaged Installers
+-------------------
+
+If you installed Odoo with an installation package downloaded on our website (the recommended method),
+updating is very simple.
+All you have to do is download the installation package corresponding to your system (see step #1)
+and install it on your server. They are updated daily and include the latest security fixes.
+Usually, you can simply double-click the package to install it on top of the current installation.
+After installing the package, be sure to restart the Odoo service or reboot your server,
+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)
+After downloading the package, extract it to a temporary location on your server.
+
+You will get a folder labelled with the version of the source code, for example "odoo-11.0+e.20180719",
+that contains a folder "odoo.egg-info" and the actual source code folder named "odoo" (for Odoo 10
+and later) or "openerp" for older versions.
+You can ignore the odoo.egg-info folder. Locate the folder where your current installation is deployed,
+and replace it with the newer "odoo" or "openerp" folder that was in the archive you just extracted.
+
+Be sure to match the folder layout, for example the new "addons" folder included in the source code
+should end up exactly at the same path it was before. Next, watch out for any specific configuration
+files that you may have manually copied or modified in the old folder, and copy them over to the
+new folder.
+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
+repository), and run the following commands::
+
+ git fetch
+ git rebase --autostash
+
+The last command may encounter source code conflicts if you had edited the Odoo source code locally.
+The error message will give you the list of files with conflicts, and you will need to resolve
+the conflicts manually, by editing them and deciding which part of the code to keep.
+
+Alternatively, if you prefer to simply discard the conflicting changes and restore the official
+version, you can use the following command::
+
+ git reset --hard
+
+Finally, restart the Odoo service or reboot the machine, and you should be done.
+
+
+Docker
+------
+
+Please refer to our `Docker image documentation <https://hub.docker.com/_/odoo/>`_ for
+specific update instructions. \ No newline at end of file