2.3.2. Installation of TalerBarr

Before you install TalerBarr, make sure you already have a working Dolibarr instance. TalerBarr is a Dolibarr module and does not replace the ERP itself.

You also need access to a GNU Taler merchant backend. The module can connect either to your own merchant backend or to a hosted multi-tenant deployment. If you still need to prepare the backend side, see Installation sur Debian and Obtain an Instance. For general Dolibarr installation instructions, see Dolibarr installation documentation. Alternatively, if you have developer experience, see Install Dolibarr and Talerbarr from the Command Line. That tutorial only shows how we, as TalerBarr developers, install Dolibarr for this tutorial showcase.

2.3.2.1. Conditions préalables

Simply speaking you need to have:

1. Dolibarr of v22+

2. Taler Merchant Instance

In majority of cases this is more than enough.

More specifically, you need to prepare the following components first:

• PHP 8.0 or newer

• Administrator access in Dolibarr to install and enable external modules

It is also recommended to enable the standard Dolibarr modules that TalerBarr operates with: - Products - Stocks - Categories or tags - Banks and cash - Invoices - Scheduled jobs

2.3.2.2. Installation methods

TalerBarr can be installed in two common ways:

1. From a packaged release, for example through DoliStore or a release zip

2. From the source repository, which is useful for development or testing

2.3.2.3. Install from a release package

2.3.2.3.1. Obtaine project .zip file

This is the simplest option for a regular Dolibarr deployment. Releases in this case can be considered as .zip file it is available in 3 places:

1. DoliStore

   

   TalerBarr package page in DoliStore.

2. TalerBarr releases on GitHub

   

   TalerBarr release page in github.

3. TalerBarr on Taler git repository

   

   TalerBarr page in Taler Git.

2.3.2.3.2. Installing it in the Dolibarr

To do this, open your Dolibarr instance, log in as an administrator, and make sure the required modules are enabled. From the home page, click Setup in the left sidebar, then open Setup -> Modules/Applications as shown in the figure below.

Dolibarr setup navigation.

Next, click Deploy/install external app/module. Then click Choose file and select the freshly downloaded .zip archive, as shown in the figure below.

Dolibarr external module installation page.

The file that u have uploaded is now shown. Press Upload button, and module will be added, as confirmation message in the right top corner will appear.

TODO: add images module_selected.png and module_deployed.png

2.3.2.4. Install from the source repository

You can install the module from source in two common ways.

If you are following the earlier developer-oriented Dolibarr setup from Install Dolibarr and Talerbarr from the Command Line, place the module in ~/dolibarr/custom:

cd ~/dolibarr/custom
git clone https://github.com/bohdanpotuzhnyi/talerbarr.git

For a more standard Dolibarr installation, place the module in $DOLIBARR_HOME/htdocs/custom, unless your Dolibarr provider or the official Dolibarr installation guide for your installation type states otherwise:

cd $DOLIBARR_HOME/htdocs/custom
git clone https://github.com/bohdanpotuzhnyi/talerbarr.git

Alternatively, you can also use talerbarr from the taler git, it is not different from the one on github:

git clone git://git.gnunet.org/talerbarr.git

After the files are present, refresh the Dolibarr modules page. Dolibarr should detect the new module automatically.

2.3.2.5. Enable the module

To enable the module, open Setup -> Modules/Applications.

Find TalerBarr in the module list and enable it using the toggle shown in the figure below. Label 1 marks the activation control. After activation, the toggle turns green, as shown in label 2.

TalerBarr activation in Dolibarr. Label 1 marks the enable toggle and label 2 shows the active state.

After the module is enabled, TalerBarr appears in the top navigation bar (Label 1). Open it to access the module for the first time. As no configuration exists yet, TalerBarr shows the initial configuration screen and asks you to create one, as shown below.

Initial TalerBarr configuration page shown after opening the module without an existing configuration.

For details about the configuration flow, continue with Configure TalerBarr.

2.3.2.6. What happens after activation

When the module is initialized, TalerBarr prepares the Dolibarr side for the Taler payment flow. Based on the module design, this includes helper objects such as:

• A default customer for Taler-originated orders

• A Taler payment method

• A clearing-account based accounting flow used for reconciliation

This means the module is intended to handle the full path from product synchronisation to order settlement.

2.3.2.7. Next step

After the module is installed and enabled, continue with Configure TalerBarr to connect Dolibarr to your Taler merchant backend and choose the synchronisation mode.