View source for Dolibarr ERP & CRM

Dolibarr ERP CRM is a modern software package to manage your company or foundation's activity . Configuration is handled using the {{nixos:option|services.dolibarr.}} options.

== First login for preinstalled installs ==
Assuming that <code>myhost.org</code> resolves to the ip address of your host, port 80 has been opened and <code>/run/keys/dolibarr-db-ini-password</code> contains the plain-text password for the dolibarr mysql user.
<syntaxHighlight lang=nix>
services.dolibarr = {
  enable = true;
  domain = "myhost.org";
  preInstalled = true;
  initialDbPasswordFile = "/run/keys/dolibarr-db-ini-password";
};
</syntaxHighlight>
This will configure dolibarr to serve on <code>myhost.org</code>, a prefilled database will be provisioned. The following credentials will be configured for the dolibarr admin user:
{|class="table"
!Login
|<code>dolibarrlogin</code> 
|-
!Password
|<code>123dolibarrlogin_pass</code>
|}
Once you're logged in, please make sure to change those default credentials.

== First login for manual installs ==
=== Configure the database (unless <code>initialDbPasswordFile</code>) ===
If you've provided a non-null value for <code>services.dolibarr.initialDbPasswordFile</code>, please skip to the next step. Otherwise, you'll have to create the <code>dolibarr</code> user and configure its password in mysql before going on.
This can simply be done with:
<pre>
$ mysql -u root # root is passwordless by default
MariaDB [(none)]>CREATE USER IF NOT EXISTS 'dolibarr'@'localhost' IDENTIFIED WITH mysql_native_password;
MariaDB [(none)]>GRANT ALL PRIVILEGES ON dolibarr.* TO 'dolibarr'@'localhost';
MariaDB [(none)]>SET PASSWORD FOR 'dolibarr'@'localhost' = PASSWORD('mytopsecretpassword');
</pre>
{{Note|You should obiously replace <code>mytopsecretpassword</code> with your own password.}}
Now that the database is configured, we can open dolibarr in the browser.

=== Start dolibarr install ===
Go to dolibarr's url in the browser with path /install. If we follow the previous example, the url should be <code>http://mydolibarurl/install</code>.

==== Check page (1st) ====
On the check page a form should propose different installation options, choose the <code>FreshInstall</code> option at the bottom of the list and click on <code>Start</code>.

==== Install page (2nd) ====
On the install page :
* set the <code>Directory to store uploaded and generated documents</code> to <code>/var/lib/dolibarr/documents</code> (unless you know what you're doing)
* ensure the <code>Database name</code> is <code>dolibarr</code> 
* ensure the <code>Driver type</code> is <code>mysqli</code> 
* ensure the <code>Database server</code> is <code>localhost</code> 
* ensure the <code>Database port</code> is <code>3306</code> 
* ensure the Database <code>Login</code> is <code>dolibarr</code> 
* ensure the Database password for <code>dolibarr</code> is the same as the one you've configured manually or with {{nixos:option|services.dolibarr.initialDbPasswordFile}} 

==== Install step 1 (3rd) ====
Nothing to do here, just check that the displayed data is correct and continue.

==== Install step 2 (4th) ====
Again, nothing to do here, just check that the displayed data is correct and continue.

==== Install step 4 (5th) (no that's not a typo XD) ====
Setup your dolibarr admin user's login and password.

==== Install step 5 (6th) ====
That's it, you're done, dolibarr is installed.

== Nixops integration ==
If you're willing to deploy dolibarr threw [https://nixos.org/nixops/manual NixOps], you can use its key capabilities to delegate the configuration of the database entirely with the help of the {{nixos:option|services.dolibarr.initialDbPasswordFile}} option. Here is a nixops machine configuration:
<syntaxHighlight lang=nix>
{
  deployment = {
    keys.dolibarr-db-ini-password = {
      text = "123dolibarr_pass";
      user = "root";
      group = "root";
      permissions = "0440";
    };
  };

  services.dolibarr = {
    enable = true;
    domain = "146.190.238.159";
    preInstalled = true;
    initialDbPasswordFile = "/run/keys/dolibarr-db-ini-password";
  };
}
</syntaxHighlight>

== Development ==
The {{nixos:option|services.dolibarr.preInstalled}} option is made possible by automatically filling the install page form and then dumping the dolibarr database to a file. The dolibarr nixosTests is made for that (and to test if dolibarr still works obviously). To generate a new dump for a preinstalled database, just run:
<pre>
$ nix-build -A nixosTests.dolibarr
$ file result/result/dolibarr-db.sql
</pre>
The dump file will be stored in <code>./result/dolibarr-db.sql</code>

== See more ==
* [https://www.dolibarr.org/documentation-home.php Official Documentation]

[[Category:Applications]]
[[Category:Server]]