MailDesk docs
Installation and first setup

Install on Odoo.sh

2 min read Odoo 18.0

This page shows how to add MailDesk to an Odoo.sh project and install it.

Who this is for: the Odoo administrator of an Odoo.sh project. You need: access to the Odoo.sh project's Git repository, and administrator access to the Odoo database. If you only have the Odoo web interface, ask the person who manages the repository to do steps 1 to 4.

Before you begin

  • Read Install MailDesk: choose your setup for the version, edition and backup checklist.
  • Work on a Development branch first. Do not start on Production.
  • Download the MailDesk files for your Odoo version from your account (the /my/modules page).

Steps

1. Add the module folders to the repository

  1. Unzip the download on your computer.
  2. Copy the MailDesk module folders into your custom addons folder in the repository, for example custom_addons/.
  3. Check that each module folder contains __manifest__.py:
custom_addons/
└── maildesk_mail_client/
    ├── __manifest__.py
    └── ...

Copy MailDesk Pro and the bridges only if they are part of your purchase.

What you should see: custom_addons/maildesk_mail_client/__manifest__.py exists in your working copy.

2. Add the Python packages to the repository's requirements.txt

Odoo.sh reads requirements.txt only in the root of the branch, or in the folder that holds the module folders. A requirements.txt inside a module folder is not read, so the packages are not installed from there.

Add these lines to the requirements.txt in the repository root. Create the file if it does not exist.

imapclient==3.0.1
google-api-python-client==2.187.0
google-auth==2.43.0
google-auth-httplib2==0.2.1
msal==1.34.0

If you install MailDesk Pro and use AI features, also add the packages of your AI provider. See the list of Python packages.

What you should see: the root of the branch contains requirements.txt with these packages.

3. Commit and push to the Development branch

  1. Commit the module folders and requirements.txt.
  2. Push to your Development branch.
  3. In Odoo.sh, open the Builds view and wait for the new build.

What you should see: the build for your commit finishes green. Odoo.sh installs the Python packages during this build.

4. Update the Apps list and install

  1. Open the database of the Development build and turn on developer mode.
  2. Go to Apps ▸ Update Apps List and confirm.
  3. Search for MailDesk and click Install on MailDesk Basic.
  4. Install Pro and the bridges that are part of your purchase.

What you should see: a MailDesk menu in the top bar.

5. Promote step by step

  1. Test on Development.
  2. Promote to Staging and test on a copy of production.
  3. Merge to Production, then install the modules in the production database.

If it does not work

  • The build is red. Open the build log. Check that requirements.txt is in the branch root and each line is valid.
  • Install fails with a missing Python module. The package is not in the root requirements.txt. Add it, push, and wait for a green build.
  • MailDesk is not in the Apps list. Check that the module folders are in the pushed branch, then click Update Apps List again.

Next step

Activate your license.

Prefer not to do this yourself?

Metzler IT offers an installation service that is quoted separately on request. It is not included with the licence.