Difference between revisions of "First setup"

From Dolibarr ERP CRM Wiki
Jump to navigation Jump to search
Visual
Tag: 2017 source edit
 
(81 intermediate revisions by 12 users not shown)
Line 1: Line 1:
−
[[Category:Admin]]
+
<!-- BEGIN interlang links -->
 +
<!-- Do NOT edit this section
 +
    Links below are automatically managed by PolyglotBot
 +
    You can edit links on the English source page : Configuração_inicial -->
 +
[[fr:Premiers_paramétrages]]
 +
[[de:Grundeinstellungen]]
 +
[[es:Primeras_configuraciones]]
 +
[[zh:设置]]
 +
[[ja:JA_First_setup]]
 +
<!-- END interlang links -->
 +
 
 +
[[Category:Admin_en]]
 
{{TemplateDocUser}}
 
{{TemplateDocUser}}
  
−
After Dolibarr installation, you must setup Dolibarr parameters to match your needs.
+
After completing the initial installation, you must configure parameters in Dolibarr to match your needs.
  
−
= Company/Foundation =
+
=Company/Organization=
−
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.
+
The first mandatory step is to define your company/organization information. For this, from home page, choose menu  "'''Home->Setup->Company/Organization'''" and add the information for your company/organization.
  
−
* '''Name:''' Name of your company or foundation
+
*'''Name:''' Name of your company/organization
−
* '''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).
+
*[[File:Logo size.jpg|thumb]]'''Logo:''' Add here a logo of your company (.png, .jpg or .gif). It can accept any size but it is recommended to use a logo with 130 pixels height and up to 800 pixels width. Here is a little scheme on what will be the result on the PDF. The recommended format is png.
−
* '''Pays:''' Don't forget to define your country because some other options depends on it.
+
*'''Logo (squared):''' Add here your squared logo (.png or .jpg) that will be used in the top right corner of the application
−
* '''VAT:''' Also tell if you have to manage VAT or not.
+
*'''Fiscal Year:''' Define your starting month of yiscal Year
 +
*'''Country:''' Define your country: other options depend on this selection.
  
−
= Modules =
+
*'''Prof ID X:''' The fields Prof ID are used to store the professional IDs of a company. Each country requires its own professional ID. For example, for a company in France you may find a SIRET, SIREN, NAF, RCS and EORI number, and for a company in Argentia, you will find CUIT/CUIL, Ingresos Brutos, CIF Intra. Dolibarr is able to manage 6 Professional ID. The label of each of them is defined with the translation key ProfIdXCC (where X is 1 to 6 and XX the country code of the company, for example XX=FR). To add a new Professional ID, you can add a new translation from menu Home - Setup - Translation for the key ProfIdXCC. If you set the value of translation to "-", it means that the professional ID is hidden when using the application in the language of translation on every company that has the country code XX.
−
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.
 
  
−
List of standard modules is defined on page [[:Category:List of Modules|List of Modules]].
+
*'''Sales Tax (VAT) Management:''' Define how you manage Sales Tax (or not).
 +
*'''Second type of tax:''' Define if you would like to use second type of taxe (or not).
 +
*'''Third type of tax:''' Define if you would like to use third type of taxe (or not).
  
−
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.
+
=Modules=
 +
[[File:List of modules en.png|alt=List of modules|thumb|List of modules]]
 +
The activation of modules is the second mandatory step. Which modules you will activate depends on what you want to do with Dolibarr. In most cases, you may want to use all modules. You have to activate each module one by one. For example, to manage a company, you might activate at least modules Third party, Invoices, and Products, but probably many more.
  
−
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 [[:Category:List of Modules|documentation of module]] for more informations.
+
To activate a module, go to page "'''Home->Setup->Modules'''" and click the button 'on/off' in the "Status" column to enable it.
 +
*The module is '''on''' if the 'on/off' button is like [[File:On off button on.png|alt='on/off' button in on position|'on/off' button in on position]]
 +
*The module is '''off''' if the 'on/off' button is like [[File:On off button off.png|alt='on/off' button in off position|'on/off' button in off position]]
  
−
= Menus =
+
The list of standard modules is defined on page [[:Category:List of Modules|List of Modules]].
−
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 =
+
If you are unsure of the function of a module, you may activate it and see what new menu item appears in Dolibarr (the horizontal bar), also after activating a module, check that you grant to yourself permissions on new features that were enabled. You can activate or deactivate a module when you want.
−
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...) =
+
Once a module has been activated, it may need further configuration (click on the setup icon that appears on the right of module line if a module needs its own setup). See [[:Category:List of Modules|documentation of module]] for more information.
−
Other entries in Setup menu are advanced options. You can forget them if you want.
 
−
* [[Setup Boxes]]
 
−
* [[Setup Alerts]]
 
−
* [[Setup Security]]
 
−
* [[Setup EMails]]
 
−
* [[Setup Limits and accuracy]]
 
−
* [[Setup Dictionnary]]
 
−
* [[Setup Other]]
 
  
−
= 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 hidden options =
+
Related videos:
−
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''':
+
Modules:
 +
(vocal in french but subtitles are available and review in this language)
  
−
== Global options ==
+
<youtube width="200" height="120">qfYP-iKWd7U</youtube>
  
−
* MAIN_APPLICATION_TITLE => This will change the title of software (that appears on the login page by default).
+
Module settings:
 +
(vocal in french but subtitles are available and review in this language)
  
−
* 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).
+
<youtube width="200" height="120">toT0jfmMCoU</youtube>
  
−
* MAIN_LOGTOHTML => If this constants is defined, it is possible to have logs inside pages by adding the parameter &logtohtml=1 into URL.
+
=Display=
 +
[[File:Display settings EN.png|alt=Display settings|thumb|Display settings]]
 +
On this page, you can set the default language of application and the look and feel of screens. In a first use, you can keep everything with default values.
  
−
* 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.
+
==Language==
 +
In the language settings, you can set the Default Language. By default it is set to "Auto Detect" so the language will be set automatically to the one of the user (so the language of the web browser).
  
−
* MAIN_AUTOFILL_TOWNFROMZIP => This will fill automatically the town from a zip value. Javascript/Ajax must not be disabled for this feature to work.
+
''Note:'' Activating multilanguage option will allow you to be able to set the preferred language of customers, to print their Invoice/Proposal/Order in their own language. Product translations will also be available.
  
−
* 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.
+
==Skin and colors==
 +
In Dolibarr you have two different pre-defined skins :
 +
* eldy [[File:Eldy Theme thumb.png]]
 +
* md [[File:Md theme thumb.png]]
 +
More skins can be downloaded on the dolistore [https://www.dolistore.com/4-skins]
  
−
* 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.
+
You can also personalize the skin color, and look in this setup.
  
−
* MAIN_MAIL_DEBUG => Write content with header of last mail into file dolibarr_mail.log into directory dolibarr_main_data_root.
+
''Tip: To test the dark mode on a specific page without going on this page to switch the dark mode option, you can add the parameter &THEME_DARKMODEENABLED=2 to force the dark mode or &THEME_DARKMODEENABLED=0 to force the dark mode off.
 +
''
  
−
* 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".
+
==Miscellaneous==
 +
On this section, you have all the default values of features like, javascript functions, length of lists, first day of the week, etc.
 +
<br />
 +
You can also put a "Message of day" that will be displayed for all the users. In this message, you can use the [[Variable substitution system]]
  
−
* 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.
+
==Login page==
 +
On this section, you can customize the login page with a message and a background image. In this message, you can use the [[Variable substitution system]]
 +
<br />
 +
It is also possible to hide/show the "'''Need help or support'''" link on login page
  
−
* 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.
+
=Menus=
−
 
+
[[File:Menu Setup.png|alt=Menu Setup|thumb|Menu Setup]]
−
* MAIN_DISABLE_PDF_COMPRESSION => Disable PDF compression.
+
Choose here which menu manager you want to use for internal and external users and for computer or smartphone. The menu manager changes the labels, orders and organization of the left and top menus.
−
 
+
See page [[Menus system]] for more information.
−
* 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
+
==Menu handlers==
−
  AddType text/javascript .jgz
+
The software comes with two different menu handler :
−
AddEncoding gzip .jgz
+
* Eldy : It is the default menu, the menu entries are centralized and hard coded. You can add entries on this menu but not change the default menu entries.
 +
* Auguria : It is a database menu manager. This menu can be fully customized to your needs.
 +
In the Menu handlers tab, you can choose the menu for internal and external users and for computer or smartphone.
  
−
* 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.
+
==Menu Editor==
 +
In this tab, you can customize each menu entry of '''auguria''' menu or the additional entries of '''eldy '''menu and create new entries
  
−
* MAIN_INVERT_SENDER_RECIPIENT =>  Invert sender and recipient in some PDF.
+
==Miscellaneous==
 +
In this tab, you can choose the behavior of the unauthorized menu entry. By default, the unauthorized menu entry are in gray, but can be hidden.
  
−
* MAIN_INPUT_DESC_HEIGHT => Number of lines in input area of product lines when editing invoices, proposals, orders, ...
+
=Other (Widgets, Alerts, Security, Limits and accuracy, Emails, SMS, Dictionary setup...)=
 +
Other entries in Setup menu are advanced options. You can ignore them if you want.
  
−
== Commercial proposal module ==
+
*[[Setup Translation]]
−
* 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.
+
*[[Setup Default values/filters/sorting]]
−
* 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.
+
*[[Setup Widgets]]
 +
*[[Setup Alerts]]
 +
*[[Setup Security]]
 +
*[[Setup Limits and accuracy]]
 +
*[[Setup PDF]]
 +
*[[Setup EMails]]
 +
*[[Setup SMS]]
 +
*[[Setup Dictionnary|Setup Dictionary]]
 +
*[[Setup Other]]
  
−
== Invoice module ==
+
=Users=
−
* FACTURE_VENTILATION => Activate an old feature of accountancy (not working).
+
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 menu '''Home -> Users & Groups''' to define users and their rights. Attention, you should consider to check and reset the user rights when you enable a new module. The list of rights available depends on the activated modules (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 the 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.'''
−
* FACTURE_SHOW_SEND_REMINDER => Show link "Send reminder by mail", same feature than "Send by mail" (obsolete feature).
 
−
* FACTURE_USE_PROFORMAT => Add the french Proformat type in list of invoice type. Warning, such invoice has no accountancy value.
 
  
−
== Order module ==
+
You can avoid these configuration steps for each newly created user, by configuring the default rights (understand rights allocated automatically each time a new user created) by configuring the default permissions on the menu [[Setup Security]].
−
* 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.
 
  
 +
=Related videos=
 +
Basic setup :
 +
(vocal in french but subtitles are available and review in this language)
  
 +
<youtube width="200" height="120">S5Rm9ixHNRA</youtube>
  
−
== Export module ==
+
Configuration options :
−
* 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=;
+
(vocal in french but subtitles are available and review in this language)
−
* 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 ==
+
<youtube width="200" height="120">o5VOYomd_Ns</youtube>
−
* 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 ==
+
Visual setup : Darkmode :
−
* PRODUCT_ADD_TYPE_IN_DOCUMENTS => Add text "Product" or "Service" at beginning of details lines on built PDF documents.
+
(vocal in french but subtitles are available and review in this language)
−
* 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 ==
+
<youtube width="200" height="120">cdhWVmTg54U</youtube>
−
* MEMBER_URL_REDIRECT_SUBSCRIPTION => Link called and shown when a member account is autocreated in member module by a guest user.
 

Latest revision as of 17:01, 11 October 2024

Return to user
documentation index
File Doc user.png

After completing the initial installation, you must configure parameters in Dolibarr to match your needs.

Company/Organization

The first mandatory step is to define your company/organization information. For this, from home page, choose menu "Home->Setup->Company/Organization" and add the information for your company/organization.

  • Name: Name of your company/organization
  • Logo size.jpg
    Logo: Add here a logo of your company (.png, .jpg or .gif). It can accept any size but it is recommended to use a logo with 130 pixels height and up to 800 pixels width. Here is a little scheme on what will be the result on the PDF. The recommended format is png.
  • Logo (squared): Add here your squared logo (.png or .jpg) that will be used in the top right corner of the application
  • Fiscal Year: Define your starting month of yiscal Year
  • Country: Define your country: other options depend on this selection.
  • Prof ID X: The fields Prof ID are used to store the professional IDs of a company. Each country requires its own professional ID. For example, for a company in France you may find a SIRET, SIREN, NAF, RCS and EORI number, and for a company in Argentia, you will find CUIT/CUIL, Ingresos Brutos, CIF Intra. Dolibarr is able to manage 6 Professional ID. The label of each of them is defined with the translation key ProfIdXCC (where X is 1 to 6 and XX the country code of the company, for example XX=FR). To add a new Professional ID, you can add a new translation from menu Home - Setup - Translation for the key ProfIdXCC. If you set the value of translation to "-", it means that the professional ID is hidden when using the application in the language of translation on every company that has the country code XX.
  • Sales Tax (VAT) Management: Define how you manage Sales Tax (or not).
  • Second type of tax: Define if you would like to use second type of taxe (or not).
  • Third type of tax: Define if you would like to use third type of taxe (or not).

Modules

List of modules
List of modules

The activation of modules is the second mandatory step. Which modules you will activate depends on what you want to do with Dolibarr. In most cases, you may want to use all modules. You have to activate each module one by one. For example, to manage a company, you might activate at least modules Third party, Invoices, and Products, but probably many more.

To activate a module, go to page "Home->Setup->Modules" and click the button 'on/off' in the "Status" column to enable it.

  • The module is on if the 'on/off' button is like 'on/off' button in on position
  • The module is off if the 'on/off' button is like 'on/off' button in off position

The list of standard modules is defined on page List of Modules.

If you are unsure of the function of a module, you may activate it and see what new menu item appears in Dolibarr (the horizontal bar), also after activating a module, check that you grant to yourself permissions on new features that were enabled. You can activate or deactivate a module when you want.

Once a module has been activated, it may need further configuration (click on the setup icon that appears on the right of module line if a module needs its own setup). See documentation of module for more information.


Related videos:

Modules: (vocal in french but subtitles are available and review in this language)

Module settings: (vocal in french but subtitles are available and review in this language)

Display

Display settings
Display settings

On this page, you can set the default language of application and the look and feel of screens. In a first use, you can keep everything with default values.

Language

In the language settings, you can set the Default Language. By default it is set to "Auto Detect" so the language will be set automatically to the one of the user (so the language of the web browser).

Note: Activating multilanguage option will allow you to be able to set the preferred language of customers, to print their Invoice/Proposal/Order in their own language. Product translations will also be available.

Skin and colors

In Dolibarr you have two different pre-defined skins :

  • eldy Eldy Theme thumb.png
  • md Md theme thumb.png

More skins can be downloaded on the dolistore [1]

You can also personalize the skin color, and look in this setup.

Tip: To test the dark mode on a specific page without going on this page to switch the dark mode option, you can add the parameter &THEME_DARKMODEENABLED=2 to force the dark mode or &THEME_DARKMODEENABLED=0 to force the dark mode off.

Miscellaneous

On this section, you have all the default values of features like, javascript functions, length of lists, first day of the week, etc.
You can also put a "Message of day" that will be displayed for all the users. In this message, you can use the Variable substitution system

Login page

On this section, you can customize the login page with a message and a background image. In this message, you can use the Variable substitution system
It is also possible to hide/show the "Need help or support" link on login page

Menus

Menu Setup
Menu Setup

Choose here which menu manager you want to use for internal and external users and for computer or smartphone. The menu manager changes the labels, orders and organization of the left and top menus. See page Menus system for more information.

Menu handlers

The software comes with two different menu handler :

  • Eldy : It is the default menu, the menu entries are centralized and hard coded. You can add entries on this menu but not change the default menu entries.
  • Auguria : It is a database menu manager. This menu can be fully customized to your needs.

In the Menu handlers tab, you can choose the menu for internal and external users and for computer or smartphone.

Menu Editor

In this tab, you can customize each menu entry of auguria menu or the additional entries of eldy menu and create new entries

Miscellaneous

In this tab, you can choose the behavior of the unauthorized menu entry. By default, the unauthorized menu entry are in gray, but can be hidden.

Other (Widgets, Alerts, Security, Limits and accuracy, Emails, SMS, Dictionary setup...)

Other entries in Setup menu are advanced options. You can ignore 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 menu Home -> Users & Groups to define users and their rights. Attention, you should consider to check and reset the user rights when you enable a new module. The list of rights available depends on the activated modules (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 the 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.

You can avoid these configuration steps for each newly created user, by configuring the default rights (understand rights allocated automatically each time a new user created) by configuring the default permissions on the menu Setup Security.

Related videos

Basic setup : (vocal in french but subtitles are available and review in this language)

Configuration options : (vocal in french but subtitles are available and review in this language)

Visual setup : Darkmode : (vocal in french but subtitles are available and review in this language)

Retrieved from "https://wiki.dolibarr.org/index.php?title=First_setup&oldid=61651"