Skip to content

Commit

Permalink
Docs: update installation instructions.
Browse files Browse the repository at this point in the history
  • Loading branch information
jaragunde committed Dec 22, 2022
1 parent 2707de4 commit aec6430
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 7 deletions.
13 changes: 7 additions & 6 deletions docs/admin/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
===============================

Expand All @@ -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
============================================================

Expand Down
7 changes: 6 additions & 1 deletion docs/developer/devel-setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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
============================================================

Expand Down

0 comments on commit aec6430

Please sign in to comment.