Overview
Installing an Odoo module is not only “click Install”. First, Odoo needs to be able to see the addon code, then you update the Apps list, and finally you give users access so the menus appear.
By the end of this guide, you will be able to:
- Place the addon in the correct folder
- Restart Odoo so it reads the new addon
- Enable Developer Mode and update the Apps list
- Install the module from Apps
- Give users the right permissions so they can see the Documents menus
Important: Steps like copying addon folders and restarting the service usually need an admin/IT person. If you are an end user without server access, share this page with your admin.
How it works (simple explanation)
- Addon folder: The module is a folder that contains the app files.
- Addons path: Odoo only loads modules that are inside a configured addons/custom_addons directory.
- Restart: Odoo reads modules when it starts. Restarting makes it “notice” the new addon.
- Developer Mode: Unlocks extra tools like “Update Apps List”.
- Apps list update: Makes Odoo scan your addons folders again.
- Access rights: Even after install, a user may not see menus until permissions are granted.
Step-by-step guide (from start to finish)
Before you start
Make sure you have the latest module folder (for example, a downloaded ZIP extracted into a folder). The folder should contain files like __manifest__.py.
1. Download the latest copy of the addon
Get the newest version of the module from your vendor/internal team. If it arrives as a ZIP file, extract it first. This ensures you have a real addon folder (not a compressed file).
- Where Outside Odoo
- Check Folder contains __manifest__.py
2. Copy the addon folder into your Odoo addons/custom_addons directory
Place the full module folder inside your Odoo addons or custom_addons directory (the folders Odoo scans for modules).
- Where Odoo server file system
- Check Module folder sits next to other addons
3. Restart the Odoo service
Restarting is important because Odoo reads module information when it starts. After restart, Odoo can “notice” the new addon files.
- Where Odoo server service restart
- Tip Ask IT if you don’t have access
4. Activate Developer Mode
Developer Mode unlocks admin tools like “Update Apps List”.
- Where Settings → Activate Developer Mode
5. Update the Apps list
Updating the Apps list makes Odoo rescan your addons/custom_addons folders so the new module appears in Apps search.
- Where Apps → Update Apps List
- Needs Developer Mode ON
6. Search the module in Apps and install it
Go to Apps, search Documents or DMS, open the module card, then click Install.
- Where Apps → Search → Install
7. If demo data is enabled, sample records may appear
Some systems install sample folders/files automatically when demo data is enabled. This is only for learning — you can still use the app without demo data.
- Where Documents app (sample folders/files)
8. Give users access permissions
Even after installation, users might not see the menu until you grant access rights. Open each user and set the Documents permission (for example: Document User / Document Manager).
- Where Settings → Users → Access Rights
- Result Menus become visible
9. Refresh Odoo and confirm the Documents menu appears
Refresh the browser (or log out and log in). Then open the top-left app menu and look for Documents.
- Where Top-left app menu → Documents
- Check Dashboard / Folders / Files visible
If you don’t see the module in Apps
Most often it’s one of these: addon folder placed in the wrong directory, Odoo wasn’t restarted, Apps list wasn’t updated, or the module folder name/contents are incomplete.
Where to find it in the app (after installation)
After the module is installed and your user has permission, you will see a new main app called Documents. This is the easiest way to confirm everything is working.
Main places you will use daily
These are the screens most end users use every day.
OpenTop-left app menu → Documents
- Dashboard: Documents → Dashboard
- Folders: Documents → Document Management → Folders
- Files: Documents → Document Management → Files
Manager/Admin screens (if you have access)
These menus may be hidden until your admin grants permission.
- Tags: Documents → Document Management → Tags
- Shares: Documents → Document Management → Shares
- File Locks: Documents → Document Management → File Locks
- Cloud Sync: Documents → Document Management → Cloud Sync
- Cloud Sync Settings: Documents → Settings → Cloud Sync Settings
- Model Document Settings: Documents → Settings → Model Document Settings
If you can’t see “Documents”
It usually means the module is not installed in Apps, or your user permissions are missing. Ask your admin to check Step 6 (Install) and Step 8 (Access Rights).
Fields table (Setup checklist)
| Field Name | Description | Example |
|---|---|---|
Addons folder |
Where the module folder is copied so Odoo can read it. |
custom_addons/ |
Restart Odoo |
Reloads Odoo so it recognizes the new addon. |
Restart service |
Developer Mode |
Enables tools like “Update Apps List”. |
Enabled |
Update Apps List |
Rescans available modules so the new addon appears in Apps. |
Apps list refreshed |
Install module |
Installs the Documents (DMS) app into your database. |
Installed |
Demo data |
Optional sample records (only if your system uses demo data). |
Sample folders created |
User access rights |
Permissions that allow a user to see and use the Documents menus. |
Document User |
Menu visible |
Confirmation that the user can see Documents in the main menu. |
Documents menu appears |
Field Explanations (all fields in the table)
Addons folder
The location where the module folder must be placed for Odoo to load it.
Restart Odoo
Without a restart, Odoo may not detect new addon files.
Developer Mode
Needed to access admin tools for module management.
Update Apps List
Makes the module show up in Apps search after you copy it.
Install module
Adds the module’s features (menus, screens, security rules) to your Odoo database.
Demo data
Optional “example records” to explore the app. Not required for real usage.
User access rights
Controls which users can open and manage Documents features.
Menu visible
Your final check: the user can see Documents and can open it successfully.
Tips
- Install with a test user first, then roll out permissions to the full team.
- After installation, set up a simple folder structure (Finance / HR / Sales) before users start uploading.
- Keep a short internal rule: “Always upload to the correct folder + add at least one tag for key documents.”
Common mistakes
- Copied the wrong folder level: Make sure the folder you copied contains
__manifest__.py. - Forgot to restart Odoo: The module may not appear until a restart.
- Apps list not updated: Odoo won’t list new modules until you update the Apps list.
- No user permission: Module is installed, but menus stay hidden until access rights are granted.