Skip to content

Connect a Git repository

A project is one Odoo codebase: an Odoo version, the repository with your modules, and the environments that run it.

  1. Open Projects and press New project.
  2. Enter a Name (lowercase letters, digits, - and _, for example shop-erp), an optional Description, and choose the Odoo version.
  3. Create it. The project’s page opens.

2. For a private repository: add a Git connection

Section titled “2. For a private repository: add a Git connection”

A public repository needs no connection. Skip to step 3.

  1. Open Settings → Git connections and press Add a Git connection.
  2. Choose the Provider: GitHub, GitLab, or Other / self-hosted for any Git host that works over HTTPS.
  3. Enter a Name (for example company GitHub) and the Access token: a token that can read the repositories. Some Git servers also need the Username the token belongs to.
  4. Press Add connection.

The token is checked with the provider at once, stored encrypted, and never shown again.

  1. On the project’s page, open the Repositories tab.
  2. Press Set the main repository.
  3. Enter the Repository URL, for example https://github.com/you/repo.git.
  4. Choose the Git connection, or None (a public repository).
  5. Press Load branches and choose the Branch. Without loading the branches, the repository’s default branch is used.
  6. Save.

The platform reads the repository’s branches right away, so a wrong address or a token without access is reported here, not at the first deploy.

Deploy your first environment.