General information on usage

Return to user
documentation index

Starting the application:

To begin, launch the application, either by clicking on the icon installed on your desktop by the installation package or by typing appropriate URL in your web browser (The URL can be of the form http://localhost/dolibarr/ for local installation but can be different in the case of a manual installation, in that case it will depend on the configuration of your Web server).

After launching application, you should see the login page with at least 2 fields:

• Login: the login of user to connect. If this is a first usage, it is the user entered at last step of the installation (eg admin)
• Password: the password of user to connect. If this is a first usage, it is the password entered at last step of the installation (eg changeme)

Homepage

Once logged in, you see the home page. It contains menu bars (one horizontal bar and one vertical bar) and more informations in the center:

• A box reminding your login account and the date of last access.
• A box of statistics related to all activated modules.
• A box showing 'tasks' table (table containing informations of tasks to be done and tasks behind schedule). A weather sums it up.
• In the lower part, there may be other information boxes. The list depends upon boxes activated via the menu Home->Setup->Boxes.

Using the menus

Each menu in the horizontal bar is related to one module. When a module is activated its associated menu appears in the horizontal menu bar. The menu entry of a module does not appear in the menus until the module has been activated. To activate a module, see page First_setup.

To use a module, click the menu associated with the module, a menu appears in the vertical bar to perform various tasks related to that module.

For example, to list the products in stock (function provided by the Products and Stock modules), click on the menu Products / Services:

Once a top menu has been selected a left menu appears with various tasks related to the activated module.

For example, menu you can see once top menu Products / Services has been selected:

Note that the organization of the menus depends on the choice of menu manager configured in Home->Setup->Menus.

Objects

Objects are the generic terms to speak about records managed by the application. It can be for example: a customer, a supplier, an invoice, an order, a proposal, an agenda event, a user, ...

Each object is managed by a Dolibarr module. Depending on the module you enabled or not, some objects may or may not appear in the application. Dolibarr policy is to use a common way of working for each managed modules or objects. So, for each object, you will find a menu entry to Create (menu is called "New Object") and a menu entry to list all objects (menu is called "List"). Then clicking on an object found in a list, you can read all properties of the object arranged in several tabs. A button "Modify" is visible to the allowed user to edit the object.

For example, this is a view of left menu to manage third-parties, and card of a selected third-party (click to enlarge):

Also, each object may have different status to define where object is within the workflow. Status of object is always visible in the last column of list of objects. Number of status will depends on object and options defined in the module setup dedicated to object management. Current definition and symbol/signage of status are (with default theme "eldy") :

• Draft - Status when object is not yet validated (white color means "don't take care of me" yet)
• Validated - Some actions are expected for object (that's why color is yellow).
• Name of status will varies according to object. It is a more advanced status than Validated, but object still need action to do on it (that's why color is artially yellow)
• Processed or Active or Enabled- No particular action is expected for object, even if some event can still occurs (green color means everything is ok currently)
• Canceled - No more action are expected on object. No specific event can occurs for this object (white color means "don't take care of me" and the cross means "anymore")
• Error - There is a problem. This status means there is a critical problem to fix on object (red color means error)

Note that with other theme, meaning of status will not differ, but colors codification may be changed (for example a theme can decide good color for cancel theme is "orange" and not "white crossed".

Features

Each feature is provided by a module. All modules are documented in the module documentation. For a complete list of modules and their documentation, see the following pages:

• The list of standard modules is defined in page Category:List_of_Modules
• The list of external modules (add-ons not provided by default) is set in the complementary modules page Category:Complementary_modules