Module development: Difference between revisions

Jump to navigation Jump to search
Line 449: Line 449:


= [[File:Art.png]] Create a package to distribute and install your module =
= [[File:Art.png]] Create a package to distribute and install your module =
This process must be used to generate a package to submit it on the http://www.dolistore.com market place.
But you can use it to have a package easy to distribute on your on network.


* Go into the directory '''/build''' and copy the file '''makepack-dolibarrmodules.conf''' into '''makepack-mymodule.conf'''. Warning, this directory may not be provided in some packages of stable versions. If so, it can be retrieved from the CVS snapshot available for download on the Dolibarr website in area "Development version" (taken in this case the whole build directory which is autonomous and independent directory).
* Go into the directory '''/build''' and copy the file '''makepack-dolibarrmodules.conf''' into '''makepack-mymodule.conf'''. Warning, this directory may not be provided in some packages of stable versions. If so, it can be retrieved from the CVS snapshot available for download on the Dolibarr website in area "Development version" (taken in this case the whole build directory which is autonomous and independent directory).
Line 458: Line 460:
perl makepack-dolibarrmodule.pl
perl makepack-dolibarrmodule.pl
</source>
</source>
The script asks you the name of your module, its major and minor version. A file '''mymodule.tgz ''' will then be manufactured containing your module ready to be deployed.
The script asks you the name of your module, its major and minor version. A file '''mymodule.zip ''' will then be manufactured containing your module ready to be deployed.


* The person who receives your module must then place the file in the root directory of a Dolibarr installation and perform the command:
* The person who receives your module must then place the file in the root directory of a Dolibarr installation and perform the command:
<source lang="bash">
<source lang="bash">
tar -xvf monmodule.tgz
tar -xvf monmodule.zip
</source>
</source>


* If you want your module to be public, you can submit it (the tgz file) on Dolibarr web site on download area: {{LinkToPluginDownload}} (you must create an account first and be logged to use the link "Submit a product").
* If you want your module to be public, you can submit it (the zip file) on Dolibarr web site on download area: {{LinkToPluginDownload}} (you must create an account first and be logged to use the link "Submit a product").
** If your module was build correctly, file will be validated later.
** If your module was build correctly, file will be validated later.
** If quality is enough and license permits it, code might be added inside main Dolibarr sources (except if you disagree for that).
** If quality is enough and license permits it, code might be added inside main Dolibarr sources (except if you disagree for that).

Navigation menu