Glossary of Terms

Quick reference for OEC.SH platform terminology and concepts.

A

Addon Repository

Definition: External Git repository containing custom Odoo addons/modules to be installed alongside the base Odoo system. Related: Projects, Addons Management Technical Context: Cloned during deployment and mounted to /mnt/extra-addons

ARQ (Async Redis Queue)

Definition: Python-based async task queue system using Redis for background job processing. Related: Deployment Operations, Backup Creation Technical Context: Handles long-running operations like deployments, backups, clones with retry logic (3 attempts, exponential backoff)

Auto-Deploy

Definition: Automatic deployment trigger when Git commits are pushed to tracked branches. Related: Environment Deployment, Git Integration Use Case: Enables CI/CD workflows for continuous deployment

B

Backup Manifest

Definition: JSON file (manifest.json) inside backup ZIP containing metadata about backup contents. Related: Backup Creation, Backup Restoration Structure: Includes database size, filestore size, Odoo version, PostgreSQL version, creation timestamp, backup ID

Backup Policy

Definition: Automated backup schedule configuration with GFS retention rules. Related: Backup Creation Components: Cron schedule expression, retention tiers (daily/weekly/monthly/yearly), enabled/disabled status

BYOS (Bring Your Own Server)

Definition: Infrastructure model where users provide their own servers (DigitalOcean, AWS, Linode, etc.) instead of platform-managed VMs. Related: Add Server, Server Management Cost Impact: Reduces per-project costs 50-80% vs platform-managed servers

C

Canonical URL

Definition: The preferred URL for a page to prevent duplicate content issues in search engines. Related: SEO, documentation structure Format: https://docs.oec.sh/path/to/page

Clone (Environment)

Definition: Creating a duplicate copy of an environment including database, filestore, and configuration, optionally with data sanitization. Related: Environment Cloning Use Cases: Create staging from production, testing, development isolation, compliance (sanitize PII)

Container

Definition: Docker container running a service (Odoo, PostgreSQL, PgBouncer) for an environment. Related: Environment Lifecycle Naming Pattern: {env_id}_odoo, {env_id}_db, {env_id}_pgbouncer, {env_id}_postgres-replica

Container State

Definition: Docker container runtime status (running, stopped, paused, exited). Related: Environment Lifecycle Note: Different from Environment State (application-level status)

Cron Job (ARQ)

Definition: Scheduled background task that runs periodically. Related: Backup Creation, Monitoring Examples: Hourly scheduled backups, 2-minute replica health checks, daily retention cleanup

D

Database (PostgreSQL)

Definition: PostgreSQL database instance storing Odoo application data. Related: Database Management Configuration: Version 15, max 100 connections, 30-second query timeout, pgvector extension support

Deployment

Definition: Process of building Docker images and starting containers to make an environment operational. Related: Deployment Operations, Environment Deployment Stages: 17 stages from git clone to health check validation

Deployment Pipeline

Definition: Sequence of 17 automated steps to deploy an environment. Related: Deployment Logs Key Stages: Git clone, Docker build, database creation, Odoo initialization, container start, health check

DNS Provider

Definition: Service that manages DNS records for custom domains (Cloudflare, Route53, etc.). Related: DNS Management Integration: Automatic SSL certificate provisioning via Let's Encrypt

Docker Network

Definition: Isolated virtual network for environment containers to communicate. Related: Environment Lifecycle Pattern: paasportal_net_{env_uuid}

E

Environment

Definition: Isolated Odoo instance with dedicated resources (CPU, RAM, disk) and containers. Related: Create Environment, Environment Lifecycle Technical Context: Docker container orchestration with Odoo + PostgreSQL + PgBouncer + optional replica

Environment State

Definition: High-level application status of an environment. Related: Environment Lifecycle States: created, pending, deploying, deployed, running, stopped, stopping, destroying, destroyed, error

Environment Type

Definition: Classification of environment by purpose (development, staging, production). Related: Create Environment Impact: Affects default auto-deploy settings, deletion protection, billing priorities

F

Filestore

Definition: Directory containing Odoo file attachments (uploaded files, images, documents). Related: Backup Creation Location: /var/lib/odoo/filestore/{database_name} inside Odoo container

Force Restore

Definition: Parameter to override migration_restore_completed flag and re-restore a migration environment. Related: Odoo.sh Migration Warning: Can cause data loss if used incorrectly; requires type-to-confirm UI

G

GFS Retention (Grandfather-Father-Son)

Definition: Backup rotation scheme with 5 tiers: daily, weekly, monthly, yearly, permanent. Related: Backup Creation Logic: Automatic promotion of backups (Monday → weekly, 1st → monthly, Jan 1 → yearly)

Git Connection

Definition: Authenticated link to a Git provider (GitHub, GitLab, Bitbucket) for repository access. Related: Git Integration Auth Methods: OAuth (user), Personal Access Token (PAT), GitHub App (organization-wide)

Git Webhook

Definition: HTTP callback from Git provider to OEC.SH when commits are pushed. Related: Git Integration Trigger: Initiates auto-deployment when enabled and branch matches

H

Health Check

Definition: HTTP endpoint probe to verify environment is responding correctly. Related: Deployment Operations Endpoint: http://{odoo_container}:8069/web/health (returns {"status": "pass"})

HMAC Signature

Definition: Hash-based message authentication code used to verify webhook authenticity. Related: Webhooks, Stripe Integration Algorithm: HMAC-SHA256

I

is_active Flag

Definition: Database boolean indicating if an environment is actively consuming quota. Related: Environment Lifecycle, Quota Management Critical: Must set to false on destroy to release quota, otherwise "ghost quota" blocks new environments

J

JSON-LD

Definition: JavaScript Object Notation for Linked Data - structured data format for SEO. Related: SEO, Schema.org Schemas Used: Website, TechArticle, Breadcrumbs, Organization

L

Let's Encrypt

Definition: Free automated certificate authority providing SSL/TLS certificates. Related: DNS Management Integration: Automatic via Traefik with 60-day auto-renewal

M

Migration Environment

Definition: Environment created specifically for migrating data from Odoo.sh. Related: Odoo.sh Migration Linked Field: migration_id foreign key, migration_restore_completed flag

Multi-Tenant

Definition: Architectural approach where multiple projects/environments share the same physical server. Related: Introduction Economics: 3-10 projects per VM, reduces per-project cost

N

Netdata

Definition: Open-source real-time monitoring system for infrastructure metrics. Related: Real-time Monitoring Architecture: Parent-child streaming (parent on OEC.SH server, child on managed servers)

O

Odoo Version

Definition: Major version of Odoo framework (14.0, 15.0, 16.0, 17.0, 18.0, 19.0). Related: Create Project Compatibility: Some features (e.g., replicas) only support 18.0 and 19.0

OpenGraph (OG) Tags

Definition: Meta tags for rich social media previews (Facebook, LinkedIn, Twitter). Related: SEO, social sharing Tags: og:title, og:description, og:image, og:url, og:type

Organization

Definition: Top-level entity in OEC.SH hierarchy containing projects, servers, team members. Related: Organization Settings, Account Setup Limits: Quota (CPU/RAM/disk), subscription plan-based

P

PgBouncer

Definition: Lightweight PostgreSQL connection pooler managing database connections. Related: Database Management Ports: 6432 (primary), 6433 (replica if exists)

PostgreSQL Replica

Definition: Read-only copy of primary database for reporting and analytics queries. Related: Database Management Requirements: Odoo 18.0 or 19.0 only Replication: Streaming replication with lag monitoring (50MB warning, 100MB critical)

Project

Definition: Logical grouping of related Odoo environments (dev, staging, prod) sharing Git repository. Related: Projects, Create Project Hierarchy: Organization → Project → Environments

Q

Quota

Definition: Organization-level resource limits for total CPU, RAM, and disk allocation across all active environments. Related: Organization Settings, Billing Enforcement: Prevents environment creation when quota exceeded (including replica resources)

R

RBAC (Role-Based Access Control)

Definition: Permission system with 74 granular permissions and 9 system roles. Related: Permissions & RBAC Hierarchy: Portal > Organization > Project

Read Replica

See PostgreSQL Replica

Redis

Definition: In-memory key-value store used for caching and pub/sub messaging. Related: ARQ task queue, SSE event broadcasting, permission caching Cache TTL: 5 minutes for user abilities

Replica Health

Definition: Status of PostgreSQL replica replication lag and connectivity. Related: Database Management States: online, offline, lagging, error

Replica Lag

Definition: Delay between primary database and replica, measured in bytes and seconds. Related: Database Management Thresholds: Warning (50MB/15s), Critical (100MB/30s)

Resource Allocation

Definition: Distribution of CPU, RAM, and disk between Odoo and PostgreSQL containers. Related: Create Environment Default Split: 70% Odoo, 30% PostgreSQL (customizable)

Restore Point

Definition: Backup that can be used to restore an environment to a previous state. Related: Backup Restoration Compatibility: Checks Odoo version, PostgreSQL version, database size

Retention Tier

Definition: GFS backup classification determining how long backup is retained. Related: Backup Creation Tiers: daily (7 days), weekly (4 weeks), monthly (12 months), yearly (indefinite), permanent (never delete)

S

Sanitization

Definition: Data obfuscation process to remove sensitive information from cloned databases. Related: Environment Cloning Presets: recommended (12 options), minimal (3), full (15+), none (1)

Server / VM

Definition: Physical or virtual machine hosting multiple Odoo environments. Related: Add Server, Server Management Requirements: Ubuntu 22.04, Docker, Traefik, Netdata, public IP

Server Status

Definition: Operational state of a server. Related: Server Management States: running, stopped, error, provisioning

Sitemap

Definition: XML file listing all documentation pages for search engine crawlers. Related: SEO Location: https://docs.oec.sh/sitemap.xml

SSE (Server-Sent Events)

Definition: HTTP protocol for server-to-client real-time updates without polling. Related: Real-time Monitoring Event Types: deployment, backup, replica, alert, server_health, task, quota, permission, migration, custom

State Machine

Definition: Finite set of states and valid transitions between them. Related: Environment Lifecycle Example: pending → deploying → running (valid), running → deploying (invalid)

Storage Provider

Definition: Cloud or remote storage service for backup storage. Related: Storage Providers Types: AWS S3, Cloudflare R2, Backblaze B2, MinIO, SFTP, FTP

Stripe

Definition: Payment processing platform for subscription billing. Related: Billing Integration: Checkout hosted page, Customer Portal, webhook handling

Structured Data

Definition: Standardized format for providing information to search engines (JSON-LD). Related: SEO, Schema.org Benefits: Rich search results, knowledge graph, breadcrumbs

Subdomain

Definition: Unique domain prefix for accessing an environment. Related: Create Environment Pattern: {project-slug}-{env-type}.oec.sh or custom domain

T

Task (ARQ)

Definition: Background job tracked by ARQ task queue. Related: Deployment Operations Lifecycle: pending, active, completed, failed, retrying

Traefik

Definition: Modern reverse proxy and load balancer routing HTTP/HTTPS traffic to containers. Related: Server Management Features: Automatic SSL, dynamic routing, health checks

W

Webhook

Definition: HTTP callback triggered by external event (Git push, Stripe payment, etc.). Related: Git Integration, Billing Security: HMAC signature verification required

Y

YAML Frontmatter

Definition: Metadata block at the top of MDX files containing structured information. Related: Documentation, SEO Fields: title, description, keywords, complexity_level, target_audience, etc.

Technical Acronyms

Total Terms: 70+ definitions covering infrastructure, deployment, backup, monitoring, security, and platform concepts.

For detailed explanations of specific features, see the related documentation links provided with each term.