Skip to Content

Redis Session Store

by

33.26

17.0 0
Live Preview
Required Apps 214
Technical Name wk_redis_session
License OPL-1
Also available in version 17.0 16.0 15.0
You bought this module and need support ? Click here!
Technical Name wk_redis_session
License OPL-1
Also available in version v 17.0 v 16.0 v 15.0

Introduction

This Odoo module replaces default file-based session storage with in-memory Redis storage. By leveraging Redis, it significantly accelerates session retrieval, ensures atomic data operations, and boosts overall system responsiveness—a powerful upgrade for high-load environments and multi-instance deployments.

Key Features

  • Store session data in Redis instead of local filesystem

  • Enable atomic session operations for consistent and reliable access

  • Dramatically faster performance via in-memory storage

  • Easy configuration within Odoo settings for seamless integration

Benefits

  • Accelerates user experience with rapid session handling

  • Enhances stability and consistency, especially under high load

  • Supports scalable deployment across multiple Odoo servers

  • Reduces latency and enhances responsiveness of web operations

Compatibility & Technical Details

  • Technical Name: wk_redis_session

  • License: OPL-1 (Odoo Proprietary License)

  • Required Modules: No functional dependencies—standalone enhancement

  • Installation Steps:

    1. Install Redis server on the infrastructure.

    2. Add the module to your Odoo add-ons path and enable it in server configuration.

    3. Enable Redis session mode in your configuration settings.

    4. Optionally configure Redis host, port, expiration time, and SSL settings for a tailored setup.

Redis Session Store

Stores the session in Redis in spite of the file system in werkzeug to increase the performance of cache.

It will help to store and manage the session more easier and faster as the sessions are manage in main memory only

Information

user-guide
User Guide
https://webkul.com/blog/odoo-redis-session-store/

About Redis

Redis is an in-memory data structure store, used as a database, cache and message broker. It supports data structures such as strings, hashes, lists, sets, sorted sets with range queries, bitmaps, hyperloglogs, geospatial indexes with radius queries and streams. Redis has built-in replication, Lua scripting, LRU eviction, transactions and different levels of on-disk persistence, and provides high availability via Redis Sentinel and automatic partitioning with Redis Cluster.

illustration

Why Redis ??

It will help to store and manage the session more easier and faster as the sessions are managed in main memory only.

Exceptionally Fast : Redis is very fast and can perform about 110000 SETs per second, about 81000 GETs per second. You can use the redis-benchmark utility for doing the same on your machine.

Supports Rich data types : Redis natively supports most of the datatypes that most developers already know like list, set, sorted set, hashes. This makes it very easy to solve a variety of problems because we know which problem can be handled better by which data type.

Operations are atomic : All the Redis operations are atomic, which ensures that if two clients concurrently access Redis server will get the updated value.

Completely configure your Redis extension

1. Firstly install the redis

Steps to install redis in debian or ubuntu based server:-

  • sudo apt-get update
  • sudo apt install redis-server
  • these commands will install redis in the server
  • and by default the connection host will be (localhost/127.0.0.1)
  • and port will be 6379 on which redis work
  • You can run the redis by redis-cli and get all keys by KEYS *

Note: At the beginning there will be empty list of Keys

2. Then install redis library for Python by command pip3 install redis

  • Then in server config file add following things:-
  • server_wide_modules=web,base,wk_redis_session
  • it will install wk_redis_session first
  • redis_session=True

It will let the odoo session store in redis if we type redis_session to be True else it will let werkzeug to store the session in .local file session

  • Configurations of redis session:-
    • redis_host = host ip of redis by default it will store localhost
    • redis_port = port number of redis by default it will store 6379
    • redis_expire = expiry of the session in seconds by default session will expires in 5 days (432000 Seconds)
    • if your redis server have ssl mode then you will have to pass the path of ssl certificate file
    • For Example:-
      redis_ssl_ca_certs = path of ssl certs(if having) bydefult it is None

Highlighted Features

Below is the highlighted features of Redis Session Store

Icon-1

Store and manage the session efficiently

Icon-2

Supports Rich Data Types

Icon-3

Works on Atomic Operations

Icon-4

Exceptionally Fast

Detailed Features List

Configure the Redis Session with your Odoo Server easily

  • Odoo Redis Session module provides the necessary structure to help you configure Redis with your Odoo server.
  • The module allows you to save the Odoo sessions on In-memory Redis Store on the same server or a third party service.

Access the data much faster than usual.

  • Since the cache is stored on Main memory instead of disk storage, accessing this data becomes much faster.
  • All the Redis operations are atomic to get the updated value every time.

Setup & Configuration

Help and Support

Get Immediate support for any of your query

You will get 90 days free support for any doubt, queries, and bug fixing (excluding data recovery) or any type of issue related to this module.

mail

Write a mail to us:

[email protected]

Any queries or want any extra features? Just drop a mail to our support.

support-icon

Get in touch with our Expert:

https://webkul.uvdesk.com/en/customer/create-ticket/

Have any technical queries, want extra features, or anything else? Our team is here to answer all your questions. Just Raise A Support Ticket.

Odoo Proprietary License v1.0
This software and associated files (the "Software") may only be used (executed,
modified, executed after modifications) if you have purchased a valid license
from the authors, typically via Odoo Apps, or if you have received a written
agreement from the authors of the Software (see the COPYRIGHT file).

You may develop Odoo modules that use the Software as a library (typically
by depending on it, importing it and using its resources), but without copying
any source code or material from the Software. You may distribute those
modules under the license of your choice, provided that this license is
compatible with the terms of the Odoo Proprietary License (For example:
LGPL, MIT, or proprietary licenses similar to this one).

It is forbidden to publish, distribute, sublicense, or sell copies of the Software
or modified copies of the Software.

The above copyright notice and this permission notice must be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.