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.
- Server side: upload addon folder → restart Odoo
- Odoo side: enable Developer Mode → Update Apps List → install module
- Access control: give user group/permissions → refresh and verify menus
Before You Start (Important Checks)
- You need admin rights in Odoo: You must be an Administrator (Settings access), or ask your Odoo admin to do these steps.
- You need server access: Someone must copy the addon folder to the server and restart the Odoo service.
- You must know your addons path: Odoo only loads modules from the folders listed in its configuration (
addons_path).
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 models, views, security.
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.
- Default addons: inside the Odoo installation addons folder (usually used for standard Odoo modules)
- Custom addons: a folder like
custom_addonsorextra-addons(recommended for custom modules)
Important:
- Do not rename the module folder unless your developer asked you to. Odoo reads the module name from the folder and manifest.
- Do not put the ZIP file directly inside addons. You must extract it so Odoo can read the files.
- Avoid double folders: Odoo must directly see
__manifest__.pyinside the module folder.
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.
- Windows (common): Open Services → find your Odoo service → click Restart.
- Linux (common): Restart the Odoo service (for example via
systemctl restart odooif your admin uses systemd).
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:
- Go to Settings.
- Look for Activate the developer mode (wording may differ slightly by Odoo version).
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.
- Go to Apps.
- In Developer Mode, click Update Apps List.
- Confirm if Odoo asks for confirmation.
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:
- Clear the default “Apps” filter if needed (some Odoo versions only show “Apps” by default and hide technical modules).
- Search by the module name (or a keyword from its description).
- Open the module card and click Install.
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.
- If demo data is enabled on your database, Odoo may load demo examples automatically during installation.
- If demo data is disabled, you will still be able to use the module normally — you just won’t see sample records.
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:
- Go to Settings → Users & Companies → Users
- Open the user
- Go to the Access Rights tab
- Find the module’s security group (for example: Dynamic Forms User / Manager / Administrator)
- Save
Which role should you choose?
- User: for regular users who create forms and view submissions
- Manager: for team leads who may need delete/cleanup permissions
- Administrator: for admins who manage module configuration/settings
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:
- The module appears in the app switcher (the grid of apps) or main menu
- You can open the screens without “Access Error” messages
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
- Go to Apps and search for the module.
- Make sure the status shows Installed.
Confirm menus are visible (access rights test)
- Log in as a user who should access the module (or ask that user to log in).
- Open the app switcher (the grid of apps) and check the module menu is visible.
- If the menu is missing, go to Settings → Users and assign the correct group, then refresh.
Create a small test form (2 fields)
- Go to the module → Forms → Create.
- Name it clearly, for example: Test Form (Setup).
- Add 2 simple fields (example: Name and Email).
- Save the form.
Publish and open the public preview/link
- Click Publish (or the equivalent action in your module).
- Open the public URL / preview link in a new browser tab.
What you should see: The form opens without errors and shows your two fields.
Submit one test entry
- Fill the form with a sample name and email.
- Click Submit.
What you should see: A success message (or thank-you message) after submitting.
Verify the submission is saved in Odoo
- Go back to Odoo.
- Open the module’s Submissions menu (or the equivalent list).
- Confirm your test entry is visible.
(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)
- The module does not appear in Apps: Confirm the module folder is in the correct
addons_path, restart Odoo, enable Developer Mode, then click Update Apps List. Also clear the “Apps” filter and search again. - I uploaded the addon but I only see a ZIP file: Extract/unzip it. Odoo needs the real folder with
__manifest__.py. - Installed but no menus are visible: The user is missing the module’s group. Assign the correct role under Settings → Users, save, then refresh or log in again.
- Access Error when opening the module: Assign the next higher role (User → Manager → Administrator) only if required for that user’s job.
- Still not working after all steps: Ask your admin to check the Odoo server log for errors during startup (missing dependency, Python error, or incorrect folder permissions).