HA Session

Version: 15.0.1.0

Author: Dakon

Compatibility: Odoo 14+

---

Overview

In a high-availability Odoo deployment (multiple workers or multiple Odoo instances behind a load balancer), maintaining user sessions consistently across nodes is critical. Odoo’s default session handling uses filesystem-based session storage, which becomes problematic when scaling horizontally — since each node maintains its own session files. dkn_auth provides a centralized, distributed session storage mechanism using Redis or PostgreSQL, ensuring:

• Seamless session sharing between Odoo instances
• Fault tolerance and scalability
• Optional session replication and TTL management

---

Features

• Centralized Session Storage: Replaces Odoo’s file-based session with Redis or PostgreSQL storage.
• Plug-and-Play Backend: Configuration-driven — choose backend (db or redis) via odoo.conf or env variable.
• Session Synchronization: Allows all Odoo nodes to share the same session pool for logged-in users.
• Session Expiration: Supports TTL-based automatic session cleanup.
• Cluster Resilience: If one node fails, users remain logged in when reconnected to another node.
• Session Locking: Prevents race conditions by locking user session during updates.

---

Installation

Instructions on how to install the module:

1. Copy the module into your Odoo addons folder.
2. Update the configuration files (odoo.conf) or use the environment variable.
3. Add 'dkn_auth' in server_wide_modules inside odoo.conf
4. Install the Python dependency detailed in the requirements.txt using the command bellow
   pip install -r requirements.txt
5. Restart the Odoo server.
6. Optionally, you can install module dkn_auth from menu Apps.

---

Configuration

There are two ways to configure this module: the first is by using the odoo.conf configuration file, and the second is to set it up using environment variables.

1. Using odoo.conf

[options]
..
dkn_auth_driver = db|redis ; choose between 'db' or 'redis'
dkn_auth_prefix = session: ; prefix for session keys
dkn_auth_expiry = 604800   ; 7 days in seconds
dkn_auth_redis_uri = redis://localhost:6379/1 ; redis connection uri if using redis driver
dkn_auth_redis_max_conn = 64 ; maximum redis connections in the pool
server_wide_modules = base,web,dkn_auth ; add dkn_auth to server wide modules
..

2. Using environment variable

----------------------------------------------------------------------
| VARIABLE                  | DESCRIPTION           |  IS MANDATORY  |
|---------------------------|-----------------------|----------------|
| DKN_AUTH_DRIVER           | driver (db|redis)     |      TRUE      |
| DKN_AUTH_PREFIX           | session prefix        |      FALSE     |
| DKN_AUTH_EXPIRY           | session expiry        |      FALSE     |
| DKN_AUTH_REDIS_URI        | database URI          |      FALSE     |
| DKN_AUTH_REDIS_MAX_CONN   | redis max connection  |      FALSE     |
----------------------------------------------------------------------

---

Development Mode

1. Setup Development Environment

There are several ways to run this module locally for development, as it requires integrating multiple dependencies. We propose using the docker-compose tools to streamline the installation of the entire stack. This is just an example of docker-compose.yaml, you can improve if needed.

services:

  db:
    image: postgres
    container_name: db
    ports:
      - "5432:5432"
    environment:
      - POSTGRES_DB=postgres
      - POSTGRES_PASSWORD=odoo
      - POSTGRES_USER=odoo
      - PGDATA=/var/lib/postgresql/data/pgdata
    volumes:
      - db-data:/var/lib/postgresql/data/pgdata

  redis:
    image: redis
    container_name: redis
    ports:
      - "6379:6379"

  odoo:
    image: dakonio/odoo:15.0
    container_name: odoo
    ports:
      - "80:8080"       # Odoo UI (http://localhost)
    environment:
      - OPTIONS__DB_HOST=db
      - OPTIONS__DB_PORT=5432
      - OPTIONS__DB_USER=odoo
      - OPTIONS__DB_NAME=odoo
      - OPTIONS__DB_PASSWORD=odoo
      - OPTIONS__LOG_HANDLER=:INFO
      - OPTIONS__LOG_LEVEL=info
      - OPTIONS__SERVER_WIDE_MODULES=base,web,dkn_auth
      - OPTIONS__DKN_AUTH_DRIVER=redis
      - OPTIONS__DKN_AUTH_PREFIX="session:"
      - OPTIONS__DKN_AUTH_EXPIRY=604800
      - OPTIONS__DKN_AUTH_REDIS_URI=redis://redis:6379/1
      - OPTIONS__DKN_AUTH_REDIS_MAX_CONN=64
    volumes:
      - ./addons/dkn_auth:/mnt/addons/dkn_auth:ro
    tty: true
    depends_on:
      - db
      - redis
    platform: linux/amd64

volumes:
  db-data:
    driver: local

---

Support

For support, please contact: