Projects

Projects are containers that organize your Odoo deployments. Each project can have multiple environments (such as development, staging, and production), all sharing the same codebase but running independently.

What is a Project?

A project represents a single Odoo application. Within one project, you can create:

• Multiple environments - separate instances for development, testing, and production
• Git repository connections - link your custom modules for automatic deployments
• Addon repositories - include additional modules from OCA or your organization
• Team access - invite members with different permission levels

Projects define the blueprint. Environments are the actual running Odoo instances.

Create a Project

1. Go to Projects in the sidebar
2. Click the New Project button
3. Select your Organization from the dropdown
4. Fill in the project details:
   • Project Name - A descriptive name (e.g., "ACME ERP System")
   • Project Slug - Auto-generated URL-friendly identifier
   • Description - Optional notes about the project
   • Odoo Version - Select from available versions (14.0 through 19.0)
5. Click Create Project

Your new project will appear in the projects list. Create an environment to start deploying.

Project Overview

When you open a project, you'll see:

• Environment count and deployment count
• Odoo version for the project
• Active environments with status indicators
• Resource allocation showing total CPU, RAM, and disk usage across environments
• Recent deployments with commit information

Connect a Git Repository

Connecting Git enables automatic deployments when you push code changes.

1. Open your project and go to the Repositories tab
2. Click Select Repository or enter the Repository URL
   • Use HTTPS format: https://github.com/username/repo.git
   • Or SSH format: [email protected]:username/repo.git
3. The Git provider (GitHub or GitLab) is detected automatically
4. Select the default branch
5. Save your changes

For private repositories, set up a Git connection first in Settings → Git Connections.

Note: Each environment can track a different branch. The project stores the repository URL - branches are configured per environment.

Addon Repositories

Add extra Odoo modules to your project from shared or custom repositories.

Shared Addons

Include addons from platform or organization repositories:

1. Go to your project's Repositories tab
2. Click Browse Addons
3. Search or filter to find addons
4. Select the ones you want to include
5. Click Apply

Project Addons

Add project-specific addon repositories:

1. Go to your project's Repositories tab
2. Scroll to Project Addons
3. Click Add Repository
4. Enter the Git URL and branch
5. Set the priority (lower = loaded first)
6. Click Save

See Addon Repositories for more details.

Team Members

Invite team members to collaborate on your project.

Roles

Managing Members

1. Open your project and go to the Members tab
2. To invite: Click Add Member, enter email, select role
3. To change role: Click the role dropdown next to a member
4. To remove: Click the remove icon next to a member

Members can be inherited from the organization or added directly to the project.

Project Settings

Access project settings by clicking on a project and selecting the Settings tab.

General Settings

• Name - Update the display name anytime
• Description - Add or modify project notes
• Slug - Cannot be changed after creation (used in URLs)

Danger Zone

• Delete Project - Permanently removes the project and all environments

Edit a Project

1. Go to Projects in the sidebar
2. Click on the project you want to edit
3. Go to the Settings tab
4. Update the fields you want to change
5. Click Save Changes

Delete a Project

Deleting a project permanently removes:

• All environments (development, staging, production)
• All deployment history
• All databases and files on the servers
• Team member assignments

Before deleting:

1. Create backups of any important environments
2. Download any data you want to keep
3. Notify your team members

To delete:

1. Open the project and go to Settings
2. Scroll to Danger Zone
3. Click Delete Project
4. Type the project name to confirm
5. Click Delete

This action cannot be undone.

Projects and Environments

Understanding the relationship between projects and environments:

One project can have many environments. Each environment can run on a different server. This allows you to:

• Keep development separate from production
• Test changes in staging before going live
• Run environments in different geographic regions

Project Status

Project status reflects its overall state:

Deployment History

View all deployments across environments:

1. Open your project
2. Click the Deployments tab
3. See commits, branches, status, and timestamps

Click a deployment to view detailed logs.

Cloning Environments

Duplicate an existing environment within the project:

1. Open your project and go to Environments
2. Find the environment you want to clone
3. Click the Clone button
4. Configure the clone options
5. Choose a sanitization preset (recommended for production data)
6. Click Clone

See Environments for details on cloning.

What's Next?

• Environments - Deploy your first Odoo instance
• Git Connections - Set up repository access
• Addon Repositories - Add custom modules
• Backups - Protect your data