This page is for new users who are installing the module for the first time. It explains what to do, why each step matters, and how to confirm you did it correctly—without technical jargon.
1) Overview
Installing an Odoo module usually follows the same pattern: put the addon folder in the right place, restart Odoo so it can “see” it, update the Apps list, install the app, and finally give users permission so they can access the menus.
- Addons folder
- Restart Odoo
- Update Apps list
- Install app
- User access rights
Who should do this? Usually an Odoo Administrator or someone with access to the server and Apps settings. If you don’t have those rights, share this page with your admin.
2) How it works
What “adding an addon” means
Odoo reads modules from a folder on the server (often called addons or custom_addons). When you copy the module folder there, you are making it available to Odoo.
Why you must restart: Restarting reloads Odoo so it notices the new module folder.
Why “Update Apps list” is needed
Odoo keeps a list of available apps. Updating the Apps list tells Odoo to scan your addons folders again and include any new modules.
Tip: If you can’t find the app, update the Apps list first
After installation: permissions control menus
Even after installing, Odoo may hide menus if your user doesn’t have the correct permissions. This is normal and is designed to keep data secure.
3) Step-by-step guide
Download the latest copy of the addon
Get the module (addon) folder from your vendor, your internal team, or your approved source. Keep it as a folder (do not copy only individual files).
What you should have: one folder that contains files like __manifest__.py, and sub-folders like models, views, security.
Upload the addon folder into your Odoo addons path
Copy the full folder into Odoo’s addons or custom_addons directory (whichever your organization uses). Keep the folder name exactly as provided.
Where this happens: This is on your server/hosting (not inside the Odoo web screen). If you are not sure which folder is correct, ask your Odoo administrator.
Restart the Odoo service
Restarting is required so Odoo reloads and detects the new addon. If you use Odoo.sh or a managed hosting, “restart” may happen automatically when you deploy.
Success check: Odoo loads normally again and you can log in without errors.
Activate Developer Mode
In Odoo, go to Settings and enable Developer Mode (sometimes called “Debug mode”). This unlocks admin tools like “Update Apps list”.
Where you will see it in the UI
- Menu path: Settings → (search for “Developer Mode” or “Activate the developer mode”).
- What changes: you will see extra debug/admin options in some screens.
Update the Apps list
Go to the Apps area and use Update Apps list so Odoo scans for new modules.
Where you will see it in the UI
- Menu path: Apps → look for an action like Update Apps List (often in the top area).
- If you don’t see the button: confirm Developer Mode is enabled.
Success check: After updating, the app becomes searchable in Apps (next step).
Search the app and install it
In Apps, search for the module name (for example: “Pokemon Card Management”). Click Install (or Activate/Enable depending on your screen).
Where you will see it in the UI
- Menu path: Apps → search box (top of the Apps page).
- What to click: the app tile/card → Install.
Success check: the button changes to “Installed” and a new app/menu becomes available (depending on your access rights).
Wait for demo data (if enabled)
Some databases install demo records automatically (sample Pokemon, types, moves). If your database has demo data enabled, you may see sample content after installation.
What you should see: sample records in lists (for example, some Pokemon types, moves, or sample Pokemon). If you don’t see demo data, that is okay—your database may be set up without demo content.
Give users access permissions
Go to Settings → Users & Companies → Users, open the user, and grant access to the module’s roles (for example: Administrator/Manager/Staff). Save the user.
Where you will see it in the UI
- Menu path: Settings → Users & Companies → Users → open the user.
- What to change: in the user’s “Access Rights” area, find the Pokemon module permissions and choose the right role.
- Roles you may see: Pokemon Staff (basic), Pokemon Manager (manage more), Pokemon Administrator (full access).
Tip: If a user can’t see the menu after installation, it is almost always an access-rights issue.
Refresh Odoo and confirm menus appear
Ask the user to refresh the browser (or log out/in). Then check the top apps menu: you should see Pokemon Card Management and its menus.
Success check: In the main app switcher/menu, you can open Pokemon Card Management and see menus like Pokemon, Owners, and Battles.
Success check: You can open Pokemon Card Management → Pokemon → All Pokemon and click Create.
4) Quick test (Confirm Everything Works)
Run these quick checks right after installation and user access setup. Each check takes about 10–30 seconds and confirms the module is ready for real users.
Can you see the app menu?
- Refresh the browser (or log out and log back in).
- Open the main app menu (app switcher) and look for Pokemon Card Management.
- Click it.
If it fails: the user likely has no access rights. Go to Settings → Users, update the user’s Pokemon roles, save, then refresh.
Pass: You can see menus like Pokemon, Owners, Battles, and Configuration.
Can you create one Pokemon record?
- Go to Pokemon → All Pokemon.
- Click Create.
- Fill a small test record: Name, Pokedex Number, Primary Type, and Stats.
- Click Save.
Pass: The record saves successfully and appears in the list/kanban.
Cleanup tip: Archive the test record later (instead of deleting) if you want to keep history clean.
Can you open Configuration screens?
- Open Configuration → Pokemon Types.
- Open Configuration → Moves.
- Open Configuration → Abilities.
- Open Configuration → Evolution Rules.
- Open Configuration → Locations.
- Open Configuration → Item Categories.
Pass: Each page opens without an “Access Error”.
Quick permission check (most common issue)
- Symptom: Admin can see everything, but staff can’t see the menu.
- Meaning: The module is installed correctly—staff permissions are missing.
- Fix: Settings → Users → open the user → grant Pokemon Staff/Manager/Admin → Save → refresh.
5) Tips
- Use a test database first: install and explore in a test environment so you feel confident before production.
- Keep the addon folder clean: don’t rename or partially copy it; copy the complete folder.
- When the app doesn’t show in search: restart Odoo and update the Apps list again.
- When menus don’t appear for a user: check user roles/access rights and then refresh the browser.
- Decide on demo data early: demo data is helpful for learning, but you may want a clean database for real operations.
6) Common mistakes
- Copying the addon into the wrong folder: Odoo only scans configured addons paths. Ask your admin which folder is used.
- Forgetting to restart Odoo: Odoo may not see the new addon until restart.
- Not updating the Apps list: the module exists on the server, but Odoo hasn’t refreshed its catalog.
- Installing the module but not giving user access: the app is installed, but users can’t see menus.
- Not refreshing the browser: menus can appear only after a refresh or re-login.