Features
Addon Repos
Overview

Addon Repositories

Addon repositories let you add extra Odoo modules to your projects. These are Git repositories containing custom addons that extend Odoo functionality beyond the standard features.

What Are Addon Repositories?

Addon repositories contain Odoo modules (addons) that you want to include in your deployments. These can be:

  • Custom Addons: Your organization's proprietary modules
  • Third-Party Addons: Community addons from OCA or other sources
  • Odoo Enterprise: The official enterprise addon repository

OEC.sh organizes addon repositories in three tiers:

  1. Platform Addons: Available to all organizations (managed by portal admins)
  2. Organization Addons: Shared across all projects in your organization
  3. Project Addons: Specific to a single project

When addons exist at multiple levels, project-level addons take priority over organization addons, which take priority over platform addons.

Adding an Addon Repository

Add Organization Addon Repository

If you have Git connections configured, use the smart selection workflow:

  1. Go to Settings → Addon Repos tab
  2. Click Add Repository
  3. Step 1: Select a Git connection
  4. Step 2: Select a repository from your connection
  5. Step 3: Select a branch
  6. Step 4: Configure details (name is auto-filled)
  7. Click Save

The slug is automatically generated from the repository name.

Alternative: Enter URL Manually

If you prefer to enter the repository URL directly, or don't have Git connections:

  1. Click Enter URL manually instead (or if no connections exist, this is shown by default)
  2. Enter the Git repository URL (e.g., https://github.com/org/repo.git)
  3. Enter the Git branch name
  4. Fill in the name and optional description
  5. Toggle Public repository if no authentication is needed
  6. Click Save

Add Project-Specific Addon Repository

  1. Open your project
  2. Go to the Settings tab
  3. Scroll to Project Addons
  4. Click Add Repository
  5. Enter the repository details:
    • Git URL: The repository URL
    • Branch: The Git branch to use
    • Priority: Controls loading order (lower = higher priority)
  6. Click Save

Repository Settings

Each addon repository has these settings:

  • Name: A display name for the repository
  • Slug: Auto-generated URL-friendly identifier (locked after creation)
  • Description: Optional description
  • Git URL: The repository URL
  • Branch: The Git branch to use
  • Priority: Loading order (default: 100, lower values load first)
  • Public/Private: Toggle based on repository visibility
  • Install Dependencies: Enable to install requirements.txt and apt.txt

Repository Status

Each repository shows a status indicator:

  • Active (green dot): Repository is included in deployments
  • Disabled (gray dot): Repository is configured but not used

Click the toggle button to enable or disable a repository without deleting it.

Selecting Addons for a Project

Projects can choose which platform and organization addons to include:

  1. Open your project
  2. Go to the Settings tab
  3. Find the Shared Addons section
  4. Click Browse Addons to open the selection modal
  5. Use the search and filter options to find addons
  6. Select the addons you want to include
  7. Click Apply to save your selections

Selected addons will be included in the next deployment.

How Addons Are Deployed

When you deploy an environment, OEC.sh automatically:

  1. Clones all selected addon repositories
  2. Installs Python dependencies from requirements.txt (if present)
  3. Installs system packages from apt.txt (if present)
  4. Configures Odoo's addon path to include all repositories
  5. Makes addons available in the Odoo Apps menu

Managing Dependencies

Addon repositories can include dependency files:

  • requirements.txt: Python packages to install
  • apt.txt: System packages to install

Enable the Install dependencies from this repository option when adding a repository to have these installed automatically during deployment.

Removing an Addon Repository

Remove from Organization

  1. Go to Settings → Addon Repos
  2. Find the repository you want to remove
  3. Click the delete icon
  4. Confirm the deletion

Remove from Project

  1. Open your project
  2. Go to Settings → Project Addons
  3. Click the delete icon next to the repository
  4. Confirm the deletion

Note: Removing a repository requires redeployment for changes to take effect. Uninstall any installed addons from Odoo first to avoid errors.

Private Repository Authentication

For private repositories:

  1. First set up a Git connection in Settings → Git Connections
  2. When adding the addon repository, the smart selection workflow uses your connection automatically
  3. For manual entry, disable the "Public repository" toggle and select your connection
  4. The connection provides authentication during deployment

See the Git Connections guide for details on setting up authentication.

What's Next?

OverviewOverview