Skip to content

How to Add Custom Modules

Easy Instance provides a flexible way to add custom Odoo modules by pushing them directly to your instance's repository. This guide walks you through the developer-focused workflow of adding modules via Git.


1. Prerequisites

Before you begin, ensure the following:

  • You have enabled "Include custom addons support" in your instance settings.
  • You have Git installed on your local machine.

2. Clone Your Repository

First, you need to have a local copy of your instance's repository.

  1. Navigate to your Easy Instance dashboard.
  2. In the Git Manager section, copy the Repository URL.
  3. Open your terminal and run the clone command:
    bash
    git clone [your-repository-url]
    cd [repository-folder]

Backup List


3. Add Your Custom Modules

Simply copy your module folders into the root of your cloned repository.

  1. Locate your custom Odoo module (ensure it contains a __manifest__.py file).
  2. Move or copy the module folder into your local repository directory.
  3. Example structure:
    text
    my-instance-repo/
    ├── my_custom_addon/
    └── ...

4. Push Changes to Easy Instance

Use standard Git commands to upload your modules to the server.

  1. Add the files:
    bash
    git add .
  2. Commit your changes:
    bash
    git commit -m "Add custom module: [module_name]"
  3. Push to the server:
    bash
    git push

Note: Easy Instance will automatically detect the new files and make them available to your Odoo environment.


5. Install the Module in Odoo

Once the push is successful, you must activate the module within the Odoo interface.

Enable Developer Mode

  1. Login to your Odoo instance.
  2. Navigate to Settings.
  3. Scroll to the bottom and click Activate the developer mode.

Update Apps List

  1. Navigate to the Apps menu.
  2. In the top navigation bar, click Update Apps List.
  3. Click Update in the confirmation dialog.

Final Installation

  1. In the Apps search bar, remove the default "Apps" filter.
  2. Search for your module name.
  3. Click the Activate button to install it.

Tip: For larger modules or multiple addons, Git provides a robust version-controlled way to manage your customizations.