summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/cla/corporate/vauxoo.md1
-rw-r--r--doc/cla/individual/kaberer.md11
-rw-r--r--doc/cla/individual/moutio.md9
-rw-r--r--doc/cla/individual/phucngta.md11
-rw-r--r--doc/reference/module.rst45
-rw-r--r--doc/setup/deploy.rst36
-rw-r--r--doc/webservices/localization.rst9
7 files changed, 98 insertions, 24 deletions
diff --git a/doc/cla/corporate/vauxoo.md b/doc/cla/corporate/vauxoo.md
index f250546a6ef..0d8c8b623e9 100644
--- a/doc/cla/corporate/vauxoo.md
+++ b/doc/cla/corporate/vauxoo.md
@@ -42,3 +42,4 @@ Edgar Rivero edgar@vauxoo.com https://github.com/egrivero
Alexander Olivares alexander@vauxoo.com https://github.com/alxolivares
Jose Manuel Robles josemanuel@vauxoo.com https://github.com/keylor2906
Erick Birbe erick@vauxoo.com https://github.com/ebirbe
+Tomas Alvarez tomas@vauxoo.com https://github.com/tomeyro
diff --git a/doc/cla/individual/kaberer.md b/doc/cla/individual/kaberer.md
new file mode 100644
index 00000000000..e17852fe338
--- /dev/null
+++ b/doc/cla/individual/kaberer.md
@@ -0,0 +1,11 @@
+Switzerland, 2018-01-30
+
+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,
+
+Kumar Aberer office@aberer-solutions.ch https://github.com/kaberer
diff --git a/doc/cla/individual/moutio.md b/doc/cla/individual/moutio.md
new file mode 100644
index 00000000000..4a1b5b4b955
--- /dev/null
+++ b/doc/cla/individual/moutio.md
@@ -0,0 +1,9 @@
+Spain, 2018-01-29
+
+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,
+
+Nacho Muñoz nacmuro@gmail.com https://github.com/moutio
diff --git a/doc/cla/individual/phucngta.md b/doc/cla/individual/phucngta.md
new file mode 100644
index 00000000000..c53fe2b7136
--- /dev/null
+++ b/doc/cla/individual/phucngta.md
@@ -0,0 +1,11 @@
+Vietnam, 2018.01.17
+
+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,
+
+Nguyen Phuc <phucngta@gmail.com> https://github.com/phucngta \ No newline at end of file
diff --git a/doc/reference/module.rst b/doc/reference/module.rst
index aecb8de8a8f..9ec0ef39c93 100644
--- a/doc/reference/module.rst
+++ b/doc/reference/module.rst
@@ -1,5 +1,3 @@
-:banner: banners/module.jpg
-
=======
Modules
=======
@@ -84,6 +82,49 @@ Available manifest fields are:
to ``auto_install``. When both ``sale`` and ``crm`` are installed, it
automatically adds CRM campaigns tracking to sale orders without either
``sale`` or ``crm`` being aware of one another
+``external_dependencies`` (``dict(key=list(str))``)
+ A dictionary containing python and/or binary dependencies.
+
+ For python dependencies, the ``python`` key must be defined for this
+ dictionary and a list of python modules to be imported should be assigned
+ to it.
+
+ For binary dependencies, the ``bin`` key must be defined for this
+ dictionary and a list of binary executable names should be assigned to it.
+
+ The module won't be installed if either the python module is not installed
+ in the host machine or the binary executable is not found within the
+ host machine's PATH environment variable.
+``application`` (``bool``, default: ``False``)
+ Whether the module should be considered as a fully-fledged application
+ (``True``) or is just a technical module (``False``) that provides some
+ extra functionality to an existing application module.
+``css`` (``list(str)``)
+ Specify css files with custom rules to be imported, these files should be
+ located in ``static/src/css`` inside the module.
+``images`` (``list(str)``)
+ Specify image files to be used by the module.
+``installable`` (``bool`` default: ``False``)
+ Whether a user should be able to install the module from the Web UI or not.
+``maintainer`` (``str``)
+ Person or entity in charge of the maintenance of this module, by default
+ it is assumed that the author is the maintainer.
+``{pre_init, post_init, uninstall}_hook`` (``str``)
+ Hooks for module installation/uninstallation, their value should be a
+ string representing the name of a function defined inside the module's
+ ``__init__.py``.
+
+ ``pre_init_hook`` takes a cursor as its only argument, this function is
+ executed prior to the module's installation.
+
+ ``post_init_hook`` takes a cursor and a registry as its arguments, this
+ function is executed right after the module's installation.
+
+ ``uninstall_hook`` takes a cursor and a registry as its arguments, this
+ function is executed after the module's uninstallation.
+
+ These hooks should only be used when setup/cleanup required for this module
+ is either extremely difficult or impossible through the api.
.. _semantic versioning: http://semver.org
.. _existing categories:
diff --git a/doc/setup/deploy.rst b/doc/setup/deploy.rst
index 0d7303a795a..b0a5cf3224e 100644
--- a/doc/setup/deploy.rst
+++ b/doc/setup/deploy.rst
@@ -44,7 +44,7 @@ correctly.
Configuration samples
---------------------
-* show only databases with names beginning with 'mycompany'
+* Show only databases with names beginning with 'mycompany'
in ``/etc/odoo.conf`` set:
@@ -87,18 +87,18 @@ machine, and is the default when no host is provided, but if you want Odoo and
PostgreSQL to execute on different machines [#different-machines]_ it will
need to `listen to network interfaces`_ [#remote-socket]_, either:
-* only accept loopback connections and `use an SSH tunnel`_ between the
+* Only accept loopback connections and `use an SSH tunnel`_ between the
machine on which Odoo runs and the one on which PostgreSQL runs, then
configure Odoo to connect to its end of the tunnel
-* accept connections to the machine on which Odoo is installed, possibly
+* Accept connections to the machine on which Odoo is installed, possibly
over ssl (see `PostgreSQL connection settings`_ for details), then configure
Odoo to connect over the network
Configuration sample
--------------------
-* allow tcp connection on localhost
-* allow tcp connection from 192.168.1.x network
+* Allow tcp connection on localhost
+* Allow tcp connection from 192.168.1.x network
in ``/etc/postgresql/9.5/main/pg_hba.conf`` set:
@@ -134,11 +134,11 @@ create a new user (``odoo``) and set it as the database user.
simply checked before performing database alterations. It should be set to
a randomly generated value to ensure third parties can not use this
interface.
-* all database operations use the :ref:`database options
+* All database operations use the :ref:`database options
<reference/cmdline/server/database>`, including the database management
screen. For the database management screen to work requires that the PostgreSQL user
have ``createdb`` right.
-* users can always drop databases they own. For the database management screen
+* Users can always drop databases they own. For the database management screen
to be completely non-functional, the PostgreSQL user needs to be created with
``no-createdb`` and the database must be owned by a different PostgreSQL user.
@@ -248,10 +248,10 @@ authentication information in cleartext. This means a secure deployment of
Odoo must use HTTPS\ [#switching]_. SSL termination can be implemented via
just about any SSL termination proxy, but requires the following setup:
-* enable Odoo's :option:`proxy mode <odoo-bin --proxy-mode>`. This should only be enabled when Odoo is behind a reverse proxy
-* set up the SSL termination proxy (`Nginx termination example`_)
-* set up the proxying itself (`Nginx proxying example`_)
-* your SSL termination proxy should also automatically redirect non-secure
+* Enable Odoo's :option:`proxy mode <odoo-bin --proxy-mode>`. This should only be enabled when Odoo is behind a reverse proxy
+* Set up the SSL termination proxy (`Nginx termination example`_)
+* Set up the proxying itself (`Nginx proxying example`_)
+* Your SSL termination proxy should also automatically redirect non-secure
connections to the secure port
.. warning::
@@ -263,8 +263,8 @@ just about any SSL termination proxy, but requires the following setup:
Configuration sample
--------------------
-* redirect http requests to https
-* proxy requests to odoo
+* Redirect http requests to https
+* Proxy requests to odoo
in ``/etc/odoo.conf`` set:
@@ -349,10 +349,10 @@ Cron Workers
To run cron jobs for an Odoo deployment as a WSGI application requires
-* a classical Odoo (run via ``odoo-bin``)
-* connected to the database in which cron jobs have to be run (via
+* A classical Odoo (run via ``odoo-bin``)
+* Connected to the database in which cron jobs have to be run (via
:option:`odoo-bin -d`)
-* which should not be exposed to the network. To ensure cron runners are not
+* Which should not be exposed to the network. To ensure cron runners are not
network-accessible, it is possible to disable the built-in HTTP server
entirely with :option:`odoo-bin --no-http` or setting ``http_enable = False``
in the configuration file
@@ -372,11 +372,11 @@ notifications.
The solutions to support livechat/motifications in a WSGI application are:
-* deploy a threaded version of Odoo (instread of a process-based preforking
+* Deploy a threaded version of Odoo (instread of a process-based preforking
one) and redirect only requests to URLs starting with ``/longpolling/`` to
that Odoo, this is the simplest and the longpolling URL can double up as
the cron instance.
-* deploy an evented Odoo via ``odoo-gevent`` and proxy requests starting
+* Deploy an evented Odoo via ``odoo-gevent`` and proxy requests starting
with ``/longpolling/`` to
:option:`the longpolling port <odoo-bin --longpolling-port>`.
diff --git a/doc/webservices/localization.rst b/doc/webservices/localization.rst
index 17559b2a01a..39e1c98181c 100644
--- a/doc/webservices/localization.rst
+++ b/doc/webservices/localization.rst
@@ -1,12 +1,13 @@
:banner: banners/localization.jpg
-==========================
-Making my Own Localization
-==========================
+=======================
+Creating a Localization
+=======================
.. warning::
- This tutorial requires knowledges about how to build a module in Odoo.
+ This tutorial requires knowledges about how to build a module in Odoo (see
+ :doc:`../../howtos/backend`).
Building a localization module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~