{"id":15026253,"url":"https://github.com/thebuzzycoder/dockerised-espocrm","last_synced_at":"2025-10-28T11:42:04.921Z","repository":{"id":96561302,"uuid":"140469960","full_name":"theBuzzyCoder/dockerised-espocrm","owner":"theBuzzyCoder","description":"EspoCRM hosted on Docker Containers with development mode and production mode","archived":false,"fork":false,"pushed_at":"2018-11-26T19:49:03.000Z","size":245,"stargazers_count":7,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-09T20:38:01.796Z","etag":null,"topics":["crm-platform","docker","docker-compose","espocrm","php72","phpunit"],"latest_commit_sha":null,"homepage":"https://thebuzzycoder.github.io/dockerised-espocrm","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/theBuzzyCoder.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-07-10T18:02:52.000Z","updated_at":"2020-11-18T14:26:42.000Z","dependencies_parsed_at":null,"dependency_job_id":"495736a3-92da-4f39-852d-ff0fa2595fe1","html_url":"https://github.com/theBuzzyCoder/dockerised-espocrm","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/theBuzzyCoder/dockerised-espocrm","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theBuzzyCoder%2Fdockerised-espocrm","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theBuzzyCoder%2Fdockerised-espocrm/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theBuzzyCoder%2Fdockerised-espocrm/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theBuzzyCoder%2Fdockerised-espocrm/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/theBuzzyCoder","download_url":"https://codeload.github.com/theBuzzyCoder/dockerised-espocrm/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theBuzzyCoder%2Fdockerised-espocrm/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261509914,"owners_count":23169682,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["crm-platform","docker","docker-compose","espocrm","php72","phpunit"],"created_at":"2024-09-24T20:04:08.938Z","updated_at":"2025-10-28T11:41:59.863Z","avatar_url":"https://github.com/theBuzzyCoder.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# EspoCRM Dockerized\n\nDockerized EspoCRM with ability to run unit-test during development and use build of EspoCRM in production.\n\n## Cloning this repository\n\nExplanation of require path configurations are given [here](./webapp/README.md)\n\n## Pre-Installation\n\n### Ubuntu / Linux\n\nMaking sure docker doesn't require superuser permission to run commands.\n\n```bash\ndocker container ls\n```\n\nIf this fails and you get Permission denied message, run the following command\n\n```bash\nsudo usermod -aG docker $USER\nsudo reboot\n```\n\n### Mac OS\n\n1. Go to Docker Preferences =\u003e File Sharing\n2. Add `/crm` path, otherwise docker volume mount will fail.\n\n## Installation [For Production]\n\n```bash\ndocker build -t crm-webapp:1.0.0 --build-arg VERSION=5.4.5 -f webapp/Dockerfile /crm\ndocker-compose -f prod.docker-compose.yml up -d\n```\n\nLoad http://localhost and follow the [installation steps of EspoCRM](https://www.espocrm.com/documentation/administration/installation/).\n\nThe Host Name of MySQL is `mysqldb:3306`.\n\n## Installation [For Development]\n\nNote: -v option is for EspoCRM's Version and -V is for verbose mode\n\n### Ubuntu / Linux\n\n```bash\nsudo mkdir /crm\nsudo chown -R $USER:$USER /crm\ngit clone git://github.com/theBuzzyCoder/dockerised-espo.git /crm\n./installer -v 5.4.5 -V\n```\n\nLoad http://localhost:8088 and follow the [installation steps of EspoCRM](https://www.espocrm.com/documentation/administration/installation/).\nThe Host Name of MySQL is `mysqldb:3306`.\n\n### Mac OS\n\n```sh\nsudo mkdir /crm\nsudo chown -R $USER:$USER /crm\ngit clone git://github.com/theBuzzyCoder/dockerised-espo.git /crm\n./macOs-installer -v 5.4.5 -V\n```\n\nLoad http://localhost:8088 and follow the [installation steps of EspoCRM](https://www.espocrm.com/documentation/administration/installation/).\nThe Host Name of MySQL is `mysqldb:3306`.\n\n## Extensions\n\nEspoCRM allows build your own custom extensions to suit your needs.\n\n[Here](./projects/README.md)'s how you can do that in this setup.\n\n## Debugging\n\n- Logs can be found in `espocrm/data/logs` folder of your container\n- You can also do this\n  - `docker volume inspect crm_database-configurations`\n  - Use MountPoint path and append `/logs` to that path to see all log files\n- Your database configurations will be stored in `espocrm/data/config.php` file of your container.\n- In case, you have forgotten your CRM's admin's login password or unable to login and outbound email is not set to send reset password, just delete `espocrm/data/config.php` file and follow the [installation steps of EspoCRM](https://www.espocrm.com/documentation/administration/installation/).\n- You can also change LOG_LEVEL in the `espocrm/data/config.php` file of your container. By default, it will be `WARNING`.\n- Adding System Email Id to send reset password should be done in SMTP settings of Outbound Email in Administration panel.\n- Adding shared email id's that will be used by users of EspoCRM should happen in Administration Panel's Group emails section of the application.\n- Just in case if you get `SQL STATE` errors or `bad server response` follow this:\n  - `docker container ls | grep Server | awk '{print $NF}'`\n  - Get the container name of crmServer and put it in \u003ccrmServer\u003e placeholders below\n  - `docker exec \u003ccrmServer\u003e php -f clear_cache.php`\n  - `docker exec \u003ccrmServer\u003e php -f rebuild.php`\n  - Go to your browser and run `Ctrl + F5` or `Ctrl + Shift + r` to force reload all the .js and .css files.\n\n## Running Unit and Integration Tests\n\nYou can run tests only on development mode. So, your docker-compose file should be dev.docker-compose.yml\nwhile bringing containers up.\n\n### Installing phpunit\n\n```bash\ndocker exec devCrmServer apk add wget\ndocker exec devCrmServer wget -O phpunit https://phar.phpunit.de/phpunit-7.phar\ndocker exec devCrmServer chmod +x phpunit\n```\n\n### Unit Test\n\n```bash\ndocker exec devCrmServer phpunit --bootstrap ./vendor/autoload.php tests/unit\n```\n\n### Integration Test\n\nMake sure you update the version in config.php file to your Espo version. By default it will be `@@version`.\n\nFor example, if espo crm version is 5.4.5 then in config.php make sure it is 5.4.5.\n\nAlso you have to generate build before running integration tests. The build will be present in `/crm/espocrm/build/EspoCRM-5.4.5`\n\nGenerating build:\n```bash\ndocker run --rm -v /crm/espocrm:/app node:8.12.0-alpine sh -c \"cd /app; npm install; npm install -g grunt-cli; grunt\"\n```\n\nRunning Test:\n```bash\ndocker exec devCrmServer cp data/config.php tests/integration/config.php\ndocker exec devCrmServer phpunit --bootstrap ./vendor/autoload.php tests/integration\n```\n\nIt takes a while to running integration tests unlike unit tests.\n\n## Contributors\n\n[List of Contributors](./Contributors.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthebuzzycoder%2Fdockerised-espocrm","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthebuzzycoder%2Fdockerised-espocrm","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthebuzzycoder%2Fdockerised-espocrm/lists"}