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

Monitoring & Backups

Backups and restore

How to create, download, restore and delete instance backups from the Backups tab, and how to schedule automatic backups on production.

Where backups live

Every instance has a Backups tab in its Console, whatever its stage (production, staging or development). Two exceptions:

  • An app node or read replica in a high availability setup has no Backups tab, because the primary instance takes the backups.
  • In a workspace, a member only sees the tab if they hold the Backups permission on that project.

The list shows the backups stored in the S3 bucket configured for the project, so you need a bucket before the list can show anything. See S3 storage, uploads and bulk backup actions to set one up. The list covers the whole project, not just the instance you opened, so you can, for example, restore a production backup onto a staging instance. A row that comes from another instance carries a badge naming its stage and branch.

Note: A member who can only reach some of the project's instances sees the line "Showing backups of the instances you have access to." Backups of the other instances stay hidden.

Creating a backup

  1. Open the instance in the Console and click the Backups tab.
  2. Click Create Backup.
  3. In the Create Backup dialog, choose one option:
    • Database Only: backs up just the database (faster, smaller size).
    • Full Backup (with Filestore): includes the database and all uploaded files (larger but complete).
  4. The backup runs as a job in the queue. While it runs, a banner at the top of the Console says "Backup in progress on instance…" and clears when the instance reports completion.
  5. Click Refresh in the Backups tab to see the new backup in the list.

Each row shows when the backup was taken, a badge with its type (Full backup, Database only, Uploaded), the full file name, its size and its age.

Downloading a backup

  1. In the Backups tab, find the backup.
  2. Click its Download icon. The file downloads to your computer.

Restoring a backup

Restoring replaces the instance's current database and filestore with the contents of the backup. Download a recent backup of the current state first if you might need it.

  1. In the Backups tab, find the backup you want. The Restore icon only appears on .zip backups.
  2. Click Restore.
  3. Read the Restore Backup dialog. If the backup belongs to a different instance, an amber line says so.
  4. Type restore in the box and click Restore.
  5. The restore runs as a queued job. The Console shows "Restore in progress on instance…" until it finishes.

If the file is not a recognised CICDoo backup, the dialog warns you and asks you to type the file's full name instead of the word restore.

Deleting a backup

  1. In the Backups tab, click the Delete icon on the backup.
  2. In the Delete Backup dialog, type delete and click Delete.

Deletion is permanent. For files that are not recognised CICDoo backups you must type the full file name instead. To delete many backups at once, see S3 storage, uploads and bulk backup actions.

Following backup and restore jobs

  1. In the Console, open the Queue tab.
  2. Find the backup or restore job and click View log.

See Deployments and the job queue.

Scheduling automatic backups

Automatic backups run on production instances only. Staging and development databases are usually rebuilt from production or from your repository, so they have no schedule, but you can still take a backup at any time with Create Backup.

  1. Open the production instance in the Console and click the Settings tab.
  2. Stay on the Odoo sub-tab.
  3. In Backup Schedule, enter one or more times in HH:MM format separated by spaces, for example 02:00 14:00. Leave it empty to turn scheduled backups off.
  4. Optionally set the format fields described below.
  5. Click Save Odoo Configuration.

On staging and development instances the Backup Schedule field reads "No backup schedule".

Backup format settings

These two fields are on the same Odoo sub-tab and apply to every backup of the instance, on any stage:

  • Backup Format: Plain SQL (a SQL dump), Custom (compressed) (a compressed single file that allows a parallel restore), or Directory (parallel) (parallel dump and restore).
  • Backup Parallel Jobs: the number of parallel jobs for the custom and directory formats. 0 means automatic, using all CPU cores.

How long backups are kept

Old backups are removed according to Backup Retention (days) in the project's Storage settings. The clean-up runs as part of an instance's own successful backup and only removes that instance's older backups. An instance without a backup schedule, which is common on staging, never cleans up after itself, so delete its old backups by hand from time to time.

Related: S3 storage, uploads and bulk backup actions, Instance settings explained, Deployments and the job queue, High availability with app nodes.

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

Previous Monitoring your instance Next S3 storage, uploads and bulk backup actions

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