From 4c0c66bdb4079f9f97c1923fd9abb5bc99eab966 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julien=20Fastr=C3=A9?= Date: Fri, 30 May 2025 15:30:19 +0200 Subject: [PATCH] Add installation dependencies and improve setup instructions Expanded the installation guide to include required dependencies such as `jq`, `php`, `composer`, and `symfony-cli`, among others. Updated setup commands to include `-W` flag for better dependency handling and added a cache clear step to ensure proper asset compilation. These changes enhance clarity and streamline the installation process. --- .../installation/installation-production.rst | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/docs/source/installation/installation-production.rst b/docs/source/installation/installation-production.rst index 08ede3d40..7169af5d8 100644 --- a/docs/source/installation/installation-production.rst +++ b/docs/source/installation/installation-production.rst @@ -14,6 +14,16 @@ Symfony apps `_. Install a new app ================= +Install required dependencies: +------------------------------ + +- `jq`: https://jqlang.org/ (install it through your package manager); +- `php`, minimal version: 8.3; +- `composer`: https://getcomposer.org/download/ +- `symfony-cli`: https://symfony.com/download +- `docker` with the plugin `compose`: https://docs.docker.com/engine/install/ and https://docs.docker.com/compose/install/ + + Initialize project and dependencies ----------------------------------- @@ -29,7 +39,7 @@ We strongly encourage you to initialize a git repository at this step, to track # add the flex endpoints required for custom recipes cat <<< "$(jq '.extra.symfony += {"endpoint": ["flex://defaults", "https://gitlab.com/api/v4/projects/57371968/repository/files/index.json/raw?ref=main"]}' composer.json)" > composer.json # install chill and some dependencies - symfony composer require chill-project/chill-bundles ^3.7.1 champs-libres/wopi-lib dev-master@dev champs-libres/wopi-bundle dev-master@dev symfony/amqp-messenger + symfony composer require -W chill-project/chill-bundles ^3.7.1 champs-libres/wopi-lib dev-master@dev champs-libres/wopi-bundle dev-master@dev symfony/amqp-messenger We encourage you to accept the inclusion of the "Docker configuration from recipes": this is the documented way to run the database. You must also accept to configure recipes from the contrib repository, unless you want to configure the bundles manually). @@ -38,6 +48,8 @@ You must also accept to configure recipes from the contrib repository, unless yo # fix some configuration ./post-install-chill.sh + # populate the cache for the first time. This is necessary to dump some translation files, required for the assets compilation + symfony console cache:clear # install node dependencies yarn install # and compile assets