Latest revision as of 17:01, 11 October 2024

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: 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

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
The module is off if the 'on/off' button is like

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.

Display

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
md

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

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.

@@ Line 1: / Line 1: @@
+<!-- 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}}
-{{ToTranslate}}
-Après l'installation proprement dite de Dolibarr, vous devez le paramétrer pour l'adapter à vos besoins avant de le mettre en production.
+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.
-== Institution ==
+*'''Name:''' Name of your company/organization
+*[[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.
+*'''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.
-Pour commencer, à partir de la page d'accueil, rendez-vous dans la partie "Configuration" et éditez les informations de votre institution.
+*'''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.
-N'oubliez pas d'indiquer votre pays car certains paramétrages (TVA) en dépendent.
-== Affichage ==
+*'''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).
-Cette partie vous permet de choisir la langue et la présentation des pages. Dans un premier temps vous devriez conserver les options par défaut.
+=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.
-== Modules ==
+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]]
-L'activation des modules est très importante. Elle dépend de l'utilisation que vous prévoyez de faire de Dolibarr. Il est très peu probable que vous ayez besoin de la totalité des modules.
+The list of standard modules is defined on page [[:Category:List of Modules|List of Modules]].
-Il vous faut donc activer les modules dont vous aurez très probablement besoin. Par exemple: Sociétés, Factures éventuellement Comptabilité.
-Si vous n'êtes pas sûr de vous, activez les modules les uns après les autres et voyez les fonctionnalités qu'ils ajoutent dans Dolibarr (vérifiez avant les droits, voir ci-dessous). Il est bien sûr possible de désactiver des modules après coup.
+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.
-Une fois activés, certains modules nécessitent une configuration supplémentaire (cliquer sur l'icône qui apparait tout à droite sur la même ligne).
+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.
-Voir, par exemple, pour les factures [[FactureConfiguration]].
-== Autre ==
-Les autres entrées du menu Configuration sont des options avancées.
-Il n'est pas obligatoire de les parcourir.
-== Utilisateurs ==
+Related videos:
-La dernière étape consiste à créer les utilisateurs. Pour cela, vous pouvez vous rendre dans la partie "Utilisateurs & Groupes" pour définir les utilisateurs et leurs droits. Attention, pensez à définir les droits utilisateurs, et aussi à les vérifier quand vous ajoutez un module (voir plus loin).
-La liste des droits disponibles dépendant des modules activés (voir plus haut), il est recommandé de configurer cette partie après avoir activé les modules désirés.
-Pour certaines actions, si vous n'avez pas les droits pour faire une action, Dolibarr ne vous la proposera pas. Vous risquez de rater des choses utiles et/ou importantes.
+Modules:
+(vocal in french but subtitles are available and review in this language)
-== Some hidden options ==
+<youtube width="200" height="120">qfYP-iKWd7U</youtube>
-Some options are available but not visible in user interface (often because they are old or beta features). To activate them, you must set a constant to 1 in page '''Home - Setup - Other setup''':
-=== Options globales ===
+Module settings:
+(vocal in french but subtitles are available and review in this language)
-* MAIN_APPLICATION_TITLE => Permet de définir le nom de l'application (qui apparait sur la page de login par defaut).
+<youtube width="200" height="120">toT0jfmMCoU</youtube>
-* MAIN_CONFIRM_AJAX => Si cette constante est définie (à autre chose que 0), le message de confirmation de suppression de lignes de facture, propal, etc, est une popup Ajax, au lieu d'un formulaire affiché par rechargement de la page.
+=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_DISABLE_FULL_SCANLIST => Constante à définir pour désactiver le scan complet des tables afin de connaitre le nombre total d'éléments pour permettre des paginations affichant le nombre de pages. A activer sur les systèmes ayant un nombre très important de données (Tables de + de 500 000 enregistrements).
+==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_DATE => Si cette constante est définie (à autre chose que 0), la date de facture, propal, commande ou paiement est préremplie avec la date du jour. Il est fortement recommandé de NE PAS ACTIVER cette option, ceci générant une saisie sans validation de la part des utilisateurs sur les dates, ce qui se traduit par des données incorrectes enregistrées et un beau casse tête lorsqu'il faut faire sa compta ! Toutefois l'option reste disponible, à la demande de certains utilisateurs.
+''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_AUTOFILL_TOWNFROMZIP => Permet le remplissage automatique de la ville depuis le code postal. Ajax ne doit pas etre désactivé pour que cette option fonctionne (Fonction bugguée).
+==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_ALLOW_SENDMAIL_F => Sur les systèmes Linux ou BSD, la fonction d'envoi de mail de PHP utilise la commande sendmail local au serveur. Dans certains cas, l'email émetteur doit être passé en ligne de commande par l'option -f à sendmail. Cette option permet donc de demander à Dolibarr d'utiliser la fonction '''mail''' de php en intégrant l'option -f. Notons que dans la plupart des cas, même avec sendmail, l'email émetteur est bien géré car intégré avec les autres paramètres dans l'entête technique du mail. Cette option permet juste de passer outre certaines configurations qui rendent obligatoire l'option -f.
+You can also personalize the skin color, and look in this setup.
-* MAIN_MAIL_NO_FULL_EMAIL => Recipient and ender email are not with format "Name <email>" but only "<email>". This can solve some compatiblity problems with very old mail agents.
+''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_DEMO => Désactive certaines fonctions pour rendre l'application figée à certains niveaux. Ceci est requis si Dolibarr est en accès comme site de démo à des utilisateurs qui aiment un peu trop faire n'importe quoi.
+==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_USE_HOURMIN_IN_DATE_RANGE => Sur toutes les lignes de détail d'entité (facture, commande, contrat...), il est possible de définir l'heure en plus du jour sur les champs date de début et de fin de services.
+==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_SHOW_LOGO => Affiche logo société en haut du menu gauche.
+=Menus=
+[[File:Menu Setup.png|alt=Menu Setup|thumb|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.
-* MAIN_REMOVE_INSTALL_WARNING => Supprime le warning de sécurité apparent aux administrateurs si l'URL /install est accessible. Il est préférable de ne pas utiliser ce paramètre mais de plutôt placer un fichier nommé install.lock dans la racine de Dolibarr, ce qui a pour effet non seulement de supprimer le warning mais aussi d'empêcher tout utilisation de l'outil d'installation et mise à jour (qui ne requiert pas d'habilitation) tant que ce fichier est présent.
+==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.
-* MAIN_DISABLE_FORCE_SAVEAS => Si votre navigateur propose systématiquement d'enregistrer les fichiers sur disques (comme les PDF), essayer d'ajouter cette option. Les fichiers pourront alors s'afficher dans le lecteur du navigateur.
+==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
-=== Module Propositions Commerciales ===
+==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.
-Aucune
+=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.
-=== Module Factures ===
+*[[Setup Translation]]
+*[[Setup Default values/filters/sorting]]
+*[[Setup Widgets]]
+*[[Setup Alerts]]
+*[[Setup Security]]
+*[[Setup Limits and accuracy]]
+*[[Setup PDF]]
+*[[Setup EMails]]
+*[[Setup SMS]]
+*[[Setup Dictionnary|Setup Dictionary]]
+*[[Setup Other]]
-* FACTURE_ENABLE_RECUR => Active la fonction des factures prédéfinies. Fonction instable.
+=Users=
-* FACTURE_VENTILATION => Active une veille fonctionnalité de ventilation comptable. Fonction instable.
+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.'''
-=== Module Commandes ===
+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_REQUIRE_SOURCE => Rend obligatoire la saisie du champ source lors de la création d'une commande.
+=Related videos=
+Basic setup :
+(vocal in french but subtitles are available and review in this language)
-=== Module Contrat ===
+<youtube width="200" height="120">S5Rm9ixHNRA</youtube>
-* CONTRAT_EDITWHENVALIDATED => Rend possible la modification d'un contrat après qu'il ait été validé.
+Configuration options :
+(vocal in french but subtitles are available and review in this language)
-=== Module Agenda ===
+<youtube width="200" height="120">o5VOYomd_Ns</youtube>
-* AGENDA_MAX_EVENTS_DAY_VIEW => Défini le nombre max d'entrées visibles pour chaque jour dans l'agenda. Vaut 3 par défaut. La valeur 0 signifie aucune limite.
+Visual setup : Darkmode :
+(vocal in french but subtitles are available and review in this language)
-=== Module Produit ===
+<youtube width="200" height="120">cdhWVmTg54U</youtube>
-* PRODUCT_CANVAS_ABILITY => Autorise les fonctions canvas (Ancien système de module).
-Ceci rend visible les fonctions du module de livres basé sur l'ancienne architecture.

First setup: Difference between revisions

Latest revision as of 17:01, 11 October 2024

Contents

Company/Organization

Modules

Display

Language

Skin and colors

Miscellaneous

Login page

Menus

Menu handlers

Menu Editor

Miscellaneous

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

Users

Related videos

Navigation menu

First setup: Difference between revisions

Latest revision as of 17:01, 11 October 2024

Company/Organization

Modules

Display

Language

Skin and colors

Miscellaneous

Login page

Menus

Menu handlers

Menu Editor

Miscellaneous

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

Users

Related videos

Navigation menu

Search