Setup: Install & Enable the Module

Updated 13 July 2026

A detailed, beginner-friendly guide to install the addon, update the Apps list, enable Developer Mode, install the app, and give users the correct access.

What You Will Do in This Setup

In simple words, you will place the addon inside Odoo’s addons folder, restart Odoo, ask Odoo to re-scan apps, install the module, and finally give the right permissions to users so they can see the menus.

Before You Start (Important Checks)

If you are not sure where your addons path is, ask your technical person (or the server admin) for the correct folder location. Uploading a module into the wrong folder is the most common reason why it doesn’t appear in Apps.

Step-by-Step Setup (For New Users)

Download the latest addon

Download the most recent copy of the module (the full addon folder). Often it comes as a ZIP file.

Make sure you have the complete addon folder that contains files like __manifest__.py (or __openerp__.py in older versions) and sub-folders like modelsviewssecurity.

Checklist: After extracting the ZIP, you should see your_module_name/__manifest__.py (not your_module_name/your_module_name/__manifest__.py).

Upload the addon folder to your Odoo addons directory

Copy the entire addon folder into one of your Odoo addons locations. Many companies keep custom modules in a separate folder (recommended) so upgrades are easier.

Important:

What you should see: After copying, your addons folder should contain the module folder like custom_addons/your_module_name.

Restart the Odoo service

Restart Odoo so it can detect the new addon folder.

Why this matters: Odoo reads addons and Python code at startup. If you don’t restart, Odoo may not detect the module correctly.

Enable Developer Mode

Developer Mode unlocks technical options like Update Apps List, advanced menus, and debugging tools.

To enable it:

If you cannot find the option, ask your administrator — some users may not have rights to enable developer features.

Update the Apps List

This step tells Odoo to scan your addons folders again and refresh the list of available modules.

What you should see: After updating, searching in Apps should show your module (if it is in the correct addons path and Odoo restarted successfully).

Find the module and install it

In the Apps menu:

What you should see: Odoo will show an “Installed” status when it finishes. New menus may appear immediately, but sometimes you need to refresh your browser.

If demo data is included, it may auto-load

Some modules provide demo data (example forms, sample records) to help you understand how it works.

Tip: For production/live databases, demo data is usually disabled (this is a good practice).

Give users permission (access rights)

Installing a module does not automatically give access to all users. Odoo uses groups (roles) to decide who can see menus and who can create/edit data.

To assign access:

Which role should you choose?

If you are not sure, start with User (minimum) and increase only if the user gets an access error.

Refresh Odoo and confirm the menus are visible

After changing access rights, refresh your browser page (or log out and log in again). Odoo sometimes needs a refresh to apply new menu visibility.

Now confirm:

If you still cannot see the menu, it usually means the user is missing the correct group.

Quick Test (Confirm Everything Works)

Use this short test after installation to confirm the module is working correctly for both administrators and normal users.

Confirm the module is installed
Confirm menus are visible (access rights test)
Create a small test form (2 fields)
Publish and open the public preview/link

What you should see: The form opens without errors and shows your two fields.

Submit one test entry

What you should see: A success message (or thank-you message) after submitting.

Verify the submission is saved in Odoo
(Optional) Verify mapping / target model output

If your module is configured to create Odoo records (for example Lead/Partner/Ticket) using mappings, confirm that the related record is created correctly.

After the test, you can keep the form for future testing or delete it (recommended only for Managers/Admins).

Common Problems (And What to Do)