Install on your own server
This page shows how to install MailDesk on a server you manage: on-premise, a VPS or Docker.
Who this is for: the person who manages your Odoo server.
You need: shell access to the server (or Docker host), permission to edit odoo.conf, permission to restart Odoo, and administrator access to the Odoo database.
If you only have the Odoo web interface, you cannot complete these steps. Ask your server administrator or your hosting provider to do steps 1 to 4.
Plan some time
Installing takes longer than reading this page. Do it in a quiet period, on a staging copy first.
Before you begin
- Read Install MailDesk: choose your setup for the version, edition and backup checklist.
- Take a full database backup.
- Download the MailDesk files for your Odoo version from your account (the /my/modules page).
Steps
1. Copy the module folders to your custom addons directory
- Unzip the download.
- Copy the module folders into your custom addons directory, for example
/opt/odoo/custom_addons/. - Copy MailDesk Pro and the bridges only if they are part of your purchase.
What you should see: /opt/odoo/custom_addons/maildesk_mail_client/__manifest__.py exists, and the module folder name is directly under the addons directory.
2. Check addons_path
- Open your
odoo.conf. - Make sure the custom addons directory is listed in
addons_path.
What you should see: the directory from step 1 appears in addons_path. With Docker, the directory must also be mounted into the container.
3. Install the Python packages
Activate the Python environment that Odoo uses, then run:
pip install 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
You can also run pip install -r requirements.txt with the requirements.txt file inside the MailDesk Basic module folder. For MailDesk Pro AI libraries, see the list of Python packages.
What you should see: pip ends without errors. With Docker, run it inside the Odoo image or container, and rebuild the image so the packages stay.
4. Restart Odoo
Restart the Odoo service so it reads the new addons path and packages.
What you should see: Odoo starts without errors in the log.
5. Update the Apps list and install
- Log in to Odoo and turn on developer mode.
- Go to Apps ▸ Update Apps List and confirm.
- Search for MailDesk and click Install on MailDesk Basic.
- Install Pro and the bridges that are part of your purchase.
What you should see: after Update Apps List, MailDesk appears in Apps. After the install, a MailDesk menu is in the top bar.
If it does not work
- MailDesk is not in the Apps list. Check that the folder is inside a path from
addons_path, that it contains__manifest__.py, and that you restarted Odoo. Then click Update Apps List again. - Odoo says a Python module is missing. The packages were installed in a different Python environment than the one Odoo uses. Install them again in the right one and restart.
- Docker: the module disappears after a restart. The addons directory is not mounted as a volume, or the packages were installed in a container that was recreated.
Next step
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.