From aec6430477daacff80ca6ac9ecc3c27d0b7bbef5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jacobo=20Aragunde=20P=C3=A9rez?= Date: Wed, 21 Dec 2022 10:50:13 +0100 Subject: [PATCH] Docs: update installation instructions. --- docs/admin/installation.rst | 13 +++++++------ docs/developer/devel-setup.rst | 7 ++++++- 2 files changed, 13 insertions(+), 7 deletions(-) diff --git a/docs/admin/installation.rst b/docs/admin/installation.rst index 3cd6b34e3..a080afed5 100644 --- a/docs/admin/installation.rst +++ b/docs/admin/installation.rst @@ -29,14 +29,10 @@ Run the following command with root privileges: * Fedora: ``dnf install postgresql-server httpd php php-pgsql php-xml php-pdo`` -Install composer to manage the project dependencies. Follow the official +If you are installing PhpReport from sources instead of a release package, you +must install composer to manage the project dependencies. Follow the official docs for the instructions: https://getcomposer.org/doc/00-intro.md#installation-linux-unix-macos -After installing composer, run ``composer dump-autoload -o`` inside PhpReport root -directory, so it can generate the autoload files. - -Run ``composer install`` to install the project dependencies. - Step 1: Setting up the database =============================== @@ -62,6 +58,11 @@ Move the program files to a location available for the web server, inside a directory called phpreport. The usual default location for the Apache web server is: ``/var/www/html/`` +If you are installing PhpReport from sources instead of a release package, you +must also run ``composer dump-autoload -o`` inside PhpReport root directory, +so it can generate the autoload files. Then, run ``composer install`` to install +the project dependencies. + Step 3: Creating the schema and initial data of the database ============================================================ diff --git a/docs/developer/devel-setup.rst b/docs/developer/devel-setup.rst index a0eb56cce..d4f44354b 100644 --- a/docs/developer/devel-setup.rst +++ b/docs/developer/devel-setup.rst @@ -11,7 +11,8 @@ Step 0: Dependencies ==================== Follow the corresponding section from the -`installation instructions <../admin/installation.rst>`__. +`installation instructions <../admin/installation.rst>`__. Make sure to also +install *composer* as specified there. Additionally, a development environment may need the following dependencies to generate minified versions of the JS code and the documentation pages: @@ -37,6 +38,10 @@ Apache web server is: ``/var/www/html/`` Alternatively, clone it elsewhere and create a link from the web server directory. +You must also run ``composer dump-autoload -o`` inside PhpReport root directory, +so it can generate the autoload files. Then, run ``composer install`` to install +the project dependencies. + Step 3: Creating the schema and initial data of the database ============================================================