Skip to content

Add EspoCRM docs#1672

Open
tmachyshyn wants to merge 4 commits intodocker-library:masterfrom
tmachyshyn:espocrm
Open

Add EspoCRM docs#1672
tmachyshyn wants to merge 4 commits intodocker-library:masterfrom
tmachyshyn:espocrm

Conversation

@tmachyshyn
Copy link
Copy Markdown

@tmachyshyn tmachyshyn commented Mar 10, 2020

This is the documentation for EspoCRM image, docker-library/official-images#7603

Comment thread espocrm/stack.yml Outdated
Comment thread espocrm/stack.yml Outdated
Comment thread espocrm/stack.yml Outdated
Comment thread espocrm/stack.yml Outdated
@tmachyshyn
Copy link
Copy Markdown
Author

@LaurentGoderre thanks for your recommendations. That's all fixed.

@tmachyshyn
Copy link
Copy Markdown
Author

@LaurentGoderre I fixed some ymlfmt & markdownfmt validation errors in the last commit.
If any other changes are needed please let me know.

@tianon
Copy link
Copy Markdown
Member

tianon commented May 7, 2026

(force push: just a rebase to kick CI and see where we're at status-wise)

@tianon
Copy link
Copy Markdown
Member

tianon commented May 7, 2026

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 examples use --link, which has been deprecated. The current pattern across these docs is --network some-network (see e.g. drupal, joomla):

$ 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 mysql matches the default ESPOCRM_DATABASE_HOST, so no extra env var is needed.)


In stack.yml:

ESPOCRM_ADMIN_PASSWORD: password

And in the prose examples:

access it via http://localhost:8080 with credentials "admin" and "password"

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 your_admin_password, and the prose examples should note that those credentials need to be changed before any real use.


ESPOCRM_DATABASE_PORT is a supported install-time option (it's in the image's defaults) but doesn't appear in the environment variables section.


Two small prose fixes:

  • "This image requires to run MySQL server" → "This image requires a running MySQL server"
  • "These environment variables are using to define" → "are used to define"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants