First setup
After Dolibarr installation, you must setup Dolibarr parameters to match your needs.
Company/Foundation
The first mandatory step is to define your company/foundation. For this, from home page, choose menu "Setup -> Company/Foundation" and edit informations for company or foundation you want to manage.
- Name: Name of your company or foundation
- Logo: Add here a logo of your company (.png, .jpg or .gif). There is no recommended size but the image but the recommended format is png with NO transparent layer (Dolibarr use FPDF that does not support this format).
- Pays: Don't forget to define your country because some other options depends on it.
- VAT: Also tell if you have to manage VAT or not.
Modules
Activation of modules is the second mandatory step. Modules you will enable depends on usage you want to do of Dolibarr. In most cases, you want use all modules, so you have to enable one by one each module you plan to use. For example, to manage a company, you might enable module: Third party, Invoices and Products, but probably a lot of more modules.
To activate modules that you want, go on page "Configuration -> Modules" and click on link "Activate" for each module you need.
List of standard modules is defined on page List of Modules.
If you are not sure of the meaning of a module, you can enable it one by one and see what new menu appears in Dolibarr (also after enabling a module, check that you grant to yourself permissions on new features that was enabled). You can enable or disable a module when you want.
Once module has been activated, some of them need a particular setup (click on icon that appears on the right of line if a module need its own setup). See documentation of module for more informations.
Menus
Choose here which menu manager you want to use for internal and external users. The menu manager change labels, orders and organization of left and top menus. See page Menus system for more information.
Display
On this page, you can define force language of application and the look and feel of screens. In a first use, you can keep everything with default values.
Other (Boxes, Alerts, Security, Limits and accuracy, Emails, Dictionnary...)
Other entries in Setup menu are advanced options. You can forget them if you want.
Users
The last step is to create users and assign permissions. Almost all the modules, even activated earlier, are not accessible if you do not give permissions. To do this, you can go to the Home menu -> Users & Groups to define users and their rights. Attention you should consider to check and reset the user rights when you enable a new modules. The list of rights available depending on the enabled modules enabled (see above), it is recommended to configure permissions after activating the modules you want to use. For certain actions, if you do not have the rights to do an action, Dolibarr will not show you action. You might miss some useful or important features. To give rights to a user or yourself if you are an administrator, go to Home -> Users & Groups, select the desired user, then click on its Permission tab.
Some options are not visible in the interface (often because they are deprecated or beta features). In most cases you do not need these functions and their use may make the application unstable.
To enable them you have to define a constant to 1 in Home - Configuration - Miscellaneous:
Global options
- MAIN_APPLICATION_TITLE => This will change the title of software (that appears on the login page by default).
- MAIN_DISABLE_FULL_SCANLIST => Constant to define to disable complete scan of tables to know the total amount of element to allow the pagination to show total number of pages. To activate on systems with a very important number of data (Tables with more than 500 000 records).
- MAIN_LOGTOHTML => If this constants is defined, it is possible to have logs inside pages by adding the parameter &logtohtml=1 into URL.
- MAIN_AUTOFILL_DATE => If this constant is defined (to something else than 0), the date of invoice, proposal, order or payment are filled with current date. It is highly recommended to NOT ENABLE this feature. This create a lot of input errors with no validated data by users. This lead in bad values saved in database giving headaches when you have to do your accountancy reports ! However some users want it, so we provide it.
- MAIN_AUTOFILL_TOWNFROMZIP => This will fill automatically the town from a zip value. Javascript/Ajax must not be disabled for this feature to work.
- MAIN_MAIL_ALLOW_SENDMAIL_F => On Linux or BSD system, PHP email function use the command sendmail local to server. In some cases, the sender email must be provided on command line of sendmail with option -f. This option is here to ask Dolibarr to call the function mail of PHP by adding value for the option -f. Note that in most cases, even with sendmail, sender email is correctly managed as it is added in the email technical header. This option is here only for rare setup of sendmail that ask the -f option to be mandatory.
- MAIN_MAIL_NO_FULL_EMAIL => Recipient email and sender are cleaned to be on form "<email>" instead of "Name <email>". This might solve problem of compatibility with very old mailers.
- MAIN_MAIL_DEBUG => Write content with header of last mail into file dolibarr_mail.log into directory dolibarr_main_data_root.
- MAIN_USE_HOURMIN_IN_DATE_RANGE => On all entities lines (invoice, order, contract...), it is possible to add hour and minutes with date on fields "date start" and "date end".
- MAIN_REMOVE_INSTALL_WARNING => Remove all security warning that appears to administrator users if URL /install is public. You shoud solve the problem if warning occurs instead of removing this warning. For this, put a file called install.lock into Dolibarr root directory. This will remove warning but also make the page /install not possible to use to protect your installation.
- MAIN_DISABLE_FORCE_SAVEAS => If your browser ask always to save downloaded files on disk (like PDF), try to add this option. File might appears directly into your browser.
- MAIN_DISABLE_PDF_COMPRESSION => Disable PDF compression.
- MAIN_GENERATE_DOCUMENTS_WITHOUT_VAT => Hide all information about VAT on generated documents.
- MAIN_OPTIMIZE_SPEED => Use some speed enhancements, like using the minifying and compressed version of javascript. Apache server must be configured to have the line
AddType text/javascript .jgz AddEncoding gzip .jgz
- MAIN_USE_BACKGROUND_ON_PDF => Define this constant with short name of an image (example "myimage.jpg") that must be saved into directory "documents/mycompany/logos". This will add this background image into your generated PDF files.
- MAIN_INVERT_SENDER_RECIPIENT => Invert sender and recipient in some PDF.
- MAIN_INPUT_DESC_HEIGHT => Number of lines in input area of product lines when editing invoices, proposals, orders, ...
Commercial proposal module
- PROPALE_ADD_DELIVERY_ADDRESS => Activate old feature to input delivery addresses on proposals. You should not use this feature and use instead the tab "proposal contacts" to associate delivery addresses to a proposal.
- PROPAL_CLONE_ON_CREATE_PAGE => On the create proposal page, ask if we want to create the proposal by cloning an already existing one. You should use instead the "Clone" button available on existing proposals.
Invoice module
- FACTURE_VENTILATION => Activate an old feature of accountancy (not working).
- FACTURE_SHOW_SEND_REMINDER => Show link "Send reminder by mail", same feature than "Send by mail" (obsolete feature).
Order module
- COMMANDE_ADD_DELIVERY_ADDRESS => Activate old feature to input delivery addresses on orders or shippings. You should not use this feature and use instead the tab "proposal contacts" to associate delivery addresses to a an order or a shipping.
- COMMANDE_REQUIRE_SOURCE => Make the input field "Source of order" mandatory.
- COMMANDE_VALID_AFTER_CLOSE_PROPAL => When an order is created on a proposal close, the order is directly defined with status "Validated".
- COMMANDE_ADD_DELIVERY_COST_LINE => Add a line with weight if weight is known for product and trigger FraisPort activated.
Export module
- EXPORT_CSV_SEPARATOR_TO_USE => String value to use as separator to delimit fields int exported files (by default Dolibarr use ","). Example: EXPORT_CSV_SEPARATOR_TO_USE=;
- EXPORT_CSV_FORCE_CHARSET => Choose the charset of file built by CSV export. By default: UTF-8. Example: EXPORT_CSV_FORCE_CHARSET=ISO-8859-1
Agenda module
- AGENDA_MAX_EVENTS_DAY_VIEW => Define the maximum number of visible entries for each day in agenda. Default value is 3. Value 0 means no limit.
Product module
- PRODUCT_ADD_TYPE_IN_DOCUMENTS => Add text "Product" or "Service" at beginning of details lines on built PDF documents.
- PRODUCT_SHOW_WHEN_CREATE => Old option no more supported (create problems) to be able to add lines of product during first step of entities creation.
Foundation module
- MEMBER_URL_REDIRECT_SUBSCRIPTION => Link called and shown when a member account is autocreated in member module by a guest user.