Odoo 17 ERP

This repository contains a Docker-based development environment for Odoo 17 ERP from Package Source.

Table of Contents

• Overview
• Features
• Prerequisites
• Directory Structure
• Installation
  • Clone the Repository
  • Initialize Git Submodules
  • Configure Environment
  • Build and Start
• Configuration
  • Environment Variables
  • Resource Allocation
• Usage
  • Starting the Environment
  • Stopping the Environment
  • Viewing Logs
  • Accessing the Database
• Development
  • Adding Custom Modules
  • Installing Modules
  • Database Management
• Troubleshooting
  • Common Issues

Overview

This workspace provides a complete development environment for Odoo 17 ERP applications using Docker and Docker Compose. The setup includes:

• Odoo application server
• PostgreSQL 16 database
• Resource-optimized configuration
• Development tools and addons support

Features

• 🐳 Containerized development environment
• 🚀 Resource-optimized for lower-end systems
• 🔒 Environment variable configuration for security
• 📦 Easy custom addon management
• ⚙️ Pre-configured PostgreSQL with performance tuning

Prerequisites

• Odoo package source (e.g., odoo_source.deb) placed in .docker/source
• Docker 20.10.x or newer
• Docker Compose v2.x
• Git

Directory Structure

odoo-docker/
├── .docker/                  # Docker configuration files
│   ├── Dockerfile           # Odoo container definition
│   ├── entrypoint.sh        # Container startup script
│   ├── odoo.conf            # Odoo configuration
│   ├── wait-for-psql.py     # Database connection utility
│   └── source                # Odoo package source
│       └── odoo_source.deb   # <Place the Odoo source package here>
├── addons/                   # Custom Odoo modules/addons
│   ├── oca/                 # OCA community addons (submodules)
│   └── asaidgroup/          # ASAid custom addons (submodules)
├── .env                      # Environment variables (excluded from git)
├── .gitignore                # Git ignore rules
├── .gitmodules               # Git submodule definitions
├── docker-compose.yml        # Docker Compose configuration
└── README.md                 # This file

Installation

Clone the Repository

git clone <repository-url>
cd odoo-docker

Initialize Git Submodules

git submodule init
git submodule update --recursive --remote

Important: This step is mandatory as it fetches all the necessary Odoo addon modules defined in .gitmodules. The docker container will not function correctly without these submodules properly initialized.

Configure Environment

cp .env.example .env
# Edit .env with your preferred settings

Build and Start

docker-compose up -d

Access Odoo at http://localhost:8069

Configuration

Environment Variables

The .env file contains all configurable parameters:

Variable	Default	Description
ODOO_DB_HOST	db	Database hostname
ODOO_DB_USER	odoo	Database username
ODOO_DB_PASSWORD	odoo_password	Database password
POSTGRES_DB	postgres	PostgreSQL database name
POSTGRES_USER	odoo	PostgreSQL username
POSTGRES_PASSWORD	odoo_password	PostgreSQL password
POSTGRES_SHARED_BUFFERS	128MB	PostgreSQL memory allocation
POSTGRES_MAX_CONNECTIONS	20	Max concurrent connections

Resource Allocation

Both services are configured with resource limits:

• Odoo: 2 CPU threads, 1GB RAM
• PostgreSQL: 2 CPU threads, 512MB RAM

To modify these limits, edit the deploy.resources.limits section in docker-compose.yml.

Usage

Starting the Environment

docker-compose up -d

Stopping the Environment

docker-compose down

Viewing Logs

# All services
docker-compose logs -f

# Specific service
docker-compose logs -f odoo

Accessing the Database

docker-compose exec db psql -U odoo postgres

Development

Adding Custom Modules

Place your custom modules in the addons directory. Odoo will automatically detect them.

If adding a new git submodule:

# Add a new submodule
git submodule add -b [branch-name] [repository-url] addons/[path]

# Example:
git submodule add -b 17.0 git@github.com:OCA/web.git addons/oca/web

Installing Modules

1. Access Odoo at http://localhost:8069
2. Create a new database or access an existing one
3. Go to Apps → Update Apps List
4. Install your custom modules

Database Management

Access the database manager at http://localhost:8069/web/database/manager

Troubleshooting

Common Issues

1. Permission Denied Errors

sudo chown -R $USER:$USER .docker addons

2. Port Conflicts

# Edit the port mappings in docker-compose.yml
# Example: "8080:8069" instead of "8069:8069"

3. Database Connection Issues

# Check PostgreSQL logs
docker-compose logs db

4. Resource Limitations

If Odoo performance is poor, try increasing the resource limits in docker-compose.yml and adjusting the corresponding settings in odoo.conf.

5. Missing Addons/Modules

# Make sure submodules are properly initialized
git submodule status

# If any are missing, run:
git submodule update --init --recursive

---

Maintained by ASAid Group Investment developer@asaidgroup.com