A complete, step-by-step guide to install the addon and start using the Gantt timeline – written for new users.
Overview
Welcome! This page walks you through everything needed to get Projects Gantt Planner running in your Odoo system – from downloading the addon folder to seeing the Gantt menu on your screen.
Projects Gantt Planner adds a visual timeline (Gantt chart) to Odoo’s Project app. You can drag tasks on a calendar, plan dates, and track progress. It works on Odoo 17 Community – you do not need Odoo Enterprise.
Who does what? Steps 1-6 are usually done by your system administrator or IT person (someone with server access). Steps 7-9 can involve both the administrator and your team manager who assigns user permissions. If you are a regular team member, share this guide with your admin and jump to Getting Started once the app is installed.
Before installing, make sure the standard Project app is already available in Odoo. Projects Gantt Planner builds on top of Project – it cannot work without it.
How It Works
Installing an Odoo addon follows a simple chain:
- You place the addon folder on the server where Odoo runs.
- Odoo is restarted so it can detect the new folder.
- You refresh the list of apps inside Odoo and install Projects Gantt Planner.
- Odoo loads menus, views, and optional sample (demo) data.
- Each user who should see the Gantt must have the right Project access rights.
The addon folder name on disk is projects_gantt_planner. In the Apps screen it appears as Projects Gantt Planner.
Step-by-Step Guide
Download the latest copy of the addon
- Get the addon package. Download the latest version of Projects Gantt Planner from your vendor, partner, or internal file share. You should receive a folder named projects_gantt_planner (or a ZIP file that contains this folder).
- Check the folder name. Inside the package, the main folder must be called exactly
projects_gantt_planner. Odoo uses this technical name to find the module. Do not rename it. - Confirm it is for Odoo 17. This guide is for version 17.0. Using the addon on a different Odoo version may cause errors.
- Keep a backup. Save a copy of the downloaded folder in a safe place before uploading, so you can reinstall or restore it later if needed.
Upload the addon folder to Odoo's addons directory
- Locate your addons path. On the server, Odoo reads addons from one or more folders. Common locations are:
- addons – standard Odoo addons folder
- custom_addons – a separate folder many companies use for custom modules
Your administrator knows which path is configured in the Odoo config file (
odoo.conf), in the settingaddons_path. - Copy the folder. Upload or copy the entire projects_gantt_planner folder into that addons directory. The result should look like:
.../custom_addons/projects_gantt_planner/Inside you should see files such as
__manifest__.pyand folders likemodels,views, andstatic. - Do not nest the folder twice. A common mistake is uploading
custom_addons/projects_gantt_planner/projects_gantt_planner/. Odoo expects only one level: the manifest file must sit directly insideprojects_gantt_planner. - Set file permissions (Linux servers). The Odoo system user must be able to read the folder. Your server administrator usually handles this.
Restart the Odoo service
- Why restart? Odoo scans addon folders when it starts. After you add a new folder, a restart is required so Odoo can see projects_gantt_planner.
- Ask your administrator to restart Odoo. This may be a Windows service, a Linux systemd service, or a Docker container – depending on how your company hosts Odoo.
- Wait until Odoo is fully running again. Open your Odoo URL in the browser and confirm you can log in normally before continuing.
Activate Developer Mode in Settings
- Log in as an administrator – a user who can open Settings and install apps.
- Open Settings. Click the Settings app (gear icon) from the main Odoo home screen.
- Scroll to the bottom of the Settings page. Find the link Activate the developer mode (or Developer Tools → Activate the developer mode).
- Click it. The page reloads. Developer mode is now on. You may see extra technical menus and a bug icon – this is normal.
- Why is this needed? Developer mode unlocks the Update Apps List option, which is required after adding a new addon folder manually. Without it, Odoo may not show your new module in the Apps list.
Update the Apps List
- Open the Apps menu. From the Odoo home screen, click Apps.
- Open the Apps list menu. Click the ⋮ (three dots) or the Update Apps List option in the top menu (visible when Developer Mode is active).
- Confirm the update. A dialog asks you to confirm. Click Update. Odoo will scan all addon folders again.
- Wait for completion. This may take a few seconds to a minute. When finished, new modules – including Projects Gantt Planner – become searchable in Apps.
- Remove the “Apps” filter if needed. In the Apps search bar, clear filters like Apps so you can also find modules that are not yet installed.
Search for the addon in Apps and activate (install) it
- Go to Apps and type Projects Gantt Planner or Gantt in the search box.
- Find the correct module. Look for the app named Projects Gantt Planner under category Services / Project. The technical name is projects_gantt_planner.
- Install Project first (if not already installed). This addon requires the standard Project app. If Project is not installed, install it before or together with the Gantt addon.
- Click Activate (or Install). Odoo installs the module. Wait until the process completes – do not close the browser tab during installation.
- Installation succeeded? You should see no error message. The button changes to Installed or offers an Upgrade option for future updates.
Demo data (sample projects and tasks)
- What is demo data? Sample projects and tasks that help you explore the Gantt chart immediately, without creating everything from scratch.
- When does it install? Demo data loads automatically only if your Odoo database was created with demo data enabled, or if you install the module on a database that uses demo content. On a clean production database, demo data is usually not loaded – and that is normal.
- What demo content is included? This addon can create sample timeline projects (such as a timeline lab with tasks spread across weeks) and planned dates on standard project demo tasks. Your administrator sees this only when demo mode is active for the database.
- Production systems: Most live company databases should not use demo data. After installation, create your own projects and tasks, then set Planned Start and Planned End on tasks to see them on the Gantt.
- Want to practice first? Ask your administrator to set up a separate test database with demo data enabled. Use that sandbox to learn the Gantt before working on real projects.
Give users permission to access the Gantt
- Open Settings → Users & Companies → Users. You need administrator access for this step.
- Select the user who should use the Gantt (for example, a project manager or team member).
- Open the Access Rights tab on the user form.
- Find the Project section. Projects Gantt Planner does not add a separate permission checkbox – it uses the standard Project app rights. Set one of:
- User – can use projects and tasks (suitable for most team members)
- Administrator – full project control (suitable for project managers)
- Ensure the Project app is enabled for that user. Under Application Access or the user’s home menu, the Project app must be available. Without Project access, the Gantt menus will not appear.
- Save the user record. Repeat for every team member who needs the Gantt timeline.
- Settings access (admins only). To change Gantt defaults (scale, colors, weekends), a user also needs access to Project → Configuration → Settings, which typically requires project manager or administrator rights.
Refresh Odoo and confirm the Gantt menu is visible
- Log out and log back in as the user you configured – or press Ctrl + F5 (hard refresh) in the browser to clear cached menus.
- Open the Project app from the Odoo home screen.
- Look for the new menu: Projects Gantt Planner. You should see it in the main Project menu with these entries:
- Tasks – all tasks on the Gantt timeline
- Projects – projects shown as timeline bars
- By Project – tasks grouped under each project
- Click Tasks. The Gantt view should open. If tasks have planned dates, you will see colored bars on the timeline.
- Success checklist:
- Menu Projects Gantt Planner is visible under Project
- Gantt view opens without an error
- You can switch view modes using the icon bar (Gantt, List, Kanban, etc.)
- Opening a project form shows a Tasks stat button when tasks exist
- If the menu is missing, go back to Step 8 and confirm the user has Project access. Also confirm Step 6 completed without errors.
Fields Table
| Field Name | Description | Example |
|---|---|---|
Addon folder name |
Technical folder name on the server – must not be renamed |
projects_gantt_planner |
App name (in Apps menu) |
Friendly name shown when searching to install |
Projects Gantt Planner |
addons_path |
Server setting listing folders where Odoo looks for modules |
/odoo/custom_addons |
Developer Mode |
Special mode that shows technical tools like Update Apps List |
Activated |
Project / User access |
Permission level allowing a user to work with projects and tasks |
User |
Project / Administrator access |
Full access to projects, tasks, and project settings |
Administrator |
Demo data |
Optional sample records loaded only on demo-enabled databases |
Sample timeline tasks |
Projects Gantt Planner menu |
New menu added under Project after successful install |
Tasks, Projects, By Project |
Field Explanations
Addon folder name
Odoo identifies modules by their folder name on disk. For this product it is always projects_gantt_planner. Renaming breaks installation.
App name (in Apps menu)
What you search for when installing. Matches the title in __manifest__.py: Projects Gantt Planner.
addons_path
A server configuration value. Your IT team adds custom_addons here so Odoo can discover modules you upload. End users normally do not edit this file.
Developer Mode
A switch in Settings for administrators. It exposes tools needed after manually copying an addon folder. It does not need to stay on forever – but keep it on until installation is finished.
Project / User access
Lets a person open the Project app, see tasks, and use the Gantt. This is the minimum right for everyday planners and team members.
Project / Administrator access
Gives full control over projects and configuration. Assign to project managers who also need to change Gantt settings under Project Configuration.
Demo data
Practice content – not real business data. Helpful on training databases; usually skipped on live production systems.
Projects Gantt Planner menu
Your proof that installation worked. Appears under Project once the module is installed and the user has Project app access.
Tips
- Install on a test database first if you are new to Odoo. Repeat the same steps on production once you are comfortable.
- After installation, open Customizing Your Gantt to set your team’s default week view, bar colors, and weekend shading.
- If you upgraded from an older module called project_gantt_view, uninstall the old one before installing Projects Gantt Planner to avoid conflicts.
- Keep a note of which addons folder you used (
addonsvscustom_addons) – it saves time during future updates.
Common Mistakes
- Skipping the Odoo restart (Step 3) The new folder exists on disk but Odoo does not know about it yet. Always restart after uploading an addon.
- Not updating the Apps list (Step 5) Without Update Apps List, the module never appears in search even if the folder is correct.
- Wrong folder structure (Step 2) The
__manifest__.pyfile must be insideprojects_gantt_planner, not in a parent or child folder with a different name. - Project app not installed (Step 6) Projects Gantt Planner depends on Project. Install Project first.
- User has no Project access (Step 8) The Gantt menus live inside the Project app. No Project rights means no Gantt menu – even if the module is installed.
- Not refreshing the browser (Step 9) Menus are cached. Hard-refresh or log in again after changing user permissions.
Quick Reference – Installation at a Glance
| Step | Action | Who |
|---|---|---|
1 |
Download projects_gantt_planner folder |
Admin / IT |
2 |
Upload to addons or custom_addons |
Admin / IT |
3 |
Restart Odoo service |
Admin / IT |
4 |
Activate Developer Mode in Settings |
Admin |
5 |
Apps → Update Apps List |
Admin |
6 |
Search Projects Gantt Planner → Activate |
Admin |
7 |
Demo data loads only on demo databases (optional) |
Automatic |
8 |
Users → Access Rights → Project: User or Administrator |
Admin / Manager |
9 |
Refresh browser → check Project → Projects Gantt Planner |
End user |