User documentation: Difference between revisions
Proofreader (talk | contribs) No edit summary |
Tag: 2017 source edit |
||
| (127 intermediate revisions by 15 users not shown) | |||
| Line 1: | Line 1: | ||
<keywords | <!-- BEGIN interlang links --> | ||
<!-- Do NOT edit this section | |||
Links below are automatically managed by PolyglotBot | |||
You can edit links on the English source page : Documentação_dos_utilizadores --> | |||
[[es:Documentación_usuarios]] | |||
[[fr:Documentation_utilisateur]] | |||
[[de:Benutzerdokumentation]] | |||
[[zh:用户手册]] | |||
[[ro:Documentaţie utilizator]] | |||
[[pt:Documentação_dos_utilizadores]] | |||
<!-- END interlang links --> | |||
[[Category:DocUserEN]] | |||
{{#metamaster:keywords|user, documentation, guide, doc, tutorial, usage, help}} | |||
This page is the main index of documents relating to user documentation. For developer documentation, [[Developer documentation|see here]]. | This page is the main index of documents relating to user documentation. For developer documentation, [[Developer documentation|see here]]. | ||
= Dolibarr and | =Quick overview of Features= | ||
*[[What Dolibarr Does|What Dolibarr is, what Dolibarr can do]] | |||
*[[What Dolibarr can't do|What Dolibarr is not, what Dolibarr can't do]] | |||
=Installation | Upgrade | Configuration= | |||
*[[Prerequisite|Prerequisites]] | |||
*[[Installation - Upgrade]] | |||
*[[First setup|Setup - Configuration]] | |||
Documentation on how to use Dolibarr is provided in next chapters... | |||
=Administration= | |||
This chapter describes features related to the system administration of the application. A lot of of this features are available under the menu Home - Administration. All of them are available to administrator users only. | |||
*Migration: [[Mass_imports|Mass imports]] / [[ExportsEn|Exports]] | |||
*[[Backups]] / [[Restores]] | |||
*[[About_pages|About pages]] | |||
*[[Upgrade]] | |||
*[[Purge]] | |||
*[[Audit]] | |||
*[[Users_Sessions|Users Sessions]] | |||
*[[Global_VAT_Update|Global VAT Update]] | |||
*[[Module_Scheduled_jobs|Scheduled Jobs]] | |||
*[[Direct_Printing_jobs|Direct Printing jobs]] | |||
*[[Mass_barcode_init|Mass barcode init]] | |||
<small>''Related videos:'' | |||
(vocal in french but subtitles are available and review in this language)</small> | |||
<youtube width="200" height="120">lTriUeIdiNs</youtube> | |||
=Dashboard= | |||
The dashboard is, by default, the first page you reach after login. You can use it to put the main information you need to mange your business. | |||
''<small>Related videos:'' | |||
(vocal in french but subtitles are available and review in this language) | |||
</small> | |||
== | <youtube width="200" height="120">VieSairH_ZQ</youtube> | ||
= | =Usage (by modules / applications)= | ||
Knowing how to use Dolibarr is knowing how to use its modules, menus, and features. | |||
Knowing how to use Dolibarr is knowing its modules, menus and features. | |||
First, once the installation step is complete (see previous chapters), let's have a look at general information on usage: | First, once the installation step is complete (see previous chapters), let's have a look at general information on usage: | ||
Once general usage is understood, you can have a look at the documentation about all standard business modules. Choose the module you are interested in to see | *[[General information on usage]] (First steps). | ||
Once general usage is understood, you can have a look at the documentation about all standard business modules. Choose the module you are interested in to see its documentation. Standard modules are modules available by default in all common installation. This is a list of main modules (also available on page [[:Category:List of Modules|List of Modules]])<span> </span>: | |||
==Human Resource Management (HR)== | |||
{| style="margin-left: 20px; margin-right: auto;" | |||
| style="text-align:center;" |<span class="fas fa-users"></span> | |||
|'''[[Module Users|Users & Groups]]'''<span> </span>: Users / Employees and Groups management | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-user-alt"></span> | |||
|'''[[Module Membership management|Members]]'''<span> </span>: Foundation members management | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-umbrella-beach"></span> | |||
|'''[[Module Leaves|Leave Request Management]]'''<span> </span>: Define and track employee leave requests | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-wallet"></span> | |||
|'''[[Module Expense Reports|Expense Reports]]'''<span> </span>: Manage expense reports claims (transportation, meal, ...) | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-id-card-alt"></span> | |||
|'''Recruitment '''<span> </span>: Manage and follow recruitment campaigns for new job positions | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-user-tie"></span> | |||
|'''[[Module HRM|HRM]]'''<span> </span>: Human resources management (management of department, employee contracts and feelings) | |||
|} | |||
==Customer Relationship Management (CRM)== | |||
{| style="margin-left: 20px; margin-right: auto;" | |||
| style="text-align:center;" |<span class="fas fa-building"></span> | |||
|'''[[Module Third Parties|Third Parties]]'''<span> </span>: Companies and contacts management (customers, prospects...) | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-file-signature"></span> | |||
|'''[[Module Commercial Proposals - Quotes|Proposals]]'''<span> </span>: Commercial proposal management | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-file-invoice"></span> | |||
|'''[[Module Sales Orders|Sales Orders]]'''<span> </span>: Sales order management | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-dolly"></span> | |||
|'''[[Module Shipments|Shipments]]'''<span> </span>: Shipments and delivery note management | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-suitcase"></span> | |||
|'''[[Module Contracts|Contracts/Subscriptions]]'''<span> </span>: Management of contracts (services or recurring subscriptions) | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-ambulance"></span> | |||
|'''[[Module Interventions En|Interventions]]'''<span> </span>: Intervention management | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-ticket-alt"></span> | |||
|'''[[Module Ticket|Tickets]]'''<span> </span>: Ticket system for issue or request management | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-ticket-alt rotate90"></span> | |||
|'''[[Module Knowledge Management|Knowledge Management System]]'''<span> </span>: Manage a Knowledge Management (KM) or Help-Desk base | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-handshake"></span> | |||
|'''Partnership Management'''<span> </span>: Module Partnership management | |||
|} | |||
==Vendor Relationship Management (VRM)== | |||
{| style="margin-left: 20px; margin-right: auto;" | |||
| style="text-align:center;" |<span class="fas fa-building"></span> | |||
|'''[[Module Suppliers Orders|Vendors]]'''<span> </span>: Vendors and purchase management (purchase orders and billing of supplier invoices) | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-file-signature"></span> | |||
|'''Vendor Commercial Proposals'''<span> </span>: Request vendor commercial proposal and prices | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-dolly"></span> | |||
|'''Reception'''<span> </span>: Vendor reception management (Create reception documents) | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-truck-loading"></span> | |||
|'''Incoterms'''<span> </span>: Add features to manage Incoterms | |||
|} | |||
==Financial Modules (Accounting/Treasury)== | |||
{| style="margin-left: 20px; margin-right: auto;" | |||
| style="text-align:center;" |<span class="fas fa-file-invoice-dollar"></span> | |||
|'''[[Module Invoice|Invoices]]'''<span> </span>: Management of invoices and credit notes for customers. Management of invoices and credit notes for suppliers | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-file-invoice-dollar"></span> | |||
|'''[[Module Taxes and social contributions|Taxes & Special Expenses]]'''<span> </span>: Management of other expenses (sales taxes, social or fiscal taxes, dividends, ...) | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-money-check-alt"></span> | |||
|'''Salaries'''<span> </span>: Record and track employee payments | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-money-bill-alt"></span> | |||
|'''Loans'''<span> </span>: Management of loans | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-file-alt"></span> | |||
|'''[[Module Donations|Donations]]'''<span> </span>: Donation management | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-university"></span> | |||
|'''[[Module Banks and Cash|Banks & Cash]]'''<span> </span>: Management of bank or cash accounts | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-money-check-alt"></span> | |||
|'''Payment By Credit Transfer'''<span> </span>: Management of payment of suppliers by Credit Transfer orders. It includes generation of SEPA file for European countries. | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-money-check-alt"></span> | |||
|'''[[Module Standing Orders|Payment By Direct Debit]]'''<span> </span>: Management of Direct Debit orders. It includes generation of SEPA file for European countries. | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-calculator"></span> | |||
|'''[[Module Margins|Margins]]'''<span> </span>: Module to follow margins | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-search-dollar"></span> | |||
|'''[[Module Accounting Simplified|Accounting (simplified)]]'''<span> </span>: Simple accounting reports (journals, turnover) based on database content. Does not use any ledger table. | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-search-dollar"></span> | |||
|'''[[Module Double Entry Accounting|Accounting (double entry)]]'''<span> </span>: Accounting management (double entries, support General and Subsidiary Ledgers). Export the ledger in several other accounting software formats. | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-globe-europe"></span> | |||
|'''Intracomm report'''<span> </span>: Intracomm report management (Support for French DEB/DES format) (<span class="fas fa-question-circle" style="color:orange;"></span><span style="color:orange;">Experimental</span>) | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-money-check-alt"></span> | |||
|'''Asset'''<span> </span>: Asset module (<span class="fas fa-exclamation-triangle" style="color:red;"></span><span style="color:red;">In Development</span>) | |||
|} | |||
==Product Management (PM)== | |||
{| style="margin-left: 20px; margin-right: auto;" | |||
| style="text-align:center;" |<span class="fas fa-cube"></span> | |||
|'''[[Module Products|Products]]'''<span> </span>: Management of Products | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-concierge-bell"></span> | |||
|'''[[Module Services En|Services]]'''<span> </span>: Management of Services | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-box-open"></span> | |||
|'''[[Module Stocks En|Stocks]]'''<span> </span>: Stock management | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-barcode"></span> | |||
|'''[[Module Lot / Serial|Product Lots]]'''<span> </span>: Lots, serial numbers, eat-by/sell-by date management for products | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-cube"></span> | |||
|'''Product Variants'''<span> </span>: Creation of product variants (color, size etc.) | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-shapes"></span> | |||
|'''[[Module BOM|Bills of Material]]'''<span> </span>: Module to define your Bills Of Materials (BOM). Can be used for Manufacturing Resource Planning by the module Manufacturing Orders (MO) | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-cubes"></span> | |||
|'''[[Module Manufacturing Orders|Manufacturing Orders]]'''<span> </span>: Module to Manage Manufacturing Orders (MO) | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-hand-holding-usd"></span> | |||
|'''[[Module Dynamic Prices|Dynamic Prices]]'''<span> </span>: Use maths expressions for auto-generation of prices (<span class="fas fa-question-circle" style="color:orange;"></span><span style="color:orange;">Experimental</span>) | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-pallet"></span> | |||
|'''[[Module Workstation|Workstation]]'''<span> </span>: Workstations management | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-box-open"></span> | |||
|'''Advanced Stock Transfer'''<span> </span>: Advanced management of Stock Transfer, with generation of transfer sheet (<span class="fas fa-exclamation-triangle" style="color:red;"></span><span style="color:red;">In Development</span>) | |||
|} | |||
==Projects/Collaborative work== | |||
{| style="margin-left: 20px; margin-right: auto;" | |||
| style="text-align:center;" |<span class="fas fa-project-diagram"></span> | |||
|'''[[Module Projects|Projects or Leads]]'''<span> </span>: Management of projects, leads/opportunities and/or tasks. You can also assign any element (invoice, order, proposal, intervention, ...) to a project and get a transversal view from the project view. | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-calendar-alt"></span> | |||
|'''[[Module Agenda En|Events/Agenda]]'''<span> </span>: Track events. Log automatic events for tracking purposes or record manual events or meetings. This is the principal module for good Customer or Vendor Relationship Management. | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-laptop-house"></span> | |||
|'''[[Module Resources|Resources]]'''<span> </span>: Manage resources (printers, cars, rooms, ...) for allocating to events | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-calendar-alt"></span> | |||
|'''[[Module Event Organization|Event Organization]]'''<span> </span>: Event Organization through Module Project | |||
|} | |||
==Electronic Content Management (ECM)== | |||
{| style="margin-left: 20px; margin-right: auto;" | |||
| style="text-align:center;" |<span class="fas fa-folder-open"></span> | |||
|'''DMS / ECM'''<span> </span>: Document Management System / Electronic Content Management. Automatic organization of your generated or stored documents. Share them online when you need. | |||
|} | |||
==Multi-modules tools== | |||
{| style="margin-left: 20px; margin-right: auto;" | |||
| style="text-align:center;" |<span class="fas fa-tag"></span> | |||
|'''[[Module Categories|Tags / Categories]]'''<span> </span>: Create tags/category (products, customers, suppliers, contacts or members) | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-paragraph"></span> | |||
|'''WYSIWYG Editor'''<span> </span>: Allow text fields to be edited/formatted using CKEditor (html) | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-dollar-sign"></span> | |||
|'''Multicurrency'''<span> </span>: Use alternative currencies in prices and documents | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-rss"></span> | |||
|'''RSS Feed'''<span> </span>: Add a RSS feed to Dolibarr pages | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-star"></span> | |||
|'''[[Module Bookmarks|Bookmarks & Shortcuts]]'''<span> </span>: Create shortcuts, always accessible, to the internal or external pages to which you frequently access | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-barcode"></span> | |||
|'''[[Module Barcode|Barcodes]]'''<span> </span>: Barcode or QR code management | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-cogs"></span> | |||
|'''[[Module Workflow En|Inter-modules Workflow]]'''<span> </span>: Workflow management between different modules (automatic creation of object and/or automatic status change) | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-cogs"></span> | |||
|'''[[Module Imports En|Data imports]]'''<span> </span>: Tool to import data into Dolibarr (with assistance) | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-cogs"></span> | |||
|'''[[Module Exports En|Data exports]]'''<span> </span>: Tool to export Dolibarr data (with assistance) | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-file"></span> | |||
|'''Stickers'''<span> </span>: Management of stickers (<span class="fas fa-exclamation-triangle" style="color:red;"></span><span style="color:red;">In Development</span>) | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-file"></span> | |||
|'''Data Privacy Policy'''<span> </span>: Module to manage Data Privacy (Conformity with the GDPR) (<span class="fas fa-question-circle" style="color:orange;"></span><span style="color:orange;">Experimental</span>) | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-bug"></span> | |||
|'''[[Module ModuleBuilder|Module and Application Builder]]'''<span> </span>: A RAD (Rapid Application Development) tool to help developers to build their own module. | |||
|- | |||
| style="text-align:center;" |<span class="fa fa-microchip"></span> | |||
|'''[[Module AI Functionalities]]'''<span> </span>: Tool to generate email template,audio, images... by choosing service AI (Chatgpt,Grok..)(<span style="color:orange;">Experimental</span>) | |||
|} | |||
==Websites and other frontal application== | |||
{| style="margin-left: 20px; margin-right: auto;" | |||
| style="text-align:center;" |<span class="fas fa-check-double"></span> | |||
|'''Poll, Survey or Vote'''<span> </span>: Create online polls, surveys or votes (like Doodle, Studs, RDVz etc...) | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-globe-americas"></span> | |||
|'''[[Module Website|Websites]]'''<span> </span>: Create websites (public) with a WYSIWYG editor. This is a webmaster or developer oriented CMS (it is better to know HTML and CSS language). Just setup your web server (Apache, Nginx, ...) to point to the dedicated Dolibarr directory to have it online on the internet with your own domain name. | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-people-arrows"></span> | |||
|'''Collab'''<span> </span>: Enable the public collaboration features, like shared pad, shared online sheets, etc... (<span class="fas fa-exclamation-triangle" style="color:red;"></span><span style="color:red;">In Development</span>) | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-cash-register"></span> | |||
|'''[[Module Point of sale (TakePOS)|POS TakePOS]]'''<span> </span>: Point of Sale module TakePOS (touchscreen POS, for shops, bars or restaurants). | |||
|} | |||
==Interfaces with external systems== | |||
== | {| style="margin-left: 20px; margin-right: auto;" | ||
| style="text-align:center;" |<span class="fas fa-share-alt"></span> | |||
|'''Social Networks'''<span> </span>: Enable Social Networks fields into third parties and addresses (skype, twitter, facebook, ...). | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-at"></span> | |||
|'''[[Module Notification|Notifications on business event]]'''<span> </span>: Send email notifications triggered by a business event: per user (setup defined on each user), per third-party contacts (setup defined on each third party) or by specific emails | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-at"></span> | |||
|'''[[Module EMailing|Mass Emailings]]'''<span> </span>: Manage bulk emailing | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-at"></span> | |||
|'''[[Module EMail Collector|Email collector]]'''<span> </span>: Add a scheduled job and a setup page to scan regularly email boxes (using IMAP protocol) and record emails received into your application, at the right place and/or create some records automatically (like leads). | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-cogs"></span> | |||
|'''[[Module Web Services API REST (developer)|API/Web services (REST server)]]'''<span> </span>: Enable the Dolibarr REST server providing API services | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-cogs"></span> | |||
|'''[[Module Web Services API SOAP|API/Web services (SOAP server)]]'''<span> </span>: Enable the Dolibarr SOAP server providing API services (<span class="fas fa-question-circle" style="color:orange;"></span><span style="color:orange;">Deprecated</span>) | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-cogs"></span> | |||
|'''[[Module Webhook|Web hooks]]'''<span> </span>: Enable the Dolibarr web hooks (Can be used to push data/requests to external servers) | |||
|- | |||
| style="text-align:center;" |<span class="fas">[[File:Object zapier.png]]</span> | |||
|'''[[Module Zapier|Zapier]]'''<span> </span>: Interface with Zapier (<span class="fas fa-exclamation-triangle" style="color:red;"></span><span style="color:red;">In Development</span>) | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-cogs"></span> | |||
|'''[[Module LDAP En|LDAP]]'''<span> </span>: LDAP directory synchronization | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-cogs"></span> | |||
|'''[[Module OAuth|OAuth]]'''<span> </span>: Enable OAuth authentication | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-globe-americas"></span> | |||
|'''External Site'''<span> </span>: Add a link to an external website as a main menu icon. Website is shown in a frame under the top menu. | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-folder"></span> | |||
|'''[[Module FTP En|FTP]]'''<span> </span>: FTP Client | |||
|- | |||
| style="text-align:center;" |<span class="fas">[[File:IP address icon.png|frameless|32px]]</span> | |||
|'''GeoIPMaxmind'''<span> </span>: GeoIP Maxmind conversions capabilities | |||
|- | |||
| style="text-align:center;" |<span class="fas">[[File:Object paybox.png|frameless|32px]]</span> | |||
|'''PayBox'''<span> </span>: Offer customers a PayBox online payment page (credit/debit cards). This can be used to allow your customers to make ad-hoc payments or payments related to a specific Dolibarr object (invoice, order etc...) | |||
|- | |||
| style="text-align:center;" |<span class="fas">[[File:Object paypal.png|frameless|32px]]</span> | |||
|'''[[Module PayPal En|Paypal]]'''<span> </span>: Offer customers a PayPal online payment page (PayPal account or credit/debit cards). This can be used to allow your customers to make ad-hoc payments or payments related to a specific Dolibarr object (invoice, order etc...) | |||
|- | |||
| style="text-align:center;" |<span class="fab fa-stripe-s"></span> | |||
|'''[[Module Stripe|Stripe]]'''<span> </span>: Offer customers a Stripe online payment page (credit/debit cards). This can be used to allow your customers to make ad-hoc payments or payments related to a specific Dolibarr object (invoice, order etc...) | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-phone"></span> | |||
|'''[[Module ClickToDial En|ClickToDial]]'''<span> </span>: Integration of a ClickToDial system (Asterisk, ...) | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-print"></span> | |||
|'''One click Printing'''<span> </span>: Enable One click Printing System | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-print"></span> | |||
|'''Receipt printers'''<span> </span>: Setup of receipt printers | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-cogs"></span> | |||
|'''Mailman and SPIP'''<span> </span>: Mailman or SPIP interface for member module | |||
|- | |||
| style="text-align:center;" |<span class="fas">[[File:Object gravatar.png|frameless|32px]]</span> | |||
|'''Gravatar'''<span> </span>: Use online Gravatar service (www.gravatar.com) to show photo of users/members (found with their emails). Needs Internet access | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-file"></span> | |||
|'''[[Module DAV|Dav]]'''<span> </span>: Setup a WebDAV server | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-bullseye"></span> | |||
|'''[[Module Webhook|Webhook]]'''<span> </span>: Interface to catch dolibarr triggers and send it to an URL | |||
|} | |||
= | ==System== | ||
{| style="margin-left: 20px; margin-right: auto;" | |||
| style="text-align:center;" |<span class="fas fa-business-time"></span> | |||
|'''[[Module Scheduled jobs|Scheduled jobs]]'''<span> </span>: Scheduled jobs management (alias cron or chrono table) | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-bug"></span> | |||
|'''Debug Logs'''<span> </span>: Logging facilities (file, syslog, ...). Such logs are for technical/debug purposes | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-bug"></span> | |||
|'''Debug Bar'''<span> </span>: A tool for developper adding a debug bar in your browser. | |||
|- | |||
| style="text-align:center;" |<span class="fas fa-cogs"></span> | |||
|'''[[Module Unalterable Archives - Logs|Unalterable Archives]]'''<span> </span>: Enable an unalterable log of business events. Events are archived in real-time. The log is a read-only table of chained events that can be exported. This module may be mandatory for some countries. | |||
|} | |||
= | ==External Modules== | ||
External modules are modules you can get on other sources than official sources. They are provided by third parties. Most of them can be found in the marketplace https://www.dolistore.com. List of external modules is defined on the page [[:Category:Complementary modules|Complementary modules]]. | |||
= FAQ = | =FAQ and Glossary= | ||
All FAQ are available through the index page [[:Category:FAQ EN|FAQ EN]] | All FAQ are available through the index page [[:Category:FAQ EN|FAQ EN]] | ||
A glossary is available on the page [[Glossary]] | |||
=Video Tutorials= | |||
The association Dolibarr has started making video tutorials on the basic functions of Dolibarr [[Video Tutorials]] | |||
[[Category:Proofreading done]] | [[Category:Proofreading done]] | ||
Latest revision as of 12:34, 12 February 2026
This page is the main index of documents relating to user documentation. For developer documentation, see here.
Quick overview of Features
Installation | Upgrade | Configuration
Documentation on how to use Dolibarr is provided in next chapters...
Administration
This chapter describes features related to the system administration of the application. A lot of of this features are available under the menu Home - Administration. All of them are available to administrator users only.
- Migration: Mass imports / Exports
- Backups / Restores
- About pages
- Upgrade
- Purge
- Audit
- Users Sessions
- Global VAT Update
- Scheduled Jobs
- Direct Printing jobs
- Mass barcode init
Related videos:
(vocal in french but subtitles are available and review in this language)
Dashboard
The dashboard is, by default, the first page you reach after login. You can use it to put the main information you need to mange your business.
Related videos: (vocal in french but subtitles are available and review in this language)
Usage (by modules / applications)
Knowing how to use Dolibarr is knowing how to use its modules, menus, and features. First, once the installation step is complete (see previous chapters), let's have a look at general information on usage:
- General information on usage (First steps).
Once general usage is understood, you can have a look at the documentation about all standard business modules. Choose the module you are interested in to see its documentation. Standard modules are modules available by default in all common installation. This is a list of main modules (also available on page List of Modules) :
Human Resource Management (HR)
| Users & Groups : Users / Employees and Groups management | |
| Members : Foundation members management | |
| Leave Request Management : Define and track employee leave requests | |
| Expense Reports : Manage expense reports claims (transportation, meal, ...) | |
| Recruitment : Manage and follow recruitment campaigns for new job positions | |
| HRM : Human resources management (management of department, employee contracts and feelings) |
Customer Relationship Management (CRM)
| Third Parties : Companies and contacts management (customers, prospects...) | |
| Proposals : Commercial proposal management | |
| Sales Orders : Sales order management | |
| Shipments : Shipments and delivery note management | |
| Contracts/Subscriptions : Management of contracts (services or recurring subscriptions) | |
| Interventions : Intervention management | |
| Tickets : Ticket system for issue or request management | |
| Knowledge Management System : Manage a Knowledge Management (KM) or Help-Desk base | |
| Partnership Management : Module Partnership management |
Vendor Relationship Management (VRM)
| Vendors : Vendors and purchase management (purchase orders and billing of supplier invoices) | |
| Vendor Commercial Proposals : Request vendor commercial proposal and prices | |
| Reception : Vendor reception management (Create reception documents) | |
| Incoterms : Add features to manage Incoterms |
Financial Modules (Accounting/Treasury)
| Invoices : Management of invoices and credit notes for customers. Management of invoices and credit notes for suppliers | |
| Taxes & Special Expenses : Management of other expenses (sales taxes, social or fiscal taxes, dividends, ...) | |
| Salaries : Record and track employee payments | |
| Loans : Management of loans | |
| Donations : Donation management | |
| Banks & Cash : Management of bank or cash accounts | |
| Payment By Credit Transfer : Management of payment of suppliers by Credit Transfer orders. It includes generation of SEPA file for European countries. | |
| Payment By Direct Debit : Management of Direct Debit orders. It includes generation of SEPA file for European countries. | |
| Margins : Module to follow margins | |
| Accounting (simplified) : Simple accounting reports (journals, turnover) based on database content. Does not use any ledger table. | |
| Accounting (double entry) : Accounting management (double entries, support General and Subsidiary Ledgers). Export the ledger in several other accounting software formats. | |
| Intracomm report : Intracomm report management (Support for French DEB/DES format) (Experimental) | |
| Asset : Asset module (In Development) |
Product Management (PM)
| Products : Management of Products | |
| Services : Management of Services | |
| Stocks : Stock management | |
| Product Lots : Lots, serial numbers, eat-by/sell-by date management for products | |
| Product Variants : Creation of product variants (color, size etc.) | |
| Bills of Material : Module to define your Bills Of Materials (BOM). Can be used for Manufacturing Resource Planning by the module Manufacturing Orders (MO) | |
| Manufacturing Orders : Module to Manage Manufacturing Orders (MO) | |
| Dynamic Prices : Use maths expressions for auto-generation of prices (Experimental) | |
| Workstation : Workstations management | |
| Advanced Stock Transfer : Advanced management of Stock Transfer, with generation of transfer sheet (In Development) |
Projects/Collaborative work
| Projects or Leads : Management of projects, leads/opportunities and/or tasks. You can also assign any element (invoice, order, proposal, intervention, ...) to a project and get a transversal view from the project view. | |
| Events/Agenda : Track events. Log automatic events for tracking purposes or record manual events or meetings. This is the principal module for good Customer or Vendor Relationship Management. | |
| Resources : Manage resources (printers, cars, rooms, ...) for allocating to events | |
| Event Organization : Event Organization through Module Project |
Electronic Content Management (ECM)
| DMS / ECM : Document Management System / Electronic Content Management. Automatic organization of your generated or stored documents. Share them online when you need. |
Multi-modules tools
| Tags / Categories : Create tags/category (products, customers, suppliers, contacts or members) | |
| WYSIWYG Editor : Allow text fields to be edited/formatted using CKEditor (html) | |
| Multicurrency : Use alternative currencies in prices and documents | |
| RSS Feed : Add a RSS feed to Dolibarr pages | |
| Bookmarks & Shortcuts : Create shortcuts, always accessible, to the internal or external pages to which you frequently access | |
| Barcodes : Barcode or QR code management | |
| Inter-modules Workflow : Workflow management between different modules (automatic creation of object and/or automatic status change) | |
| Data imports : Tool to import data into Dolibarr (with assistance) | |
| Data exports : Tool to export Dolibarr data (with assistance) | |
| Stickers : Management of stickers (In Development) | |
| Data Privacy Policy : Module to manage Data Privacy (Conformity with the GDPR) (Experimental) | |
| Module and Application Builder : A RAD (Rapid Application Development) tool to help developers to build their own module. | |
| Module AI Functionalities : Tool to generate email template,audio, images... by choosing service AI (Chatgpt,Grok..)(Experimental) |
Websites and other frontal application
| Poll, Survey or Vote : Create online polls, surveys or votes (like Doodle, Studs, RDVz etc...) | |
| Websites : Create websites (public) with a WYSIWYG editor. This is a webmaster or developer oriented CMS (it is better to know HTML and CSS language). Just setup your web server (Apache, Nginx, ...) to point to the dedicated Dolibarr directory to have it online on the internet with your own domain name. | |
| Collab : Enable the public collaboration features, like shared pad, shared online sheets, etc... (In Development) | |
| POS TakePOS : Point of Sale module TakePOS (touchscreen POS, for shops, bars or restaurants). |
Interfaces with external systems
| Social Networks : Enable Social Networks fields into third parties and addresses (skype, twitter, facebook, ...). | |
| Notifications on business event : Send email notifications triggered by a business event: per user (setup defined on each user), per third-party contacts (setup defined on each third party) or by specific emails | |
| Mass Emailings : Manage bulk emailing | |
| Email collector : Add a scheduled job and a setup page to scan regularly email boxes (using IMAP protocol) and record emails received into your application, at the right place and/or create some records automatically (like leads). | |
| API/Web services (REST server) : Enable the Dolibarr REST server providing API services | |
| API/Web services (SOAP server) : Enable the Dolibarr SOAP server providing API services (Deprecated) | |
| Web hooks : Enable the Dolibarr web hooks (Can be used to push data/requests to external servers) | |
| Zapier : Interface with Zapier (In Development) | |
| LDAP : LDAP directory synchronization | |
| OAuth : Enable OAuth authentication | |
| External Site : Add a link to an external website as a main menu icon. Website is shown in a frame under the top menu. | |
| FTP : FTP Client | |
| GeoIPMaxmind : GeoIP Maxmind conversions capabilities | |
| PayBox : Offer customers a PayBox online payment page (credit/debit cards). This can be used to allow your customers to make ad-hoc payments or payments related to a specific Dolibarr object (invoice, order etc...) | |
| Paypal : Offer customers a PayPal online payment page (PayPal account or credit/debit cards). This can be used to allow your customers to make ad-hoc payments or payments related to a specific Dolibarr object (invoice, order etc...) | |
| Stripe : Offer customers a Stripe online payment page (credit/debit cards). This can be used to allow your customers to make ad-hoc payments or payments related to a specific Dolibarr object (invoice, order etc...) | |
| ClickToDial : Integration of a ClickToDial system (Asterisk, ...) | |
| One click Printing : Enable One click Printing System | |
| Receipt printers : Setup of receipt printers | |
| Mailman and SPIP : Mailman or SPIP interface for member module | |
| Gravatar : Use online Gravatar service (www.gravatar.com) to show photo of users/members (found with their emails). Needs Internet access | |
| Dav : Setup a WebDAV server | |
| Webhook : Interface to catch dolibarr triggers and send it to an URL |
System
| Scheduled jobs : Scheduled jobs management (alias cron or chrono table) | |
| Debug Logs : Logging facilities (file, syslog, ...). Such logs are for technical/debug purposes | |
| Debug Bar : A tool for developper adding a debug bar in your browser. | |
| Unalterable Archives : Enable an unalterable log of business events. Events are archived in real-time. The log is a read-only table of chained events that can be exported. This module may be mandatory for some countries. |
External Modules
External modules are modules you can get on other sources than official sources. They are provided by third parties. Most of them can be found in the marketplace https://www.dolistore.com. List of external modules is defined on the page Complementary modules.
FAQ and Glossary
All FAQ are available through the index page FAQ EN
A glossary is available on the page Glossary
Video Tutorials
The association Dolibarr has started making video tutorials on the basic functions of Dolibarr Video Tutorials