diff --git a/espocrm/README-short.txt b/espocrm/README-short.txt new file mode 100644 index 000000000000..82ebd48256be --- /dev/null +++ b/espocrm/README-short.txt @@ -0,0 +1 @@ +EspoCRM is a highly customizable open source CRM software. diff --git a/espocrm/content.md b/espocrm/content.md new file mode 100644 index 000000000000..cb3f940c938b --- /dev/null +++ b/espocrm/content.md @@ -0,0 +1,132 @@ +# What is EspoCRM? + +EspoCRM is a highly customizable open source CRM software that allows users to see, enter and evaluate all your company relationships regardless of the type. People, companies, projects or opportunities - all in an easy and intuitive interface. + +%%LOGO%% + +# How to use this image + +This image requires to run MySQL server: + +```console +docker run --name mysql -e MYSQL_ROOT_PASSWORD=password -d mysql:8 +``` + +Run EspoCRM container: + +```console +docker run --name some-%%REPO%% --link mysql:mysql -d %%IMAGE%% +``` + +Run EspoCRM container via a specific port: + +```console +docker run --name some-%%REPO%% -p 8080:80 --link mysql:mysql -d %%IMAGE%% +``` + +Then, access it via `http://localhost:8080` with credentials "admin" and "password". + +Run EspoCRM via a specific IP or a domain with a port: + +```console +docker run --name some-%%REPO%% -e ESPOCRM_SITE_URL=http://172.20.0.100:8080 -p 8080:80 --link mysql:mysql -d %%IMAGE%% +``` + +Then, access it via `http://172.20.0.100:8080` with credentials "admin" and "password". + +## %%STACK%% + +Run `docker stack deploy -c stack.yml %%REPO%%` (or `docker-compose -f stack.yml up`), wait for it to initialize completely, and visit `http://localhost:8080`. + +## Environment variables + +This is one-time environment variables which are using only for the fresh installation. If you need to define configuration options on the container startup, see the [Config Environments](#config-environments). + +#### ESPOCRM_DATABASE_PLATFORM + +Database platform. The possible values: `Mysql` or `Postgresql`. The default value is `Mysql`. + +#### ESPOCRM_DATABASE_HOST + +Database host name for EspoCRM. The default value is `mysql`. + +#### ESPOCRM_DATABASE_NAME + +Database name for EspoCRM. The default value is `espocrm`. + +#### ESPOCRM_DATABASE_USER + +Database user for EspoCRM. The default value is `root`. + +#### ESPOCRM_DATABASE_PASSWORD + +Database password for EspoCRM. The default value is `password`. + +#### ESPOCRM_ADMIN_USERNAME + +User name for an administrator of EspoCRM. The default value is `admin`. + +#### ESPOCRM_ADMIN_PASSWORD + +User password for an administrator of EspoCRM. The default value is `password`. + +#### ESPOCRM_SITE_URL + +The URL of EspoCRM. This option is very important for normal operating of EspoCRM. Examples: `http://172.20.0.100:8080`, `http://my-crm.local`. + +### Other optional options + +The list of possible values and their default values can be found in EspoCRM Administrator panel > Settings. + +- `ESPOCRM_LANGUAGE` +- `ESPOCRM_DATE_FORMAT` +- `ESPOCRM_TIME_FORMAT` +- `ESPOCRM_TIME_ZONE` +- `ESPOCRM_WEEK_START` +- `ESPOCRM_DEFAULT_CURRENCY` +- `ESPOCRM_THOUSAND_SEPARATOR` +- `ESPOCRM_DECIMAL_MARK` + +## Config Environments + +These environment variables are using to define configuration parameters of the EspoCRM every time on the container startup. The parameters that can be changed are defined in the `data/config.php` or `data/config-internal.php`. + +### Naming + +Config environment variables should be converted from the camel-case format. For example: + +The `exportDisabled` config option should be converted to `ESPOCRM_CONFIG_EXPORT_DISABLED`. + +### Logger + +There are additional options to change the `logger`: + +- `ESPOCRM_CONFIG_LOGGER_LEVEL: 'DEBUG'` +- `ESPOCRM_CONFIG_LOGGER_MAX_FILE_NUMBER: 30` +- `ESPOCRM_CONFIG_LOGGER_PATH: 'data/logs/espo.log'` + +### Allowed types: + +#### String + +```yaml +ESPOCRM_CONFIG_WEB_SOCKET_URL: 'wss://my-espocrm.com:8080' +``` + +#### Integer + +```yaml +ESPOCRM_CONFIG_EMAIL_MESSAGE_MAX_SIZE: 10 +``` + +#### Boolean + +```yaml +ESPOCRM_CONFIG_USE_WEB_SOCKET: 'true' +``` + +#### Null + +```yaml +ESPOCRM_CONFIG_CURRENCY_DECIMAL_PLACES: 'null' +``` diff --git a/espocrm/get-help.md b/espocrm/get-help.md new file mode 100644 index 000000000000..88e755bdafe8 --- /dev/null +++ b/espocrm/get-help.md @@ -0,0 +1 @@ +[GitHub Issues](https://github.com/espocrm/espocrm/issues), [EspoCRM Documentation](https://docs.espocrm.com), [EspoCRM Community](https://forum.espocrm.com) diff --git a/espocrm/github-repo b/espocrm/github-repo new file mode 100644 index 000000000000..cb578347e0e0 --- /dev/null +++ b/espocrm/github-repo @@ -0,0 +1 @@ +https://github.com/espocrm/espocrm-docker diff --git a/espocrm/license.md b/espocrm/license.md new file mode 100644 index 000000000000..40baafa8894a --- /dev/null +++ b/espocrm/license.md @@ -0,0 +1 @@ +View [license information](https://www.espocrm.com/espocrm-open-source-license/) for the software contained in this image. diff --git a/espocrm/logo.png b/espocrm/logo.png new file mode 100644 index 000000000000..879de5e8b684 Binary files /dev/null and b/espocrm/logo.png differ diff --git a/espocrm/maintainer.md b/espocrm/maintainer.md new file mode 100644 index 000000000000..1f189b7424e8 --- /dev/null +++ b/espocrm/maintainer.md @@ -0,0 +1 @@ +[EspoCRM](%%GITHUB-REPO%%) diff --git a/espocrm/stack.yml b/espocrm/stack.yml new file mode 100644 index 000000000000..84330b36479e --- /dev/null +++ b/espocrm/stack.yml @@ -0,0 +1,58 @@ +version: '3.8' + +services: + + mysql: + image: mysql:8 + container_name: mysql + environment: + MYSQL_ROOT_PASSWORD: root_password + MYSQL_DATABASE: espocrm + MYSQL_USER: espocrm + MYSQL_PASSWORD: database_password + volumes: + - mysql:/var/lib/mysql + restart: always + + espocrm: + image: espocrm + container_name: espocrm + environment: + ESPOCRM_DATABASE_HOST: mysql + ESPOCRM_DATABASE_USER: espocrm + ESPOCRM_DATABASE_PASSWORD: database_password + ESPOCRM_ADMIN_USERNAME: admin + ESPOCRM_ADMIN_PASSWORD: password + ESPOCRM_SITE_URL: http://localhost:8080 + volumes: + - espocrm:/var/www/html + restart: always + ports: + - 8080:80 + + espocrm-daemon: + image: espocrm + container_name: espocrm-daemon + volumes: + - espocrm:/var/www/html + restart: always + entrypoint: docker-daemon.sh + + espocrm-websocket: + image: espocrm + container_name: espocrm-websocket + environment: + ESPOCRM_CONFIG_USE_WEB_SOCKET: 'true' + ESPOCRM_CONFIG_WEB_SOCKET_URL: ws://localhost:8081 + ESPOCRM_CONFIG_WEB_SOCKET_ZERO_M_Q_SUBSCRIBER_DSN: tcp://*:7777 + ESPOCRM_CONFIG_WEB_SOCKET_ZERO_M_Q_SUBMISSION_DSN: tcp://espocrm-websocket:7777 + volumes: + - espocrm:/var/www/html + restart: always + entrypoint: docker-websocket.sh + ports: + - 8081:8080 + +volumes: + mysql: + espocrm: