Search 1.9 billion lines of Odoo code on GitHub
muk_session_store
<h1 class="title">MuK Session Store</h1>
<p>In a distributed system the filestore based session store of Odoo has the problem that
unwanted session timeouts occur regularly. This module offers two additional options for
the Session Store. Sessions can be stored either in a Redis database or directly in
Postgres. Both options have the advantage that the session information can also be queried
in a distributed system.</p>
<a name="requirements"></a>
<h2>Requirements</h2>
<p>The requirements are only required if Redis is used as the session store.</p>
<a name="redis"></a>
<h3>Redis</h3>
<p>A interface to the Redis key-value store for Python. To install Redis please follow the
<a class="reference external" href="https://github.com/andymccurdy/redis-py">instructions</a> or install the library via pip.</p>
<p><code>pip install redis</code></p>
<a name="installation"></a>
<h2>Installation</h2>
<p>To install this module, you need to:</p>
<p>Download the module and add it to your Odoo addons folder. Afterward, log on to
your Odoo server and go to the Apps menu. Trigger the debug mode and update the
list by clicking on the "Update Apps List" link. Now install the module by
clicking on the install button.</p>
<p>Another way to install this module is via the package management for Python
(<a class="reference external" href="https://pypi.org/project/pip/">PyPI</a>).</p>
<p>To install our modules using the package manager make sure
<a class="reference external" href="https://pypi.org/project/odoo-autodiscover/">odoo-autodiscover</a> is installed
correctly. Note that for Odoo version 11.0 and later this is not necessary anymore.
Then open a console and install the module by entering the following command:</p>
<p><code>pip install --extra-index-url https://nexus.mukit.at/repository/odoo/simple <module></code></p>
<p>The module name consists of the Odoo version and the module name, where
underscores are replaced by a dash.</p>
<p><strong>Module:</strong></p>
<p><code>odoo<version>-addon-<module_name></code></p>
<p><strong>Example:</strong></p>
<p><code>sudo -H pip3 install --extra-index-url https://nexus.mukit.at/repository/odoo/simple odoo13-addon-muk-utils</code></p>
<p>Once the installation has been successfully completed, the app is already in the
correct folder. Log on to your Odoo server and go to the Apps menu. Trigger the
debug mode and update the list by clicking on the "Update Apps List" link. Now
install the module by clicking on the install button.</p>
<p>The biggest advantage of this variant is that you can now also update the app
using the "pip" command. To do this, enter the following command in your console:</p>
<p><code>pip install --upgrade --extra-index-url https://nexus.mukit.at/repository/odoo/simple <module></code></p>
<p>When the process is finished, restart your server and update the application in
Odoo. The steps are the same as for the installation only the button has changed
from "Install" to "Upgrade".</p>
<p>You can also view available Apps directly in our <a class="reference external" href="https://nexus.mukit.at/#browse/browse:odoo">repository</a>
and find a more detailed installation guide on our <a class="reference external" href="https://mukit.at/page/open-source">website</a>.</p>
<p>For modules licensed under a proprietary license, you will receive the access data after you purchased
the module. If the purchase were made at the Odoo store please contact our <a class="reference external" href="mailto:support@mukit.at">support</a>
with a confirmation of the purchase to receive the corresponding access data.</p>
<a name="upgrade"></a>
<h2>Upgrade</h2>
<p>To upgrade this module, you need to:</p>
<p>Download the module and add it to your Odoo addons folder. Restart the server
and log on to your Odoo server. Select the Apps menu and upgrade the module by
clicking on the upgrade button.</p>
<p>If you installed the module using the "pip" command, you can also update the
module in the same way. Just type the following command into the console:</p>
<p><code>pip install --upgrade --extra-index-url https://nexus.mukit.at/repository/odoo/simple <module></code></p>
<p>When the process is finished, restart your server and update the application in
Odoo, just like you would normally.</p>
<a name="configuration"></a>
<h2>Configuration</h2>
<p>Since this module need to be activated even if no database is selected it should
be loaded right at the server start. This can be done by editing the configuration
file or passing a load parameter to the start script.</p>
<p>Parameter: <code>--load=web,muk_session_store</code></p>
<p>The following fields can be modified in the config file:</p>
<p><strong>Store:</strong></p>
<ul class="simple">
<li>session_store_database</li>
<li>session_store_redis</li>
</ul>
<p><strong>Postgres:</strong></p>
<ul class="simple">
<li>session_store_dbname</li>
<li>session_store_dbtable</li>
</ul>
<p><strong>Redis:</strong></p>
<ul class="simple">
<li>session_store_prefix</li>
<li>session_store_host</li>
<li>session_store_port</li>
<li>session_store_dbindex</li>
<li>session_store_pass</li>
<li>session_store_ssl</li>
<li>session_store_ssl_cert_reqs</li>
</ul>
<a name="usage"></a>
<h2>Usage</h2>
<p>After setting the parameters, the session store is used automatically.</p>
<p>In order to use ssl, which is a requirement of some databases, session_store_ssl
should be set to True and session_store_ssl_cert_reqs should be set to 'required'
except in the case where the server certificate does not match the host name.</p>
<p>e.g.
# Server has a proper certificate
session_store_ssl=True
session_store_ssl_cert_reqs=required</p>
<p># Server does not have a proper certificate (AWS possibly)
session_store_ssl=True
session_store_ssl_cert_reqs=None</p>
<p>For more information please see the redis python module documentation</p>
<a name="credit"></a>
<h2>Credit</h2>
<a name="contributors"></a>
<h3>Contributors</h3>
<ul class="simple">
<li>Mathias Markl <<a class="reference external" href="mailto:mathias.markl@mukit.at">mathias.markl@mukit.at</a>></li>
</ul>
<a name="images"></a>
<h3>Images</h3>
<p>Some pictures are based on or inspired by the icon set of Font Awesome:</p>
<ul class="simple">
<li><a class="reference external" href="https://fontawesome.com">Font Awesome</a></li>
</ul>
<a name="projects"></a>
<h3>Projects</h3>
<p>Parts of the module are inspired by:</p>
<ul class="simple">
<li><a class="reference external" href="https://github.com/it-projects-llc/misc-addons">PSQL Session Store</a></li>
</ul>
<a name="author-maintainer"></a>
<h3>Author & Maintainer</h3>
<p>This module is maintained by the <a class="reference external" href="https://www.mukit.at/">MuK IT GmbH</a>.</p>
<p>MuK IT is an Austrian company specialized in customizing and extending Odoo.
We develop custom solutions for your individual needs to help you focus on
your strength and expertise to grow your business.</p>
<p>If you want to get in touch please contact us via <a class="reference external" href="mailto:sale@mukit.at">mail</a>
or visit our <a class="reference external" href="https://mukit.at">website</a>.</p>