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

Instances & Console

Creating an instance

How to create a staging or development instance from the Console sidebar, pick its base branch and Odoo version, and read the instance header and tabs.

The Console sidebar

Open a project and you land in the Console. The left sidebar lists every instance of the project, grouped by stage:

  • Production (green dot)
  • Staging (amber dot)
  • Development (blue dot)

Each entry shows the instance's branch name and its Odoo version. A thumbtack icon on the version means the instance is pinned to a version other than the project's. A stage with nothing in it shows "No instances". Click an entry to open that instance's console.

The sidebar also has a "Projects" link back to your project list, an "Agent Tasks" link, and a "Project Settings" link at the bottom. In a workspace, "Agent Tasks" and "Project Settings" only appear for members with the matching permission.

Creating a new instance

New instances are created in the Staging or Development groups. Production instances are not created from this sidebar.

  1. Open the project in the Console.
  2. In the sidebar, click the plus (+) button next to Staging or Development.
  3. In the "Create Instance" dialog, enter a Branch Name (for example, feature-xyz). This is the new git branch the instance will run.
  4. Check Fork From, the base branch the new branch is created from. It is pre-filled with your project's default branch (for example main, master or 18.0); change it if you want to start from another branch.
  5. Check the Stage field. It shows the stage of the plus button you clicked and cannot be changed here.
  6. Leave Odoo Version on the project's version (marked "(project)"), or pick another version to rehearse an upgrade. Production is not affected by this choice.
  7. Click Create.

CICDoo creates the branch in your repository and opens the new instance's console. The first deployment then runs as a job in the queue; see Deployments and the job queue.

The Create Instance dialog refuses the request, with a message, when:

  • The branch name or the Fork From branch is empty.
  • An instance with that branch name already exists in the project.
  • No server is configured for that stage in the project. Pick a "Staging Server" or "Development Server" in the project settings first, see Project environments, extensions and deletion.
  • The branch cannot be created in your repository (for example, the Fork From branch does not exist).

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.

Reading the instance header

At the top of every instance console you see:

  • The branch name as the page title.
  • A stage badge: green for Production, amber for Staging, blue for Development.
  • The Odoo version badge, with a thumbtack when the version is pinned for this instance.
  • An Odoo status indicator, showing "Checking..." at first and then a state such as Online, Offline, Down or Degraded.
  • An IDE status indicator, for members who can use the Web IDE. Click it to open the IDE.
  • When external uptime monitoring is active, uptime bars with the uptime percentage and average response time in milliseconds ("Collecting data..." until there is history).
  • The instance domain under the title.
  • The Open Instance button, which opens the running Odoo instance in a new browser tab.

Below the header is a row of quick actions: "Restart", "Connect", "Merge", "Stop" and, on staging and development instances, "Remove". Each button only appears if you have the matching permission. See Restarting, stopping and removing an instance.

The console tabs

Under the quick actions is the tab bar. On narrow screens the tabs show only their icons; hover or widen the window to see the names.

In a workspace, each tab except Commits, Access and Queue needs its own permission. If a member opens a project where nothing has been granted, the console shows "No console access on this project" instead of the tabs.

Related: Branches and instances, Production, staging and development stages, Restarting, stopping and removing an instance.

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

Previous Workspaces and team collaboration Next Restarting, stopping and removing an instance

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