Chill-project/chill-bundles
6
0
Fork 0
mirror of https://gitlab.com/Chill-Projet/chill-bundles.git synced 2025-06-07 18:44:08 +00:00
Code Issues Actions Projects Releases Wiki Activity

fix installation instructions

Browse Source
This commit is contained in:
Julien Fastré 2020-04-22 13:09:26 +02:00
parent 79b9f0d274
commit 2b63c51dee
1 changed files with 23 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
source/installation/index.rst
View File

@ -11,8 +11,8 @@
A copy of the license is included in the section entitled "GNU A copy of the license is included in the section entitled "GNU
Free Documentation License". Free Documentation License".
Installation Installation & Usage
############# ####################
Requirements Requirements
@ -22,10 +22,10 @@ Requirements
- Make is used to automate scripts. - Make is used to automate scripts.
Installation in development mode Installation in development mode
******************************* ********************************
Get the code 1. Get the code
============ ===============
Clone or download the chill-standard project and `cd` into the main directory. Clone or download the chill-standard project and `cd` into the main directory.
@ -36,11 +36,10 @@ Clone or download the chill-standard project and `cd` into the main directory.
cd Chill-Standard cd Chill-Standard
As a developer, the code will stay on your computer and will be executed in docker container. To avoid permission problem, the code should be run with the same uid/gid from your current user. This is why we get your current user id with the command ``id -u`` in each following scripts. As a developer, the code will stay on your computer and will be executed in docker container. To avoid permission problem, the code should be run with the same uid/gid from your current user. This is why we get your current user id with the command ``id -u`` in each following scripts.
Prepare your variables 2. Prepare your variables
====================== =========================
Have a look at the variable in ``env.dist`` and in ``app/config/parameters.yml.dist`` and check if you need to adapt them. If they do not adapt with your need, or if some are missing: Have a look at the variable in ``env.dist`` and in ``app/config/parameters.yml.dist`` and check if you need to adapt them. If they do not adapt with your need, or if some are missing:
@ -51,8 +50,8 @@ Have a look at the variable in ``env.dist`` and in ``app/config/parameters.yml.d
**Note**: If you intend to use the bundle ``Chill-Doc-Store``, you will need to configure and install an openstack object storage container with temporary url middleware. You will have to configure `secret keys <https://docs.openstack.org/swift/latest/api/temporary_url_middleware.html#secret-keys>`_. **Note**: If you intend to use the bundle ``Chill-Doc-Store``, you will need to configure and install an openstack object storage container with temporary url middleware. You will have to configure `secret keys <https://docs.openstack.org/swift/latest/api/temporary_url_middleware.html#secret-keys>`_.
Run the bootstrap script 3. Run the bootstrap script
======================== ===========================
This script can be run using `make` This script can be run using `make`
@ -65,18 +64,11 @@ This script will :
1. force docker-compose to, eventually, pull the base images and build the image used by this project ; 1. force docker-compose to, eventually, pull the base images and build the image used by this project ;
2. run an install script to download `composer <https://getcomposer.org>`_ ; 2. run an install script to download `composer <https://getcomposer.org>`_ ;
3. install the php dependencies 3. install the php dependencies
4. build assets
Build assets
============
run those commands: 4. Start the project
====================
.. code-block:: bash
make build-assets
Start the project
=================
.. code-block:: bash .. code-block:: bash
@ -86,7 +78,7 @@ Start the project
.. code-block:: bash .. code-block:: bash
docker-compose exec --user $(id -u) php app/console doctrine:migrations:migrate make migrate
Chill will be available at ``http://localhost:8001.`` Currently, there isn't any user or data. To add fixtures, run Chill will be available at ``http://localhost:8001.`` Currently, there isn't any user or data. To add fixtures, run
@ -101,11 +93,20 @@ There are several users available:
The password is always ``password``. The password is always ``password``.
Now, read the how-tos. Now, read `Operations` below.
Operations Operations
********** **********
Build assets
============
run those commands:
.. code-block:: bash
make build-assets
How to execute the console ? How to execute the console ?
============================ ============================