espocrm / documentation

EspoCRM Documentation

EspoCRM

EspoCRM is a free, open-source CRM platform designed to help organizations build and maintain strong customer relationships. It provides a wide range of tools to store, organize, and manage leads, contacts, sales opportunities, marketing campaigns, support cases, and more – all business information in a simple and intuitive interface.

Architecture

EspoCRM is a web application with a frontend designed as a single-page application and a REST API backend written in PHP.

Demo

You can try the CRM on an online demo.

Requirements

• PHP 8.1 - 8.3;
• MySQL 5.7 (and later), or MariaDB 10.2 (and later);
• PostgreSQL 15 (and later) (beta, official support soon).

For more information about server configuration, see this article.

Why EspoCRM?

• Open-source transparency. EspoCRM’s source code is open and accessible, so anyone can inspect it and see how data is being managed within the CRM.
• Customization freedom. You can develop features, create custom entities, fields, relationships, buttons to make the CRM fit your specific needs.
• Clean user interface. EspoCRM has a uncluttered, minimalist and very fast user inteface that is easy to navigate and has a short learning curve.
• Straightforward REST API. It can be easily integrated with other applications using a REST API.

Who is EspoCRM for?

• Startups, small & medium-sized businesses. It’s an affordable solution that is flexible and fully customizable.
• Developers & tech enthusiasts. You can extend functionalities, build extensions, and create custom integrations.
• Anyone seeking a free CRM. If you're looking for a user-friendly and secure CRM platform, it can be a good option.

Installing stable version

See installation instructions:

• Manual installation
• Installation by script
• Installation with Docker
• Installation with Traefik

Download

Download the latest release from our website. You can also download the latest and previous release packages from GitHub releases.

Release notes

Release notes are available at GitHub releases.

Documentation

See the documentation for administrators, users and developers.

Bug reporting

Create a GitHub issue or post on our forum.

Development

See the developer documentation.

We highly recommend using an IDE for development. The backend codebase follows SOLID principles, utilizes interfaces, static typing and generics. We recommend to start learning EspoCRM from the Dependency Injection article in the documentation.

Metadata plays an integral role in the EspoCRM application. All possible parameters are described with a JSON Schema, meaning you will have autocompletion in the IDE. You can also find the full metadata reference in the documentation.

Community & Support

If you have a question regarding some features, need help or customizations, want to get in touch with other EspoCRM users, or add a feature request, please use our community forum. We believe that using the forum to ask for help and share experience allows everyone in the community to contribute and use this knowledge later.

License

EspoCRM is an open-source project licensed under GNU AGPLv3.

Contributing

Before we can merge your pull request, you need to accept our CLA here. See the contributing guidelines.

Branches:

• fix – upcoming maintenance release; minor fixes should be pushed to this branch;
• master – develop branch; new features should be pushed to this branch;
• stable – last stable release.

Language

If you want to improve existing translation or add a language that is not available yet, you can contribute on our POEditor project. See instructions here. It may be reasonable to let us know about your intention to join the POEditor project by posting on our forum or via the contact form on our website.

Changes on POEditor are usually merged to the GitHub repository before minor releases.

documentation's Issues

Typo in https://docs.espocrm.com/development/frontend/record-panels/

record-panels.md file.

Step 1 says to create Create a file custom/Espo/Custom/Resources/metadata/clientDefs/Account.js, but it should be Account.json

please merged

https://github.com/mdesantiago41/documentation/commit/24617287fbc4a1907cb68782815b7a2aea995408

workflow : trigger onchange billing address not available

Use case : send Email with old and new billing address when billing address did change.

Entity : account

Issue : billing address elements are not available in fieldlist
Tried workaround : using formula entity\isAttributeChanged(billingAddressPostalCode) || ..
but this does not trigger after updating the record.

Version 5.7.11

Translations into indonesian language

Hello team EspoCRM ,
I am translator indonesian language , i want to help your project to translate espoCRM into indonesian language , thank you for your attention,

Regard

API Create blank record

Hi, there.

I've tried to use API Rest in Espocrm, but after POST in Account, Contact and Meeting the fields record create is blank.

I used Firefox Extension http://restclient.net/ for test the rest.
The auth is ok, I tested.

Current version: 4.0.2
URL: http://ideiasoftware.com.br/crm/api/v1/Meeting

Post:

{
        "name": "Treinamento Inifit",
        "deleted": false,
        "status": "Held",
        "dateStart": "2016-03-04 10:00:00",
        "dateEnd": "2016-03-04 12:00:00",
        "duration": 3600,
        "reminders":
        [
        ],
        "description": "Test from api",
        "createdAt": "2016-03-02 13:20:53",
        "modifiedAt": "2016-03-10 01:59:41",
        "parentId": "56d6e8b306bbc347c",
        "parentType": "Account",
        "parentName": "Infinit Telecom",
        "accountId": "56d6e8b306bbc347c",
        "accountName": "Infinit Telecom",

.......
}

Return ok:

    {
        "id": "56e0db0e5635efa86",
        "deleted": false,
        "status": "Planned",
        "duration": "3600",
        "createdAt": "2016-03-10 02:25:18",
        "modifiedAt": "2016-03-10 02:25:18",
        "createdById": "1"
    }

Screen shot:

Requesting for German language

Good day sir i want to contribute in translation

Is there documentation about the 'devMode' setting?

I would like to not use the minified espo file and instead use single source files.
I need to know what other consequences are brought by activationg dev mode.

Thanks

pleas

Dear to : Project owner
Excuse me, I would like to translate in your project into Russian, if you are willing to let me contribute to your project.

Want to send Mass emails

I want to send Mass emails
have installed EC v4.8.1 in a AWS EC2 instance.

In Scheduled Jobs says:

Note: Add this line to the crontab file to run Espo Scheduled Jobs:

• • • • • cd /opt/bitnami/apps/espocrm/htdocs; /bitnami/lampstack-linux-x64/output/php/bin/php -f cron.php > /dev/null 2>&1

Please advise where I have to put the previous line:

• Check Group Email Accounts / Scheduling
• Send Mass Emails / Scheduling
• CRON.PHP thru SSH

Thanks

Luis R

Found an issue in user-guide/emails.md

Hi, i found an issue in original emails.md in user-guide when translating.

It's possible to use placefolders in email template's body and subject e.g. {Account.name}, {Person.emailAddress}. They will be replaced with values of related records.

You can use additional reserved placefolders in template body: {optOutUrl} and {optOutLink}.

I think the correct word should be used here is "placeholders", instead of "placefolders".

Translations into spanish

Hi did you need spanish translations?

Clarify when 'EspoClient: Unknown Error'

The message "Uncaught exception 'Exception' with message 'EspoClient: Unknown Error' in "

the response code is 200, but i receive this message when i just try your example

$client = new EspoApiClient('https://your-espocrm-site', 'USERNAME', 'PASSWORD');

$response = $client->request('POST', 'Lead', [
'firstName' => 'Test',
'lastName' => 'Hello'
]);

This message does not make the error very clear

Spanish Translation

Hi!

Can I translate your project into Spanish?

Best Regards!

Request for Cebuano Translation

Hi,

I would like to contribute in this project thru translations. I want to translate the documents to Cebuano language.

Thanks.

Add a new client implementation to the docs

Hi there!

Over the last week I've been working on a port of the exiting PHP API client to Rust. It is basically done now, and working.
Is there any sort of process to add this client to the list of client implementations here? By adding it, Rust users will be easily be able to get started on a project that interfaces with EspoCRM, without having to deal with the hassle of searching for an API implementation themselves, or creating one like I did.

The library is currently already available on crates.io.

Thanks

additional info

• suggest to add link to "how to upgrade extensions", or explain that this is part of the knowledgebase in the portal
• suggest to be explicit if it is allowed to jump from 1.03 -> 1.05 directly, skipping 1.04

Request for Turkish translation

Hi, can I translate this project into Turkish language?

I have issue with upgrade from 3.9.2 to 4.0.0

After upgrade from 3.9.2 to version 4.0.0 the . not working .

But i got message error 500 in installing .

and give me this message "Error 404
The url you requested can't be handled."

Request for Spanish translation

Hi!, can I translate this project into spanish?

Request for polish translation

Hello, can I translate this project into polish language?

Requesting for Filipino Translation

I would like to contribute on this project thru translating the book into Tagalog, only if you allow me to do so. I am also from the Philippines.

Install Espocrm in Windows Server 2008, IIS

Hi ,

I tried to install Espocrm in windows server using IIS , but it give me this error

Permission denied for "data" directory. Please set 775 for "data" or just execute this command in the terminal
cd C:\inetpub\wwwroot\Archive && find data -type d -exec chmod 775 {} +;
Operation not permitted? Try this one: cd C:\inetpub\wwwroot\Archive && find data -type d -exec sudo chmod 775 {} +;

вопрос

Спасибо. Можете переместить папку user-guide на уровень выше?

Как это сделать?

Contribute Chinese Simplified Translation

Hello,
I am a Chinese Simplified translator, I am reaching out to see whether you want some Chinese Simplified (zh-CN) translation contribution.
Wait for your reply.

Best,
Kenneth

Localization/Translation to Filipino

Good day , Can I translate your project into my native langauge which is filipino

Ajax failed message during installation

Hi,

I am trying to install ESPOCRM, but during installation this message Ajax failed is displayed.
In firebug i can see url http://my_domain/api/v1/Metadata return code 401

I'm using php5.6 / nginx 1.10.3 and i use https://www.espocrm.com/documentation/administration/nginx-server-configuration/ to configure nginx.

Thanks for your help,
Best Regards,
Pascall

Вопрос по файлу bpm.md

Можно я переведу файл bpm.md не полностью сразу, а частями?

suggestion : log handling

For log processing it would be nice to always log to espo.log,
and move it to espo-2020-01-16.log at the end of the day.

This facilitates log processing eg
grep -i Espo.WARNING espo.log | cut -c 22-100 | uniq -c

Gmail Oauth panel does not show up for gmail account

OS: Ubuntu 20.04.1 LTS
Browser: Firefox, Chrome
EspoCRM: 5.9.4 (Running in local docker)

I set up Personal Email Account using a gmail address and saved the account. As per the docs (https://docs.espocrm.com/extensions/google-integration/gmail/), a panel on the right should allow me to authenticate with gmail server using OAuth, but there was no such panel after 'Save', just the block showing Assigned User, Created and Modified.

I have attached the screenshot below.

Thanks,
Hemant

Request to translations

Dear to owner project, introduce my name yuyuart who come from indonesia, i want to translate to indonesia in your project, if you wish, allow me to contribute in your project,.Regards,

Install Espocrm in Windows Server 2019, IIS

Hello folks,

I tried to install EspoCRM in a fresh installation of Windows Server 2019, but after I configured the IIS and gave the IIS permissions on EspoCRM folder I get the following problem:

I can click the start button, but it doesn't direct me to the next phase of the installation.

I got PHP 7.3 running on this machine, but also tried older versions.

Best regrads

Patrick

translating into indonesian language

hello can i translate it into indonesian language. so that Indonesian people can read it more easily understood

Translation of espoCRM documentation into spanish language

Greetings espoCRM Team!

I would like to help translating the documentation of espoCRM into spanish language. In order to do so, I have a couple of questions.

Should I make a new branch called Spanish and do the translation from there? or how would it be more convenient to have this translation?

Thanks in advance for your answer.

Spanish translation

I want to translate this project into Spanish, are there files to translate or is everything done?

Translating into Vietnamese

Hello, I'm Vietnamese and i want to help translating this program into Vietnamese

Add files

Hello team espoCRM

I have translate some file to indonesian , i want you add more files to indonesian language, like spanish and other language, thank you for attention!

Link on documentation website incorrect

The link on this page is incorrect, it is:

https://www.espocrm.com/documentation/administration//documentation/administration/ldap-authorization/

but should be:

https://www.espocrm.com/documentation/administration/ldap-authorization/

Request for Turkish translation

Hello, can I translate this project into Turkish language?

Translate to Thai language

Hello, I'm from Thailand and i would like to help translate the documentation to Thai language.
I would like to know how do you accept your contribution?

Looking forward to contribute.
Montakran.

Filipino Translation

Hi there. Can I add Filipino translations to your docs? I'd really like to contribute so that other Filipinos may discover and use this awesome project as well.

Contribution of Simplified Indonesian Translation

Hello,
I am an Indonesian translator Can I join this project, I am contacting you to find out if you want some Simplified (ID) translation translation.
Waiting for your reply.

add files

Hello team espoCRM

I have translate some file to Italian , i want you add more files to Italian language, like Italian and other language, thank you for attention!

I can't upload in file , give me error 405

I can't upload any file , when I try to do that give me error 405 .
thank your advice
"PHP Warning: mkdir(): Permission denied in C:\inetpub\wwwroot\Archive\application\Espo\Core\Utils\File\Manager.php on line 405"

Requesting for Tagalog or Cebuano Translation

Hi, I would like to open translation for Tagalog or Cebuano. I willing to contribute for this project using our own languageand also to introduce this project to my fellow Filipino people.

How to make a GET request for modifiedAt after a specifict datetime?

I've found that ?where[0][field]=somefield&where[0][type]=equals&where[0][value]=somevalue can be used to make a request for equality. But how can I query on a datetime field like modifiedAt? I'd like to query for all entities that have been modified after a specific datetime. How can this be done?

Is there a complete documentation for the filters that can be used on a GET request? How are the query parameters that build a filter to be used?

I will clone the files to tl_PH

I will clone your recent files of development and some of the user-guide so that i could easily translate the files directly from github. will make PR and put a commit description of "For Translation"

Thanks
@yurikuzn

Logo design

Hello, I would like to design a logo for your project. Do you have something on your mind for your logo? I can give some ideas if you are interested?
Greetings
Nuno

Nginx configuration?

I saw that you mention continuously that EspoCRM can be installed on Nginx too, but I see no official documentation about the .conf file parts that needs to be there.

Googling a little, I found only this result which I didn't test honestly: https://www.rosehosting.com/blog/how-to-install-espocrm-with-nginx-on-an-ubuntu-vps/

Can you please maybe offer an official version for it?

Thanks in advance!

asd

..

Clarify when API token gets invalidated

https://github.com/espocrm/documentation/blob/master/development/api.md states:

or token is not valid anymore

Please can you elaborate why/when/how a token might be invalidated?

I would like to create an API token for my API script to use, but I am worried that it might 'randomly' encounter this 401 error due to the token becoming invalidated. This is just for a "quick and dirty" script, so I don't really want to implement code to handle that situation if the conditions that cause token invalidation will not apply...