Skip to content

Update Symfony server docs to be more highlighted #11428

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Update Symfony server docs to be more highlighted #11428

wants to merge 1 commit into from

Conversation

Pierstoval
Copy link
Contributor

I found the Docker-based setup very useful, and it was not really obvious to me that service names needed to be specific in order for the CLI to change the associated env vars.

That's why I thought adding a note tag to it would highlight it a bit more in order for it to be clear. Especially because this note shows the list of service names that are mandatory for Symfony CLI to adapt.

WDYT?

elasticsearch: ...
# RABBITMQ_DSN
rabbitmq: ...
Here is the list of services you can autoconfigure with their environment variable name:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We are always setting env vars. So, if your MySQL container is named db, env vars will be prefixed with DB_. The only specificity of naming it DATABASE_ is that Symfony Flex uses that by default. But having the possibility to choose the prefix is important when using more than 1 container of the same type.

Copy link
Contributor Author

@Pierstoval Pierstoval Apr 15, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, this is not really the behavior I expected 😄 It's even better 😃

Would you suggest I add another line with the db service using the DB_URL env var, as a mark of example?

It could be more interesting to have more details about the exact checks that are done.

I would guess that it only changes the host+port part in the URL/DSN, but is this even close to truth? Could you give more specific details about the internals of these automated checks so the docs can be more self-explanatory using better examples that fit all cases? 🙂

@javiereguiluz
Copy link
Member

@tucksaun could you please review this proposal to see if we can merge it or requires some changes? Thanks!

@tucksaun
Copy link
Contributor

I have the feeling what we need instead is a small tweak of the section following this one (ie If your ``docker-compose.yaml`` file doesn't use the environment variable names...): we talk about variables names whereas we want to mention service names?

@javiereguiluz
Copy link
Member

This contribution stalled ... should we close? Change anything? merge "as is"? Thanks.

@javiereguiluz
Copy link
Member

Let's close this one and we can reconsider if we receive more feedback. Thanks.

@Pierstoval Pierstoval deleted the sf-cli branch September 26, 2019 18:39
@fabpot
Copy link
Member

fabpot commented Sep 28, 2019

see #12391

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

Successfully merging this pull request may close these issues.

5 participants