All articles

Getting Started

What is CICDoo Getting started: the onboarding wizard The Dashboard and Infrastructure Map

Concepts

Production, staging and development stages Domains, subdomains and SSL Odoo versions and editions (Community vs Enterprise) Workspaces and team collaboration

Servers

Adding a server Server domains and DNS Using a load balancer Server actions: deploy, logs and charts Deleting a server

Projects & Git

Creating a project Connecting GitHub Project GitHub settings and webhook Connecting GitLab Branches and instances Tagging and filtering projects High availability with app nodes Project environments, extensions and deletion

Instances & Console

Creating an instance Restarting, stopping and removing an instance Merging branches between stages Web IDE and remote access SSH access to instances Instance settings explained Deployments and the job queue

Agent Tasks

What agent tasks are Setting up agent tasks Running a task and reviewing the result Agent time and top-ups Agent insights and task filters

Monitoring & Backups

Monitoring your instance Backups and restore S3 storage, uploads and bulk backup actions Alert notifications (email and SMS)

Workspaces & Permissions

Inviting workspace members Member permissions and resource access A member cannot see or use a resource Audit log and server activity

Account & Security

Two-factor authentication (2FA) Profile and integrations settings Passwords and account recovery

Billing & Plans

Plans and pricing Upgrading and managing your subscription If a project subscription goes unpaid The channel partner program Onboarding a client as a partner

Support & Tickets

Opening a support ticket Getting help from the CICDoo team

Troubleshooting

Troubleshooting: cannot connect a server Troubleshooting: a deployment failed Troubleshooting: git push fails with 403 after moving a repository Troubleshooting: my instance is down or slow Troubleshooting: domain or SSL problems

Projects & Git

Branches and instances

How Git branches map to instances, how to create a staging or development instance from a branch, and where to follow commits and deployments.

How branches map to instances

Each instance of a project runs one Git branch on one server.

  • Production runs the project's default branch. It is created with the project, on the production server you picked.
  • Staging and Development instances run branches you create from the console, on the staging or development server set for the project.

When you open a project, the console sidebar lists its instances under "Production", "Staging" and "Development". Each entry is named after its branch and shows its Odoo version. Click an entry to open that instance's console. See Production, staging and development stages.

Creating a staging or development instance

You need a server for that stage first: set a "Staging Server" or "Development Server" on the Environments tab of the project settings. See Project environments, extensions and deletion.

  1. Open the project console (the "Branches" button on the project card).
  2. In the sidebar, click the plus button next to "Staging" or "Development".
  3. In the "Create Instance" window, enter a "Branch Name", for example feature-xyz. This is the new Git branch.
  4. Check "Fork From", the branch the new one is created from. It is pre-filled with the project's default branch.
  5. Check "Stage". It shows the stage you clicked and cannot be changed here.
  6. Leave "Odoo Version" on the project's version, marked "(project)", or pick another one to test an upgrade. Production is not affected.
  7. Click "Create".

CICDoo creates the branch in your repository and the instance under its stage in the sidebar. The first deployment then runs as a job. For the full list of reasons the window can refuse a request, see Creating an instance.

Note: In a workspace, the plus buttons are only shown to members who have the "Create instances" permission on the project. See Member permissions and resource access.

Deploying by pushing code

  1. Push commits to the branch an instance runs, from your computer or the Web IDE.
  2. GitHub or GitLab notifies CICDoo, which queues a deployment for that instance.
  3. Open the instance console. While work is in progress, a "Working on instance…" banner shows at the top and clears when the instance reports completion.
  4. Open the "Queue" tab to follow the job, and the "Commits" tab to see the new commits under "Recent Commits". Both tabs have a "Refresh" button.

If a push or a merge does not upgrade the instance, the project's push webhook may be missing. See Project GitHub settings and webhook.

The instance console at a glance

At the top of an instance console you see the branch name, a stage badge, the instance's domain and an "Open Instance" button, plus actions such as "Restart", "Connect", "Merge", "Stop" and, on staging and development, "Remove". The tabs below include "Commits", "Access", "Queue", "Logs", "Monitoring", "Backups" and "Settings". Each action and tab only shows when you have the matching permission, and "Backups" is hidden on high availability app nodes. See Creating an instance for a full tour.

Related: Creating a project, Merging branches between stages, Deployments and the job queue, Restarting, stopping and removing an instance.

If you get stuck, open a support ticket from the Tickets page or the chat widget.

Previous Connecting GitLab Next Tagging and filtering projects

Still stuck? Open a ticket from the app or talk to an engineer.