Odoo 15 ERP Documentation¶
Welcome to the Odoo 15 ERP Documentation Portal. This comprehensive guide covers the complete system including custom Odoo modules, Field PWA application, Landing Page, REST API, and operational procedures.
Quick Navigation¶
-
Getting Started
Installation, configuration, and quick start guides for new deployments
-
Custom Modules
Business modules: SMS integration, digital signatures, accounting sync, and more
-
Landing Page
Public website with lead capture forms integrated with Odoo CRM & Helpdesk
-
Field PWA
Mobile progressive web app for field technicians and sales representatives
-
API Reference
REST API documentation with authentication, endpoints, and code examples
-
Operations
Deployment, backup, SSL certificates, monitoring, and maintenance guides
-
Development
Module development, coding standards, testing, and contribution guidelines
System Architecture¶
flowchart TB
subgraph "Internet"
Users[Users/Browsers]
Mobile[Mobile Devices]
end
subgraph "Nginx Reverse Proxy"
SSL[SSL Termination<br/>HTTPS/TLS 1.2+]
end
subgraph "Docker Services"
Odoo[Odoo 15 ERP<br/>:8069]
Landing[Landing Page<br/>Flask :8001]
PWA[Field PWA<br/>Flask :8000]
Docs[Documentation<br/>MkDocs :8002]
end
subgraph "Data Layer"
DB[(PostgreSQL<br/>Local/RDS)]
FileStore[(Filestore<br/>./odoo-data)]
S3[(AWS S3<br/>Signatures/Photos)]
end
subgraph "External Integrations"
JustCall[JustCall API<br/>SMS/MMS]
Xero[Xero API<br/>Accounting]
reCAPTCHA[Google reCAPTCHA<br/>Spam Protection]
end
Users --> SSL
Mobile --> SSL
SSL -->|erp.domain| Odoo
SSL -->|www.domain| Landing
SSL -->|field.domain| PWA
SSL -->|docs.domain| Docs
Odoo --> DB
Odoo --> FileStore
Odoo --> S3
Odoo --> JustCall
Odoo --> Xero
Landing --> Odoo
Landing --> reCAPTCHA
PWA --> Odoo
PWA --> S3
System Components¶
| Component | Description | Technology |
|---|---|---|
| Odoo 15 ERP | Core business management platform | Python 3.8+, PostgreSQL |
| Custom Modules | SMS, Signatures, Xero, Helpdesk extensions | Odoo ORM |
| Landing Page | Public website with lead/helpdesk forms | Flask 3.x, Tailwind CSS |
| Field PWA | Mobile app for technicians and sales | Flask 3.x, Bootstrap 5 |
| REST API | External integrations via OAuth/JWT/API Key | restapi module |
| Documentation | This documentation portal | MkDocs Material |
Custom Modules Overview¶
Core Business¶
| Module | Purpose | Key Features |
|---|---|---|
jdx_core_data |
Base configuration | MTO route, stock locations, colors, categories |
bi_product_dimension |
Product pricing | Width × Height pricing for window treatments |
jdx_service_signature |
Digital signatures | Canvas capture, S3 storage, warranty acknowledgment |
Integrations¶
| Module | Purpose | Key Features |
|---|---|---|
justcall_sms |
SMS/MMS messaging | Unified inbox, multi-line, webhooks, templates |
xero_integration |
Accounting sync | OAuth2, invoice sync, payment reconciliation |
restapi |
REST API | OAuth½, JWT, API Key authentication |
jdx_google_chat |
Team notifications | FSM, Sales, Invoice, PO alerts to Google Chat |
Field Service¶
| Module | Purpose | Key Features |
|---|---|---|
fieldservice |
FSM orders | OCA module for work orders, locations, workers |
jdx_field_service_automation |
Automation | Auto-create FSM orders from delivery validation |
jdx_helpdesk_fsm |
A/S workflow | Create service orders from helpdesk tickets |
Environment Access¶
| Service | URL | Notes |
|---|---|---|
| Odoo ERP | http://localhost:8016 | Direct port access |
| Landing Page | http://localhost | Via nginx |
| Field PWA | http://localhost:8000 | Direct port access |
| Documentation | http://localhost:8002 | Direct port access |
| Service | URL | Notes |
|---|---|---|
| Odoo ERP | https://erp.example.com | Via nginx with SSL |
| Landing Page | https://example.com | Via nginx with SSL |
| Field PWA | https://field.example.com | Via nginx with SSL |
| Documentation | https://docs.example.com | Via nginx with SSL |
Quick Start¶
# Clone repository
git clone git@github.com:example/odoo15-production.git
cd odoo15-production
# Configure environment
cp .env.example .env
nano .env # Review and customize settings
# Verify configuration
./production_deploy.sh config
# Start all services
./production_deploy.sh start
# Check health
./production_deploy.sh health
See Installation Guide for detailed setup instructions.
Version Information¶
| Component | Version | Notes |
|---|---|---|
| Odoo | 15.0 | Community Edition |
| Python | 3.8+ | Container runtime |
| PostgreSQL | 15 | Local or AWS RDS |
| Flask | 3.0+ | Landing Page & PWA |
| MkDocs Material | 9.x | Documentation |
| Tailwind CSS | 3.x | Landing Page styling |
| Docker Compose | 2.x | Container orchestration |
Documentation Sections¶
| Section | Description |
|---|---|
| Getting Started | Installation, configuration, quick start |
| Modules | Custom module documentation and configuration |
| Field PWA | Mobile app features and setup |
| Landing Page | Public website configuration |
| API Reference | REST API endpoints and authentication |
| Operations | Deployment, backup, monitoring, security |
| Development | Coding standards, testing, contributing |