| Availability |
Odoo Online
Odoo.sh
On Premise
|
| Odoo Apps Dependencies |
Discuss (mail)
|
| Lines of code | 784 |
| Technical Name |
sm_portal_document |
| License | OPL-1 |
| Versions | 17.0 18.0 19.0 |
Portal Documents Management
Share documents & directories with portal users - create, upload, download, and browse from the customer portal
Video Overview
Key Features
1 Browse Directories from Portal
Portal users see a beautiful card-based directory grid at |
Directory browsing screenshot |
|
|
2 Create Directories from PortalPortal users can create root directories and sub-directories directly from the portal interface. Collapsible form - clean and easy to use. Admin controls which directories allow portal uploads. |
3 Upload & Download DocumentsUpload any file type from the portal - PDF, images, Office documents, archives, and more. Each document shows its file type icon, size, uploader, and date. One-click download for all documents. |
|
|
|
4 Follower-Based Access ControlOnly followers of a directory can see it in the portal. Add portal users as followers from the backend chatter - they instantly get access to the directory and all its documents. Simple and secure. |
5 Full Backend ManagementManage all directories and documents from the Odoo backend with kanban, list, and form views. Toggle Allow Portal Upload per directory. Stat buttons for quick navigation between directories and their documents. |
Backend management screenshot |
|
Dynamic icons per file type |
6 Dynamic File Type IconsEach document automatically displays the correct file type icon based on its MIME type - PDF, images, Word, Excel, PowerPoint, text, archives, video, audio, and code files are all recognized. |
How It Works
|
1
Create DirectoriesCreate directories in the backend. Add portal users as followers to grant access. |
2
Enable Portal UploadToggle "Allow Portal Upload" on directories where you want portal users to be able to add content. |
3
Portal Users Browse & UploadPortal users see their directories at /my/directories. They can browse, create sub-folders, upload files, and download documents. |
Portal Documents Management — Documentation
Table of Contents
1. Getting Started
Prerequisites
| Requirement | Description |
|---|---|
| Odoo 19.0 | Community or Enterprise edition |
| portal module | Must be installed (auto-installed with most Odoo packages) |
| mail module | Must be installed (ships with Odoo by default) |
Installation
- Place sm_portal_document folder in your Odoo addons path.
- Restart Odoo server.
- Go to Apps, update the Apps List, search for Portal Documents Management and click Install.
2. Configuration
Create Directories
- Navigate to Portal Documents → Directories → New.
- Enter a directory name and optionally set a parent directory.
- Toggle Allow Portal Upload if you want portal users to create sub-directories and upload files.
- In the chatter, add portal users as followers to grant them access.
Note
Only followers of a directory can see it in the portal. Sub-directories created by portal users automatically inherit the parent's followers.
Manage Documents
- Navigate to Portal Documents → Documents.
- Create documents manually or let portal users upload them.
- Each document is linked to a directory and inherits the directory's follower-based access.
3. Usage
Portal User Experience
- Portal users log in and go to My Account (/my).
- A Documents card appears in the portal home page.
- Clicking it opens the directory list at /my/directories.
- Clicking a directory shows:
- Sub-directories as clickable cards
- Documents in a table with file icons, size, uploader, date, and download button
- If Allow Portal Upload is enabled, two action buttons appear:
- New Sub-Directory — create a child folder
- Upload Document — upload any file
- Click the download button on any document to save it locally.
Backend User Experience
- Kanban view: Visual cards for directories and documents.
- List view: Tabular overview with all key fields.
- Form view: Full details with stat buttons linking to child directories/documents.
- Chatter: Add/remove followers to control portal access.
4. Access Control
| User Type | Access Level | How |
|---|---|---|
| System Admin | Full CRUD | base.group_system |
| Internal User | Full CRUD | base.group_user |
| Portal User | Read + Create (no delete) | base.group_portal + follower rule |
Portal users can only see directories where they are added as a follower. Documents inherit access from their parent directory's followers.
5. Technical Details
Models
- sm.portal.directory — Directory model (inherits mail.thread, portal.mixin)
- sm.portal.document — Document model (inherits mail.thread, portal.mixin)
Portal Routes
| Route | Description |
|---|---|
| /my/directories | List root directories |
| /my/directories/<id> | Directory detail (sub-dirs + documents) |
| /my/directories/create | Create root directory (POST) |
| /my/directories/<id>/create | Create sub-directory (POST) |
| /my/directories/<id>/upload | Upload document (POST) |
| /my/documents/<id>/download | Download document file |
Odoo Proprietary License v1.0 This software and associated files (the "Software") may only be used (executed, modified, executed after modifications) if you have purchased a valid license from the authors, typically via Odoo Apps, or if you have received a written agreement from the authors of the Software (see the COPYRIGHT file). You may develop Odoo modules that use the Software as a library (typically by depending on it, importing it and using its resources), but without copying any source code or material from the Software. You may distribute those modules under the license of your choice, provided that this license is compatible with the terms of the Odoo Proprietary License (For example: LGPL, MIT, or proprietary licenses similar to this one). It is forbidden to publish, distribute, sublicense, or sell copies of the Software or modified copies of the Software. The above copyright notice and this permission notice must be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Please log in to comment on this module