Add EspoCRM docs#1672
Conversation
|
@LaurentGoderre thanks for your recommendations. That's all fixed. |
|
@LaurentGoderre I fixed some ymlfmt & markdownfmt validation errors in the last commit. |
|
(force push: just a rebase to kick CI and see where we're at status-wise) |
|
There might be other things you want to update here (it's probably been a minute since you looked at it 😄) but here are a few notes I saw while reviewing it: The $ docker run --name mysql --network some-network -e MYSQL_ROOT_PASSWORD=password -d mysql:8
$ docker run --name some-%%REPO%% --network some-network -d %%IMAGE%%$ docker run --name some-%%REPO%% --network some-network -p 8080:80 -d %%IMAGE%%$ docker run --name some-%%REPO%% --network some-network -e ESPOCRM_SITE_URL=http://172.20.0.100:8080 -p 8080:80 -d %%IMAGE%%(The container name In ESPOCRM_ADMIN_PASSWORD: passwordAnd in the prose examples:
The image does the right thing -- it emits an explicit startup warning when default credentials are detected. But the docs present them as the happy path with no caveat. The stack.yml value should use a placeholder like
Two small prose fixes:
|
| image: espocrm/espocrm:latest | ||
| container_name: espocrm | ||
| environment: | ||
| ESPOCRM_DATABASE_HOST: espocrm-db | ||
| ESPOCRM_DATABASE_USER: espocrm | ||
| ESPOCRM_DATABASE_PASSWORD: your_database_password | ||
| ESPOCRM_ADMIN_USERNAME: admin | ||
| ESPOCRM_ADMIN_PASSWORD: your_admin_password | ||
| ESPOCRM_SITE_URL: "http://localhost:8080" | ||
| volumes: | ||
| - espocrm-data:/var/www/html/data | ||
| - espocrm-custom:/var/www/html/custom | ||
| - espocrm-custom-client:/var/www/html/client/custom | ||
| restart: unless-stopped | ||
| depends_on: | ||
| espocrm-db: | ||
| condition: service_healthy | ||
| healthcheck: | ||
| test: ["CMD", "bin/command", "app-check"] | ||
| start_period: 20s | ||
| interval: 60s | ||
| timeout: 20s | ||
| retries: 3 | ||
| ports: | ||
| - 8080:80 | ||
|
|
||
| espocrm-daemon: | ||
| image: espocrm/espocrm:latest | ||
| container_name: espocrm-daemon | ||
| volumes_from: | ||
| - espocrm | ||
| restart: unless-stopped | ||
| entrypoint: docker-daemon.sh | ||
| depends_on: | ||
| espocrm: | ||
| condition: service_healthy | ||
| healthcheck: | ||
| test: ["CMD", "bin/command", "app-check"] | ||
| start_period: 20s | ||
| interval: 180s | ||
| timeout: 20s | ||
| retries: 3 | ||
|
|
||
| espocrm-websocket: | ||
| image: espocrm/espocrm:latest |
There was a problem hiding this comment.
This file should reference only images from DOI 👀
What's the purpose of each espocrm container having the same exact health check? Does it actually check the running service in some way?
| image: espocrm/espocrm:latest | |
| container_name: espocrm | |
| environment: | |
| ESPOCRM_DATABASE_HOST: espocrm-db | |
| ESPOCRM_DATABASE_USER: espocrm | |
| ESPOCRM_DATABASE_PASSWORD: your_database_password | |
| ESPOCRM_ADMIN_USERNAME: admin | |
| ESPOCRM_ADMIN_PASSWORD: your_admin_password | |
| ESPOCRM_SITE_URL: "http://localhost:8080" | |
| volumes: | |
| - espocrm-data:/var/www/html/data | |
| - espocrm-custom:/var/www/html/custom | |
| - espocrm-custom-client:/var/www/html/client/custom | |
| restart: unless-stopped | |
| depends_on: | |
| espocrm-db: | |
| condition: service_healthy | |
| healthcheck: | |
| test: ["CMD", "bin/command", "app-check"] | |
| start_period: 20s | |
| interval: 60s | |
| timeout: 20s | |
| retries: 3 | |
| ports: | |
| - 8080:80 | |
| espocrm-daemon: | |
| image: espocrm/espocrm:latest | |
| container_name: espocrm-daemon | |
| volumes_from: | |
| - espocrm | |
| restart: unless-stopped | |
| entrypoint: docker-daemon.sh | |
| depends_on: | |
| espocrm: | |
| condition: service_healthy | |
| healthcheck: | |
| test: ["CMD", "bin/command", "app-check"] | |
| start_period: 20s | |
| interval: 180s | |
| timeout: 20s | |
| retries: 3 | |
| espocrm-websocket: | |
| image: espocrm/espocrm:latest | |
| image: espocrm:latest | |
| container_name: espocrm | |
| environment: | |
| ESPOCRM_DATABASE_HOST: espocrm-db | |
| ESPOCRM_DATABASE_USER: espocrm | |
| ESPOCRM_DATABASE_PASSWORD: your_database_password | |
| ESPOCRM_ADMIN_USERNAME: admin | |
| ESPOCRM_ADMIN_PASSWORD: your_admin_password | |
| ESPOCRM_SITE_URL: "http://localhost:8080" | |
| volumes: | |
| - espocrm-data:/var/www/html/data | |
| - espocrm-custom:/var/www/html/custom | |
| - espocrm-custom-client:/var/www/html/client/custom | |
| restart: unless-stopped | |
| depends_on: | |
| espocrm-db: | |
| condition: service_healthy | |
| healthcheck: | |
| test: ["CMD", "bin/command", "app-check"] | |
| start_period: 20s | |
| interval: 60s | |
| timeout: 20s | |
| retries: 3 | |
| ports: | |
| - 8080:80 | |
| espocrm-daemon: | |
| image: espocrm:latest | |
| container_name: espocrm-daemon | |
| volumes_from: | |
| - espocrm | |
| restart: unless-stopped | |
| entrypoint: docker-daemon.sh | |
| depends_on: | |
| espocrm: | |
| condition: service_healthy | |
| healthcheck: | |
| test: ["CMD", "bin/command", "app-check"] | |
| start_period: 20s | |
| interval: 180s | |
| timeout: 20s | |
| retries: 3 | |
| espocrm-websocket: | |
| image: espocrm:latest |
|
@tianon thank you for your feedback. We have reviewed your comments and implemented several improvements. Please feel free to share any further suggestions. |
| -d %%REPO%% && \ | ||
| docker run \ | ||
| --name espocrm-daemon \ | ||
| --network espocrm-network \ | ||
| --restart unless-stopped \ | ||
| --volumes-from espocrm \ | ||
| --entrypoint docker-daemon.sh \ | ||
| -d %%REPO%% |
There was a problem hiding this comment.
These should both still use %%IMAGE%% (which on the per-arch repo pages will expand to something like amd64/espocrm instead of just espocrm like %%REPO%% does -- they're the same on the library/ repos though).
| -e ESPOCRM_ADMIN_USERNAME=admin \ | ||
| -e ESPOCRM_ADMIN_PASSWORD=your_admin_password \ | ||
| -e ESPOCRM_SITE_URL=http://192.168.0.100:8080 \ | ||
| -d %%REPO%% |
|
|
||
| ```bash | ||
| docker pull mariadb | ||
| docker pull %%REPO%% |
There was a problem hiding this comment.
I don't know if you've got an SVG version of this, but it seems like it'd lend itself well to an SVG format (logo.png can be replaced by logo.svg and then our tooling will generate crisp versions of whatever sizes Docker Hub needs, both now and in the future).
This is the documentation for EspoCRM image, docker-library/official-images#7603