Step-by-Step Guide: Installing and Configuring a Module in Dolibarr
   03/07/2025 00:00:00     Dolibarr    0 Comments
Step-by-Step Guide: Installing and Configuring a Module in Dolibarr

Dolibarr is an open-source ERP and CRM solution widely used by businesses to efficiently manage their administrative, accounting, and commercial activities. One of Dolibarr's key strengths is its modularity, allowing users to add features based on their specific business needs.

Whether you need to manage invoices, stock, projects, or human resources, installing and configuring modules enables you to customize Dolibarr and optimize your business processes.

In this article, we will go step by step through the installation and configuration of a module in Dolibarr, explaining the different installation methods, essential settings, and best practices to ensure a smooth setup.


1. Where to Find Dolibarr Modules?

Dolibarr offers multiple sources for downloading modules:

  • Built-in Modules: Some modules come pre-installed with Dolibarr and only need to be activated.
  • Dolistore: The official Dolibarr store offers a wide range of free and paid modules to extend functionalities.
  • Alternative Marketplaces: Some developers offer modules on platforms like GitHub, GitLab, DolibarrStore, and Dolimarketplace.
  • Custom Development: Businesses with specific needs can develop and install their own modules.

Before installing a module, always verify its compatibility with your Dolibarr version.


2. Methods for Installing a Module in Dolibarr

There are three main methods to install a module in Dolibarr:

2.1 Installing via the Dolibarr Interface

If the module comes from Dolistore or an official source, you can install it directly from Dolibarr’s interface:

  1. Log in to Dolibarr as an administrator.
  2. Navigate to "Home" → "Setup" → "Modules/Applications".
  3. Click "Add an external module".
  4. Upload the ZIP file of the module.
  5. Click "Upload", and Dolibarr will install the module.

Once installed, the module will appear in the available modules list.


2.2 Manual Installation via FTP or SSH

If you downloaded a module from an external source (e.g., GitHub or a third-party developer), you must install it manually:

  1. Download the module ZIP file.
  2. Unzip the file on your computer.
  3. Upload the module folder to the following Dolibarr directory:
    bash
    htdocs/custom/
  4. Ensure proper file permissions:
    bash
    chmod -R 755 htdocs/custom/mymodule
  5. Access Dolibarr, navigate to "Modules/Applications", and the module should appear in the list.

2.3 Installation via Git

For installing a module directly from a Git repository (useful for automatic updates), follow these steps:

  1. Connect to your server via SSH.
  2. Navigate to the htdocs/custom/ directory:
    bash
    cd /var/www/html/dolibarr/htdocs/custom/
  3. Clone the module from GitHub or GitLab:
    bash
    git clone https://github.com/projectname/mymodule.git
  4. Set the correct file permissions:
    bash
    chmod -R 755 mymodule
  5. The module will automatically appear in Dolibarr under "Modules/Applications".

3. Activating a Module in Dolibarr

After installing a module, it must be activated:

  1. Go to "Home" → "Setup" → "Modules/Applications".
  2. Locate your module in the installed modules list.
  3. Click "Activate".
  4. Follow any additional setup instructions provided by the module.

Some modules require running an SQL script to create database tables. Dolibarr will notify you if this step is necessary.


4. Configuring a Module After Installation

Each module may have specific settings that need to be configured:

  1. Access the module’s settings

    • After activation, click "Configure" next to the module.
    • Adjust the parameters according to your business needs.
  2. Manage user permissions

    • Navigate to "Home" → "Users & Groups".
    • Assign the appropriate access rights to users who need the module.
  3. Test the module

    • Perform functionality tests to ensure everything works correctly.
    • Check Dolibarr’s logs for errors:
      bash
      tail -f htdocs/documents/dolibarr.log

5. Updating or Uninstalling a Module

5.1 Updating a Module

If a new version of the module is available, follow these steps:

  • Via the Dolibarr interface: Download the updated version and reinstall the module.
  • Via FTP/Git: Replace the existing files in htdocs/custom/ and check if any database updates are required.

Before updating, always create a full backup of your Dolibarr system.


5.2 Uninstalling a Module

If you no longer need a module, you can uninstall it:

  1. Disable the module in "Modules/Applications".
  2. Delete its folder from htdocs/custom/.
  3. Remove any associated database tables if necessary (proceed with caution).

6. Best Practices for Installing Dolibarr Modules

  • Always verify compatibility of the module with your Dolibarr version.
  • Test the module in a staging environment before deploying it in production.
  • Create a full backup before installing or updating a module.
  • Never modify core module files to avoid issues during updates.
  • Use modules from trusted sources, such as Dolistore, GitHub, DolibarrStore, or Dolimarketplace.

Conclusion

Installing and configuring a module in Dolibarr allows you to extend the ERP’s functionalities and tailor the system to your specific needs. By following this guide, you can download, install, activate, and configure your modules with ease.

Whether for commercial management, invoicing, stock tracking, or project management, Dolibarr’s modules provide advanced customization and improved business operations.

Have you installed a module in Dolibarr before? Share your experience in the comments!

Comments

Log in or register to post comments