Update README with Symfony set up hint #621
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added a clarification note to README.md to inform users how to set up a Symfony Flex application using the `docker compose up --pull always -d --wait` Docker command. This additional information provides clearer guidance for users looking to set up the application.
|
Context is that I never expected that symfony gets set up via |
maxhelias
reviewed
Apr 27, 2024
|
I'm ok with @maxhelias' proposal. It's already written in the first line of the READMe and in the description that this is an "installer and runtime". |
|
It's @dunglas, im a big fan of your work. Yes I read that but didn't realize that the docker command would set it up. I think this change if it is fine with you will improve the instructions for stupid people like me who tend to rush to the execution part. |
|
Thanks! Isn't rewording step 3 as suggested by Max good enough? We try to keep the README as readable and as focused as possible. |
|
Yes, I will reword step 3 as he suggested and update the PR. I'm just currently not at home. |
Rephrasing point 3 instead of using a note. See: dunglas#621 (comment)
|
Updated. I got notice that it should be "set up", not a native. |
leroy0211
reviewed
Apr 27, 2024
maxhelias
approved these changes
Apr 29, 2024
|
Thanks for this contribution 😃 |
Give a little bit take a little bit. |
lbmolnar
pushed a commit
to lbmolnar/commission-calculator-demo
that referenced
this pull request
May 7, 2024
Rephrasing point 3 instead of using a note. See: dunglas/symfony-docker#621 (comment)
DimaMaimesko
pushed a commit
to DimaMaimesko/project-manajer
that referenced
this pull request
Jun 1, 2024
Rephrasing point 3 instead of using a note. See: dunglas/symfony-docker#621 (comment)
lleeoo130
pushed a commit
to lleeoo130/test-repo
that referenced
this pull request
Aug 16, 2024
Added a clarification note to README.md to inform users how to set up a Symfony Flex application using the `docker compose up --pull always -d --wait` Docker command. This additional information provides clearer guidance for users looking to set up the application. Update README Rephrasing point 3 instead of using a note. See: dunglas/symfony-docker#621 (comment) new begining removed migration test mig new dumps added schema update added schema update switch to mysql added sql file added drop database before creating added --force to drop database on tests removed test database migration + database removed test on app_test added first test hado lint on dockerfile added security + hwi_oauth created User added google login
yelloweq
pushed a commit
to yelloweq/portfolio
that referenced
this pull request
Sep 29, 2024
Clone Symfony Starter Repo Autoload tests only in the dev environment Tests don't need to be registered in the production autoloader. Move flex-id to extra settings bumped min version to 7.1 reworked the flex section under extra Remove useless conflict Not much use to depend on `symfony/framework-bundle:3.3.x-dev` and then declare a conflict with `<3.3`. renamed the flex section to symfony - Add Docker support Update package name Remove the Dotenv component Upgrade the Docker setup and dependencies Fix docker-compose.yml Add missing 'make' dependency Removed IP checks block from front controller Various fixes Just type "docker-compose up" to install a Flex project (major refactoring) Dynamic resolution Fix typo h2 and HTTPS support Use composer create-project Wait for the PHP container to start Nginx Allow to use Symfony 4 Fix .gitignore Use multi-stage build Use php:7.2-fpm-alpine image which allows FPM to listen on all interfaces even when IPv6 is disabled. See docker-library/php#562 Bump dependencies Remove composer as first parent layer Support specific version Fix the build of app with auto-script like recipe framework-bundle Use SYMFONY_VERSION as a variable name everywhere to avoid mistakes Pass stability from env variable Improve OPcache settings Reverse proxy with nginx Performance tuning for app volume Use cached strategy on volume ( the host’s view is authoritative (permit delays before updates on the host appear in the container) to optimize container performance. Docker documentation on this : https://docs.docker.com/docker-for-mac/osxfs-caching/#tuning-with-consistent-cached-and-delegated-configurations Fix the STABILITY env Gather all Dockerfile in one Basic readme telling how to select symfony version (#23) * Basic readme telling how to select symfony version * Describe installing symfony with custom stability * Update README.md Fix typo Fix docker-compose after all dockerfile in one Add documentation for debugging Bump version Prevent some warnings related to env vars Fix reverse proxy Add missing depends_on section Improve README.md Updated readme to include a note about linux users (#37) * Updated readme to include a note about linux users * Fixed typo and moved section before Credits * Updated section title * Use title case in the title Fixed xdebug guide Adding Travis integration Use php.ini depending on env fix service name in docker-compose command Replace the service name in docker-compose command with the correct one Replace Prestissimo by Flex simplify docker-compose command with override file remove warning intl Add the extra.symfony.docker flag Solution to issues/52 dunglas/symfony-docker#52 Solved Add Max to credits section Upgrade Dockerfile Upgrade Dockerfile Fix --with-libzip Add missing proxy options added ability to define custom server name; fixed chrome/brave ssl issues using subjectAltName Missing install for prod mode Adapt installation for dump env var Add docs for customize server name feat: add support for PHP preloading feat: switch to GitHub Actions (#72) * feat: switch to GitHub Actions * feat: add docker compose cache * docs: add GH actions badge feat: split dev and prod docker-compose files feat: Use Caddy server (#75) * feat: Use Caddy server * cs fix: static files server configuration docs: refactor and add a doc explaining how to deploy in prod Fix typo in production.md fix: a comment in docker-compose.override.yml fix: remove use of deprecated Composer flag --no-suggest oversight 'docker-compose' Remove global Flex as it's not needed with Composer 2 feat: add support for Doctrine ORM (#74) * feat: add support for Doctrine ORM * feat: wait for DB and handle migrations if necessary * feat: automatically use the MARIADB password * fix cs * feat: switch to postgres * feat: switch to Postgres fix: DATABASE_URL env var docs: symfony/orm-pack now installs a Postgres service fix: deprecated option on composer v2 Mention HTTPs redirect fix in documentation Update troubleshooting.md feat: add built-in Mercure support (#89) * feat: Mercure support * feat: add native Mercure support * improvements * feat: add Mercure UI * fix: typo * finish fix: update SSL trust issue feat: upgrade to PHP 8 (#92) * feat: upgrade to PHP 8 * fix: preload docs: add HTTP/3 to README.md Update doc for Xdebug 3 Typo fix feat: add .editorconfig and fix indent of some files (#98) fix: .editorconfig xml definition (#99) fix: ensure bin/console is always executable (#100) fix: experimental_http3 moved under server.protocol to fix deprecation notice (#105) fix: properly check for DB environment (#107) Make sure the `DATABASE_URL` is checked without comments :) fix: do not check DB availability if code errors (#110) * fix: do not check DB availability if code errors Do not wait for the DB to be available if there are other errors blocking the access to it. * Update docker-entrypoint.sh Co-authored-by: Kévin Dunglas <[email protected]> Create FUNDING.yml feat: synchronize with API Platform's definition (#113) feat: Add expose_php = Off (#116) feat: Try to create empty database at startup, in order to avoid the error message : "The database is not up or not reachable" if database doesnt exist. (#119) fix: error message : run: adapting config using caddyfile: /etc/caddy/Caddyfile:5: unrecognized global option: servers (#118) Revert "feat: Try to create empty database at startup, in order to avoid the error message : "The database is not up or not reachable" if database doesnt exist. (#119)" This reverts commit cb77bd1. Revert "fix: error message : run: adapting config using caddyfile: /etc/caddy/Caddyfile:5: unrecognized global option: servers (#118)" This reverts commit 9a27dd1. fix: backport latest changes made in API Platform (#121) fix: issue preventing Caddy to start (#125) * fix: issue preventing Caddy to start * ci: remove counter-productive Docker Compose cache action fix: ensure that the latest version of Mercure and Vulcain are always used. (#131) * fix: ensure that the latest version of Mercure and Vulcain are always used * fix: temporarily disable Vulcain fix: add Vulcain back (#133) feat: update xdebug version to 3.0.4 (#141) feat: update apcu version to 5.1.20 (#140) Fix comment and add another comment (#148) This comment seems to got wrong over time: The config made sense first: dunglas/symfony-docker@df6286b#diff-e45e45baeda1c1e73482975a664062aa56f20c03dd9d64a827aba57775bed0d3 Then the config became obsolete: dunglas/symfony-docker@4e25808 Then the config became a (I think wrong) comment: dunglas/symfony-docker@0167334#diff-e45e45baeda1c1e73482975a664062aa56f20c03dd9d64a827aba57775bed0d3 I don't use Mac so I don't know but maybe the whole comment could be removed completely since the `cached` option was introduced. feat: compat with MercureBundle 0.3 (#128) * feat: compat with MercureBundle 0.3 * fix: review docs: remove Messenger from the list of supported packages (#151) feat: allow to install the website skeleton (#152) * feat: allow to install the website skeleton * wip * wip * cleanup * revert rename in docs * cleanup fix: healthcheck (#154) docs: add docker-compose build (#155) docs: explain how to use SF Docker with an existing project (#156) fix: download the correct skeleton in the Dockerfile (#157) Fix typos in the docs (#158) docs: fix typo in xdebug.md (#159) docs: add a section for xdebug in PHPStorm (#160) docs: Improve Xdebug configuration documentation with PHPStorm (#162) fix: set php-fpm process_control_timeout (#176) Copied from api-platform/api-platform#1997 Added a Makefile (#180) fix: prevent installing another Mercure hub (#181) docs: Add new extra services availables (#183) doc: precision about makefile (#185) Do not run composer install in prod (#188) Sync Docker and composer PHP versions in new projects (#190) feat: upgrade to PHP 8.1 (#193) feat: make HTTP ports variable (#195) fix: multistage alias from lower to uppercase docs(xdebug): fix host on Linux Check for for files in subdirectories of migrations/ Typo fix Remove iconv workaround Replace unsupported wip tld by localhost (#254) ICU 71.1 support feat: remove deprecated flags feat: improve PHP config (#266) * feat: improve PHP config Tweak PHP config according to Blackfire's recommendation. * Update docker/php/conf.d/symfony.prod.ini Co-authored-by: Jacob Dreesen <[email protected]> * fix * fix Co-authored-by: Jacob Dreesen <[email protected]> feat: Promote Compose v2 Windows performance hint (#270) docs: trust certificate on Windows (#272) Added information about how to add the caddy cert to the trusted certificates on Windows as this info was only provided for Linux & Mac. feat: add native Xdebug support (#271) * feat: add native Xdebug support * cleanup * fix review * fix review * Improve docs * some more improvements * remove useless env var Update README.md Update README.md refactor: improve image, uniformize with API Platform (#275) * refactor: improve image, uniformize with API Platform * feat: remove the SKELETON arg chore: minor improvements and sync with API Platform (#277) chore: compatibility with the new ORM recipe (#278) chore: add a default value for XDEBUG_MODE fix: stop use obsolete experimental_http3 option fix: use !ChangeThisMercureHubJWTSecretKey! as default JWT secret key (#295) Use php extensions installer https://github.com/mlocati/docker-php-extension-installer Fixes dunglas/symfony-docker#276 docs: Xdebug on symfony commands fix: fixed reference code feat: improve Dockerfile link on copy docs: add license feat: rename DEBUG to CADDY_DEBUG Using the new binary-only image from Composer chore: remove build args Update Dockerfile Co-authored-by: Maxime Helias <[email protected]> feat: Allow local certificates to be used by Caddy Update build doc to support Windows OS docs: use correct .PHONY syntax with colon (:) Ensure tmp folder is empty feat: upgrade to PHP 8.2 chore: disable Caddy's push directive Match / and . in Makefile help regex docs: configuring a load balancer or a reverse proxy Use hadolint to check dockerfile docs: add server name tips and custom https port note (#368) * docs: add server name tips and custom https port note * Update docs/build.md Co-authored-by: Kévin Dunglas <[email protected]> * Update docs/build.md Co-authored-by: Kévin Dunglas <[email protected]> Co-authored-by: Kévin Dunglas <[email protected]> Watch Caddyfile in dev env Add charset in docker-compose.yml Typo (#387) * Typo * Update build.md --------- Co-authored-by: Kévin Dunglas <[email protected]> Format dev PHP extensions as prod Sort prod PHP extensions alphabetically Fix indentation in Dockerfile (#396) There was an indentation with 4spaces that made vim edition look weird. fix: Caddy build (#407) ci: simplify Hadolint config SYMFONY constant have to be based on PHP one refactor: simplify Dockerfile Upgrade posgres default version (#417) In the 2.8 doctrine bundle recipes the default posgres version is 15 so let's keep in sinc with it Co-authored-by: matheo <[email protected]> feat: suppress Docker healthcheck requests from logs (#432) docs: minor improvements in production.md (#433) feat: faster builds feat: set chmod in COPY instructions (#450) * Set chmod in COPY instructions for docker scripts * Use octal notation in COPY chmod Add healthcheck logic for waiting that php service is ready (#448) feat: Change xdebug.client_host configuration for dev environments (#461) Co-authored-by: Benjamin <[email protected]> feat: add Caddy healthcheck and various cleanup (#462) * feat: add Caddy healthcheck and various cleanup * fix healtcheck chore: sync with API Platform feat: better healthcheck and prevent useless composer install calls feat: switch to FrankenPHP (#460) Remove duplicate app.ini copy link in Dockerfile (#468) fix: session support chore: remove useless fgci package Adding --detach option to the command fix: do not use xdebug://gateway to resolve host address Update Dockerfile Replace spaces indentations by tabs indentations in dockerfile fix: install Composer dependencies if vendor directory is empty (#491) * fix: install Composer dependencies if vendor directory is empty * Update frankenphp/docker-entrypoint.sh Co-authored-by: Vincent <[email protected]> --------- Co-authored-by: Kévin Dunglas <[email protected]> Co-authored-by: Vincent <[email protected]> chore: backport fixes and improvements from API Platform Fix typos documentation Fix typos documentation for windows users chore: remove top-level version elements Update README.md --pull option requires an argument ("always"|"missing"|"never") docs: fix command to run containers (#512) * docs(production): fix command to run containers The commands were pointing to a `docker-compose.yml` file that doesn't exist. It's `compose.yaml` now. * docs(tls): update config file name * docs(extra-services): update config file name docs: add tips to pass local environment variables to containers fix: use the dev-main version of runtime/frankenphp-symfony for Symfony 7 compat Update the version of recommended Symfony version feat: add caddy server extra docs: add note chore: switch to stable versions docs: replace FPM by FrankenPHP docs: add test target in makefile template docs: updating the project (#520) * doc: add template-sync tool to the documentation * docs: add a link tu update.md in README * fix: pr review * Update README.md * Update and rename update.md to updating.md --------- Co-authored-by: Kévin Dunglas <[email protected]> docs: update template-sync link docs: various fixes in production.md docs: remove unecessary whitespace in production.md feat: use install-php-extensions to install Composer docs: update digitalocean screenshots missing dot feat: add Brotli compression support docs: add mention to use composer require inside container Update docs "Troubleshooting -> HTTPs and Redirects" section Add documentation on how to use MySQL instead of PostgreSQL. (#567) Co-authored-by: Kévin Dunglas <[email protected]> Co-authored-by: Borislav Kosun <[email protected]> Co-authored-by: Maxime Helias <[email protected]> docs: update template-sync link ci: fail when getting an HTTP error (#581) * Update ci.yml Allow curl check to fail if response code is greater than or equal to 400. * Update ci.yml * Update ci.yml feat: switch to Debian instead of Alpine docs: using Alpine Linux instead of Debian Added git specific file copy command to docs. With the new instructions the copying to an existing project doesn't destoy the cloned symfony-docker repository. Re-added the warning about the .git directory. The re added version warns to not copy it instead of recommending it's deletion. Corrected improper use of with. docs: use the same command as in the symfony doc docs: add all options available with env var (#598) * docs: add all options available with env var * Update docs/options.md Co-authored-by: Kévin Dunglas <[email protected]> * Update docs/options.md --------- Co-authored-by: Kévin Dunglas <[email protected]> Update makefile.md Add a `make bash` command to use a bash session so that the up and down arrows use previously used commands. build(compose.yaml): introduce TRUSTED_HOSTS and CADDY_MERCURE_PUBLIC_URL variables Fix issue with invalid TRUSTED_HOSTS and MERCURE_PUBLIC_URL when using http://localhost or :80 as SERVER_NAME docs(tls.md): add instructions about disabling HTTPS fix: volume instruction moved for all stages * /app/var shall be a volume on all stages to keep the overlay clean. Fixes #602 * Update Dockerfile --------- Co-authored-by: Oliver Skibbe <[email protected]> Co-authored-by: Maxime Helias <[email protected]> feat: use the --all-or-nothing flags for migrations Update README with Symfony set up hint Added a clarification note to README.md to inform users how to set up a Symfony Flex application using the `docker compose up --pull always -d --wait` Docker command. This additional information provides clearer guidance for users looking to set up the application. Update README Rephrasing point 3 instead of using a note. See: dunglas/symfony-docker#621 (comment) docs: fix Alpine image tag (#637) Add healthcheck section to the documentation to change from PostgreSQL to MySQL. GitHub CI was failing with an unhealthy status. Update mysql.md Added instructions to start docker services after re-building chore: simplify Caddyfile (Caddy 2.8) Fix to load app's ini files after all other extensions are loaded (#617) Co-authored-by: Borislav Kosun <[email protected]> Co-authored-by: Leroy Baeyens <[email protected]> fix: development volumes with new location of the 20-app.dev.ini file (#652) With the fix to load app's ini files after all other extensions are loaded (#617), the app-dev.ini file has been renamed 20-app.dev.ini and has been moved to a folder named "app.conf.d". Although, the fix forgot to update the development environment file `compose.override.yaml` with the new name and location. chore: remove useless trusted proxies environement variables (#651)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added a clarification note to README.md to inform users how to set up a Symfony Flex application using the
docker compose up --pull always -d --waitDocker command. This additional information provides clearer guidance for users looking to set up the application.