mirror of
https://github.com/Dolibarr/dolibarr.git
synced 2025-12-08 02:28:23 +01:00
02bedc49d3
Conflicts: test/phpunit/PricesTest.php test/phpunit/RestAPIUserTest.php test/phpunit/WebservicesInvoicesTest.php
208 lines
7.6 KiB
Markdown
208 lines
7.6 KiB
Markdown
# DOLIBARR ERP & CRM
|
||
|
||
 
|
||
|
||
Dolibarr ERP & CRM is a modern software package to manage your organization's activity (contacts, suppliers, invoices, orders, stocks, agenda…).
|
||
|
||
It's an Open Source Software (written in PHP language) designed for small, medium or large companies, foundations and freelances.
|
||
|
||
You can freely use, study, modify or distribute it according to its Free Software licence.
|
||
|
||
You can use it as a standalone application or as a web application to be able to access it from the Internet or a LAN.
|
||
|
||
|
||
|
||
|
||
## LICENSE
|
||
|
||
Dolibarr is released under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version (GPL-3+).
|
||
|
||
See the [COPYING](https://github.com/Dolibarr/dolibarr/blob/develop/COPYING) file for a full copy of the license.
|
||
|
||
Other licenses apply for some included dependencies. See [COPYRIGHT](https://github.com/Dolibarr/dolibarr/blob/develop/COPYRIGHT) for a full list.
|
||
|
||
|
||
## INSTALLING
|
||
|
||
### Download
|
||
|
||
Releases can be downloaded from [official website](https://www.dolibarr.org/).
|
||
|
||
### Install from composer
|
||
|
||
If you do not already have Composer installed, you may do so by following the instructions at [getcomposer.org](https://getcomposer.org/). On Linux and macOS, you may run the following commands:
|
||
|
||
```bash
|
||
curl -sS https://getcomposer.org/installer | php
|
||
mv composer.phar /usr/local/bin/composer
|
||
```
|
||
|
||
On Windows, you can download and run https://getcomposer.org/Composer-Setup.exe
|
||
|
||
You can then create a new project
|
||
|
||
```bash
|
||
composer create-project dolibarr/dolibarr erp
|
||
```
|
||
|
||
### Simple setup
|
||
|
||
If you have low technical skills and you're looking to install Dolibarr ERP/CRM in just a few clicks, you can use one of the packaged versions:
|
||
|
||
- DoliWamp for Windows
|
||
- DoliDeb for Debian or Ubuntu
|
||
- DoliRpm for Redhat, Fedora, OpenSuse, Mandriva or Mageia
|
||
|
||
### Advanced setup
|
||
|
||
You can use a Web server and a supported database (MariaDB, MySQL or PostgreSQL) to install the standard version.
|
||
|
||
- Uncompress the downloaded archive
|
||
- Copy the "dolibarr" directory and all its files inside your web server root or anywhere you'd like and set up your web server to use "*dolibarr/htdocs*" as root for a new web server virtual host (second choice need to be server administrator)
|
||
- Create an empty `htdocs/conf/conf.php` file and set permissions for your web server user (*write* permissions will be removed once install is finished)
|
||
- From your browser, go to the dolibarr "install/" page
|
||
|
||
The URL will depends on choices made in the first step:
|
||
|
||
http://localhost/dolibarr/htdocs/install/
|
||
|
||
or
|
||
|
||
http://localhost/dolibarr/install/
|
||
|
||
or
|
||
|
||
http://yourdolibarrvirtualhost/install/
|
||
|
||
- Follow the installer instructions
|
||
|
||
|
||
## UPGRADING
|
||
|
||
- Overwrite all old files from 'dolibarr' directory with files provided into the new version's package.
|
||
- At first next access, Dolibarr will redirect your to the "install/" page to follow the upgrade process.
|
||
If an `install.lock` file exists to lock any other upgrade process, the application will ask you to remove the file manually (you should find the `install.lock` file into the directory used to store generated and uploaded documents, in most cases, it is the directory called "*documents*").
|
||
|
||
*Note: migration process can be safely done multiple times by calling the `/install/index.php` page*
|
||
|
||
|
||
## WHAT'S NEW
|
||
|
||
See the [ChangeLog](https://github.com/Dolibarr/dolibarr/blob/develop/ChangeLog) file.
|
||
|
||
|
||
## FEATURES
|
||
|
||
### Main application/modules (all optional)
|
||
|
||
- Customers, Prospects and/or Suppliers directory
|
||
- Products and/or Services catalog
|
||
- Commercial proposals management
|
||
- Customer and Supplier Orders management
|
||
- Invoices and payment management
|
||
- Standing orders management (European SEPA)
|
||
- Bank accounts management
|
||
- Shared calendar/agenda (with ical and vcal export for third party tools integration)
|
||
- Opportunities and/or project management
|
||
- Projects management
|
||
- Contracts management
|
||
- Stock management
|
||
- Shipping management
|
||
- Interventions management
|
||
- Employee's leave requests management
|
||
- Expense reports
|
||
- Timesheets
|
||
- Electronic Document Management (EDM)
|
||
- Foundations members management
|
||
- Mass emailing
|
||
- Surveys
|
||
- Point of Sale
|
||
- …
|
||
|
||
### Other application/modules
|
||
|
||
- Bookmarks management
|
||
- Donations management
|
||
- Reporting
|
||
- Data export/import
|
||
- Thirdparties and/or products categories
|
||
- Barcodes support
|
||
- Margin calculations
|
||
- LDAP connectivity
|
||
- ClickToDial integration
|
||
- RSS integration
|
||
- Skype integration
|
||
- Payment platforms integration (PayPal, Stripe, Paybox...)
|
||
- …
|
||
|
||
### Other general features
|
||
|
||
- Localization in most major languages.
|
||
- Multi-Users and groups with finely grained rights.
|
||
- Multi-currency.
|
||
- Multi-company by adding of an external module.
|
||
- Very user friendly and easy to use.
|
||
- Highly customizable: enable only the modules you need, add user personalized fields, choose your skin, several menu managers (can be used by internal users as a back-office with a particular menu, or by external users as a front-office with another one)
|
||
- Works with PHP 5.3+ and MariaDB 5.0.3+, MySQL 5.0.3+ or PostgreSQL 8.1.4+ (See requirements on the [Wiki](https://wiki.dolibarr.org/index.php/Prerequisite))
|
||
- Compatible with all Cloud solutions that match MySQL, PHP or PostgreSQL prerequisites.
|
||
- APIs.
|
||
- An easy to understand, maintain and develop code (PHP with no heavy framework; trigger and hook architecture)
|
||
- Support for country specific features:
|
||
- Spanish Tax RE and ISPF
|
||
- French NPR VAT rate (VAT called "Non Perçue Récupérable" for DOM-TOM)
|
||
- Canadian double taxes (federal/province) and other countries using cumulative VAT
|
||
- Tunisian tax stamp
|
||
- Argentina invoice numbering using A,B,C...
|
||
- Compatible with [European directives](http://europa.eu/legislation_summaries/taxation/l31057_en.htm) (2006/112/CE ... 2010/45/UE)
|
||
- PDF or ODT generation for invoice, proposals, orders...
|
||
- …
|
||
|
||
### Extending
|
||
|
||
Dolibarr can be extended with a lot of other external application or modules from third party developers available at the [DoliStore](https://www.dolistore.com).
|
||
|
||
|
||
## WHAT DOLIBARR CAN'T DO YET
|
||
|
||
These are features that Dolibarr does **not** yet fully support:
|
||
|
||
- Tasks dependencies in projects
|
||
- Payroll module
|
||
- No native embedded Webmail
|
||
- Dolibarr can't do coffee (yet)
|
||
|
||
|
||
## DOCUMENTATION
|
||
|
||
Administrator, user, developer and translator's documentations are available along with other community resources on the [Wiki](https://wiki.dolibarr.org).
|
||
|
||
|
||
## CONTRIBUTING
|
||
|
||
This project exists thanks to all the people who contribute. [[Contribute](https://github.com/Dolibarr/dolibarr/blob/develop/.github/CONTRIBUTING.md)].
|
||
<a href="https://github.com/Dolibarr/dolibarr/graphs/contributors"><img src="https://opencollective.com/dolibarr/contributors.svg?width=890&button=false" /></a>
|
||
|
||
|
||
## CREDITS
|
||
|
||
Dolibarr is the work of many contributors over the years and uses some fine libraries.
|
||
|
||
See [COPYRIGHT](https://github.com/Dolibarr/dolibarr/blob/develop/COPYRIGHT) file.
|
||
|
||
|
||
## NEWS AND SOCIAL NETWORKS
|
||
|
||
Follow Dolibarr project on:
|
||
|
||
- [Facebook](https://www.facebook.com/dolibarr)
|
||
- [Google+](https://plus.google.com/+DolibarrOrg)
|
||
- [Twitter](https://www.twitter.com/dolibarr)
|
||
- [LinkedIn](https://www.linkedin.com/company/association-dolibarr)
|
||
- [YouTube](https://www.youtube.com/user/DolibarrERPCRM)
|
||
- [GitHub](https://github.com/Dolibarr/dolibarr)
|
||
|
||
|
||
### Sponsors
|
||
|
||
Support this project by becoming a sponsor. Your logo will show up here. 🙏 [[Become a sponsor/backer](https://opencollective.com/dolibarr#backer)]
|